Twitchの設定とEventSub

単純なチャットには通常のページ取得を使います。フォロー、サブスク、Bits、報酬、レイド、Hype Train、チャネル操作にはEventSub/WebSocketモードを使います。

Twitchソースのモードを選ぶ

モード適した用途重要な違い
標準(Standard) Twitchのチャットページまたはポップアウトページから、基本的な公開チャットを取得します。 ページに公開された内容を読み取ります。簡単ですが、EventSubの全イベントは取得できません。
WebSocket / EventSub フォロー、サブスク、Bits、報酬、レイド、配信状態、Hype Train、モデレーション同期、チャット送信、チャネル情報。 Twitch OAuthが必要です。ログイン済みアカウント、チャネル内の役割、チャネルの資格、付与されたスコープが許可するイベントのみが有効になります。

デスクトップアプリの設定

  1. 選択する項目: ソースを追加 → Twitch(Add source → Twitch).
  2. URLで使われるTwitchチャネルのログイン名を入力します。次のURLでは、 twitch.tv/examplechannelの場合は、次を入力します: examplechannel.
  3. 次はそのままにします: WebSocket を選択すると、より多くの情報を取得できるEventSubソースを使います。現在、アプリのTwitchはこのモードが標準です。
  4. 選択する項目: ソースを有効化(Activate source)、次に Twitchにログイン.
  5. 要求された権限を承認し、Twitchソースウィンドウを開いたままにします。
External browserとLocal appのログイン方法を表示したTwitchソースのログイン画面
デスクトップソースには、外部ブラウザのOAuth方式とアプリ内方式があります。通常のブラウザですでにTwitchが使えている場合は、外部ブラウザ方式が一般的に最も簡単です。

ブラウザ拡張機能でのEventSub設定

  1. 最新版のSocial Stream Ninja拡張機能をインストールして有効にします。
  2. 開く項目: Twitch EventSubソースページ.
  3. 置き換える値: examplechannel をURL内で、監視したいチャネルのログイン名に置き換えてください。
  4. 選択する項目: Twitchにログイン を選び、要求されたアクセスを承認します。
  5. そのページを開いたままにし、アラートをテストする前にUserとChannelの値が正しいことを確認してください。
https://socialstream.ninja/sources/websocket/twitch.html?channel=CHANNEL_LOGIN

基本のStandard取得を使う場合は、通常のTwitchチャットまたはポップアウトチャットページを開き、チャットを表示したままにします。

Twitchが要求するもの

Social Streamは、対応する操作と購読に必要な権限を持つユーザートークンを要求します。スコープを付与しても、アカウントが配信者やモデレーターになるわけではありません。Twitchは選択したチャネルでのアカウントの役割を引き続き確認します。

権限グループ用途
チャット(Chat)チャットの読み取り、送信、参加者一覧の取得。
フォロワーとサブスクライバーフォローイベント、サブスクイベント、ギフトサブスク、再サブスクメッセージ。
Bits、報酬、Hype TrainCheer、カスタムチャンネルポイント報酬の交換、Hype Trainの状態。
モデレーションアカウントにチャネルのモデレーション権限がある場合、メッセージ削除、BAN/タイムアウト、ブロックの同期。
チャネル管理タイトルとカテゴリの読み取り/更新、広告の読み取り/管理、チャネル指標の表示。

Twitch公式の次をご覧ください: スコープリファレンス および EventSubの購読タイプ.

現在のソースが処理するイベント

  • フォロー: new_follower.
  • サブスク: new_subscriber, resub、および subscription_gift.
  • Bits: cheer に寄付額が付いたもの。
  • チャンネルポイント: reward.
  • レイド: raid.
  • 配信と広告の状態: stream_online, stream_offline、および ad_break.
  • Hype Train: hype_train 開始、進行、終了の更新。
  • モデレーション: 許可されている場合に、BANとメッセージ削除の更新。

Twitchのサブスクイベントには、資格のあるアフィリエイト/パートナーチャネルと配信者権限が必要です。フォローやモデレーションの購読では、イベントに応じて、ログイン済みユーザーが配信者または権限を持つモデレーターである必要があります。

受信後のアラート名とペイロードフィールドには、次を参照してください: イベントとアラートの互換性ガイド および イベントリファレンス.

イベントが届かない場合の最初の確認

  1. ソースページに正しい次の値が表示されていることを確認します: ユーザー(User) および チャンネル(Channel).
  2. ソースページ/ウィンドウを開いたままにし、チャット接続が有効であることを確認してください。
  3. チャットは動くのにフォロー/サブスク/報酬が届かない場合は、ログアウトして再認証し、現在のスコープを付与してください。
  4. ログイン済みアカウントが、そのチャネルの配信者または許可されたモデレーターであることを確認してください。
  5. ドックとアラートオーバーレイが同じSocial StreamセッションIDを使っていることを確認してください。
  6. ポップアップの架空テストメッセージまたはMulti Alertsプレビューを使い、取得側とオーバーレイ側の問題を切り分けてください。

EventSubは同じ通知を複数回配信することがあります。 Twitchは少なくとも1回の配信を保証すると説明しています。Social Streamには重複防止がありますが、独自のAPI利用側でも、可能ならイベント/メッセージの識別情報で重複を除外してください。公式の次を参照してください: EventSubの概要.