> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/integration/references/product-ad-reference-1.md). # Product ad reference The below outlines the properties possible in a standard request, and the response if you receive an ad. ## Requested items | String | Description | Required/optional | | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | | `catalogId` | Your product catalog identifier for your website. | Required | | `customerId` | The unique identifier for the customer being served ads. | Optional | | `filterMode` | Optional way of defining the structure of your request. See Ad generation filtering for more information. | Optional, preferred | | `maxNumberOfAds` | The maximum number of ads you would like returned up to 10. | Required | | `options` |

Optional way of defining the structure of your request. See Ad generation filtering for more information.

This is also the object where you can request advertiser information in order to comply with local advertising legislation like Europe’s Digital Services Act.

| Optional, preferred | | `placement` | The unique placement you are requesting ads for. | Required | | `productFilters` | Any product filters relevant to your request. Such as a category, location, or size. | Required | | `sessionId` | The unique identifier of the customer's session. Used for attribution in standard integrations. Review Integration workflow options for more information. | Required in standard integrations | | `memoryToken` |

Used for pagination. Use a token provided in a previous ad request to ensure Epsilon Retail Media only serves new ads to your customers.

If provided, Epsilon Retail Media will exclude previously served ads in the ad response. Review Pagination to learn more.

| Optional | | `dtmCookieId` | Cookies created and stored by the website, used for tracking user behavior on the same domain. | Optional | | `audience` | Specifies specific audience segments that the shopper belongs to. Only relevant is using [Audience Targeting Option 3](/retail-media-interface/integration/data-api/audience-targeting-new/integration-option-3-sync-audiences-only.md) | Optional | ## Returned items | String | Description | Example value | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `ads.customPayload` |

This custom payload that should be threaded from the catalog file to ad generation.

The field should contain a valid JSON object serialised into a byte array and Base64 encoded. The JSON object should adhere to a schema.

| Custom per integration | | `ads.sellerId` | The unique Id of the seller. Will only populate if a sellerId is set on a team. sellerIds are typically used when onboarding marketplace sellers. | `73nns-32sxr-32ss` Custom per integration | | `ads.id` |

The unique id of the ad.
This is unique to each request made to Epsilon Retail Media and cannot be cached.

| `display_yCaCIy_kKaJnRnzrenBkVSytwr8yNTgxMzM4` | | `ads.gtin` | The product code of the ad. This will be the product code synchronised in your product catalog. | `25813383` | | `ads.discount` | Legacy, can be ignored. | `{
"amount": 0,
"minPrice": 0,
"maxPerCustomer": 0
}` | | `ads.position` | The ad's position in the Epsilon Retail Media response. You should honour this position in the event fixed tenancy campaigns are utilised. | 1 | | `ads.memoryToken` |

Used for pagination and chaining ad requests.

If provided in your next ad request for the same context, Epsilon Retail Media will exclude previously served ads in the ad response. Review Pagination to learn more.

| | | `ads.metadata` |

Object containing the advertiser info required to help advertisers comply with local advertising legislation such as the Digital Services Actin Europe.

advertiser is carried from the Company name in the supplier team.

onBehalfOf is carried from the Ad financer in the supplier team.

| `"metadata": {
"advertiserInfo": {
"advertiser": "Bob's advertising agency",
"onBehalfOf": "Brand company inc"
}
...` | | `banners` | Comprises of banner objects. View the [Banner ad (static) reference](/retail-media-interface/integration/references/banner-ad-static-reference.md) to learn more. | `"banners": [],` | | `metadata.warnings` | Object containing warning information about the ad request. Currently only warns if the maximum number of segments is exceeded. | `"metadata": {
"warnings": [
"Audience Segment IDs exceeded the limit of 100 and were truncated"
]` | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://help.citrusad.com/retail-media-interface/integration/references/product-ad-reference-1.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.