IG 影音內容

代表 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 專業帳號擁有的影音內容的資料,無法用於取得個人 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

針對狀態為 ACTIVE 的廣告,提供與自主影音內容相關聯的所有 Instagram 廣告資訊總覽,包括相關的廣告編號和廣告投遞狀態。僅適用於含有 Facebook 登入的 Instagram API。

boost_eligibility_info

此欄位提供使用 Instagram Instagram 影音內容做為廣告的加強推廣資格相關資訊,以及不符合資格時的其他詳細資訊。僅適用於含有 Facebook 登入的 Instagram API。

caption 公開

說明文字。不含相簿子項。不含 @ 符號,除非應用程式用戶可以在 Facebook 粉絲專頁執行管理員層級的任務,且該粉絲專頁連結到用於建立說明文字的 Instagram 帳號。僅適用於含有 Facebook 登入的 Instagram API。

comments_count 公開

影音內容的留言數。不含相簿子影音內容和影音內容描述的留言。包含回覆留言的次數。

copyright_check_information.status

傳回 statusmatches_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_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

針對 21.0 和更早版本行銷人 API 端點建立的 Instagram 影音內容編號。

like_count

影音內容的按讚次數,包括對留言的回覆次數。不含相簿子影音內容的按讚數,也不含以影音內容建立之推廣貼文的按讚數。


如果透過另一個端點或欄位擴充進行間接查詢,當影音內容擁有者已隱藏按讚數時,會忽略 like_count 欄位。

media_audio_type 公開

影音內容中使用的音訊類型。可以是 MUSICORIGINAL_SOUND。僅針對 Reels 等影片素材傳回;不針對其他影音內容類型(例如相片和輪播)傳回。

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 Reel 的觀看次數,包含付費和自主衡量指標。針對多文發佈至 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>

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

<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。支援非廣告貼文、限時動態、Reel 和整個輪播相簿。若要刪除輪播相簿中的影音內容,您必須指定輪播容器影音內容編號,才能刪除整個輪播相簿。不支援刪除輪播廣告中的個別影音素材。

要求語法

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