IGユーザー

InstagramビジネスアカウントまたはInstagramクリエイターアカウントのことを指します。

このドキュメント全体で、「Instagramユーザー」と「Instagramアカウント」は同じ意味で使われています。どちらもアプリユーザーのInstagramプロアカウントを表します。

Requirements

Instagram API with Instagram LoginInstagram API with Facebook Login

Access Tokens

  • Instagram User 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_basic
  • 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

If you are requesting the shopping_product_tag_eligibility field for product tagging, you will also need:

  • catalog_management
  • instagram_shopping_tag_products

Business Roles

Not applicable.

If you are requesting the shopping_product_tag_eligibility field for product tagging, the app user must have an admin role on the Business Manager that owns the IG User's Instagram Shop.

Instagram Shop

Not applicable.

If you are requesting the shopping_product_tag_eligibility field for product tagging, the IG User must have an approved Instagram Shop with a product catalog containing products.

作成

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

読み取り

GET /<IG_USER_ID>

Instagramビジネスアカウントまたはクリエイターアカウントについてのフィールドおよびエッジを取得します。

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

リクエストの構文

GET https://graph.facebook.com/<API_VERSION>/<IG_USER_ID>
  ?fields=<LIST_OF_FIELDS>
  &access_token=<ACCESS_TOKEN>

パスパラメーター

プレースホルダー

<API_VERSION>

APIのバージョン

<IG_USER_ID>

必須。IGユーザーID。

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

キープレースホルダー

access_token

<ACCESS_TOKEN>

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

fields

<LIST_OF_FIELDS>

各IGユーザーについて戻り値として結果セットに入れる、IGユーザーのフィールドのコンマ区切りリスト。

フィールド

フィールド拡張を使って、公開フィールドをエッジから返すことが可能です。ページバックのInstagramアカウントへのアクセスで参照できるフィールドはわずかです。

フィールド名説明

alt_text
公開

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

biography
公開

プロフィール自己紹介テキスト。

followers_count
公開

このユーザーをフォローするInstagramユーザーの合計数。

follows_count

このユーザーがフォローするInstagramユーザーの合計数。

has_profile_pic

アプリユーザーのInstagramプロアカウントにプロフィール写真があるかどうかを示します。

id
公開

app-scoped user ID。ページバックのInstagramアカウントの場合に参照可能です。

is_published

アプリユーザーのInstagramアカウントが公開されているかどうかを示します。ページバックのInstagramアカウントの場合に参照可能です。

legacy_instagram_user_id

バージョン21.0以前のマーケティングAPIエンドポイント用に作成されたアプリユーザーのInstagram ID。ページバックのInstagramアカウントの場合に参照可能です。

media_count
公開

アプリユーザーのアカウントで公開されているIGメディアの合計数。

name

アプリユーザーのInstagramプロフィール名。

profile_picture_url

アプリユーザーのInstagramプロフィール写真のURL。

collaborative_media_search

IDによって特定のコラボレーションメディアを検索します。フィールド拡張を介してアクセスします。FacebookログインによるInstagram APIのみで利用可能です。

shopping_product_tag_eligibility

アプリユーザーがInstagramショップを開設しており、商品タグ付けの利用資格がある場合はtrueを、そうでない場合はfalseを返します。

username
公開

アプリユーザーのInstagramプロフィールのユーザーネーム。

website
公開

アプリユーザーのウェブサイトURL。

エッジ

エッジ説明

agencies

このInstagramプロアカウントの広告を掲載できるビジネスのリスト。

authorized_adaccounts

このInstagramプロアカウントの広告を掲載できる広告アカウント。

business_discovery

他のInstagramビジネスまたはInstagramクリエイターであるIGユーザーに関するデータを取得します。

connected_threads_user

InstagramアカウントにリンクされたThreadsアカウントを表します。

content_publishing_limit

IGユーザーの現在のコンテンツ公開の使用状況を表します。

insights

IGユーザーについてのソーシャルインタラクション指標を表します。

instagram_backed_threads_user

Instagramアカウントによって裏付けられているThreadsアカウントを表します。

live_media

IGユーザーのライブ動画IGメディアのコレクションを表します。

media

IGユーザーIGメディアのコレクションを表します。

media_publish

Instagram Business IGユーザーIGコンテナを公開します。

mentions

IGユーザーが別のInstagramユーザーによって@mentionされたIGコメントまたはキャプションの付いたIGメディアに対するIGコメントを作成します。

mentioned_comment

別のInstagramユーザーによりIGユーザーが@メンションされたIGコメントに関するデータを取得します。

mentioned_media

別のInstagramユーザーのキャプション内でIGユーザーが@メンションされたIGメディアに関するデータを取得します。

recently_searched_hashtags

過去7日間にIGユーザーが検索したIGハッシュタグを取得します。

stories

IGユーザーのストーリーズIGメディアオブジェクトのコレクションを表します。

tags

別のInstagramユーザーによりIGユーザーがタグ付けされたIGメディアのコレクションを表します。

upcoming_events

このInstagramプロアカウントが主催するイベントのリスト。

collaboration_invites

IGユーザーがコラボレーションに招待されているIG Mediaオブジェクト属性(media_id、media_owner_username、caption、media_url)のコレクションを表します。

collaborative_media

IGユーザーが承認された共同投稿者であるIGメディアのコレクションを表します。ユーザーが直接所有するメディアは含まれません。FacebookログインによるInstagram APIのみで利用可能です。

応答

デフォルトとリクエストのフィールドおよびエッジを含む、JSON形式のオブジェクト。

{
  "<FIELD>":"<VALUE>",
  ...
}

cURLの例

リクエスト

curl -X GET \
  'https://graph.facebook.com/v25.0/17841405822304914?fields=biography%2Cid%2Cusername%2Cwebsite&access_token=EAACwX...'

応答

{
  "biography": "Dino data crunching app",
  "id": "17841405822304914",
  "username": "metricsaurus",
  "website": "http://www.metricsaurus.com/"
}

更新

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

削除

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