Snapchat Profile
Snapchatの公開プロフィールでは、ユーザー名、表示名、プロフィール文、アバター、カバー画像、Webサイト、アカウント属性、所在地、表示中のプロフィール数値が公開されている場合があります。この照会に特化したエンドポイントは、既知のユーザー名1件を正規化されたアカウントのスナップショットに変換し、情報補完、確認、後日の比較に活用できるようにします。
Snapchat Profile API の主な機能
- ユーザー名による完全一致検索アカウントを検索するのではなく、タスクごとに既知のSnapchatユーザー名を1件照会します。先頭の @ は1つまで付けても付けなくてもかまいません。
- 正規化されたプロフィール識別情報取得可能なユーザー名、表示名、プロフィール文、公開URL、固定のソース識別子を AccountItem レコードで返します。
- プロフィールメディアと付随情報取得可能なアバター、カバー画像、Webサイト、所在地のフィールドを個別に保持し、表示、インデックス作成、情報補完のワークフローで使えるようにします。
- 表示中のアカウント指標取得時点で表示されている認証・非公開フラグと、フォロワー数・フォロー数・投稿数を記録します。
Snapchat Profile API のパラメータ
| パラメータ | 必須 | 説明 |
|---|---|---|
username | 必須 | 必須。Snapchatのユーザー名です。任意の先頭 @ を1つ付け、その後に1〜64文字のASCII英字、数字、ピリオド、アンダースコア、ハイフンを続けます。スペース、プロフィールURL、その他の文字は拒否されます。 |
Snapchat Profile API の使い方
受け付けられる形式のユーザー名を1件送信し、非同期タスクの完了を待ってから正規化プロフィールの結果を読み取ります。
- 英字、数字、ピリオド、アンダースコア、ハイフンで構成される既知のSnapchatユーザー名を1件選びます。先頭の @ は1つまで任意です。
- username を /v1/snapchat/profile に送信し、返された task_id を保持します。
- タスクが succeeded または failed になるまで /v1/tasks/{task_id} をポーリングします。
- 成功したら data.results.items を読み取ります。この詳細照会では通常、プロフィール1件または空のリストが返されます。
curl -X POST "https://api.socq.ai/v1/snapchat/profile" \
-H "Authorization: Bearer $SOCQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"username":"zane"}'
# Poll GET /v1/tasks/{task_id}
# Read data.results.items after the task succeedsSnapchat Profile API の主なユースケース
- 既知アカウントの情報補完: Snapchatユーザー名をすでに持つレコードに、公開識別情報、プロフィール文、プロフィールメディア、Webサイト、取得可能な数値を追加します。
- 選定プロフィールの確認: ストーリーズ、Spotlight、アカウント管理操作を混在させることなく、1つの公開アカウントを統一されたプロフィールカードや確認キューに表示します。
- 公開スナップショットの比較: 連続して取得した結果とともに collected_at を保存し、公開プロフィールのテキスト、アカウント属性、メディア、表示中の数値の経時的な変化を比較します。
Snapchat Profile API 活用のヒント
- リクエストでは先頭の @ を1つ受け付けますが、自社のレコードでは統一された正規の形式でユーザー名を管理してください。
- タスクごとに送信するユーザー名は必ず1件にしてください。一括送信、プロフィールURL、results_limit はこのエンドポイントの仕様外です。
- 形式が受け付けられたことは入力検証を通過したというだけで、そのユーザー名がアクセス可能な公開プロフィールに解決される保証ではありません。
- Webサイト、所在地、プロフィールメディア、アカウント属性、個々の指標は任意フィールドとして扱ってください。
- プロフィールのテキストや表示中の数値は特定時点の値のため、保存するすべての結果に collected_at を残してください。
関連API
Snapchat Profile API 以外に別の種類の公開Snapchatデータが必要な場合は、これらのAPIをご利用ください。
- Snapchat Spotlight API — 既知の公開Snapchat Spotlight 1件を取得し、正規化されたクリエイター、キャプション、メディア、オーディオ、タイムスタンプ、再生時間、表示中のエンゲージメントの各フィールドを、取得可能な範囲で返します。
- Snapchat Spotlight Comments API