Snapchat Spotlight Comments
Snapchat Spotlightのコメントは、指定した1件のSpotlightに関連付けられた公開の反応です。SocQは返された各コメントを CommentItem として保存し、ソースの識別情報、コメント本文、取得可能な投稿者情報、親コメントと投稿への参照、公開日時と取得日時、表示中のいいね数や返信数を保持します。
Snapchat Spotlight Comments API の主な機能
- タスクごとにSpotlightのURLを1件snapchat.comまたはSnapchatのサブドメイン上の空でない url を1件送信します。プロバイダーはその対象についてソースを1ページ分リクエストします。
- 正規化されたコメントレコードコメントID、本文、ソースURL、タイムスタンプ、取得可能な投稿者の識別情報を、安定した CommentItem 1.0 の結果形式で読み取れます。
- スレッドとエンゲージメントの情報ソースが公開している場合は parent_id、post_id、likes_count、replies_count を保持します。欠けているフィールドを0として扱ったり、スレッド全体を網羅しているとみなしたりはしません。
Snapchat Spotlight Comments API のパラメータ
| パラメータ | 必須 | 説明 |
|---|---|---|
url | 必須 | 必須。空でないSnapchatのURLです。ランタイムの検証ではsnapchat.comとそのサブドメインを受け付けます。プロバイダーが意図したSpotlightリソースを受け取れるよう、/@username/spotlight/{spotlight_id} 形式の公開正規URLを使用してください。 |
Snapchat Spotlight Comments API の使い方
公開Snapchat SpotlightのURLを送信して非同期タスクを追跡し、保存された正規化コメントをタスク結果のページネーションで読み取ります。
- 確認したい公開Snapchat Spotlightの正規URLをコピーします。
- url を /v1/snapchat/spotlight-comments に POST し、返された task_id を保存します。
- タスクが成功するか失敗を返すまで /v1/tasks/{task_id} をポーリングします。
- data.results.items を読み取ります。保存されたタスク結果がAPIレスポンスの複数ページにまたがる場合は、has_more が true の間 next_cursor を使って続きを取得します。
curl -X POST "https://api.socq.ai/v1/snapchat/spotlight-comments" \
-H "Authorization: Bearer $SOCQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://www.snapchat.com/@queenhaley_13/spotlight/W7_EDlXWTBiXAEEniNoMPwAAYY2pnZnF0bG52AZslQsUdAZslQoRQAAAAAQ"}'
# Poll GET /v1/tasks/{task_id}
# Read data.results.items and follow next_cursor while has_more is trueSnapchat Spotlight Comments API の主なユースケース
- 反応の定性的な確認: 返された公開コメントの本文と取得可能な投稿者情報から、選定したSpotlightに寄せられた質問、反応、繰り返し現れるテーマを確認します。
- ソースに紐付いたコメントアーカイブ: コメントID、ソースURL、post_id、parent_id、published_at、collected_at を保持し、保存したすべてのコメントが取得可能な出所情報を保てるようにします。
- 表示中のエンゲージメントのスナップショット: 返されたコメント間で取得可能な likes_count と replies_count を比較し、各観測値を collected_at に結び付けます。
Snapchat Spotlight Comments API 活用のヒント
- ランタイムの検証は厳密なパスではなくSnapchatのホストを確認するだけですが、/@username/spotlight/{spotlight_id} 形式の公開正規URLを使用してください。
- 送信ペイロードに cursor や results_limit を含めないでください。このエンドポイントが扱うのは url のみで、プロバイダーから1ページ分を収集します。
- parent_id と replies_count は参考情報として扱い、返されたレコードに返信ツリー全体が含まれている証拠とはみなさないでください。
- ソースが提供しない場合に備えて、ID、URL、本文、投稿者フィールド、published_at、parent_id、post_id、指標が null になることを許容してください。
- プロバイダーの収集範囲と GET /v1/tasks/{task_id} のページネーションは区別してください。後者のカーソルは、完了したタスクにすでに保存された結果をページ単位で読み進めるだけです。
関連API
Snapchat Spotlight Comments API 以外に別の種類の公開Snapchatデータが必要な場合は、これらのAPIをご利用ください。
- Snapchat Profile API
- Snapchat Spotlight API — 既知の公開Snapchat Spotlight 1件を取得し、正規化されたクリエイター、キャプション、メディア、オーディオ、タイムスタンプ、再生時間、表示中のエンゲージメントの各フィールドを、取得可能な範囲で返します。