Get Started
Studio API
Content Delivery API
Deep dive
curl --request GET \
--url https://api.mottostreaming.com/monetization/ads/v1/video_ads \
--header 'Authorization: Bearer <token>'{
"video_ads": [
{
"project_id": "<string>",
"name": "<string>",
"id": "<string>",
"ad_manifest": {
"title": "<string>",
"video_files": [
{
"quality": "VIDEO_QUALITY_UNSPECIFIED",
"config": {
"asset_id": "<string>"
}
}
],
"aspect_ratio": "<string>",
"duration_seconds": 123,
"allow_skip_after_seconds": 123,
"clickthrough_url": "<string>",
"impression_tracking_url": "<string>",
"error_tracking_url": "<string>"
},
"ad_tag_url": "<string>",
"visibility": "VISIBILITY_UNSPECIFIED",
"geo_applicability_exempt": {
"country_codes": [
"<string>"
]
},
"geo_applicability_apply": {
"country_codes": [
"<string>"
]
},
"applies_to_all": true,
"target": {
"entity_ids": [
"<string>"
],
"event_ids": [
"<string>"
],
"creative_work_ids": [
"<string>"
],
"content_start_time": "2023-11-07T05:31:56Z",
"content_end_time": "2023-11-07T05:31:56Z"
},
"priority": "<string>"
}
],
"next_page_token": "<string>"
}List video ads
ListVideoAds
Return list of video_ads.
curl --request GET \
--url https://api.mottostreaming.com/monetization/ads/v1/video_ads \
--header 'Authorization: Bearer <token>'{
"video_ads": [
{
"project_id": "<string>",
"name": "<string>",
"id": "<string>",
"ad_manifest": {
"title": "<string>",
"video_files": [
{
"quality": "VIDEO_QUALITY_UNSPECIFIED",
"config": {
"asset_id": "<string>"
}
}
],
"aspect_ratio": "<string>",
"duration_seconds": 123,
"allow_skip_after_seconds": 123,
"clickthrough_url": "<string>",
"impression_tracking_url": "<string>",
"error_tracking_url": "<string>"
},
"ad_tag_url": "<string>",
"visibility": "VISIBILITY_UNSPECIFIED",
"geo_applicability_exempt": {
"country_codes": [
"<string>"
]
},
"geo_applicability_apply": {
"country_codes": [
"<string>"
]
},
"applies_to_all": true,
"target": {
"entity_ids": [
"<string>"
],
"event_ids": [
"<string>"
],
"creative_work_ids": [
"<string>"
],
"content_start_time": "2023-11-07T05:31:56Z",
"content_end_time": "2023-11-07T05:31:56Z"
},
"priority": "<string>"
}
],
"next_page_token": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Maximum number of records to return
If this field is not empty then it must contain the next_page_token value
returned by a previous call to this method. Using this field causes the
method to return additional results from the previous method call.
You can filter the list of video_ads by the following fields:
disabled: Whether the video_ad is disabled or not.
Response
OK
Show child attributes
Show child attributes
The ID of the project that the ad belongs to.
Name of the video ad
The necessary parameters to generate a manifest (for a VAST or VMAP) to be used for this video ad.
Show child attributes
Show child attributes
The title of the video ad
The media files for the video ad. At least one media file is required.
Show child attributes
Show child attributes
VIDEO_QUALITY_UNSPECIFIED, VIDEO_QUALITY_240P, VIDEO_QUALITY_480P, VIDEO_QUALITY_720P, VIDEO_QUALITY_1080P The aspect ratio of the video ad, e.g. "16:9". Defaults to "16:9" if not provided.
The total duration in seconds of the video ad
The number of seconds after which the ad can be skipped. Use 0 for non-skippable ads.
The destination URL when the ad is clicked. Leave empty for no clickability.
The URL to be pinged for impression tracking. Leave empty for no tracking.
The URL to be pinged for error tracking. Leave empty for no tracking.
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.
Visibility settings for the video ad. When not set to published, the ad will not be shown to end users.
VISIBILITY_UNSPECIFIED, VISIBILITY_PUBLISHED, VISIBILITY_UNLISTED, VISIBILITY_HIDDEN Viewers from these countries will not have this video ad shown.
Show child attributes
Show child attributes
A country code (ISO 3316-1 alpha-2: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)
Viewers from these countries will have this video ad shown.
Show child attributes
Show child attributes
A country code (ISO 3316-1 alpha-2: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)
This video ad applies to all videos in the project.
This video ad applies to a specific set of videos, as defined by the target.
Show child attributes
Show child attributes
The entities with which this video ad is associated. If provided, all videos that are associated with these entities will be included in the video ad.
The events with which this video ad is associated. If provided, all videos that are associated with these events will be included in the video ad.
The creative works with which this video ad is associated. If provided, all videos that are associated with these creative works will be included in the video ad.
Any content defined by entity_ids, event_ids and creative_work_ids after content_start_time will be considered as part of the video ad (as long as it is before content_end_time).
If not provided, there is no lower time bound on the content.
Any content defined by entity_ids, event_ids and creative_work_ids before content_end_time will be considered as part of the video ad (as long as it is after content_start_time).
If not provided, there is no upper time bound on the content.
The priority of the ad. If multiple ads apply to a video, the ad with the highest priority will be used.
If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as page_token in the next call to this method.