Instagram Highlight Items
Instagramハイライトのアイテムは、公開プロフィールのハイライト内に保存されたストーリーズで、テキスト、投稿者情報、メディアの参照情報、タイムスタンプ、表示中のエンゲージメントシグナルを含みます。これらのレコードは、ハイライトのコンテンツ一覧の作成、メディアの確認、取得元を踏まえたレポーティング、既知のハイライト間の比較に活用できます。
Instagram Highlight Items API の主な機能
- 複数ハイライトの入力1つ以上の数値のハイライトIDを送信でき、指定した識別子ごとに1回ずつアップストリームへの照会を行います。
- 正規化されたストーリーズのアイテムレコードアイテムID、公開URL、タイトルまたはキャプションのテキスト、投稿者情報、表示中の指標、メディアのメタデータ、タイムスタンプを1つのレコード形式で受け取れます。
- 取得元ハイライトの記録返される各アイテムは送信したハイライトIDを extra.highlight_id に保持するため、複数のハイライトから取得したレコードも区別できます。
Instagram Highlight Items API のパラメータ
| パラメータ | 必須 | 説明 |
|---|---|---|
highlight_ids | 必須 | 1つ以上の既知のInstagramハイライトIDです。空でない数字の文字列で、カンマまたは改行で区切って指定します。 |
Instagram Highlight Items API の使い方
既知のハイライトIDを非同期タスクとして送信し、タスクIDをポーリングして、保存された正規化レコードを結果カーソルのページネーションで読み取ります。
- 現在有効な数値のハイライトIDを1つ以上用意します。IDがわからない場合は、先にユーザー名でストーリーズのハイライトを収集し、返されたコンテナレコードから extra.highlight_id を読み取ります。
- highlight_ids を /v1/instagram/highlight-items に POST します。
- status が succeeded または failed になるまで /v1/tasks/{task_id} をポーリングします。
- /v1/tasks/{task_id}?limit=50 を読み取り、results.has_more が true の間は results.next_cursor をたどって続きを取得します。
# Replace the documented sample with a current highlight ID before running.
curl -X POST "https://api.socq.ai/v1/instagram/highlight-items" \
-H "Authorization: Bearer $SOCQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"highlight_ids":["18067016518767507"]}'
# Poll GET /v1/tasks/{task_id}
# Read data.results.items and follow next_cursor while has_more is trueInstagram Highlight Items API の主なユースケース
- 保存済みストーリーズのコンテンツ一覧: 返されたアイテムID、テキスト、公開URL、メディアの参照情報、タイムスタンプを、既知のハイライトごとに確認しやすい一覧として整理します。
- ハイライトのメディア確認: 各ハイライトで現在公開されているストーリーズのアイテムについて、画像・動画のURL、サムネイル、サイズ、再生時間、キャプション、投稿者情報を確認します。
- ハイライト間の比較: extra.highlight_id でレコードをグループ化し、選んだハイライト間で、返されたコンテンツの種類、投稿日時、投稿者、表示中の指標を比較します。
Instagram Highlight Items API 活用のヒント
- ハイライトIDがわからない場合は、先にユーザー名で instagram/story-highlights を呼び出し、成功した結果の extra.highlight_id を使ってください。このエンドポイントはユーザー名からIDを探しません。
- コレクターは指定された値ごとに個別の照会を行うため、送信前に重複するIDを取り除いてください。
- results_limit は追加しないでください。各ハイライトIDからは、1回のアップストリームレスポンスで取得できるアイテムが返されます。
- 正規化されたレコードはどちらも type が story になるため、highlight-items と story-highlights の区別には resource を使ってください。
- テキスト、投稿者のフィールド、指標、メディア、URL、タイムスタンプは任意項目として扱い、利用できない、または削除されたストーリーズのアイテムではレコードが生成されないケースを許容してください。
- results.next_cursor は、保存済みのタスクレコードの続きを読み取るためだけに使ってください。Instagramからの収集を継続するものではありません。
関連API
Instagram Highlight Items API 以外に別の種類の公開Instagramデータが必要な場合は、これらのAPIをご利用ください。
- Instagram Posts API — ユーザー名から、公開投稿、メディア、ハッシュタグ、メンション、タイムスタンプ、エンゲージメントを取得します。
- Instagram Reels API — ユーザー名から、公開リール、メディア、オーディオ、ハッシュタグ、メンション、エンゲージメントを取得します。
- Instagram Profiles API — ユーザー名から、公開プロフィールのアカウント情報、プロフィール文、リンク、アカウント属性、カテゴリ、表示中のカウントを取得します。
- Instagram Tagged Posts API — 指定したプロフィールがタグ付けされた公開投稿を、投稿者、メディア、メンション、タグ付けされたユーザーの情報、エンゲージメントとともに取得します。
- Instagram Transcript API — 公開投稿またはリールのURLから、文字起こしテキスト、言語、形式、元のURL、ショートコードを抽出します。
- Instagram Story Highlights API — ユーザー名から公開ストーリーズハイライトの一覧を取得し、タイトル、所有者情報、メディア数、再利用可能なハイライトIDを返します。
- Instagram Followers Count API
- Instagram Search API
- Instagram Comments API
- Instagram Followers List API
- Instagram Following List API
- Instagram Hashtag Posts API
- Instagram Audio Reels API
- Instagram Post Info API
- Instagram Reels Search API
- Instagram Trending Reels API
- Instagram Stories API
- Instagram Similar Accounts API
- Instagram Comment Replies API
- Instagram Post Likers API
- Instagram Location Info API
- Instagram Location Posts API
- Instagram Location Search API
- Instagram Hashtag Search API
- Instagram Account Age Checker API