IGメディア

Instagramのアルバム、写真、動画(アップロードされた動画、ライブ動画、リール動画、ストーリーズ)を表します。

If you are migrating from Marketing API Instagram Ads endpoints to Instagram Platform endpoints, be aware that some field names are different.

以下のフィールドを紹介します。

  • legacy_instagram_media_id

次のマーケティングAPI Instagram広告エンドポイントフィールドはサポートされていません。

  • filter_name
  • location
  • location_name
  • latitude
  • longitude

作成

この操作はサポートされていません。

読み取り

GET /<IG_MEDIA_ID>

Instagramメディアのフィールドエッジを取得します。

要件

Instagramログインを使ったInstagram APIFacebookログインを使ったInstagram API

アクセストークン

  • Instagramユーザーアクセストークン

ホストURL

graph.instagram.com

graph.facebook.com

ログインタイプ

Instagram用のビジネスログイン

ビジネス向けFacebookログイン

アクセス許可
  • instagram_business_basic
  • instagram_basic
  • pages_read_engagement

アプリユーザーのInstagramプロアカウントにリンクされたページ上で、ビジネスマネージャを介してアプリユーザーに役割が付与されている場合は、アプリに次のいずれかも必要です。

  • ads_management
  • ads_read

制限

  • comments_countlike_countなどのフィールドはターゲットInstagramメディアのエンゲージメントのみを返します。他のサーフェスのデータは含まれません。例えば、comments_countは写真に付けられたコメントの数を返しますが、その写真を使用した広告に付けられたコメントは返しません。宣伝/広告メディアのエンゲージメントを含む集計数を取得するには、total_comments_counttotal_like_countを使用してください。クロス投稿されたFacebook投稿の数が含まれるのは、その投稿がセッションのユーザーからアクセス可能な場合です。
  • アプリユーザーが管理者と同等のタスクをアプリで実行できない限り、キャプションに@記号は含まれません。
  • permalinkなど一部のフィールドは、アルバム内の写真(子)には使えません。
  • ライブ動画Instagramメディアは、配信中のみ読み取り可能です。
  • このAPIは、Instagramプロアカウントが所有するメディアのデータのみを返します。個人用Instagramアカウントが所有するメディアのデータを取得するために使用することはできません。
  • reposts_countsaved_countshares_counttotal_like_counttotal_comments_counttotal_views_countフィールドはカルーセルの子メディアでは利用できず、トップレベルのメディアオブジェクトの場合のみ返されます。メディア所有者は、「いいね!」の数、コメント数、閲覧数、再投稿数、シェア数の表示を無効にできます。その場合、対応するフィールドは返されません。

リクエストの構文

GET https://<HOST_URL>/<API_VERSION>/<IG_MEDIA_ID> \
  ?fields=<LIST_OF_FIELDS> \
  &access_token=<ACCESS_TOKEN>

パスパラメーター

プレースホルダー

<API_VERSION>

最新バージョン:

v26.0

アプリが使用しているAPIバージョン。API呼び出しで指定されていない場合は、Metaアプリを作成した時点での最新バージョンになります。そのバージョンが利用できなくなった場合は、利用できる最も古いバージョンになります。バージョン管理について詳しくはこちらをご覧ください。

<HOST_URL>

エンドポイントをクエリするためにアプリが使用しているホストURL

<IG_MEDIA_ID>

必須。公開されるメディアのID。

クエリ文字列パラメーター

キープレースホルダー

access_token

<ACCESS_TOKEN>

必須。アプリユーザーのFacebookまたはInstagramユーザーアクセストークン。

fields

<LIST_OF_FIELDS>

戻り値を取得するフィールドのコンマ区切りリスト。

フィールド

公開フィールドは、フィールド拡張機能で読み取ることができます。

フィールド説明

alt_text 公開

アクセシビリティのための、画像の説明文。

boost_ads_list

ステータスがACTIVEである広告のオーガニックメディアに関連するすべてのInstagram広告情報の概要を提供します。これには、相対的な広告IDと広告配信ステータスが含まれます。FacebookログインによるInstagram APIのみで利用可能です。

boost_eligibility_info

このフィールドには、広告としてInstagramメディアを利用できるかどうかに関する情報と、利用資格がない場合には追加の詳細が表示されます。FacebookログインによるInstagram APIのみで利用可能です。

caption 公開

キャプション。アルバムの子を除きます。@記号は、キャプションの作成に使用されたInstagramアカウントにリンクしているFacebookページに対し、アプリユーザーが管理者と同等のタスクを実行できない限り、除外されます。FacebookログインによるInstagram APIのみで利用可能です。

comments_count 公開

メディアに付けられたコメントの数。アルバムの子メディアとメディアのキャプションに付けられたコメントを除きます。コメントへの返信を含みます。

copyright_check_information.status

statusオブジェクトとmatches_foundオブジェクトを返します

statusオブジェクト説明

status

  • completed – 検出処理は終了しました
  • error – 検出処理でエラーが発生しました
  • in_progress – 検出処理は実行中です
  • not_started – 検出処理はまだ始まっていません

matches_found

以下のいずれかを設定します。

  • 動画が著作権違反をしていない場合は、false
  • 動画が著作権違反をしている場合は、true

動画が著作権違反をしている場合、著作権が保護されているマテリアルのオブジェクト配列と、違反が動画内で発生している場合は、その違反を軽減するために取るべきアクションの配列を含むcopyright_matchesが返されます。

copyright_matchesオブジェクト説明

author

著作権が保護されている動画の作成者

content_title

著作権が保護されている動画の名前

matched_segments

次のキーと値のペアを持つオブジェクトの配列

  • duration_in_seconds – コンテンツが著作権を侵害している秒数
  • segment_typeAUDIOまたはVIDEOのいずれか
  • start_time_in_seconds – 動画の開始時間を設定します

owner_copyright_policy

返されるオブジェクトには次のものが含まれます。

  • name – 著作権所有者のポリシーの名前。
  • actions – 著作権所有者のポリシーで定義された緩和ステップを含むactionオブジェクトの配列。場所によって異なる緩和ステップが含まれる場合があります。
    • action – 著作権違反をしている動画に対する緩和措置。緩和の手順は、国によって異なる可能性があります。次のいずれかの値になります。
      • BLOCK – 動画は、geos配列にリストされているオーディエンスに対してブロックされます
      • MUTE - 動画は、geos配列にリストされているオーディエンスに対してミュートされます

id 公開

メディアID。

is_ai_generated

メディアにAIラベルがあるかどうかを示します。アルバムの子は除外されます。

is_comment_enabled

コメントが有効か無効かを示します。アルバムの子を除きます。

is_shared_to_feed 公開

リールのみ。trueの場合、リール動画は[フィード]タブと[リール]タブの両方に表示されます。falseの場合、リール動画は[リール]タブだけに表示されます。

これらの値によって、リール動画が実際に[リール]タブに表示されるかどうかが決まるわけではありません。リール動画が資格条件を満たしていない場合や、当社のアルゴリズムで選択されない場合があるからです。資格要件については、リール仕様をご覧ください。

legacy_instagram_media_id

v21.0以前のマーケティングAPIエンドポイント用に作成されたInstagramメディアのID。

like_count

メディアに対する「いいね!」の数。コメントに対する返信も含まれます。アルバムの子メディアへの「いいね!」と、メディアから作成された宣伝投稿への「いいね!」を除きます。


別のエンドポイントやフィールド展開を通して間接的に問い合わせた場合、メディアの所有者が「いいね!」の数を非表示にしている場合にlike_countフィールドは省略されます。

media_audio_type 公開

メディアで使われている音声のタイプ。MUSICまたはORIGINAL_SOUNDのいずれかです。リールなどの動画メディアの場合にのみ返されます。その他のメディアタイプ(写真やカルーセルなど)の場合は返されません。

media_product_type 公開

メディアが公開されるサーフェス。ADFEEDSTORY、またはREELS。FacebookログインによるInstagram APIのみで利用可能です。

media_type 公開

メディアタイプ。CAROUSEL_ALBUMIMAGE、またはVIDEO

media_url 公開

メディアのURL。

メディアに著作権対象コンテンツが含まれている場合や、著作権違反のフラグが付いている場合、media_urlフィールドは応答から省かれます。著作権対象コンテンツの例として、リールの音声などが挙げられます。

owner 公開

メディアを作成したInstagramユーザーID。クエリするアプリユーザーがメディアも作成した場合にのみ返されます。それ以外の場合は、代わりにusernameフィールドが返されます。

permalink 公開

メディアを指す永続URL。

shortcode 公開

メディアを指すショートコード。

thumbnail_url 公開

メディアのサムネイルURL。VIDEOメディアでのみ使用可能。

timestamp 公開

ISO 8601形式のUTCでの作成日(デフォルトはUTC ±00:00)。

username 公開

メディアを作成したユーザーのユーザーネーム。

view_count 公開

Instagramリールの再生数。ペイドとオーガニックの両方の指標が含まれます。Facebookにクロス投稿されたコンテンツに関しては、セッションユーザーがそのFacebook投稿にアクセスできる場合に、InstagramとFacebookの合計閲覧数が返されます。

ビジネスディスカバリーAPIのみで利用可能です。

reposts_count 公開

メディアが再投稿された回数。FEEDおよびREELSメディアで利用可能です。ハッシュタグAPIエンドポイントからはアクセスできません。FacebookログインによるInstagram APIのみで利用可能です。

saved_count

メディアが保存された回数。FEEDおよびREELSメディアで利用可能です。メディアの所有者または承認された共同投稿者のみがアクセスできます。ビジネスディスカバリー、タグ付け/メンションされたメディア、ハッシュタグAPIエンドポイントからはアクセスできません。FacebookログインによるInstagram APIのみで利用可能です。

shares_count

メディアがシェアされた回数。FEEDおよびREELSメディアで利用可能です。ビジネスディスカバリーまたはハッシュタグAPIエンドポイントからはアクセスできません。FacebookログインによるInstagram APIのみで利用可能です。

total_comments_count 公開

すべてのサーフェスにおけるメディアへのコメントの合計数(関連する宣伝されたメディアへのコメントを含む)。ハッシュタグAPIエンドポイントからはアクセスできません。FacebookログインによるInstagram APIのみで利用可能です。

total_like_count 公開

すべてのサーフェスにおけるメディアへの「いいね!」の合計数(関連する宣伝されたメディアへの「いいね!」を含む)。ハッシュタグAPIエンドポイントからはアクセスできません。FacebookログインによるInstagram APIのみで利用可能です。

total_views_count

すべてのサーフェスにおける動画コンテンツの合計再生数(宣伝されたメディアの再生数とリプレイを含む)。動画メディアでのみ利用可能です。ビジネスディスカバリーまたはハッシュタグAPIエンドポイントからはアクセスできません。ビジネスディスカバリーの場合は、代わりにview_countを使ってください。FacebookログインによるInstagram APIのみで利用可能です。

エッジ

フィールド拡張により公開エッジを返すことが可能です。

エッジ説明

children 公開。

InstagramメディアアルバムのInstagramメディアオブジェクトのコレクションを表します。

collaborators

Instagramメディアオブジェクトにコラボレーターとして追加されたユーザーのリストを表します。FacebookログインによるInstagram APIのみで利用可能です。

comments

Instagramメディアオブジェクトに対するInstagramコメントのコレクションを表します。

insights

Instagramメディアオブジェクトに対するソーシャルインタラクション指標を表します。

cURLの例

リクエストの例

curl -X GET \
  'https://graph.instagram.com/v26.0/17895695668004550?fields=id,media_type,media_url,owner,timestamp&access_token=IGQVJ...'

応答の例

{
  "id": "17918920912340654",
  "media_type": "IMAGE",
  "media_url": "https://sconten...",
  "owner": {
    "id": "17841405309211844"
  },
  "timestamp": "2019-09-26T22:36:43+0000"
}

更新

POST /<IG_MEDIA_ID>

Instagramメディアに対するコメントを有効または無効にします。

Requirements

Instagram API with Instagram LoginInstagram API with Facebook Login

Access Tokens

  • Instagram User access token

Host URL

graph.instagram.com

graph.facebook.com

Login Type

Business Login for Instagram

Facebook Login for Business

Permissions
  • instagram_business_basic
  • instagram_business_manage_comments
  • instagram_basic
  • instagram_manage_comments
  • pages_read_engagement

If the app user was granted a role via the Business Manager on the Page connected to the targeted IG User, you will also need one of:

  • ads_management
  • ads_read

制限

ライブ動画Instagramメディアはサポートされていません。

リクエストの構文

POST https://<HOST_URL>/<API_VERSION>/<IG_MEDIA_ID>
  ?comment_enabled=<BOOL>
  &access_token=<ACCESS_TOKEN>

パスパラメーター

プレースホルダー

<API_VERSION>

最新バージョン:

v26.0

アプリが使用しているAPIバージョン。API呼び出しで指定されていない場合は、Metaアプリを作成した時点での最新バージョンになります。そのバージョンが利用できなくなった場合は、利用できる最も古いバージョンになります。バージョン管理について詳しくはこちらをご覧ください。

<HOST_URL>

エンドポイントをクエリするためにアプリが使用しているホストURL

<IG_MEDIA_ID>

必須。公開されるメディアのID。

クエリ文字列パラメーター

キープレースホルダー

access_token

<ACCESS_TOKEN>

必須。アプリユーザーのユーザーアクセストークン

comment_enabled

<BOOL>

必須。コメントを有効にするにはtrueに設定し、無効にするにはfalseに設定します。

cURLの例

リクエストの例

curl -i -X POST \
 "https://graph.instagram.com/v26.0/17918920912340654?comment_enabled=true&access_token=EAAOc..."

応答の例

{
  "success": true
}

削除

DELETE /<IG_MEDIA_ID>

Instagramメディアを削除します。

要件

Facebookログインを利用したInstagram API

アクセストークン

ホストURL

graph.facebook.com

ログインタイプ

ビジネス向けFacebookログイン

アクセス許可
  • instagram_basic
  • instagram_manage_contents

制限

このAPIはFacebookログインを利用したInstagram APIのみをサポートしています。広告以外の投稿、ストーリーズ、リール、カルーセルアルバム全体がサポートされています。カルーセルアルバム内のメディアを削除するには、カルーセルコンテナメディアIDを指定してカルーセルアルバム全体を削除する必要があります。カルーセル内のメディアを個別に削除することはできません。

リクエストの構文

POST https://graph.facebook.com/<API_VERSION>/<IG_MEDIA_ID>
  ?access_token=<ACCESS_TOKEN>

パスパラメーター

プレースホルダー

<API_VERSION>

最新バージョン:

v26.0

アプリが使用しているAPIバージョン。API呼び出しで指定されていない場合は、Metaアプリを作成した時点での最新バージョンになります。そのバージョンが利用できなくなった場合は、利用できる最も古いバージョンになります。バージョン管理について詳しくはこちらをご覧ください。

<IG_MEDIA_ID>

必須。公開されるメディアのID。

クエリ文字列パラメーター

キープレースホルダー

access_token

<ACCESS_TOKEN>

必須。アプリユーザーのユーザーアクセストークン

cURLの例

リクエストの例

curl -i -X DELETE \
 "https://graph.facebook.com/v26.0/17918920912340654?comment_enabled=true&access_token=EAAOc..."

応答の例(成功)

{
  "success": true,
  "deleted_id": "17918920912340654"
}

応答の例(失敗、メディアタイプがサポートされていない)

{
  "error": {
   "message": "Fatal",
   "type": "OAuthException",
   "code": -1,
   "error_subcode": 2207073,
   "is_transient": false,
   "error_user_title": "Media Type Not Supported",
   "error_user_msg": "The media type is not supported for this endpoint",
   "fbtrace_id": "Api-OlNdfcpOwIu6hNaT5Kw"
  },
}