Ad Videos

Reading

You can't perform this operation on this endpoint.

Creating

You can make a POST request to advideos edge from the following paths:

/act_{ad_account_id}/advideos

When posting to this edge, a Video will be created.

Parameters

Parameter	Description
`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 Supports Emoji
`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
`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. 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	Default value: `false`
`music_variations_opt_in` boolean	Default value: `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. Supports Emoji
`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.

Return Type

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,

}

Error Codes

Error	Description
389	Unable to fetch video file from URL.
100	Invalid parameter
382	The video file you tried to upload is too small. Please try again with a larger file.
200	Permissions error
368	The action attempted has been deemed abusive or is otherwise disallowed
222	Video not visible
190	Invalid OAuth 2.0 Access Token
351	There was a problem with your video file. Please try again with another file,
390	There was a problem uploading your video file. Please try again.
6001	There was a problem uploading your video. Please try again.

Updating

You can't perform this operation on this endpoint.

Deleting

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

Parameters

Parameter Description

Parameter	Description
`video_id` video ID	Ad account library video ID Required

video_id

video ID

Ad account library video ID

Required

Return Type

Struct {

success: bool,

}

Error Codes

Error	Description
100	Invalid parameter
613	Calls to this api have exceeded the rate limit.