Instagram 影音內容

代表 Instagram 相簿、相片或影片(上載的影片、直播視像、Reel 或限時動態)。

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 API設有 Facebook 登入功能的 Instagram API

存取憑證

  • Instagram 用戶存取憑證

主機網址

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 專業帳戶所擁有影音內容的資料。此 API 不可用於獲取 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>

應用程式用來查詢端點的主機網址

<IG_MEDIA_ID>

此為必要項目。待發佈影音內容的編號。

查詢字串參數

鍵值預留位置

access_token

<ACCESS_TOKEN>

此為必要項目。應用程式用戶的 Facebook 或 Instagram 用戶存取憑證。

fields

<LIST_OF_FIELDS>

您想系統傳回的欄位逗號分隔清單。

欄位

可透過欄位擴充功能讀取的公開欄位。

欄位說明

alt_text 公開

圖像說明文字,用於提升無障礙體驗。

boost_ads_list

提供與自主影音內容關聯的所有 Instagram 廣告資訊的概述(廣告狀態為 ACTIVE),其中包括相關的廣告編號和廣告刊登狀態。僅適用於設有 Facebook 登入功能的 Instagram API。

boost_eligibility_info

此欄位提供相關資訊,說明以廣告形式發佈 Instagram 影音內容時的加強推廣資格;如果影音內容不符合資格,則會提供其他詳細資訊。僅適用於設有 Facebook 登入功能的 Instagram API。

caption 公開

說明文字。不包括相簿子物件。不包括 @ 符號,除非在用於建立此說明文字的 Instagram 帳戶所連結的 Facebook 專頁上,應用程式用戶可以執行管理員級別的任務。僅適用於設有 Facebook 登入功能的 Instagram API。

comments_count 公開

影音內容的回應次數。不包括相簿子影音內容的留言及影音內容說明文字。包括對留言的回覆。

copyright_check_information.status

傳回 statusmatches_found 物件

狀態物件說明

status

  • completed:已完成偵測程序
  • error:偵測期間發生錯誤
  • in_progress:偵測程序進行中
  • not_started:未啟動偵測程序

matches_found

設定為下列其中一項:

  • 如果影片沒有侵犯版權,則設定為 false
  • 如果影片有侵害版權,則設定為 true

如果影片侵犯版權,則系統會將傳回 copyright_matches,並附上版權內容的物件陣列、影片中侵犯版權的時間點,以及為降低侵犯版權事件影響所採取的緩解措施。

copyright_matches 物件說明

author

受版權保護的影片之作者

content_title

受版權保護的影片名稱

matched_segments

帶有以下鍵值組合的物件陣列:

  • duration_in_seconds:內容侵犯版權的秒數
  • segment_typeAUDIOVIDEO
  • start_time_in_seconds:設定為影片的開始時間

owner_copyright_policy

傳回的物件包括:

  • name:版權擁有者政策的名稱
  • actionsaction 物件列陣,附以所採取的緩解措施,有關措施按版權擁有者的政策而定。其中可能包括為不同地方採取不同緩解措施。
    • action:為降低侵犯版權事件影響所採取的緩解措施。採取的緩解措施可能因國家/地區而異。可以是下列其中一個值:
      • BLOCK:封鎖影片以不向 geos 陣列中的分享對象展示
      • MUTE:向 geos 陣列中的分享對象將影片設定為靜音

id 公開

影音內容編號。

is_ai_generated

指明影音內容是否有 AI 標籤。不包括相簿子物件。

is_comment_enabled

表示留言處於啟用還是停用狀態。不包括相簿子物件。

is_shared_to_feed 公開

僅適用於 Reels。如果為 true,則表示 Reel 可同時顯示在動態消息Reels 分頁。如果為 false,則表示 Reel 只可顯示在 Reels 分頁。

請注意,這兩個值都不表示 Reel 是否實際顯示在 Reels 分頁,因為 Reel 可能不符合資格要求或未被我們的演算法選中。有關資格條件的資訊,請參閱 Reel 規格

legacy_instagram_media_id

為 v21.0 或更舊版本的推廣 API 端點建立的 Instagram 影音內容編號。

like_count

影音內容獲得的讚好次數,包括對回應的回覆。不包括相簿子影音內容的讚好次數,以及使用此影音內容建立的推廣帖子所獲得的讚好次數。


如果透過其他端點或欄位擴充功能間接查詢,且影音內容擁有者隱藏了讚好次數,則會省略 like_count 欄位。

media_audio_type 公開

影音內容中使用的音訊類型。可以是 MUSICORIGINAL_SOUND。僅為影片影音內容(例如 Reel)傳回此欄位;不會為相片和輪播廣告等其他影音內容類型傳回此欄位。

media_product_type 公開

影音內容的發佈平台。可以是 ADFEEDSTORYREELS。僅適用於設有 Facebook 登入功能的 Instagram API。

media_type 公開

影音內容類型。可以是 CAROUSEL_ALBUMIMAGEVIDEO

media_url 公開

影音內容網址。

如果影音內容包含受版權保護的內容,或者已被標示為侵犯版權,則回應會省略 media_url 欄位。受版權保護的內容包括 Reels 上的音訊。

owner 公開

建立影音內容的 Instagram 用戶編號。只有在發出查詢要求的應用程式用戶也是影音內容的建立者時傳回,否則將改為傳回 username 欄位。

permalink 公開

影音內容的永久網址。

shortcode 公開

影音內容的短代碼。

thumbnail_url 公開

影音內容縮圖網址。僅適用於 VIDEO 影音內容。

timestamp 公開

ISO 8601 格式顯示的建立日期,採用 UTC 時間,預設為 UTC ±00:00。

username 公開

建立影音內容的用戶之用戶名稱。

view_count 公開

Instagram Reels 的觀看次數,當中包含付費和自主衡量數據。如果多重發佈至 Facebook 的內容,當連線階段用戶可以存取 Facebook 帖子時,系統會傳回 Instagram 和 Facebook 的總瀏覽次數。

僅適用於商家探索 API

reposts_count 公開

影音內容的轉發次數。適用於動態消息和 Reels 影音內容。無法透過主題標籤 API 端點存取。僅適用於設有 Facebook 登入功能的 Instagram API。

saved_count

影音內容的儲存次數。適用於動態消息和 Reels 影音內容。只有影音內容擁有者或已接受的協作者可以存取。無法透過商家探索、被標註/提及的影音內容或主題標籤 API 端點存取。僅適用於設有 Facebook 登入功能的 Instagram API。

shares_count

影音內容的分享次數。適用於動態消息和 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>

應用程式用來查詢端點的主機網址

<IG_MEDIA_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

存取憑證

代管網址

graph.facebook.com

登入類型

商家專用 Facebook 登入

權限
  • instagram_basic
  • instagram_manage_contents

限制

此 API 僅支援設有 Facebook 登入的 Instagram API。非廣告帖子、限時動態、Reels 和整個輪播相簿均受支援。如要刪除輪播相簿中的影音內容,則必須指定輪播容器影音內容編號,以刪除整個輪播相簿。不支援單獨刪除輪播廣告中的影音內容。

要求語法

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

路徑參數

預留位置

<API_VERSION>

最新版本為:

v26.0

應用程式正在使用的 API 版本。如果 API 呼叫中沒有指定版本,這將是您建立 Meta 應用程式時的最新版本;如果該版本不再可用,則會是最舊可用的版本。進一步了解版本管理。

<IG_MEDIA_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"
  },
}