PCAAd

A single Product Contextual Ad, containing its position, identifiers, creative assets, and tracking URLs.

positionintegerrequired

The position of the ad within the placement, starting from 0.

banner_group_idstringrequired

The unique ID of the banner group.

Example: BR47088564532X

banner_idstringrequired

The unique ID of the banner (creative).

Example: BR780200001869

assets objectrequired

A key-value map containing the creative assets and landing page information for the ad. The structure is dynamic and populated during campaign onboarding.

Known keys:

Key	Type	Description
`creative`	object	The creative assets for the ad. Structure depends on `template_id`. See creative keys below.
`landing_page`	object	The ad's click-through destination. See landing page keys below.

creative object keys:

Key	Type	Description
`template_id`	string	The unique ID of the template that defines the structure and rendering logic for this creative. Use this to determine how to parse and render the ad.
(additional keys)	any	Additional key-value pairs that vary by template. These can include image URLs, text fields, product IDs, colors, and other attributes. The full list is defined when you create templates in the network account section of the Ads Portal.

landing_page object keys:

Key	Type	Description
`url`	string	The destination URL for the ad's click-through action.
`type`	string	The type of landing page. Supported value: `CUSTOM_URL`.

property name*any

A key-value map containing the creative assets and landing page information for the ad. The structure is dynamic and populated during campaign onboarding.

Known keys:

Key	Type	Description
`creative`	object	The creative assets for the ad. Structure depends on `template_id`. See creative keys below.
`landing_page`	object	The ad's click-through destination. See landing page keys below.

creative object keys:

Key	Type	Description
`template_id`	string	The unique ID of the template that defines the structure and rendering logic for this creative. Use this to determine how to parse and render the ad.
(additional keys)	any	Additional key-value pairs that vary by template. These can include image URLs, text fields, product IDs, colors, and other attributes. The full list is defined when you create templates in the network account section of the Ads Portal.

landing_page object keys:

Key	Type	Description
`url`	string	The destination URL for the ad's click-through action.
`type`	string	The type of landing page. Supported value: `CUSTOM_URL`.

tracking objectrequired

The URLs FCC returns for event tracking on this ad.

Fire the impressionUrl, viewUrl, and clickUrl at the corresponding events. Replace the macros in your client-side code before firing the event.

Macros:

[STARTTIME]: Unix epoch timestamp in milliseconds when the ad creative begins to render.
[ENDTIME]: Unix epoch timestamp in milliseconds when the ad creative is no longer in view.
[EVENTTIME]: Unix epoch timestamp in milliseconds when the click event/impression event occurs.

impressionUrlstringrequired

URL to fire on an impression. Replace [EVENTTIME] with epoch milliseconds before firing. see the Engagement Events API.

Example: https://<tracker-domain>/v3/tr/impression?pl=...&iet=[EVENTTIME]

viewUrlstringrequired

URL to fire when the ad is viewable per publisher defined criteria. Replace [STARTTIME] with the view start epoch milliseconds and [ENDTIME] with the view end epoch milliseconds. see the Engagement Events API.

Example: https://<tracker-domain>/v3/tr/view?pl=...&vst=[STARTTIME]&vet=[ENDTIME]

clickUrlstringrequired

URL to fire on a click. Replace [EVENTTIME] with epoch milliseconds before firing. see the Engagement Events API.

Example: https://<tracker-domain>/v3/tr/click?pl=...&cet=[EVENTTIME]

PCAAd
{
  "position": 0,
  "banner_group_id": "BR47088564532X",
  "banner_id": "BR780200001869",
  "assets": {},
  "tracking": {
    "impressionUrl": "https://<tracker-domain>/v3/tr/impression?pl=...&iet=[EVENTTIME]",
    "viewUrl": "https://<tracker-domain>/v3/tr/view?pl=...&vst=[STARTTIME]&vet=[ENDTIME]",
    "clickUrl": "https://<tracker-domain>/v3/tr/click?pl=...&cet=[EVENTTIME]"
  }
}