instagram/
highlight-items

既知のInstagramハイライトIDから公開ストーリーズのアイテムを取得し、テキスト、投稿者情報、表示中の指標、メディアの詳細、取得元の情報を含む正規化レコードとして返します。

Instagram Highlight Items API

既知のハイライトID
ストーリーズのアイテムレコード
メディアと取得元の情報
結果1件あたり0.5クレジット
準備完了
準備完了

パラメータを入力してリクエストを送信してください。タスクのステータスと正規化された結果がここに表示されます。

README

SocQ 編集 · 更新

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をポーリングして、保存された正規化レコードを結果カーソルのページネーションで読み取ります。

  1. 現在有効な数値のハイライトIDを1つ以上用意します。IDがわからない場合は、先にユーザー名でストーリーズのハイライトを収集し、返されたコンテナレコードから extra.highlight_id を読み取ります。
  2. highlight_ids を /v1/instagram/highlight-items に POST します。
  3. status が succeeded または failed になるまで /v1/tasks/{task_id} をポーリングします。
  4. /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 true

Instagram 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からの収集を継続するものではありません。

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のデータを、対応する他のソーシャルプラットフォームの公開データと組み合わせられます。

Instagram Highlight Items API — よくある質問

Instagram Highlight Items APIは、既知の数値のInstagramハイライトIDから公開ストーリーズのアイテムを取得するためのプログラムインターフェースです。正規化されたアイテムの識別情報、テキスト、投稿者、表示中の指標、メディアのメタデータ、タイムスタンプ、取得元ハイライトの情報を返します。

現在有効な既知のハイライトIDを使うか、先にユーザー名でストーリーズのハイライトを収集してください。instagram/story-highlights の成功した結果では、取得可能な場合に取得元の識別子が extra.highlight_id として含まれます。このエンドポイントはユーザー名を受け付けません。

正規化されたアイテムには、ID、URL、テキスト、投稿者ID、ユーザー名と名前、表示中の指標、画像・動画のメタデータ、created_at、collected_at、extra.highlight_id が含まれる場合があります。どのフィールドを取得できるかは、公開アップストリームのレスポンスによります。

results_limit は指定できず、コレクターはハイライトIDごとに1回アップストリームにリクエストします。ただし、タスク結果のエンドポイントでは、limit と results.next_cursor を使って保存済みのレコードをページ送りで取得できます。

ハイライトに現在公開されているレコードがない場合や、ストーリーズのアイテムが削除、制限、非公開化、または利用不可になっている場合があります。タスクが保存するのは、現在の公開レスポンスに含まれるレコードのみです。

返された正規化レコード1件につき0.5クレジットで、基本料金はかかりません。見積もりは送信したハイライトID1つにつき20レコードで算出し、最終的な使用量は実際に返されたレコード数に基づきます。