Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
project_id
string
required

The ID of the project that the ad belongs to.

name
string
required

Name of the video ad

ad_manifest
object

The necessary parameters to generate a manifest (for a VAST or VMAP) to be used for this video ad.

Important: at most one of ad_manifest, ad_tag_url may be set per request.

ad_tag_url
string

A third-party hosted ad tag URL to be used for this video ad. This is typically a VAST or VMAP tag in Google Ad Manager or similar.

Important: at most one of ad_manifest, ad_tag_url may be set per request.

visibility
enum<string>

Visibility settings for the video ad. When not set to published, the ad will not be shown to end users.

Available options:
VISIBILITY_UNSPECIFIED,
VISIBILITY_PUBLISHED,
VISIBILITY_UNLISTED,
VISIBILITY_HIDDEN
geo_applicability_exempt
object

Viewers from these countries will not have this video ad shown.

Important: at most one of geo_applicability_exempt, geo_applicability_apply may be set per request.

geo_applicability_apply
object

Viewers from these countries will have this video ad shown.

Important: at most one of geo_applicability_exempt, geo_applicability_apply may be set per request.

applies_to_all
boolean

This video ad applies to all videos in the project.

Important: at most one of applies_to_all, target, filter may be set per request.

target
object

This video ad applies to a specific set of videos, as defined by the target.

Important: at most one of applies_to_all, target, filter may be set per request.

filter
object

This video ad applies to a complex set of events and creative works, as defined by the filter target.

Important: at most one of applies_to_all, target, filter may be set per request.

priority
string

The priority of the ad. If multiple ads apply to a video, the ad with the highest priority will be used.

Response

OK

video_ad
object