Close httplib2 connections.
get(advertiserId, youtubeAdGroupAdId, x__xgafv=None)
Gets a YouTube ad group ad.
list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists YouTube ad group ads.
Retrieves the next page of results.
close()
Close httplib2 connections.
get(advertiserId, youtubeAdGroupAdId, x__xgafv=None)
Gets a YouTube ad group ad.
Args:
advertiserId: string, Required. The ID of the advertiser this ad group ad belongs to. (required)
youtubeAdGroupAdId: string, Required. The ID of the ad group ad to fetch. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single YouTube ad group ad associated with a YouTube ad group.
"adGroupAdId": "A String", # The unique ID of the ad group ad. Assigned by the system.
"adGroupId": "A String", # The unique ID of the ad group that the ad group ad belongs to.
"adUrls": [ # The list of ad urls.
{ # Additional URLs related to the ad, including beacons.
"type": "A String", # The type of the AD url.
"url": "A String", # The url value of the ad url.
},
],
"advertiserId": "A String", # The unique ID of the advertiser the ad group ad belongs to.
"audioAd": { # The details for audio ad. # Audio ad for reach purpose. [details](https://support.google.com/displayvideo/answer/6274216)
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address which is loaded in background for tracking purpose.
"video": { # Details of the YouTube video. # The YouTube video of the ad.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"bumperAd": { # Ad details for BumperAd. # Non-skippable short video ad for reach purpose and video length equal to or less than 6 seconds. [details](https://support.google.com/displayvideo/answer/6274216)
"commonInStreamAttribute": { # The common attributes for InStreamAd, NonSkippableAd and BumperAd. # Common attributes data model.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # The meta data of an image asset. # The image which shows next to the video Ad.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address which is loaded in background for tracking purpose.
"video": { # Details of the YouTube video. # The YouTube video of the ad.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
},
"displayName": "A String", # The display name of the ad group ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
"displayVideoSourceAd": { # The ad of which source is DV360 creative. # The ad sourcing DV360 creative.
"creativeId": "A String", # The ID of the source creative.
},
"entityStatus": "A String", # The entity status of the ad group ad.
"inStreamAd": { # Ad details for InStreamAd # Skippable in-stream ad after 5 seconds for brand awareness or reach marketing objectives. [details](https://support.google.com/displayvideo/answer/6274216)
"commonInStreamAttribute": { # The common attributes for InStreamAd, NonSkippableAd and BumperAd. # Common attributes data model.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # The meta data of an image asset. # The image which shows next to the video Ad.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address which is loaded in background for tracking purpose.
"video": { # Details of the YouTube video. # The YouTube video of the ad.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking url template.
"a_key": "A String",
},
},
"mastheadAd": { # The details for masthead ad. # The ad which shows on YouTube homepage. [details](https://support.google.com/google-ads/answer/9709826)
"autoplayVideoDuration": "A String", # Video will autoplay for certain period of time.
"autoplayVideoStartMillisecond": "A String", # Video will start to play after certain period of time in millisecond.
"callToActionButtonLabel": "A String", # The text on the call-to-action button.
"callToActionFinalUrl": "A String", # The destination URL for the call-to-action button.
"callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
"companionYoutubeVideos": [ # The videos (up to 2) that appear next to the Masthead ad on desktop.
{ # Details of the YouTube video.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
],
"description": "A String", # The description of the ad.
"headline": "A String", # The headline of the ad.
"showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
"video": { # Details of the YouTube video. # The YouTube video of the ad.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
"videoAspectRatio": "A String", # Aspect ratio of the autoplaying YouTube video on the Masthead.
},
"name": "A String", # The resource name of the ad group ad.
"nonSkippableAd": { # Ad details for NonSkippableAd # Non-skippable short in-stream ad for reach marketing objectives, and video length is between 6 and 15 seconds. [details](https://support.google.com/displayvideo/answer/6274216)
"commonInStreamAttribute": { # The common attributes for InStreamAd, NonSkippableAd and BumperAd. # Common attributes data model.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # The meta data of an image asset. # The image which shows next to the video Ad.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address which is loaded in background for tracking purpose.
"video": { # Details of the YouTube video. # The YouTube video of the ad.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking url template.
"a_key": "A String",
},
},
"videoDiscoverAd": { # The details for video discovery ad. # An ad which shows in places of discovery to promote a video. [details](https://support.google.com/displayvideo/answer/6274216)
"description1": "A String", # First text line for the ad.
"description2": "A String", # Second text line for the ad.
"headline": "A String", # The headline of the video discovery ad.
"thumbnail": "A String", # Thumbnail image to use in the ad.
"video": { # Details of the YouTube video. # The YouTube video which the ad wants to promote.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"videoPerformanceAd": { # The details for video performance ad. # The ad to drive actions to the business, service or product. [details](https://support.google.com/google-ads/answer/10147229)
"actionButtonLabels": [ # The list of text assets which show on the call-to-action button.
"A String",
],
"companionBanners": [ # The list of companion banners of this ad.
{ # The meta data of an image asset.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
],
"customParameters": { # The custom parameters to pass custom values to tracking url template.
"a_key": "A String",
},
"descriptions": [ # The list of descriptions which show on the call-to-action banner.
"A String",
],
"displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display url.
"displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display url.
"domain": "A String", # The domain of the display url
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"headlines": [ # The list of headlines which show on the call-to-action banner.
"A String",
],
"longHeadlines": [ # The list of lone headlines which show on the call-to-action banner.
"A String",
],
"trackingUrl": "A String", # The URL address which is loaded in background for tracking purpose.
"videos": [ # The list of YouTube video assets in this ad.
{ # Details of the YouTube video.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
],
},
}
list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists YouTube ad group ads.
Args:
advertiserId: string, Required. The ID of the advertiser the ad groups belongs to. (required)
filter: string, Allows filtering by custom YouTube ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. Only the restrictions for * the same field can be combined by `OR`. A sequence of restrictions * implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported properties: - `adGroupId` - `displayName` - `entityStatus` - `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` and its * entityStatus is `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters.
orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAdGroupAds` method. If not specified, the first page of results will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for YoutubeAdGroupAdService.ListYoutubeAdGroupAds.
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListYoutubeAdGroupAds` method to retrieve the next page of results.
"youtubeAdGroupAds": [ # The list of ad group ads. This list will be absent if empty.
{ # A single YouTube ad group ad associated with a YouTube ad group.
"adGroupAdId": "A String", # The unique ID of the ad group ad. Assigned by the system.
"adGroupId": "A String", # The unique ID of the ad group that the ad group ad belongs to.
"adUrls": [ # The list of ad urls.
{ # Additional URLs related to the ad, including beacons.
"type": "A String", # The type of the AD url.
"url": "A String", # The url value of the ad url.
},
],
"advertiserId": "A String", # The unique ID of the advertiser the ad group ad belongs to.
"audioAd": { # The details for audio ad. # Audio ad for reach purpose. [details](https://support.google.com/displayvideo/answer/6274216)
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address which is loaded in background for tracking purpose.
"video": { # Details of the YouTube video. # The YouTube video of the ad.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"bumperAd": { # Ad details for BumperAd. # Non-skippable short video ad for reach purpose and video length equal to or less than 6 seconds. [details](https://support.google.com/displayvideo/answer/6274216)
"commonInStreamAttribute": { # The common attributes for InStreamAd, NonSkippableAd and BumperAd. # Common attributes data model.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # The meta data of an image asset. # The image which shows next to the video Ad.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address which is loaded in background for tracking purpose.
"video": { # Details of the YouTube video. # The YouTube video of the ad.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
},
"displayName": "A String", # The display name of the ad group ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
"displayVideoSourceAd": { # The ad of which source is DV360 creative. # The ad sourcing DV360 creative.
"creativeId": "A String", # The ID of the source creative.
},
"entityStatus": "A String", # The entity status of the ad group ad.
"inStreamAd": { # Ad details for InStreamAd # Skippable in-stream ad after 5 seconds for brand awareness or reach marketing objectives. [details](https://support.google.com/displayvideo/answer/6274216)
"commonInStreamAttribute": { # The common attributes for InStreamAd, NonSkippableAd and BumperAd. # Common attributes data model.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # The meta data of an image asset. # The image which shows next to the video Ad.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address which is loaded in background for tracking purpose.
"video": { # Details of the YouTube video. # The YouTube video of the ad.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking url template.
"a_key": "A String",
},
},
"mastheadAd": { # The details for masthead ad. # The ad which shows on YouTube homepage. [details](https://support.google.com/google-ads/answer/9709826)
"autoplayVideoDuration": "A String", # Video will autoplay for certain period of time.
"autoplayVideoStartMillisecond": "A String", # Video will start to play after certain period of time in millisecond.
"callToActionButtonLabel": "A String", # The text on the call-to-action button.
"callToActionFinalUrl": "A String", # The destination URL for the call-to-action button.
"callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
"companionYoutubeVideos": [ # The videos (up to 2) that appear next to the Masthead ad on desktop.
{ # Details of the YouTube video.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
],
"description": "A String", # The description of the ad.
"headline": "A String", # The headline of the ad.
"showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
"video": { # Details of the YouTube video. # The YouTube video of the ad.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
"videoAspectRatio": "A String", # Aspect ratio of the autoplaying YouTube video on the Masthead.
},
"name": "A String", # The resource name of the ad group ad.
"nonSkippableAd": { # Ad details for NonSkippableAd # Non-skippable short in-stream ad for reach marketing objectives, and video length is between 6 and 15 seconds. [details](https://support.google.com/displayvideo/answer/6274216)
"commonInStreamAttribute": { # The common attributes for InStreamAd, NonSkippableAd and BumperAd. # Common attributes data model.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # The meta data of an image asset. # The image which shows next to the video Ad.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address which is loaded in background for tracking purpose.
"video": { # Details of the YouTube video. # The YouTube video of the ad.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking url template.
"a_key": "A String",
},
},
"videoDiscoverAd": { # The details for video discovery ad. # An ad which shows in places of discovery to promote a video. [details](https://support.google.com/displayvideo/answer/6274216)
"description1": "A String", # First text line for the ad.
"description2": "A String", # Second text line for the ad.
"headline": "A String", # The headline of the video discovery ad.
"thumbnail": "A String", # Thumbnail image to use in the ad.
"video": { # Details of the YouTube video. # The YouTube video which the ad wants to promote.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"videoPerformanceAd": { # The details for video performance ad. # The ad to drive actions to the business, service or product. [details](https://support.google.com/google-ads/answer/10147229)
"actionButtonLabels": [ # The list of text assets which show on the call-to-action button.
"A String",
],
"companionBanners": [ # The list of companion banners of this ad.
{ # The meta data of an image asset.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
],
"customParameters": { # The custom parameters to pass custom values to tracking url template.
"a_key": "A String",
},
"descriptions": [ # The list of descriptions which show on the call-to-action banner.
"A String",
],
"displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display url.
"displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display url.
"domain": "A String", # The domain of the display url
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"headlines": [ # The list of headlines which show on the call-to-action banner.
"A String",
],
"longHeadlines": [ # The list of lone headlines which show on the call-to-action banner.
"A String",
],
"trackingUrl": "A String", # The URL address which is loaded in background for tracking purpose.
"videos": [ # The list of YouTube video assets in this ad.
{ # Details of the YouTube video.
"id": "A String", # The ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
],
},
},
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.