Introduction
In our stable versions, we currently offer three different endpoints to fetch information on creatives:/retail-media/accounts/:account-id/creativesdocumented here,/retail-media/accounts/:account-id/creatives/:creative-iddocumented here,/retail-media/accounts/:account-id/creatives/search?creative-ids=<string>&creative-ids=<string>documented here.
Endpoint
Verb | Endpoint | Description |
|---|---|---|
|
| Search for creatives by external account ID |
Attributes
Attribute | Data Type | Description |
|---|---|---|
|
| The name of the creative. Accepted values: string Default: all Writeable? Y / Nullable? Y |
|
| Creative ID, generated internally by Criteo. Accepted values: int64 Default: all Writeable? Y / Nullable? Y |
|
| The types of creatives available, there are four acceptable values that can be used in combination or a single one if desired:
Accepted values are case-insensitive. Accepted values: string Default: all Writeable? Y / Nullable? Y |
|
| Brand ID, generated internally by Criteo and originated from brand name provided in retailer’s Catalog Accepted values: int64 Default: all Writeable? Y / Nullable? Y |
|
| The unique ID of the Creative template. Accepted values: int64 Default: all Writeable? Y / Nullable? Y |
|
| List of Retailer IDs, to use as filter in the search or returned as containing the specific brand Accepted values: list of strings of int32 Default: all Writeable? Y / Nullable? Y |
|
| Type page type the creative is designed for. There are eleven acceptable values that can be used in combination or a single one if desired:
Accepted values are case-insensitive Accepted Values: string Default: all Writeable? N / Nullable? N |
- The default limit is 50 if it is not included in the request.
- The maximum that a user can input is 500 in the request. A user will run into a 400 error in the event they attempt to go beyond this limit.
- Writeable (Y/N): Indicates if the field can be modified in requests.
- Nullable (Y/N): Indicates if the field can accept null/empty values.
- Primary Key: A unique, immutable identifier of the entity, generated internally by Criteo. Primary keys are typically ID fields (e.g.,
retailerId,campaignId,lineItemId) and are usually required in the URL path.
Search for Creatives
This endpoint returns a list of creatives based on the provided filters. When more than one filter is supplied, all filters must be satisfied (logical AND expression). You can also search for creatives by external account ID. Request exampleResponses
Code | Reason | Client Exposed Message |
|---|---|---|
🔴 | Validation issue: provided invalid offset and limit (either negative numbers or limit above the maximum). | Offset and limit should be non-negative OR Limit exceeds the maximum |
🔴 |
|