DPA Templates

Use DPA 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 DPA template is an Ad with special rules, and is intended for shopping campaigns only. Bulk operations for DPA templates are the same as for the Ad object.

Fields

DPA 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 sponsorBy of the Product Ad template, using a macro to customize the sponsorBy of the product ad.
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 DPA template under one DPA ad group.

Important

When you create a DPA 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 DPA templates:

  • {title}
  • {description}
  • {price}
  • {availability}
  • {brand}
  • {id}
  • {link}
  • {adgroupid}
  • {campaignid}
  • {advertiserid}

Endpoint

Resource URI

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