See the overview for an explanation of format.
| Field | Required | Type | Writable | Description |
|---|---|---|---|---|
| Ad Id | Required only when editing existing Ads | integer | No | Numeric ID value of the ad group ad. If left blank a new Ad will be created and a unique ID will be assigned. |
| Ad Group Id | Yes | integer | No | Numeric ID value of the parent ad group. You can specify a custom identifier (for example, "ext[custom ad group ID]") for an Ad Group that you are creating at the same time as this Ad. |
| Ad Group Name | No | string | No | Ad Group Name |
| Name | Yes | string | Yes | The name of the entry. |
| Status | Yes | string | Yes | The status setting for the entry.
|
| Ad Type | Required for YouTube and Demand Gen Ads | string | Yes | The ad format of the ad. In-stream & In-feed Video are YouTube video ad types sold on a CPV basis. Bumper ads are 6-second or less video YouTube ads sold on a CPM basis. Non-skippable video ads are in-stream YouTube ads between 6 and 15 seconds sold on a CPM basis. YouTube audio are audio YouTube ads. Responsive video ads are YouTube ad types that serve as multiple formats. Efficient reach ads will serve as YouTube bumper if the video is short enough, and YouTube in-stream otherwise. Demand Gen Video ads serve on multiple formats, including but not limited to YouTube. Demand Gen Image ads show images. Demand Gen Carousel ads show cards. Demand Gen Product ads show products. Select one of the following values:
|
| Video Id | Required for YouTube and Demand Gen Video Ads | string | Yes | The YouTube video ID |
| Display URL | Yes for In-stream and Bumper | string | Yes | The ad display URL |
| Landing Page URL | Required for In-stream, Bumper, and Demand Gen ads | string | Yes | The ad landing page URL |
| DCM Tracking - Placement Id | Required only when updating DCM Tracking Ad | integer | Yes | Numeric ID value of DCM placement for the corresponding tracking ad. To remove a DCM Tracking Ad, leave the three columns DCM Tracking - Placement ID, DCM Tracking - Ad ID and DCM Tracking - Creative ID blank. |
| DCM Tracking - Ad Id | Required only when updating DCM Tracking Ad | integer | Yes | Numeric ID value of DCM Ad for the corresponding tracking ad.To remove a DCM Tracking Ad, leave the three columns DCM Tracking - Placement ID, DCM Tracking - Ad ID and DCM Tracking - Creative ID blank. |
| DCM Tracking - Creative Id | Required only when updating DCM Tracking Ad | integer | Yes | Numeric ID value of the creative for the corresponding tracking ad.To remove a DCM Tracking Ad, leave the three columns DCM Tracking - Placement ID, DCM Tracking - Ad ID and DCM Tracking - Creative ID blank. |
| Click Tracker URL | No | string | Yes | The ad click tracker URL |
| Click Tracker URL Parameters | No | string, list of lists | Yes | The click tracker URL custom parameters. Format = (name1; value1;); (name2; value2;); etc. |
| Call to Action | Required when the parent line item is a YouTube video action line item, 'Headline' is not empty, or 'Ad Type' is 'Demand Gen Video', 'Demand Gen Image', 'Demand Gen Carousel' | string | Yes | Label for the Call to Action button (1 line with up to 10 characters). |
| Headline | Required for Demand Gen Ads | string | Yes | Headline for the Call to Action overlay (1 line with up to 15 characters). |
| Display URL Path 1 | No | string | Yes | Display URL path 1 |
| Display URL Path 2 | No | string | Yes | Display URL path 2 |
| In-feed Video Thumbnail | Yes for In-feed Video | string | Yes | The video thumbnail to use for video discovery ads
|
| In-feed Video Headline | Required for In-feed Video and Demand Gen ads | string | Yes | The headline text for a discovery or responsive ad, or the long headline for Demand Gen ads. |
| Description 1 | Required for In-feed Video and Demand Gen ads | string | Yes | The discovery ad description 1 text or responsive ad description |
| Description 2 | Required for In-feed Video | string | Yes | The discovery ad description 2 text |
| In-feed Video Landing Page | Yes for In-feed Video | string | Yes | The discovery ad landing page |
| Mobile Landing Page URL | No | string | Yes | The ad landing page URL for mobile devices |
| Business Name | Required for Demand Gen Ads | string | Yes | The name of the business that is being advertised |
| Landing Page URL Suffix | No | string | Yes | The suffix for the landing page URL |
| Logo Asset IDs | Required for Demand Gen Ads | string, list | Yes | The list of asset ids for the logos. This list is generated in ascending numerical order. |
| Marketing Image Asset IDs | Required when 'Ad Type' is 'Demand Gen Image' | string, list | Yes | The list of asset ids for the marketing images. This list is generated in ascending order. |
| Demand Gen Cards | Required when 'Ad Type' is 'Demand Gen Carousel' | string, list of lists | Yes | This defines a list of cards, in the following format: (final url; final mobile; url; headline; cta text; marketing image asset id; additional marketing asset ids...). For example: (google.com; mobile.google.com; Headline; Click Here; 10020; 20020; 30020).Each marketing asset must have a unique aspect ratio. If one card under an Ad has a square marketing image, then all cards under that Ad must have a square marketing image (this applies to the other aspect ratios as well). |
| Companion Banner Asset IDs | No | string, list | Yes | The list of asset ids for the companion banners. This list is generated in ascending numerical order. This is supported for Video Performance, Demand Gen Video, In-stream, Bumper, and Non-skippable Ads. List format = 100; 200; |