グラフAPIバージョン

Ad Videos

読み取り

GET GraphAdAccountAdVideosEdge

Graph API Explorer
GET /v19.0/{ad-account-id}/advideos 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(
    '/{ad-account-id}/advideos',
    '{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(
    "/{ad-account-id}/advideos",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{ad-account-id}/advideos",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{ad-account-id}/advideos"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
グラフAPIを使用する方法については、グラフAPIの使用ガイドをご覧ください。

パラメーター

パラメーター説明
max_aspect_ratio
float

Maximum video aspect ratio to be used in the video aspect ratio filter.

maxheight
int64

Maximum video height to be used in the video height filter.

maxlength
int64

Maximum video duration to be used in the video duration filter.

maxwidth
int64

Maximum video width to be used in the video width filter.

min_aspect_ratio
float

Minimum video aspect ratio to be used in the video aspect ratio filter.

minheight
int64

Minimum video height to be used in the video height filter.

minlength
int64

Minimum video duration to be used in the video duration filter.

minwidth
int64

Minimum video width to be used in the video width filter.

title
string

Video name used in the video names filter.

項目

このエッジからの読み込むではJSONフォーマットの結果が返されます:

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

data

Videoノードの一覧です。

paging

ページネ―ションについて詳しくは、グラフAPIガイドをご覧ください。

summary

エッジの集計情報(数値など)。サマリーパラメータで取得するフィールドを指定します(サマリー=total_countなど)。

フィールド説明
total_count
unsigned int32

Total number of videos returned by the query.

エラーコード

エラー詳細
100Invalid parameter
2635You are calling a deprecated version of the Ads API. Please update to the latest version.
80004There have been too many calls to this ad-account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting#ads-management.
190Invalid OAuth 2.0 Access Token
200Permissions error
283That action requires the extended permission pages_read_engagement and/or pages_read_user_content and/or pages_manage_ads and/or pages_manage_metadata
2500Error parsing graph query

作成

advideosのエッジにPOSTリクエストを以下のパスで送信できます:
このエッジにPOSTする場合、a Videoが作成されます。

パラメーター

パラメーター説明
audio_story_wave_animation_handle
string

Everstore handle of wave animation used to burn audio story video

composer_session_id
string

SELF_EXPLANATORY

description
UTF-8 string

SELF_EXPLANATORY

絵文字をサポートします
end_offset
int64

end_offset

file_size
int64

The size of the video file in bytes. Using during chunked upload.

file_url
string

SELF_EXPLANATORY

fisheye_video_cropped
boolean

Whether the single fisheye video is cropped or not

front_z_rotation
float

The front z rotation in degrees on the single fisheye video

name
string

The name of the video in the library.

og_action_type_id
numeric string or integer

SELF_EXPLANATORY

og_icon_id
numeric string or integer

SELF_EXPLANATORY

og_object_id
OG object ID or URL string

SELF_EXPLANATORY

og_phrase
string

SELF_EXPLANATORY

og_suggestion_mechanism
string

SELF_EXPLANATORY

original_fov
int64

Original field of view of the source camera

original_projection_type
enum {equirectangular, cubemap, half_equirectangular}

Original Projection type of the video being uploaded

prompt_id
string

SELF_EXPLANATORY

prompt_tracking_string
string

SELF_EXPLANATORY

react_mode_metadata
JSON-encoded string

This metadata is used in clip reaction feature

referenced_sticker_id
numeric string or integer

SELF_EXPLANATORY

slideshow_spec
JSON object

An object required for slideshow video.

images_urls
list<URL>

A 3-7 element array of the URLs of the images. Required.

必須
duration_ms
integer

The duration in milliseconds of each image. Default value is 1000.

transition_ms
integer

The duration in milliseconds of the crossfade transition between images. Default value is 1000.

reordering_opt_in
boolean
デフォルト値: false

music_variations_opt_in
boolean
デフォルト値: false

source
string

The video, encoded as form data. See the Video Format doc for more details on video formats.

start_offset
int64

The start position in byte of the chunk that is being sent, inclusive. Used during chunked upload.

time_since_original_post
int64

SELF_EXPLANATORY

title
UTF-8 string

The name of the video being uploaded. Must be less than 255 characters. Special characters may count as more than 1 character.

絵文字をサポートします
transcode_setting_properties
string

Properties used in computing transcode settings for the video

unpublished_content_type
enum {SCHEDULED, SCHEDULED_RECURRING, DRAFT, ADS_POST, INLINE_CREATED, PUBLISHED, REVIEWABLE_BRANDED_CONTENT}

SELF_EXPLANATORY

upload_phase
enum {start, transfer, finish, cancel}

The phase during chunked upload. Using during chunked upload.

upload_session_id
numeric string or integer

The session ID of this chunked upload. Using during chunked upload.

video_file_chunk
string

The chunk of the video, between start_offset and end_offset. Using during chunked upload.

戻り値の型

Struct {
id: numeric string,
upload_session_id: numeric string,
video_id: numeric string,
start_offset: numeric string,
end_offset: numeric string,
success: bool,
skip_upload: bool,
upload_domain: string,
region_hint: string,
xpv_asset_id: numeric string,
is_xpv_single_prod: bool,
transcode_bit_rate_bps: numeric string,
transcode_dimension: numeric string,
should_expand_to_transcode_dimension: bool,
action_id: string,
gop_size_seconds: numeric string,
target_video_codec: string,
target_hdr: string,
maximum_frame_rate: numeric string,
}

エラーコード

エラー詳細
200Permissions error
389Unable to fetch video file from URL.
100Invalid parameter
368The action attempted has been deemed abusive or is otherwise disallowed
6000There was a problem uploading your video file. Please try again with another file.
351There was a problem with your video file. Please try again with another file,
190Invalid OAuth 2.0 Access Token
222Video not visible
390There was a problem uploading your video file. Please try again.
6001There was a problem uploading your video. Please try again.

更新中…

このエンドポイントではこの操作を実行できません。

削除中です

You can dissociate a Video from an AdAccount by making a DELETE request to /act_{ad_account_id}/advideos.

パラメーター

パラメーター説明
video_id
video ID

Ad account library video ID

必須

戻り値の型

Struct {
success: bool,
}

エラーコード

エラー詳細
613Calls to this api have exceeded the rate limit.
100Invalid parameter