Graph API 版本

Video Captions

閱讀中

VideoCaptions

例子

Graph API Explorer
GET /v21.0/{video-id}/captions HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{video-id}/captions',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{video-id}/captions",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{video-id}/captions",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{video-id}/captions"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
如果想了解如何使用 Graph API,請參閱我們的使用 Graph API 指南

參數

這個端點沒有任何參數。

欄位

由此關係連線進行的閱讀將回傳 JSON 格式結果:

{ "data": [], "paging": {} }

data

VideoCaption 節點的清單。

paging

如需更多有關分頁的詳細資料,請參閱 Graph API 指南

Error Codes

錯誤說明
100Invalid parameter

建立中

你無法在此端點執行此操作。

更新中

Permissions

To update a video's caption, you need one of the following:

  • User is the owner of the video
  • User has manage access on page that owns the video
  • User has advertiser access on account that owns the video

Limitations

The file size limit for video captions is 200K.

You can update a Video by making a POST request to /{video_id}/captions.

參數

參數描述
captions_file
file

Caption file in SRT (SubRip Text) format. File name must be in the format filename.locale.srt

default_locale
string

Specify which locale should be used as the default for the video. Can be set to 'none'

locales_to_delete
list<string>
預設值:Vector

locales of caption to delete

傳回類型

This endpoint supports 寫入後讀取 and will read the node to which you POSTed.
Struct {
success: bool,
}

Error Codes

錯誤說明
482The captions files you selected contain locales that had been applied to video, please remove and try again.
386You uploaded a .SRT file with an incorrect file name. Please use this format: filename.en_US.srt
387There was a problem uploading your captions file. Please try again.

正在刪除

你無法在此端點執行此操作。