Ad Templates¶

Use Dynamic Product Ad templates if you wish to customize your product ad fields with macros. By using macros, you can enhance the look of your product ad and extend its functionality.

Important

Operations to retrieve data for product ads are the same as for the Ad Object. The Dynamic Product Ad template is an Ad with special rules, and is intended for shopping campaigns only. Bulk operations for Dynamic Product Ad templates are the same as for the Ad object.

Fields¶

Dynamic Product Ad templates contain the following fields:

Field name	Description
`title`	The title of the Product Ad template. For example, you can use macros, like `{title} with {price}`. When the ad displays on the device, the macros will be replaced with the actual product ad title and price.
`description`	The description of the Product Ad template, using a macro to customize the description of the product ad.
`sponsoredBy`	The `sponsoredBy` of the Product Ad template, using a macro to customize the `sponsoredBy` of the product ad.
`isAdTemplate`	A mandatory field that defines the Product Ad Template and whose value must be set to TRUE.
`imagePortraitUrlBG`	A URL to a vertical (portrait) 9:16 aspect ratio 720p to 1080p high-resolution image that will be used as a background image for carousel ads (both native and DPA) to allow them to render in mobile moments and portrait native positions. Recommended to allow your carousel ads to get more supply reach.
`landingUrl`	The landing page URL of the Product Ad template, using a macro to customize the landing page URL of the product ad.
`customParameters`	A list of key-value pairs that are appended one by one to your landingUrl. For example:

  [
  {
    "key": "src_param",
    "value": "gemini_dpa"
  },
  {
    "key": "trackingid",
    "value": "123"
  },
  {
    "key": "cid",
    "value": "556677"
  }
]

Note

You can only create a single Dynamic Product Ad template under one Dynamic Product ad group.

Important

When you create a Dynamic Product Ad template, you must specify at least one field. Leave all the fields that you don’t want to customize as empty. Note that if you’re using the template for landingUrl, custom parameters won’t be applied. In other words, if you want to use custom parameters, don’t use the landingUrl template.

Supported Macros¶

The following list includes the supported macros for Dynamic Product Ad templates:

Macro	Description
`{id}`	The Product ID from the Advertiser Feed
`{title}`	The title of the Product Ad template
`{description}`
`{link}`
`{ulink}`	The Unescaped/Unencoded Landing Page URL
`{brand}`	The Brand from the Advertiser Feed
`{availability}`	The Availability from the Advertiser Feed
`{price}`	The Price from the Advertiser Feed
`{sales_price}`	The Sales Price from the Advertiser Feed
`{effective_price}`
`{expiring_soon}`
`{custom_label_0}`
`{custom_label_1}`
`{custom_label_2}`
`{custom_label_3}`
`{custom_label_4}`
`{custom_label_5}`
`{advertiserId}`	The Native Advertiser ID of the Advertiser
`{campaignId}`	The Native Campaign ID of the Advertiser
`{adGroupId}`	The Native AdGroup ID of the Advertiser

Endpoint¶

Resource URI

https://api.gemini.yahoo.com/v3/rest/ad/

Example Template¶

The following is an example of a Dynamic Product Ad template with the landingUrl, isAdTemplate and impressionTrackingUrls fields specified.

{
  "adGroupId": 9583202006,
  "campaignId": 361307005,
  "advertiserId": 88922,
  "sponsoredBy": "Sandboxes Inc",
  "status": "ACTIVE",
      "isAdTemplate": true,
  "landingUrl": "https://www.clicktrackingredirectdomain.com/?{link}",
  "impressionTrackingUrls": {
         "impression":["https://impressiontag5.com"]
      }
}

Use impressionTrackingUrls¶

To set third-party impression tracking for your ads, use impressionTrackingUrls. Ensure that the impression parameter adheres to the requirements specified in the field description table below.

For example:

"impressionTrackingUrls": {
      "impression": ["https: //www.impression.com"], // maximum 3 comma-separated impression URLs
  }

impressionTrackingUrls Fields¶

Field	Description	Required?
`impression`	Supported third-party impression tracking URLs: Must be an image tag Must be secure (SSL) Cannot include redirect Cannot include macros other than [timestamp] Up to 3 impression URLs are supported per ad.	No

Field

Description

Required?

impression

Supported third-party impression tracking URLs:

Must be an image tag
Must be secure (SSL)
Cannot include redirect
Cannot include macros other than [timestamp]

Up to 3 impression URLs are supported per ad.

Note

You’ll need to add square brackets [ ] around the impression URL because you have the option of adding up to 3 impression URLs, each separated by commas.

Important

When an ad is displayed, a Pixel/URL in the impressionTrackingUrl field’s impression are fired. This allows 3rd parties to track when an ad is served and to track post-impression conversions. If you fire your own 3rd party impression pixel, it should line up closely with the impressions column in reporting. Post-impressions conversions are provided as a column in reports, but not in the UI.

Click Tracking¶

If you wish to insert impression tracking and click tracking, you’ll need to apply click tracking with the redirect domain specified in the landingURL field. You can apply impression tracking in the impressionTrackingURLs field shown below.

For example:

"landingUrl": "https://www.clicktrackingredirectdomain.com/?{link}",
"impressionTrackingUrls": {
       "impression":["https://impressiontag.com"]
 }