Close httplib2 connections.
get(advertiserId, adGroupAdId, x__xgafv=None)
Gets an ad group ad.
list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists ad group ads.
Retrieves the next page of results.
close()
Close httplib2 connections.
get(advertiserId, adGroupAdId, x__xgafv=None)
Gets an ad group ad.
Args:
advertiserId: string, Required. The ID of the advertiser this ad group ad belongs to. (required)
adGroupAdId: 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 ad associated with an ad group.
"adGroupAdId": "A String", # The unique ID of the ad. Assigned by the system.
"adGroupId": "A String", # The unique ID of the ad group that the ad belongs to.
"adUrls": [ # List of URLs used by the ad.
{ # Additional URLs related to the ad, including beacons.
"type": "A String", # The type of the Ad URL.
"url": "A String", # The URL string value.
},
],
"advertiserId": "A String", # The unique ID of the advertiser the ad belongs to.
"audioAd": { # Details for an audio ad. # Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
"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 loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"bumperAd": { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # 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 loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video 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. Must be UTF-8 encoded with a maximum size of 255 bytes.
"displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Details of an ad sourced from a Display & Video 360 creative.
"creativeId": "A String", # The ID of the source creative.
},
"entityStatus": "A String", # The entity status of the ad.
"inStreamAd": { # Details for an in-stream ad. # Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # 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 loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video 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": { # Details for a Masthead Ad. # Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
"autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
"autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
"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 that appear next to the Masthead Ad on desktop. Can be no more than two.
{ # Details of a YouTube video.
"id": "A String", # The YouTube video 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 a YouTube video. # The YouTube video used by the ad.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
"videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
},
"name": "A String", # The resource name of the ad.
"nonSkippableAd": { # Details for a non-skippable ad. # Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # 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 loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video 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": { # Details for a video discovery ad. # Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
"description1": "A String", # First text line for the ad.
"description2": "A String", # Second text line for the ad.
"headline": "A String", # The headline of ad.
"thumbnail": "A String", # Thumbnail image used in the ad.
"video": { # Details of a YouTube video. # The YouTube video the ad promotes.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"videoPerformanceAd": { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
"actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
"A String",
],
"companionBanners": [ # The list of companion banners used by this ad.
{ # 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 shown 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 shown on the call-to-action banner.
"A String",
],
"longHeadlines": [ # The list of lone headlines shown on the call-to-action banner.
"A String",
],
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"videos": [ # The list of YouTube video assets used by this ad.
{ # Details of a YouTube video.
"id": "A String", # The YouTube video 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 ad group ads.
Args:
advertiserId: string, Required. The ID of the advertiser the ad groups belongs to. (required)
filter: string, Optional. Allows filtering by custom ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `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. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
orderBy: string, Optional. 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, Optional. 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, Optional. 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 `ListAdGroupAds` 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:
{
"adGroupAds": [ # The list of ad group ads. This list will be absent if empty.
{ # A single ad associated with an ad group.
"adGroupAdId": "A String", # The unique ID of the ad. Assigned by the system.
"adGroupId": "A String", # The unique ID of the ad group that the ad belongs to.
"adUrls": [ # List of URLs used by the ad.
{ # Additional URLs related to the ad, including beacons.
"type": "A String", # The type of the Ad URL.
"url": "A String", # The URL string value.
},
],
"advertiserId": "A String", # The unique ID of the advertiser the ad belongs to.
"audioAd": { # Details for an audio ad. # Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
"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 loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"bumperAd": { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # 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 loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video 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. Must be UTF-8 encoded with a maximum size of 255 bytes.
"displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Details of an ad sourced from a Display & Video 360 creative.
"creativeId": "A String", # The ID of the source creative.
},
"entityStatus": "A String", # The entity status of the ad.
"inStreamAd": { # Details for an in-stream ad. # Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # 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 loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video 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": { # Details for a Masthead Ad. # Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
"autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
"autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
"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 that appear next to the Masthead Ad on desktop. Can be no more than two.
{ # Details of a YouTube video.
"id": "A String", # The YouTube video 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 a YouTube video. # The YouTube video used by the ad.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
"videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
},
"name": "A String", # The resource name of the ad.
"nonSkippableAd": { # Details for a non-skippable ad. # Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # 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 loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video 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": { # Details for a video discovery ad. # Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
"description1": "A String", # First text line for the ad.
"description2": "A String", # Second text line for the ad.
"headline": "A String", # The headline of ad.
"thumbnail": "A String", # Thumbnail image used in the ad.
"video": { # Details of a YouTube video. # The YouTube video the ad promotes.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"videoPerformanceAd": { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
"actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
"A String",
],
"companionBanners": [ # The list of companion banners used by this ad.
{ # 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 shown 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 shown on the call-to-action banner.
"A String",
],
"longHeadlines": [ # The list of lone headlines shown on the call-to-action banner.
"A String",
],
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"videos": [ # The list of YouTube video assets used by this ad.
{ # Details of a YouTube video.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
],
},
},
],
"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 `ListAdGroupAds` method to retrieve the next page of results.
}
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.