{
"openapi": "3.0.1",
"info": {
"title": "Criteo API",
"description": "Criteo API - RetailMedia",
"version": "2026-07"
},
"servers": [
{
"url": "https://api.criteo.com"
}
],
"paths": {
"/2026-07/retail-media/account-management/accounts/{accountId}/brands/add": {
"post": {
"tags": [
"Accounts"
],
"summary": "/2026-07/retail-media/account-management/accounts/{accountId}/brands/add",
"description": "Add brands to an account",
"operationId": "AddBrands",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "the account id to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputOfRetailMediaBrands"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceOutcomeOfRetailMediaBrands"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Accounts_Manage"
]
}
]
}
},
"/2026-07/retail-media/account-management/accounts/{accountId}/brands/remove": {
"post": {
"tags": [
"Accounts"
],
"summary": "/2026-07/retail-media/account-management/accounts/{accountId}/brands/remove",
"description": "Remove brands from an account",
"operationId": "RemoveBrands",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "the account id to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputOfRetailMediaBrands"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceOutcomeOfRetailMediaBrands"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Accounts_Manage"
]
}
]
}
},
"/2026-07/retail-media/account-management/accounts/{accountId}/create-brand-account": {
"post": {
"tags": [
"Accounts"
],
"summary": "/2026-07/retail-media/account-management/accounts/{accountId}/create-brand-account",
"description": "Creates a new child Demand Brand account for the provided parent Private Market account",
"operationId": "CreatePrivateMarketDemandBrandAccount",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The given account id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputOfRetailMediaBrandAccountCreation"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceOutcomeOfRetailMediaAccount"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Accounts_Manage"
]
}
]
}
},
"/2026-07/retail-media/account-management/accounts/{accountId}/create-seller-account": {
"post": {
"tags": [
"Accounts"
],
"summary": "/2026-07/retail-media/account-management/accounts/{accountId}/create-seller-account",
"description": "Creates a new child Demand Seller account for the provided parent Private Market account",
"operationId": "CreatePrivateMarketDemandSellerAccount",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The given account id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputOfRetailMediaSellerAccountCreation"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceOutcomeOfRetailMediaAccount"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Accounts_Manage"
]
}
]
}
},
"/2026-07/retail-media/account-management/accounts/{accountId}/private-market-child-accounts": {
"get": {
"tags": [
"Accounts"
],
"summary": "/2026-07/retail-media/account-management/accounts/{accountId}/private-market-child-accounts",
"description": "Gets Private Market child accounts that are associated with the given account",
"operationId": "GetPrivateMarketChildAccountsByAccountId",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "The number of accounts to be returned. The default is 25.",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "offset",
"in": "query",
"description": "The (zero-based) offset into the collection of accounts. The default is 0.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceCollectionOutcomeOfRetailMediaChildAccountAndMetadata"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Accounts_Read"
]
}
]
}
},
"/2026-07/retail-media/account-management/accounts/{accountId}/sellers": {
"put": {
"tags": [
"Accounts"
],
"summary": "/2026-07/retail-media/account-management/accounts/{accountId}/sellers",
"description": "Replace the sellers associated with an account",
"operationId": "UpdateSellers",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The given account id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceCollectionInputOfRetailMediaSeller"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceCollectionOutcomeOfRetailMediaSeller"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Accounts_Manage"
]
}
]
}
},
"/2026-07/retail-media/accounts": {
"get": {
"tags": [
"Accounts"
],
"summary": "/2026-07/retail-media/accounts",
"description": "Gets page of account objects that the current user can access",
"operationId": "GetAccounts",
"parameters": [
{
"name": "limitToId",
"in": "query",
"description": "The ids that you would like to limit your result set to",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "pageIndex",
"in": "query",
"description": "The 0 indexed page index you would like to receive given the page size",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "pageSize",
"in": "query",
"description": "The maximum number of items you would like to receive in this request",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonApiPageResponseOfAccount"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Accounts_Read"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/audience-segments": {
"patch": {
"tags": [
"Audience"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/audience-segments",
"description": "Updates the properties of all segments with a valid configuration, and returns the full segments. For those that cannot be updated, one or multiple errors are returned.",
"operationId": "bulkUpdateAudienceSegments",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "Account id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Segment Update request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSegmentBulkUpdateInputV1"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success or partial success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSegmentEntityV1ListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Audience_Manage"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/audience-segments/{audience-segment-id}/contact-list": {
"get": {
"tags": [
"Audience"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/audience-segments/{audience-segment-id}/contact-list",
"description": "Returns the statistics of a contact list segment.",
"operationId": "getAudienceSegmentContactListStatistics",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "audience-segment-id",
"in": "path",
"description": "Segment Id.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success or partial success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmContactListStatisticsEntityV1Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Audience_Read"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/audience-segments/create": {
"post": {
"tags": [
"Audience"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/audience-segments/create",
"description": "Creates all segments with a valid configuration, and returns the full segments. For those that cannot be created, one or multiple errors are returned.",
"operationId": "bulkCreateAudienceSegments",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Segment creation parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSegmentBulkCreateInputV1"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success or partial success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSegmentEntityV1ListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Audience_Manage"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/audience-segments/delete": {
"post": {
"tags": [
"Audience"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/audience-segments/delete",
"description": "Delete the segments associated to the given IDs.",
"operationId": "bulkDeleteAudienceSegments",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "Account id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Segment delete request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSegmentBulkDeleteInputV1"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success or partial success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSegmentIdEntityV1ListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Audience_Manage"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/audience-segments/search": {
"post": {
"tags": [
"Audience"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/audience-segments/search",
"description": "Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.",
"operationId": "searchAudienceSegments",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "The number of elements to be returned. The default is 50 and the maximum is 500.",
"schema": {
"maximum": 500,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 50
}
},
{
"name": "offset",
"in": "query",
"description": "The (zero-based) offset into the collection. The default is 0.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"requestBody": {
"description": "Segment search filters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSegmentSearchInputV1"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success or partial success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSegmentEntityV1RmAudienceSegmentSearchMetadataV1ListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Audience_Read"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/audiences/search": {
"post": {
"tags": [
"Audience"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/audiences/search",
"description": "Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied.",
"operationId": "searchAudiences",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "The number of elements to be returned. The default is 50 and the maximum is 500.",
"schema": {
"maximum": 500,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 50
}
},
{
"name": "offset",
"in": "query",
"description": "The (zero-based) offset into the collection. The default is 0.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"requestBody": {
"description": "Audience search filters.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSearchInputV1"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success or partial success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceEntityV1RmAudienceSearchMetadataV1ListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Audience_Read"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/balances": {
"get": {
"tags": [
"Balance"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/balances",
"description": "Gets page of balance objects for the given account id",
"operationId": "GetBalancesByAccountId",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "The account to get balances for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limitToId",
"in": "query",
"description": "The ids that you would like to limit your result set to",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "pageIndex",
"in": "query",
"description": "The 0 indexed page index you would like to receive given the page size",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "pageSize",
"in": "query",
"description": "The maximum number of items you would like to receive in this request",
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceResponseV2PagedListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Balance_Read"
]
}
]
},
"post": {
"tags": [
"Balance"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/balances",
"description": "Create balance for the given account id",
"operationId": "CreateBalanceByAccountId",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "The account to create balances for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "An object that represents the available options to set when creating a Retail Media Balance",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateBalanceV2Request"
}
}
},
"required": true,
"x-bodyName": "createBalance"
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceResponseV2Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Balance_Manage"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/balances/{balance-id}": {
"get": {
"tags": [
"Balance"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/balances/{balance-id}",
"description": "Get a balance for the given account id and balance id",
"operationId": "GetBalanceByAccountAndBalanceId",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "The account of the balance",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "balance-id",
"in": "path",
"description": "The balance id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceResponseV2Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Balance_Read"
]
}
]
},
"patch": {
"tags": [
"Balance"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/balances/{balance-id}",
"description": "Modify a balance for the given account id",
"operationId": "ModifyBalanceByAccountAndBalanceId",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "The account of the balance",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "balance-id",
"in": "path",
"description": "The balance to change the dates",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "An object that represents the available options to modify a balance.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateBalanceModelV2Request"
}
}
},
"required": true,
"x-bodyName": "updateBalanceModel"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceResponseV2Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Balance_Manage"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/balances/{balance-id}/add-funds": {
"post": {
"tags": [
"Balance"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/balances/{balance-id}/add-funds",
"description": "Add funds to a balance for the given account id",
"operationId": "AddFundsByAccountAndBalanceId",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "The account of the balance",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "balance-id",
"in": "path",
"description": "The balance to add funds to",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "An object that represents the available options of adding funds to a balance.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddFundsToBalanceV2Request"
}
}
},
"required": true,
"x-bodyName": "addFundsToBalance"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceResponseV2Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Balance_Manage"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/balances/{balance-id}/change-dates": {
"post": {
"tags": [
"Balance"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/balances/{balance-id}/change-dates",
"description": "Change dates of a balance for the given account id",
"operationId": "ChangeDatesByAccountAndBalanceId",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "The account of the balance",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "balance-id",
"in": "path",
"description": "The balance to change the dates",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "An object that represents the available options to modify schedule of a balance.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeDatesOfBalanceV2Request"
}
}
},
"required": true,
"x-bodyName": "changeDatesOfBalance"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceResponseV2Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Balance_Manage"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/campaigns": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/campaigns",
"description": "Gets page of campaign objects for the given account id",
"operationId": "GetCampaignsByAccountId",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "The given account id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limitToId",
"in": "query",
"description": "The ids that you would like to limit your result set to",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "pageIndex",
"in": "query",
"description": "The 0 indexed page index you would like to receive given the page size",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "pageSize",
"in": "query",
"description": "The maximum number of items you would like to receive in this request",
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonApiPageResponseOfCampaignV202301"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
},
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/campaigns",
"description": "Creates a new campaign with the specified settings",
"operationId": "CreateCampaignsByAccountId",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "The given account id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The campaign settings to create a campaign with",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostCampaignV202301"
}
}
},
"required": true,
"x-bodyName": "campaign"
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonApiSingleResponseOfCampaignV202301"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/creatives": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/creatives",
"description": "Get account creatives",
"operationId": "GetAccountCreatives",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "External account id to retrieve creatives for",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Creatives found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Creative202110ListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
},
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/creatives",
"description": "Create a creative for an account",
"operationId": "CreateCreative",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "External account id to create a creative for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The creative to create",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreativeCreateModel202207"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Creatives created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Creative202210Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/creatives/{creative-id}": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/creatives/{creative-id}",
"description": "Get the specified creative",
"operationId": "GetCreative",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "External account id to retrieve creatives for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "creative-id",
"in": "path",
"description": "Creative to get",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Creatives found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Creative2Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
},
"put": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/creatives/{creative-id}",
"description": "Update a creative",
"operationId": "UpdateCreative",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "External account id containing the creative",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "creative-id",
"in": "path",
"description": "Creative to update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The creative to create",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreativeUpdateModel202207"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Creative updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Creative202210Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/creatives/search": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/creatives/search",
"description": "Get account creatives",
"operationId": "SearchAccountCreatives",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "External account id to retrieve creatives for",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "creative-ids",
"in": "query",
"description": "Creatives to filter by",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Creatives found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Creative2ListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/keywords/in-review-report": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/keywords/in-review-report",
"description": "Generate a list of reports for line items which contain one or more actionable keyword reviews",
"operationId": "GetKeywordInReviewReport",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "The account to generate a report for",
"required": true,
"schema": {
"type": "string",
"format": "int64"
}
},
{
"name": "limit",
"in": "query",
"description": "Number of items per page",
"schema": {
"maximum": 50,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "offset",
"in": "query",
"description": "Offset for pagination",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/accounts/{account-id}/line-items": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/accounts/{account-id}/line-items",
"description": "Gets page of line item objects for the given account id",
"operationId": "GetLineItemsByAccountId",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "The given account id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limitToCampaignId",
"in": "query",
"description": "The campaign ids that you would like to limit your result set to",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "limitToId",
"in": "query",
"description": "The ids that you would like to limit your result set to",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "limitToType",
"in": "query",
"description": "The campaign types that you would like to limit your result set to",
"schema": {
"enum": [
"Unknown",
"Auction",
"Preferred"
],
"type": "string",
"nullable": true
}
},
{
"name": "pageIndex",
"in": "query",
"description": "The 0 indexed page index you would like to receive given the page size",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "pageSize",
"in": "query",
"description": "The maximum number of items you would like to receive in this request",
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonLineItemPagedListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/accounts/{accountId}/brand-catalog-export": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/accounts/{accountId}/brand-catalog-export",
"description": "Create a request for a Catalog available to the indicated account.",
"operationId": "CreateBrandCatalogExport",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The account to request the catalog for.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputOfBrandCatalogRequestV2"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Catalog request successfully created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceOutcomeOfCatalogStatusV2"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/accounts/{accountId}/brands": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/accounts/{accountId}/brands",
"description": "Gets page of retailer objects that are associated with the given account",
"operationId": "GetBrandsByAccountId",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The given account id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limitToId",
"in": "query",
"description": "The ids that you would like to limit your result set to",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "pageIndex",
"in": "query",
"description": "The 0 indexed page index you would like to receive given the page size",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "pageSize",
"in": "query",
"description": "The maximum number of items you would like to receive in this request",
"schema": {
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonApiPageResponseOfBrand"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/accounts/{accountId}/catalogs": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/accounts/{accountId}/catalogs",
"description": "Create a request for a Catalog available to the indicated account.",
"operationId": "CatalogApi_PostApiV1ExternalAccountCatalogsByAccountId",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The account to request the catalog for.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonApiRequestOfCatalogRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Catalog request successfully created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonApiSingleResponseOfCatalogStatus"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/accounts/{accountId}/catalogs/sellers": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/accounts/{accountId}/catalogs/sellers",
"description": "Create a request for a Catalog available to the indicated account.",
"operationId": "Catalog_PostApiExternalV1AccountCatalogsSellersByAccountId",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The account to request the catalog for.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonApiRequestOfSellerCatalogRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Catalog request successfully created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonApiSingleResponseOfCatalogStatus"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/accounts/{accountId}/grant-consent": {
"post": {
"tags": [
"Accounts"
],
"summary": "/2026-07/retail-media/accounts/{accountId}/grant-consent",
"description": "Grant consent to a business application on behalf of a Private Market demand account",
"operationId": "GrantConsent",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The demand account ID on which to grant consent",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantConsentInput"
}
}
},
"x-bodyName": "grantConsentInput"
},
"responses": {
"204": {
"description": "Success"
}
},
"security": [
{
"oauth": [
"RetailMedia_Accounts_Manage"
]
}
]
}
},
"/2026-07/retail-media/accounts/{accountId}/retailers/search": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/accounts/{accountId}/retailers/search",
"description": "Searches for retailers associated with the specified account and returns budget model availability for each retailer",
"operationId": "SearchAccountRetailers",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The external account identifier",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "The maximum number of items to return. Must be between 1 and 10. Default is 5.",
"schema": {
"maximum": 10,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 5
}
},
{
"name": "offset",
"in": "query",
"description": "The number of items to skip before starting to collect the result set. Default is 0.",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"requestBody": {
"description": "The search request containing filtering parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputOfRetailerSearchRequestV2"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceCollectionOutcomeOfRetailerResultV2AndMetadata"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/accounts/{accountId}/seller-catalog-export": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/accounts/{accountId}/seller-catalog-export",
"description": "Create a request for a Catalog available to the indicated account.",
"operationId": "CreateSellerCatalogExport",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The account to request the catalog for.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputOfSellerCatalogRequestV2"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Catalog request successfully created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceOutcomeOfCatalogStatusV2"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/accounts/fees/search": {
"post": {
"tags": [
"Accounts"
],
"summary": "/2026-07/retail-media/accounts/fees/search",
"description": "Get fees for provided accounts",
"operationId": "AccountFeesSearch",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "used for paging, number of results returned per request, Maximum of 500",
"schema": {
"maximum": 500,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 50
}
},
{
"name": "offset",
"in": "query",
"description": "used for paging, number of records to skip",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputAccountFeesSearchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Accounts_Read"
]
}
]
}
},
"/2026-07/retail-media/accounts/fees/update": {
"post": {
"tags": [
"Accounts"
],
"summary": "/2026-07/retail-media/accounts/fees/update",
"description": "Set fees for provided accounts",
"operationId": "UpdateAccountFees",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputAccountFeesUpdateRequest"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
}
},
"security": [
{
"oauth": [
"RetailMedia_Accounts_Manage"
]
}
]
}
},
"/2026-07/retail-media/accounts/sellers/search": {
"post": {
"tags": [
"Accounts"
],
"summary": "/2026-07/retail-media/accounts/sellers/search",
"description": "Get the sellers mapped to provided accounts",
"operationId": "SearchSellers",
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputOfSellerSearch"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceCollectionOutcomeOfSellerSearchResult"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Accounts_Read"
]
}
]
}
},
"/2026-07/retail-media/assets": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/assets",
"description": "Creates an asset",
"operationId": "CreateAsset",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"AssetFile"
],
"properties": {
"AssetFile": {
"type": "string",
"description": "The asset binary content",
"format": "binary"
}
}
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssetResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/auction-line-items/{lineItemId}": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/auction-line-items/{lineItemId}",
"description": "Gets a sponsored product line item by its id.",
"operationId": "GetAuctionLineItem",
"parameters": [
{
"name": "lineItemId",
"in": "path",
"description": "The id of the line item",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceOutcomeOfSponsoredProductsLineItem"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
},
"put": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/auction-line-items/{lineItemId}",
"description": "Updates a Sponsored Products Line Item given a line item id and a request.",
"operationId": "UpdateAuctionLineItem",
"parameters": [
{
"name": "lineItemId",
"in": "path",
"description": "The external line item ID of the sponsored products line item.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "An update request containing all details of the requested update.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceOutcomeOfSponsoredProductsLineItem"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/audience-segments/{audience-segment-id}/contact-list/add-remove": {
"post": {
"tags": [
"Audience"
],
"summary": "/2026-07/retail-media/audience-segments/{audience-segment-id}/contact-list/add-remove",
"description": "Add/remove identifiers to or from a retail-media contact list audience-segment, with external audience segment id.",
"operationId": "AddRemoveContactListByAudienceSegment",
"parameters": [
{
"name": "audience-segment-id",
"in": "path",
"description": "The id of the contact list audience-segment to amend, we only accept external Id here",
"required": true,
"schema": {
"type": "string",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetailMediaContactlistAmendmentRequest"
}
}
},
"required": true,
"x-bodyName": "body"
},
"responses": {
"200": {
"description": "Summary of created request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetailMediaContactlistOperation"
},
"example": {
"type": "AddRemoveContactlistResult",
"data": {
"contactListId": 568708742535471104,
"operation": "add",
"requestDate": "2018-12-10T10:00:50.0000000+00:00",
"identifierType": "madid",
"nbValidIdentifiers": 7343,
"nbInvalidIdentifiers": 13,
"sampleInvalidIdentifiers": [
"InvalidIdentifier"
]
},
"errors": [
{
"traceId": "667ac683ac797284.667ac683ac797284<:667ac683ac797284",
"type": "availability",
"code": "internal-error",
"instance": "",
"title": "Internal error"
}
],
"warnings": [
{
"traceId": "56ed4096-f96a-4944-8881-05468efe0ec9",
"type": "deprecation",
"code": "deprecated-field",
"instance": "/audiences/314195",
"title": "'nbValidIds' is deprecated",
"detail": "The field 'nbValidIds' is deprecated please use 'nbValidIdentifiers'"
}
]
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Audience_Manage"
]
}
]
}
},
"/2026-07/retail-media/audience-segments/{audience-segment-id}/contact-list/clear": {
"post": {
"tags": [
"Audience"
],
"summary": "/2026-07/retail-media/audience-segments/{audience-segment-id}/contact-list/clear",
"description": "Delete all identifiers from a retail-media contact list audience-segment, with external audience segment id.",
"operationId": "ClearContactListByAudienceSegment",
"parameters": [
{
"name": "audience-segment-id",
"in": "path",
"description": "The id of the contact list audience-segment to amend, we only accept external Id here",
"required": true,
"schema": {
"type": "string",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "The Contact List identifiers were deleted",
"content": {
"application/json": { }
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Audience_Manage"
]
}
]
}
},
"/2026-07/retail-media/balances/{balance-id}/campaigns": {
"get": {
"tags": [
"Balance"
],
"summary": "/2026-07/retail-media/balances/{balance-id}/campaigns",
"description": "Gets page of campaigns for the given balanceId",
"operationId": "GetCampaignsByBalanceId",
"parameters": [
{
"name": "balance-id",
"in": "path",
"description": "The balance to get campaigns from",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limitToId",
"in": "query",
"description": "The ids that you would like to limit your result set to",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "pageIndex",
"in": "query",
"description": "The 0 indexed page index you would like to receive given the page size",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "pageSize",
"in": "query",
"description": "The maximum number of items you would like to receive in this request",
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceCampaign202110PagedListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Balance_Read"
]
}
]
}
},
"/2026-07/retail-media/balances/{balance-id}/campaigns/append": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/balances/{balance-id}/campaigns/append",
"description": "appends one or more campaigns to the specified balance",
"operationId": "AppendCampaignsByBalanceId",
"parameters": [
{
"name": "balance-id",
"in": "path",
"description": "The balance to add campaigns from",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The campaigns to append",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceCampaign202110ListRequest"
}
}
},
"x-bodyName": "campaigns"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceCampaign202110PagedListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/balances/{balance-id}/campaigns/delete": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/balances/{balance-id}/campaigns/delete",
"description": "Removes one or more campaigns on the specified balance",
"operationId": "DeleteCampaignsByBalanceId",
"parameters": [
{
"name": "balance-id",
"in": "path",
"description": "The balance to remove campaigns from",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The campaigns to append",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceCampaign202110ListRequest"
}
}
},
"x-bodyName": "campaigns"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceCampaign202110PagedListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/balances/{balanceId}/history": {
"get": {
"tags": [
"Balance"
],
"summary": "/2026-07/retail-media/balances/{balanceId}/history",
"description": "Gets the balance's historical change data.",
"operationId": "GetBalanceHistory",
"parameters": [
{
"name": "balanceId",
"in": "path",
"description": "Balance id.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "The number of elements to be returned.",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "limitToChangeTypes",
"in": "query",
"description": "Comma separated change types string that will be queried.",
"schema": {
"type": "string"
}
},
{
"name": "offset",
"in": "query",
"description": "The (zero-based) starting offset in the collection.",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PageOfBalanceHistoryChangeDataCaptureV1"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Balance_Read"
]
}
]
}
},
"/2026-07/retail-media/billing/partner-report": {
"post": {
"tags": [
"Billing"
],
"summary": "/2026-07/retail-media/billing/partner-report",
"description": "Create a Partner Billing Report request.",
"operationId": "CreatePartnerBillingReportRequestV1",
"requestBody": {
"description": "Partner Billing Report request object.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputPartnerBillingReportRequestV1"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceOutcomePartnerBillingReportStatusV1"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Billing_Read"
]
}
]
}
},
"/2026-07/retail-media/billing/partner-report/{requestId}/output": {
"get": {
"tags": [
"Billing"
],
"summary": "/2026-07/retail-media/billing/partner-report/{requestId}/output",
"description": "Get the output of an existing Partner Billing Report.",
"operationId": "GetPartnerBillingReportOutputV1",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "The id of a Partner Billing Report request.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/csv": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Billing_Read"
]
}
]
}
},
"/2026-07/retail-media/billing/partner-report/{requestId}/status": {
"get": {
"tags": [
"Billing"
],
"summary": "/2026-07/retail-media/billing/partner-report/{requestId}/status",
"description": "Get the status of an existing Partner Billing Report.",
"operationId": "GetPartnerBillingReportStatusV1",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "The id of a Partner Billing Report request.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceOutcomePartnerBillingReportStatusV1"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Billing_Read"
]
}
]
}
},
"/2026-07/retail-media/brands/search": {
"post": {
"tags": [
"Accounts"
],
"summary": "/2026-07/retail-media/brands/search",
"description": "Search for brands given a retailer ID and search term.",
"operationId": "SearchBrands",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "the number of brands to return",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "offset",
"in": "query",
"description": "offset of paginated results",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"requestBody": {
"description": "BrandIdSearchRequest which contains the request parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputBrandIdSearchRequest"
}
}
},
"x-bodyName": "brandIdSearchRequest"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Accounts_Read"
]
}
]
}
},
"/2026-07/retail-media/campaigns/{campaign-id}/preferred-line-items": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/campaigns/{campaign-id}/preferred-line-items",
"description": "Gets page of preferred line item objects for the given campaign id",
"operationId": "GetPreferredLineItemsByCampaignId",
"parameters": [
{
"name": "campaign-id",
"in": "path",
"description": "The given campaign id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limitToId",
"in": "query",
"description": "The ids that you would like to limit your result set to",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "pageIndex",
"in": "query",
"description": "The 0 indexed page index you would like to receive given the page size",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "pageSize",
"in": "query",
"description": "The maximum number of items you would like to receive in this request",
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreferredLineItemV2PagedListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
},
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/campaigns/{campaign-id}/preferred-line-items",
"description": "Creates a new preferred line item with the specified settings",
"operationId": "CreatePreferredLineItemByCampaignId",
"parameters": [
{
"name": "campaign-id",
"in": "path",
"description": "The given campaign id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The line item settings to create a line item with",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreferredLineItemCreateModelV2Request"
}
}
},
"required": true,
"x-bodyName": "lineItem"
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreferredLineItemV2Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/campaigns/{campaignId}": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/campaigns/{campaignId}",
"description": "Gets the campaign for the given campaign id",
"operationId": "GetCampaignByCampaignId",
"parameters": [
{
"name": "campaignId",
"in": "path",
"description": "The given campaign id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonApiSingleResponseOfCampaignV202301"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
},
"put": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/campaigns/{campaignId}",
"description": "Updates the campaign for the given campaign id",
"operationId": "UpdateCampaignByCampaignId",
"parameters": [
{
"name": "campaignId",
"in": "path",
"description": "The given campaign id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The campaign settings to update that campaign with",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutCampaignV202301"
}
}
},
"required": true,
"x-bodyName": "campaign"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonApiSingleResponseOfCampaignV202301"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/campaigns/{campaignId}/auction-line-items": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/campaigns/{campaignId}/auction-line-items",
"description": "Gets a page of sponsored product line items by campaign id.",
"operationId": "GetAuctionLineItemsByCampaign",
"parameters": [
{
"name": "campaignId",
"in": "path",
"description": "The id of the campaign",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "The number of elements to be returned on a page.",
"schema": {
"maximum": 500,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "limitToIds",
"in": "query",
"description": "The ids to limit the auction line item results to",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "offset",
"in": "query",
"description": "The (zero-based) starting offset into the collection.",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceCollectionOutcomeOfSponsoredProductsLineItemAndMetadata"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
},
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/campaigns/{campaignId}/auction-line-items",
"description": "Creates new auction line item with the specified settings",
"operationId": "CreateAuctionLineItem",
"parameters": [
{
"name": "campaignId",
"in": "path",
"description": "The given campaign id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The line item settings to create a line item with",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputOfSponsoredProductsLineItemCreateRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceOutcomeOfSponsoredProductsLineItem"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/campaigns/{campaignId}/campaign-budget-overrides": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/campaigns/{campaignId}/campaign-budget-overrides",
"description": "Get current campaign budget overrides by given campaign id.",
"operationId": "GetCampaignBudgetOverrides",
"parameters": [
{
"name": "campaignId",
"in": "path",
"description": "Campaign id.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceOutcomeOfCampaignBudgetOverrides"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
},
"put": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/campaigns/{campaignId}/campaign-budget-overrides",
"description": "Update campaign budget overrides by given campaign id and new campaign budget overrides settings.",
"operationId": "UpdateCampaignBudgetOverrides",
"parameters": [
{
"name": "campaignId",
"in": "path",
"description": "Campaign id.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "New campaign budget overrides settings value resource input.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputOfCampaignBudgetOverrides"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceOutcomeOfCampaignBudgetOverrides"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/catalog/merchants/{merchantId}/store-inventory/delete": {
"post": {
"tags": [
"Catalog"
],
"summary": "/2026-07/retail-media/catalog/merchants/{merchantId}/store-inventory/delete",
"description": "Used to publish a batch of store inventories to delete. The batch is processed asynchronously.",
"operationId": "DeleteStoreInventoryPerMerchantId",
"parameters": [
{
"name": "merchantId",
"in": "path",
"description": "Identifies the merchant, can also be called partnerId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchStoreInventoryDeleteRequest"
}
}
},
"required": true,
"x-bodyName": "body"
},
"responses": {
"204": {
"description": "Batch accepted.",
"content": {
"application/json": { }
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Catalog_Manage"
]
}
]
}
},
"/2026-07/retail-media/catalog/merchants/{merchantId}/store-inventory/upsert": {
"post": {
"tags": [
"Catalog"
],
"summary": "/2026-07/retail-media/catalog/merchants/{merchantId}/store-inventory/upsert",
"description": "Used to publish a batch of store inventories to upsert. The batch is processed asynchronously.",
"operationId": "UpsertStoreInventoryPerMerchantId",
"parameters": [
{
"name": "merchantId",
"in": "path",
"description": "Identifies the merchant, can also be called partnerId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchStoreInventoryRequest"
}
}
},
"required": true,
"x-bodyName": "body"
},
"responses": {
"204": {
"description": "Batch accepted.",
"content": {
"application/json": { }
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Catalog_Manage"
]
}
]
}
},
"/2026-07/retail-media/catalogs/{catalogId}/output": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/catalogs/{catalogId}/output",
"description": "Output the indicated catalog. Catalogs are only available for retrieval when their associated status request\r\nis at a Success status.\r\nProduces application/x-json-stream CatalogProduct json objects (first introduced in the 2021-07 version).",
"operationId": "GetCatalogOutput",
"parameters": [
{
"name": "catalogId",
"in": "path",
"description": "A catalog ID returned from an account catalog request.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Catalog download initiated.",
"content": {
"application/x-json-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"204": {
"description": "Catalog has expired."
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/catalogs/{catalogId}/status": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/catalogs/{catalogId}/status",
"description": "Check the status of a catalog request.",
"operationId": "GetCatalogStatus",
"parameters": [
{
"name": "catalogId",
"in": "path",
"description": "A catalog ID returned from an account catalog request.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Catalog request found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonApiSingleResponseOfCatalogStatus"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/categories": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/categories",
"description": "Endpoint to search categories by text and retailer.",
"operationId": "CategorySearch_GetApiExternalV1Categories",
"parameters": [
{
"name": "pageIndex",
"in": "query",
"description": "The start position in the overall list of matches. Must be zero or greater.",
"schema": {
"maximum": 500,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "pageSize",
"in": "query",
"description": "The maximum number of results to return with each call. Must be greater than zero.",
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 100
}
},
{
"name": "retailerId",
"in": "query",
"description": "The retailer id for which Categories fetched",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "textSubstring",
"in": "query",
"description": "Query string to search across Categories",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Categories found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Category202204ListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/categories/{categoryId}": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/categories/{categoryId}",
"description": "Endpoint to search for a specific category by categoryId.",
"operationId": "GetCategory",
"parameters": [
{
"name": "categoryId",
"in": "path",
"description": "ID of the desired category",
"required": true,
"schema": {
"type": "string",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Retrieval completed and category is returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Category202204"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/line-items/{externalLineItemId}/keywords/recommended": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/line-items/{externalLineItemId}/keywords/recommended",
"description": "Retrieves a collection of recommended keywords for a line item",
"operationId": "GetRecommendedKeywords",
"parameters": [
{
"name": "externalLineItemId",
"in": "path",
"description": "The line item identifier",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceOutcomeOfRecommendedKeywordsResult"
}
}
}
}
},
"deprecated": true,
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/line-items/{id}/keywords": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/line-items/{id}/keywords",
"description": "Fetch keywords associated with the specified line item",
"operationId": "FetchKeywords",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the line item",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KeywordsModelResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/line-items/{id}/keywords/add-remove": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/line-items/{id}/keywords/add-remove",
"description": "Add or Remove keywords from the line item in bulk",
"operationId": "AddRemoveKeywords",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the line item",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddRemoveKeywordsModelRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceOutcome"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/line-items/{id}/keywords/set-bid": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/line-items/{id}/keywords/set-bid",
"description": "Set bid overrides for associated keywords to the given line item in bulk",
"operationId": "SetKeywordBids",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of the line item",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetBidsModelRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceOutcome"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/line-items/{line-item-id}": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/line-items/{line-item-id}",
"description": "Gets the line item for the given line item id",
"operationId": "GetLineItemsByCampaignId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The given line item id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommonLineItemResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/line-items/{line-item-id}/bid-multipliers": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/line-items/{line-item-id}/bid-multipliers",
"description": "Fetch all bid multipliers for a given line item",
"operationId": "GetBidMultipliersByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "LineItemId for bid multiplier retrieval",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "BidMultipliers Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonApiSingleResponseOfLineItemBidMultipliersV2"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
},
"put": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/line-items/{line-item-id}/bid-multipliers",
"description": "Updates the bid multipliers for a given line item",
"operationId": "UpdateBidMultipliersByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "LineItemId for bid multiplier retrieval",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "New Bid Multipliers to be set",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LineItemBidMultipliersV2Request"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "BidMultipliers Updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LineItemBidMultipliersV2Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/line-items/{line-item-id}/keywords/review": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/line-items/{line-item-id}/keywords/review",
"description": "Update the status of keyword reviews under a line item",
"operationId": "UpdateKeywordReviews",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The line item to update keyword review statuses for",
"required": true,
"schema": {
"type": "string",
"format": "int64"
}
}
],
"requestBody": {
"description": "Request object containing a list of Phrase-ReviewState pairs to update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputRetailMediaKeywordsReview"
}
}
},
"x-bodyName": "keywordReviewSetStateRequest"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceOutcomeRetailMediaKeywordsReviewResult"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/line-items/{line-item-id}/products": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/line-items/{line-item-id}/products",
"description": "Retrieve a page of promoted products for a line item",
"operationId": "FetchPromotedProducts",
"parameters": [
{
"name": "fields",
"in": "query",
"description": "A comma separated list of attribute names from the response model to compute and return.\r\n Valid values are `status` and `bidOverride` in any order. Defaults to `status`.",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Maximum page size to fetch. Defaults to 500.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "line-item-id",
"in": "path",
"description": "ID of the line item.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "offset",
"in": "query",
"description": "Offset of the first item to fetch. Defaults to zero.",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Promoted products associated with the line item",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PromotedProductResourceCollectionOutcome"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/line-items/{line-item-id}/products/append": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/line-items/{line-item-id}/products/append",
"description": "Append a collection of promoted products to a line item",
"operationId": "AppendPromotedProducts",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "ID of the line item",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Request body whose {data} contains an array of promoted products.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PromotedProductResourceCollectionInput"
}
}
}
},
"responses": {
"200": {
"description": "Promoted products appended to the line item with warnings",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductResourceOutcome"
}
}
}
},
"204": {
"description": "Promoted products appended to the line item"
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/line-items/{line-item-id}/products/delete": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/line-items/{line-item-id}/products/delete",
"description": "Remove a collection of promoted products from a line item",
"operationId": "DeletePromotedProducts",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "ID of the line item",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Request body whose {data} contains an array of promoted products.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PromotedProductResourceCollectionInput"
}
}
}
},
"responses": {
"204": {
"description": "Promoted products removed from the line item"
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/line-items/{line-item-id}/products/pause": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/line-items/{line-item-id}/products/pause",
"description": "Pause a collection of promoted products associated with a line item",
"operationId": "PausePromotedProducts",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "ID of the line item",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Request body whose {data} contains an array of promoted products.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PromotedProductResourceCollectionInput"
}
}
}
},
"responses": {
"204": {
"description": "Promoted products paused"
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/line-items/{line-item-id}/products/unpause": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/line-items/{line-item-id}/products/unpause",
"description": "Un-pause a collection of promoted products associated with a line item",
"operationId": "UnpausePromotedProducts",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "ID of the line item",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Request body whose {data} contains an array of promoted products.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PromotedProductResourceCollectionInput"
}
}
}
},
"responses": {
"204": {
"description": "Promoted products un-paused"
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/line-items/{lineItemId}/line-item-budget-overrides": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/line-items/{lineItemId}/line-item-budget-overrides",
"description": "Gets a collection of monthly and daily budget overrides for the provided line item.",
"operationId": "GetLineItemBudgetOverrides",
"parameters": [
{
"name": "lineItemId",
"in": "path",
"description": "The line item id to get budget overrides for.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceOutcomeOfLineItemBudgetOverrides"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
},
"put": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/line-items/{lineItemId}/line-item-budget-overrides",
"description": "Update line item budget overrides by given external line item id and new line item budget overrides settings.",
"operationId": "UpdateLineItemBudgetOverrides",
"parameters": [
{
"name": "lineItemId",
"in": "path",
"description": "Line item external id.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "New line item budget overrides settings value resource input.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputOfLineItemBudgetOverrides"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceOutcomeOfLineItemBudgetOverrides"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/me": {
"get": {
"tags": [
"Gateway"
],
"summary": "/2026-07/retail-media/me",
"description": "Get information about the currently logged application",
"operationId": "GetCurrentApplication",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplicationSummaryModelResponse"
}
}
}
}
},
"security": [
{
"oauth": [ ]
}
]
}
},
"/2026-07/retail-media/preferred-line-items/{line-item-id}": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/preferred-line-items/{line-item-id}",
"description": "Gets the preferred line item for the given line item id",
"operationId": "GetPreferredLineItemsByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The given line item id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreferredLineItemV2Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
},
"put": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/preferred-line-items/{line-item-id}",
"description": "Updates the preferred line item for the given line item id",
"operationId": "UpdatePreferredLineItemByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The given line item id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The line item settings to create a line item with",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreferredLineItemUpdateModelV2Request"
}
}
},
"required": true,
"x-bodyName": "lineItem"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreferredLineItemV2Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket",
"description": "This endpoint gets the add to basket target on the specified line item.",
"operationId": "GetAddToBasketTargetsByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The line item to interact with",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddToBasketTarget202110Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
},
"put": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket",
"description": "This endpoint sets the scope of the add to basket target on the specified line item.",
"operationId": "PutAddToBasketTargetByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The line item to interact with",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The add to basket target to set the scope for",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddToBasketTarget202110Request"
}
}
},
"required": true,
"x-bodyName": "addToBasketTarget"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddToBasketTarget202110Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/append": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/append",
"description": "This endpoint appends one or more add to basket ids to targeting on the specified line item. The resulting state of the add to basket target is returned.",
"operationId": "AppendAddToBasketTargetsByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The line item to interact with",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Ids to append to the target",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddToBasketIdsUpdateModel202110Request"
}
}
},
"x-bodyName": "idsToAppend"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddToBasketTarget202110Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/delete": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/delete",
"description": "This endpoint removes one or more add to basket ids from targeting on the specified line item. The resulting state of the add to basket target is returned.",
"operationId": "DeleteAddToBasketTargetsByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The line item to interact with",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Ids to remove from the target",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddToBasketIdsUpdateModel202110Request"
}
}
},
"x-bodyName": "idsToRemove"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddToBasketTarget202110Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences",
"description": "This endpoint gets the audience target on the specified line item.",
"operationId": "GetAudienceTargetsByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The line item to interact with",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudienceTarget202110Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
},
"put": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences",
"description": "This endpoint sets the scope of the audience target on the specified line item.",
"operationId": "PutAudienceTargetsByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The line item to interact with",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The audience target to set the scope for",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudienceTarget202110Request"
}
}
},
"required": true,
"x-bodyName": "audienceTarget"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudienceTarget202110Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/append": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/append",
"description": "This endpoint appends one or more audiences ids to targeting on the specified line item. The resulting state of the audience target is returned.",
"operationId": "AppendAudienceTargetsByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The line item to interact with",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Audience ids to append to the target",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudienceIdsUpdateModel202110Request"
}
}
},
"x-bodyName": "idsToAppend"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudienceTarget202110Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/delete": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/delete",
"description": "This endpoint removes one or more audiences ids from targeting on the specified line item. The resulting state of the audience target is returned.",
"operationId": "DeleteAudienceTargetsByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The line item to interact with",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Audience ids to remove from the target",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudienceIdsUpdateModel202110Request"
}
}
},
"x-bodyName": "idsToRemove"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudienceTarget202110Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores",
"description": "This endpoint gets the store target on the specified line item.",
"operationId": "GetStoreTargetsByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The line item to interact with",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreTarget202110Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
},
"put": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores",
"description": "This endpoint sets the scope of the store target on the specified line item.",
"operationId": "PutStoreTargetByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The line item to interact with",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The store target to set the scope for",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreTarget202110Request"
}
}
},
"required": true,
"x-bodyName": "storeTarget"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreTarget202110Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores/append": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores/append",
"description": "This endpoint appends one or more store ids to targeting on the specified line item. The resulting state of the store target is returned.",
"operationId": "AppendStoreTargetsByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The line item to interact with",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Store ids to append to the target",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreIdsUpdateModel202110Request"
}
}
},
"x-bodyName": "idsToAppend"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreTarget202110Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores/delete": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores/delete",
"description": "This endpoint removes one or more store ids from targeting on the specified line item. The resulting state of the store target is returned.",
"operationId": "DeleteStoreTargetByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "The line item to interact with",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Store ids to remove from the target",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreIdsUpdateModel202110Request"
}
}
},
"x-bodyName": "idsToRemove"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreTarget202110Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/reports/{reportId}/output": {
"get": {
"tags": [
"Analytics"
],
"summary": "/2026-07/retail-media/reports/{reportId}/output",
"description": "Returns the output of an async report",
"operationId": "GetAsyncExportOutput",
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The ID of the report to retrieve",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/2026-07/retail-media/reports/{reportId}/status": {
"get": {
"tags": [
"Analytics"
],
"summary": "/2026-07/retail-media/reports/{reportId}/status",
"description": "Returns the status of an async report",
"operationId": "GetAsyncExportStatus",
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The ID of the report to retrieve",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncReportResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/2026-07/retail-media/reports/attributed-transactions": {
"post": {
"tags": [
"Analytics"
],
"summary": "/2026-07/retail-media/reports/attributed-transactions",
"description": "Creates an attributed-transactions async report. The request accepts explicit attributed-transaction dimensions, metrics, and filters.\r\n
\r\nThis endpoint is subject to specific rate limits.",
"operationId": "GenerateAsyncAttributedTransactionsReport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncAttributedTransactionsReportRequest"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncReportResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/2026-07/retail-media/reports/fillrate": {
"post": {
"tags": [
"Analytics"
],
"summary": "/2026-07/retail-media/reports/fillrate",
"description": "Returns an asynchronous Fill Rate Report\r\n
\r\nThis endpoint is subject to specific rate limits.",
"operationId": "GenerateAsyncFillRateReport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncFillRateReportRequest"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncReportResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/2026-07/retail-media/reports/missed-opportunities": {
"post": {
"tags": [
"Analytics"
],
"summary": "/2026-07/retail-media/reports/missed-opportunities",
"description": "Creates a missed-opportunities async report. The request accepts explicit missed-opportunities dimensions, metrics, and filters.\r\n
\r\nThis endpoint is subject to specific rate limits.",
"operationId": "GenerateAsyncMissedOpportunitiesReport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncMissedOpportunitiesReportRequest"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncReportResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/2026-07/retail-media/reports/performance": {
"post": {
"tags": [
"Analytics"
],
"summary": "/2026-07/retail-media/reports/performance",
"description": "Creates a performance DSP analytics async report. Dimensions and metrics select the output schema, and filters constrain eligible data.\r\n
\r\nThis endpoint is subject to specific rate limits.",
"operationId": "GenerateAsyncPerformanceReport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncPerformanceReportRequest"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncReportResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/2026-07/retail-media/reports/revenue": {
"post": {
"tags": [
"Analytics"
],
"summary": "/2026-07/retail-media/reports/revenue",
"description": "Returns an asynchronous Revenue Report\r\n
\r\nThis endpoint is subject to specific rate limits.",
"operationId": "GenerateAsyncRevenueReport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncRevenueReportRequest"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncReportResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/2026-07/retail-media/reports/sync/attributed-transactions": {
"post": {
"tags": [
"Analytics"
],
"summary": "/2026-07/retail-media/reports/sync/attributed-transactions",
"description": "Returns a synchronous Attributed Transactions Report",
"operationId": "GenerateSyncAttributedTransactionsReport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyncAttributedTransactionsReportRequest"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/2026-07/retail-media/reports/sync/campaigns": {
"post": {
"tags": [
"Analytics"
],
"summary": "/2026-07/retail-media/reports/sync/campaigns",
"description": "Returns a synchronous Campaigns Report",
"operationId": "GenerateSyncCampaignsReport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyncCampaignsReportRequest"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/2026-07/retail-media/reports/sync/line-items": {
"post": {
"tags": [
"Analytics"
],
"summary": "/2026-07/retail-media/reports/sync/line-items",
"description": "Returns a synchronous Line Items Report",
"operationId": "GenerateSyncLineItemsReport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyncLineItemsReportRequest"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/2026-07/retail-media/reports/sync/real-time-performance": {
"post": {
"tags": [
"Analytics"
],
"summary": "/2026-07/retail-media/reports/sync/real-time-performance",
"description": "Returns a synchronous Real Time Performance Report. Returns empty rows; metadata includes dataCompleteThrough (latest time from streaming table in the request timezone).\r\n
\r\nThis endpoint is subject to specific rate limits.",
"operationId": "GenerateSyncRealTimePerformanceReport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SyncRealTimePerformanceReportRequest"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/2026-07/retail-media/reports/unfilled-placements": {
"post": {
"tags": [
"Analytics"
],
"summary": "/2026-07/retail-media/reports/unfilled-placements",
"description": "Returns an asynchronous Unfilled Placements Report\r\n
\r\nThis endpoint is subject to specific rate limits.",
"operationId": "GenerateAsyncUnfilledPlacementsReport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncUnfilledPlacementsReportRequest"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncReportResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/2026-07/retail-media/retailers/{retailer-id}/templates": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/retailers/{retailer-id}/templates",
"description": "Get retailer creative templates",
"operationId": "GetRetailerCreativeTemplates",
"parameters": [
{
"name": "retailer-id",
"in": "path",
"description": "External retailer id to retrieve creative templates for",
"required": true,
"schema": {
"type": "string",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Templates found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/retailers/{retailer-id}/templates/{template-id}": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/retailers/{retailer-id}/templates/{template-id}",
"description": "Gets the template for the specified retailer id and template id",
"operationId": "GetCreativeTemplate",
"parameters": [
{
"name": "retailer-id",
"in": "path",
"description": "Retailer Id",
"required": true,
"schema": {
"type": "string",
"format": "int32"
}
},
{
"name": "template-id",
"in": "path",
"description": "Template Id",
"required": true,
"schema": {
"type": "string",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Template found for the retailer",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/retailers/{retailerId}/categories/search": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/retailers/{retailerId}/categories/search",
"description": "Search a retailer categories by given text substring and category ids.",
"operationId": "SearchCategory",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "Limit of the search result.",
"schema": {
"maximum": 500,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 50
}
},
{
"name": "offset",
"in": "query",
"description": "Offset of the search result.",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "retailerId",
"in": "path",
"description": "Retailer id.",
"required": true,
"schema": {
"type": "string",
"format": "int32"
}
}
],
"requestBody": {
"description": "Request of categories search.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputCategoriesSearchRequestV1"
}
}
},
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceCollectionOutcomeCategory202204Metadata"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/retailers/{retailerId}/cpc-min-bids": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/retailers/{retailerId}/cpc-min-bids",
"description": "Get overall and individual minimum bid amount for given retailer id and sku id list.",
"operationId": "GetCpcMinBidsBySkuIdsV1",
"parameters": [
{
"name": "retailerId",
"in": "path",
"description": "Retailer Id.",
"required": true,
"schema": {
"type": "string",
"format": "int32"
}
}
],
"requestBody": {
"description": "Cpc minimum bid amount request object.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputCpcMinBidsRequest"
}
}
},
"required": true,
"x-bodyName": "cpcMinBidsRequest"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceOutcomeCpcMinBidsResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/2026-07/retail-media/retailers/{retailerId}/pages": {
"get": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/retailers/{retailerId}/pages",
"description": "Get the page types available for the given retailer",
"operationId": "RetailerApi_GetApi202110ExternalRetailerPagesByRetailerId",
"parameters": [
{
"name": "retailerId",
"in": "path",
"description": "The retailers to fetch pages for",
"required": true,
"schema": {
"type": "string",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Pages fetched successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetailerPages202110"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/retailers/{retailerId}/recommend-categories": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/retailers/{retailerId}/recommend-categories",
"description": "Endpoint to get recommended categories by given retailer id and sku id list.",
"operationId": "GetRecommendedCategories",
"parameters": [
{
"name": "retailerId",
"in": "path",
"description": "Retailer id.",
"required": true,
"schema": {
"type": "string",
"format": "int32"
}
}
],
"requestBody": {
"description": "Request of recommended categories.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputRecommendedCategoriesRequestV1"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceCollectionOutcomeCategory202204"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/2026-07/retail-media/retailers/{retailerId}/recommend-keywords": {
"post": {
"tags": [
"Campaign"
],
"summary": "/2026-07/retail-media/retailers/{retailerId}/recommend-keywords",
"description": "Recommend keywords by given retailer id and sku ids.",
"operationId": "RecommendedKeywords",
"parameters": [
{
"name": "retailerId",
"in": "path",
"description": "Retailer id.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Request of recommended keywords.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputRecommendedKeywordsRequestV1"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceOutcomeRecommendedKeywordsResponseV1"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
}
},
"components": {
"schemas": {
"AccountFeesSearchRequest": {
"type": "object",
"properties": {
"accountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Account Ids to return fees",
"nullable": true
}
},
"additionalProperties": false,
"description": "the request body for account fees search"
},
"AccountFeesUpdateRequest": {
"required": [
"accountIds",
"fees"
],
"type": "object",
"properties": {
"accountIds": {
"maxItems": 25,
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "accounts to update"
},
"fees": {
"$ref": "#/components/schemas/PrivateMarketFees"
}
},
"additionalProperties": false,
"description": "request body to set provided fees for the provided accounts"
},
"AddFundsToBalanceV2": {
"required": [
"deltaAmount"
],
"type": "object",
"properties": {
"deltaAmount": {
"type": "number",
"description": "Amount of billable funds to be added / decreased allotted to the balance.",
"format": "double"
},
"memo": {
"type": "string",
"description": "Memo"
},
"poNumber": {
"type": "string",
"description": "Purchase Order number."
}
},
"description": "An object that represents the available options of adding funds to a balance."
},
"AddFundsToBalanceV2Request": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ResourceOfAddFundsToBalanceV2"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single entity"
},
"AddRemoveKeywordModel": {
"type": "object",
"properties": {
"isDeleted": {
"type": "boolean"
},
"matchType": {
"$ref": "#/components/schemas/MatchTypeModel"
},
"phrase": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "A single keyword to be added or removed"
},
"AddRemoveKeywordsModel": {
"type": "object",
"properties": {
"keywords": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddRemoveKeywordModel"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "Data model containing keywords to be added or removed from a line item"
},
"AddRemoveKeywordsModelRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AddRemoveKeywordsModelResource"
}
},
"additionalProperties": false,
"description": "Request object to add or remove keywords from a line item"
},
"AddRemoveKeywordsModelResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AddRemoveKeywordsModel"
},
"id": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Resource object containing keywords to be added or removed from a line item"
},
"AddToBasketIdsUpdateModel202110": {
"type": "object",
"properties": {
"categoryIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Category ids that add to basket should target"
},
"productIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Product ids that add to basket should target"
}
},
"description": "Update model for updating add to basket target ids"
},
"AddToBasketIdsUpdateModel202110Request": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueTypeResourceOfAddToBasketIdsUpdateModel202110"
}
},
"description": "Data model for a value type input resource"
},
"AddToBasketTarget202110": {
"required": [
"scope"
],
"type": "object",
"properties": {
"categoryIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Category ids that add to basket should target"
},
"productIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Product ids that add to basket should target"
},
"scope": {
"enum": [
"unknown",
"include",
"exclude"
],
"type": "string",
"description": "Scope of the add to basket target"
}
},
"description": "Identifies add to basket targeting for a line item"
},
"AddToBasketTarget202110Request": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueTypeResourceOfAddToBasketTarget202110"
}
},
"description": "Data model for a value type input resource"
},
"AddToBasketTarget202110Response": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueTypeResourceOfAddToBasketTarget202110"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
}
},
"description": "Data model for a value type resource outcome"
},
"ApplicationSummaryModel": {
"type": "object",
"properties": {
"applicationId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"criteoService": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"organizationId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"description": "Used for the /me endpoint. Contains information about the currently authenticated application that we accept to give to our clients",
"nullable": true
},
"ApplicationSummaryModelResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ApplicationSummaryModel"
},
"type": {
"type": "string",
"nullable": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value",
"nullable": true
},
"ApplicationSummaryModelResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ApplicationSummaryModelResource"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"Asset": {
"required": [
"fileExtension"
],
"type": "object",
"properties": {
"fileExtension": {
"type": "string",
"description": "The file extension that is asset is representing. Example: jpg, png, gif or pdf."
},
"fileLocation": {
"type": "string",
"description": "A url pointing towards the static file the asset represents.",
"nullable": true
}
},
"description": "Handles pointing towards binary content that advertisers can use later on, for example in their creatives.",
"nullable": true,
"x-criteo-canonical": {
"infoType": "entity",
"name": "RetailMediaAsset",
"version": "202110"
}
},
"AssetResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Asset"
},
"id": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"description": "A class that represents a domain entity exposed by an API",
"nullable": true
},
"AssetResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AssetResource"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single entity"
},
"AsyncAttributedTransactionsReport": {
"required": [
"dimensions",
"endDate",
"filters",
"metrics",
"startDate"
],
"type": "object",
"properties": {
"clickAttributionWindow": {
"enum": [
"none",
"7D",
"14D",
"30D"
],
"type": "string"
},
"clickMatchLevel": {
"enum": [
"sameSku",
"sameCategory",
"sameBrand",
"campaign"
],
"type": "string",
"default": "campaign"
},
"dimensions": {
"type": "array",
"items": {
"enum": [
"purchasedDate",
"purchasedHour",
"advertisedDate",
"advertisedHour",
"daysDifference",
"campaignId",
"campaignName",
"lineItemId",
"lineItemName",
"advertisedProductId",
"advertisedProductGtin",
"advertisedProductMpn",
"advertisedProductName",
"advertisedProductCategory",
"purchasedProductId",
"purchasedProductGtin",
"purchasedProductMpn",
"purchasedProductName",
"purchasedProductCategory",
"advertisedEngagement",
"advertisedToPurchasedProductRelationship",
"salesChannel",
"retailerId",
"retailerName",
"pageType",
"keyword",
"attributionWindow",
"saleSellerId",
"saleSellerName",
"activitySellerId",
"activitySellerName"
],
"type": "string"
}
},
"endDate": {
"type": "string",
"format": "date-time"
},
"filters": {
"$ref": "#/components/schemas/AttributedTransactionsReportFilters"
},
"format": {
"enum": [
"json",
"json-compact",
"json-newline",
"csv"
],
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"enum": [
"attributedUnits",
"attributedSales"
],
"type": "string"
}
},
"startDate": {
"type": "string",
"format": "date-time"
},
"timezone": {
"type": "string",
"default": "UTC"
},
"viewAttributionWindow": {
"enum": [
"none",
"1D",
"7D",
"14D",
"30D"
],
"type": "string"
},
"viewMatchLevel": {
"enum": [
"sameSku",
"sameCategory",
"sameBrand",
"campaign"
],
"type": "string",
"default": "campaign"
}
},
"description": "Create payload attributes for an attributed-transactions async report."
},
"AsyncAttributedTransactionsReportRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AsyncAttributedTransactionsReportResource"
}
},
"description": "A top-level object that encapsulates an attributed-transactions async report create request."
},
"AsyncAttributedTransactionsReportResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AsyncAttributedTransactionsReport"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"AsyncFillRateReport": {
"required": [
"dimensions",
"endDate",
"metrics",
"startDate",
"supplyAccountIds"
],
"type": "object",
"properties": {
"adServerType": {
"enum": [
"all",
"gam",
"criteo"
],
"type": "string",
"description": "Filter on the type of the ad server: criteo, gam, all",
"default": "all"
},
"dimensions": {
"minItems": 1,
"type": "array",
"items": {
"enum": [
"date",
"retailerId",
"retailerName",
"placementId",
"placementName",
"pageTypeName",
"environment",
"servedCategory",
"retailerCategoryId",
"retailerCategoryName",
"adServerType"
],
"type": "string"
},
"description": "List of dimensions to report on"
},
"endDate": {
"type": "string",
"description": "End date",
"format": "date-time"
},
"format": {
"enum": [
"json",
"json-compact",
"json-newline",
"csv"
],
"type": "string",
"description": "Format of the output",
"default": "json"
},
"metrics": {
"minItems": 1,
"type": "array",
"items": {
"enum": [
"pageViews",
"availablePlacements",
"unfilledPlacements",
"fillRate",
"placementImpressions",
"productImpressions",
"impressions",
"placementClicks",
"productClicks",
"clicks",
"placementImpressionsCTR",
"productImpressionsCTR",
"cpm",
"cpc",
"placementImpressionsRevenue",
"productClicksRevenue",
"revenue",
"workingMedia",
"netRevenue",
"nonDeliverablePlacements",
"deliverablePlacements",
"placementsWithCandidates",
"coveredPlacements",
"coverageRate"
],
"type": "string"
},
"description": "List of metrics to report on"
},
"startDate": {
"type": "string",
"description": "Start date",
"format": "date-time"
},
"supplyAccountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Supply account ids to report on"
},
"timezone": {
"type": "string",
"description": "Time zone : see criteo developer portal for supported time zones",
"default": "UTC"
}
},
"description": "Async FillRate report body request"
},
"AsyncFillRateReportRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AsyncFillRateReportResource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value"
},
"AsyncFillRateReportResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AsyncFillRateReport"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"AsyncMissedOpportunitiesReport": {
"required": [
"dimensions",
"endDate",
"filters",
"metrics",
"startDate"
],
"type": "object",
"properties": {
"dimensions": {
"type": "array",
"items": {
"enum": [
"date",
"campaignId",
"campaignName",
"lineItemId",
"lineItemName",
"retailerId",
"retailerName",
"buyType",
"bidStrategy"
],
"type": "string"
}
},
"endDate": {
"type": "string",
"format": "date-time"
},
"filters": {
"$ref": "#/components/schemas/MissedOpportunitiesReportFilters"
},
"format": {
"enum": [
"json",
"json-compact",
"json-newline",
"csv"
],
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"enum": [
"daypartingScheduled",
"totalSpend",
"roas",
"capoutHour",
"attributedSales",
"impressions",
"clicks",
"cpc",
"cpm",
"ctr",
"missedTraffic",
"missedSpend",
"missedClicks",
"missedImpressions",
"missedSales"
],
"type": "string"
}
},
"startDate": {
"type": "string",
"format": "date-time"
}
},
"description": "Create payload attributes for a missed-opportunities async report."
},
"AsyncMissedOpportunitiesReportRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AsyncMissedOpportunitiesReportResource"
}
},
"description": "A top-level object that encapsulates a missed-opportunities async report create request."
},
"AsyncMissedOpportunitiesReportResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AsyncMissedOpportunitiesReport"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"AsyncPerformanceReport": {
"required": [
"dimensions",
"endDate",
"filters",
"metrics",
"startDate"
],
"type": "object",
"properties": {
"clickAttributionWindow": {
"enum": [
"none",
"7D",
"14D",
"30D"
],
"type": "string"
},
"clickMatchLevel": {
"enum": [
"sameSku",
"sameCategory",
"sameBrand",
"campaign"
],
"type": "string",
"default": "campaign"
},
"dimensions": {
"type": "array",
"items": {
"enum": [
"date",
"hour",
"accountId",
"accountName",
"campaignId",
"campaignName",
"campaignType",
"lineItemId",
"lineItemName",
"retailerId",
"retailerName",
"brandId",
"brandName",
"productCategory",
"productId",
"productName",
"salesChannel",
"mediaType",
"buyType",
"budgetModel",
"activationPlatform",
"environment",
"pageType",
"pageCategory",
"servedCategory",
"taxonomyBreadcrumb",
"keyword",
"searchTerm",
"searchTermType",
"searchTermTargeting",
"creativeId",
"creativeName",
"creativeType",
"creativeTemplateId",
"creativeTemplateName",
"targetedKeywordType"
],
"type": "string"
}
},
"endDate": {
"type": "string",
"format": "date-time"
},
"filters": {
"$ref": "#/components/schemas/PerformanceReportFilters"
},
"format": {
"enum": [
"json",
"json-compact",
"json-newline",
"csv"
],
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"enum": [
"impressions",
"clicks",
"spend",
"attributedSales",
"attributedUnits",
"attributedOrders",
"assistedSales",
"assistedUnits",
"ctr",
"cpc",
"cpo",
"cpm",
"roas",
"videoViews",
"videosStarted",
"videosPlayedTo25",
"videosPlayedTo50",
"videosPlayedTo75",
"videosPlayedTo100",
"videoPlayingRate",
"videoCompletionRate",
"videoImpressions",
"videoMuted",
"videoUnmuted",
"videoPaused",
"videoResumed",
"videoAvgInteractionRate",
"videoViewability",
"videoStartingRate",
"videoCPC",
"videoCPCV",
"newToBrandAttributedSales",
"newToBrandAttributedSalesRate",
"newToBrandAttributedUnits",
"newToBrandAttributedUnitsRate",
"uniqueVisitors",
"frequency",
"winRate",
"sampledBidsWon",
"sampledBidsParticipated"
],
"type": "string"
}
},
"startDate": {
"type": "string",
"format": "date-time"
},
"timezone": {
"type": "string",
"default": "UTC"
},
"viewAttributionWindow": {
"enum": [
"none",
"1D",
"7D",
"14D",
"30D"
],
"type": "string"
},
"viewMatchLevel": {
"enum": [
"sameSku",
"sameCategory",
"sameBrand",
"campaign"
],
"type": "string",
"default": "campaign"
}
},
"description": "Create payload attributes for a performance DSP analytics async report."
},
"AsyncPerformanceReportRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AsyncPerformanceReportResource"
}
},
"description": "A top-level object that encapsulates a performance DSP analytics async report create request."
},
"AsyncPerformanceReportResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AsyncPerformanceReport"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"AsyncReportResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/StatusResponseResource"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"description": "Async Report response format"
},
"AsyncRevenueReport": {
"required": [
"endDate",
"startDate"
],
"type": "object",
"properties": {
"accountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Account ids to filter"
},
"activationPlatforms": {
"type": "array",
"items": {
"enum": [
"CommerceMax",
"PrivateMarket"
],
"type": "string"
},
"description": "Filter on the activation platform: CommerceMax, PrivateMarket"
},
"advertiserTypes": {
"type": "array",
"items": {
"enum": [
"retailer",
"brand",
"seller"
],
"type": "string"
},
"description": "Filter on the type of advertiser: retailer, brand, seller"
},
"budgetModels": {
"type": "array",
"items": {
"enum": [
"CriteoBudget",
"RetailerBudget"
],
"type": "string"
},
"description": "Filter on the budget model: CriteoBudget, RetailerBudget"
},
"buyType": {
"enum": [
"auction",
"preferredDeals",
"sponsorship"
],
"type": "string",
"description": "Filter on buy type: Auction, Preferred Deals or Sponsorship"
},
"campaignIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Campaign ids to filter"
},
"campaignType": {
"enum": [
"all",
"sponsoredProducts",
"onSiteDisplays"
],
"type": "string",
"description": "Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays",
"default": "all"
},
"clickAttributionWindow": {
"enum": [
"none",
"7D",
"14D",
"30D"
],
"type": "string",
"description": "Click attribution window",
"default": "none"
},
"clickMatchLevel": {
"enum": [
"sameSku",
"sameCategory",
"sameBrand",
"campaign"
],
"type": "string",
"description": "Click Match Level: Campaign, Same SKU, Same Category or Same Brand",
"default": "campaign"
},
"dimensions": {
"type": "array",
"items": {
"enum": [
"date",
"hour",
"parentAccount",
"accountId",
"accountName",
"accountTypeName",
"advertiserType",
"campaignId",
"campaignName",
"campaignTypeName",
"campaignStartDate",
"campaignEndDate",
"lineItemId",
"lineItemName",
"lineItemStartDate",
"lineItemEndDate",
"lineItemStatus",
"retailerId",
"retailerName",
"brandId",
"brandName",
"placementId",
"placementName",
"pageTypeName",
"environment",
"pageCategory",
"advProductId",
"advProductName",
"advProductGtin",
"advProductMpn",
"buyType",
"budgetModel",
"activationPlatform",
"soldBy",
"saleChannel",
"salesChannel",
"mediaType",
"attributionSettings",
"activityType",
"keyword",
"skuRelation",
"retailerCategoryId",
"retailerCategoryName",
"taxonomyBreadcrumb",
"taxonomy1Id",
"taxonomy1Name",
"taxonomy2Id",
"taxonomy2Name",
"taxonomy3Id",
"taxonomy3Name",
"taxonomy4Id",
"taxonomy4Name",
"taxonomy5Id",
"taxonomy5Name",
"taxonomy6Id",
"taxonomy6Name",
"taxonomy7Id",
"taxonomy7Name",
"targetedKeywordType"
],
"type": "string"
},
"description": "List of dimensions to report on"
},
"endDate": {
"type": "string",
"description": "End date",
"format": "date-time"
},
"format": {
"enum": [
"json",
"json-compact",
"json-newline",
"csv"
],
"type": "string",
"description": "Format of the output",
"default": "json"
},
"id": {
"type": "string",
"description": "Supply account id to report on"
},
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Supply account ids to report on"
},
"lineItemIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Line item ids to filter"
},
"mediaType": {
"enum": [
"unknown",
"video",
"display",
"all"
],
"type": "string",
"description": "Filter on the type of media: unknown, display, video",
"default": "all"
},
"metrics": {
"type": "array",
"items": {
"enum": [
"numberOfCampaigns",
"numberOfLineItems",
"numberOfSkus",
"skuPrice",
"pageViews",
"impressions",
"productClicks",
"placementClicks",
"clicks",
"sales",
"units",
"transactions",
"assistedSales",
"assistedUnits",
"revenue",
"openAuctionRevenue",
"preferredDealsRevenue",
"ctr",
"cr",
"cpc",
"cpm",
"roas",
"workingMedia",
"netRevenue",
"videoViews",
"videosStarted",
"videosPlayedTo25",
"videosPlayedTo50",
"videosPlayedTo75",
"videosPlayedTo100",
"videoPlayingRate",
"videoCompletionRate",
"videoImpressions",
"videoMuted",
"videoUnmuted",
"videoResumed",
"videoPaused",
"videoAvgInteractionRate",
"videoViewability",
"videoStartingRate",
"videoCPC",
"videoCPCV",
"uniqueVisitors",
"frequency"
],
"type": "string"
},
"description": "List of metrics to report on"
},
"reportType": {
"enum": [
"advertiser",
"environment",
"pageType",
"productCategory",
"brand"
],
"type": "string",
"description": "Type of report, if no dimensions and metrics are provided, falls back to advertiser reportType"
},
"retailerIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Retailer ids to filter"
},
"revenueType": {
"enum": [
"auction",
"preferred"
],
"type": "string",
"description": "Type of revenue"
},
"salesChannel": {
"enum": [
"online",
"offline",
"all"
],
"type": "string",
"description": "Filter on specific sales channel: offline or online",
"default": "all"
},
"skuRelations": {
"type": "array",
"items": {
"enum": [
"sameSku",
"sameParentSku",
"sameCategory",
"sameBrand",
"sameSeller"
],
"type": "string"
},
"description": "Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller"
},
"soldBy": {
"enum": [
"directSold",
"indirectSold",
"privateMarket",
"authorizedBuyer"
],
"type": "string",
"description": "Filter on the seller: Indirect Sold, Direct Sold, Authorized Buyer or Private Market"
},
"startDate": {
"type": "string",
"description": "Start date",
"format": "date-time"
},
"targetedKeywordTypes": {
"type": "array",
"items": {
"enum": [
"unknown",
"generic",
"branded",
"conquesting"
],
"type": "string"
},
"description": "Filter on targeted keyword type: unknown, generic, branded, conquesting"
},
"timezone": {
"type": "string",
"description": "Time zone : see criteo developer portal for supported time zones",
"default": "UTC"
},
"viewAttributionWindow": {
"enum": [
"none",
"1D",
"7D",
"14D",
"30D"
],
"type": "string",
"description": "View attribution window",
"default": "none"
},
"viewMatchLevel": {
"enum": [
"sameSku",
"sameCategory",
"sameBrand",
"campaign"
],
"type": "string",
"description": "View Match Level: Campaign, Same SKU, Same Category or Same Brand",
"default": "campaign"
}
},
"description": "Async Revenue report body request"
},
"AsyncRevenueReportRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AsyncRevenueReportResource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value"
},
"AsyncRevenueReportResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AsyncRevenueReport"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"AsyncUnfilledPlacementsReport": {
"required": [
"dimensions",
"endDate",
"metrics",
"startDate",
"supplyAccountIds"
],
"type": "object",
"properties": {
"adServerType": {
"enum": [
"all",
"gam",
"criteo"
],
"type": "string",
"description": "Filter on the type of the ad server: criteo, gam, all",
"default": "all"
},
"campaignType": {
"enum": [
"all",
"sponsoredProducts",
"onSiteDisplays"
],
"type": "string",
"description": "Filter on the type of the campaign: onsite display, onsite sponsored products, all",
"default": "all"
},
"dimensions": {
"minItems": 1,
"type": "array",
"items": {
"enum": [
"date",
"retailerId",
"retailerName",
"placementId",
"placementName",
"pageTypeName",
"servedCategory",
"environment",
"retailerCategoryId",
"retailerCategoryName",
"adServerType",
"campaignType"
],
"type": "string"
},
"description": "List of dimensions to report on"
},
"endDate": {
"type": "string",
"description": "End date",
"format": "date-time"
},
"format": {
"enum": [
"json",
"json-compact",
"json-newline",
"csv"
],
"type": "string",
"description": "Format of the output",
"default": "json"
},
"metrics": {
"minItems": 1,
"type": "array",
"items": {
"enum": [
"totalUnfilledPlacements",
"unfilledUserOptOut",
"unfilledNotEnoughDemand",
"unfilledTotalAuctionSettings",
"unfilledTotalAuctionConsiderations",
"unfilledAdvertiserAuctionSettings",
"unfilledRetailerAuctionSettings",
"unfilledCriteoAuctionSettings",
"unfilledReturnedButNotPainted",
"nonDeliverableUnmappedCategories",
"nonDeliverablePagesWithUnknownProducts",
"nonDeliverableBlockedOptOut",
"nonDeliverableBlockedPageCategory",
"nonDeliverableInactivePlacement",
"nonDeliverableInsufficientOrganicResults",
"nonDeliverableInvalidTraffic",
"nonDeliverableTestPlacement",
"uncoveredUnusedFormats",
"uncoveredSearchTermWithoutCategory",
"uncoveredNoDemandBrandedKeywordConquestingEnabled",
"uncoveredNoDemandBrandedKeywordConquestingDisabled",
"uncoveredNoDemandUnbrandedInventory",
"uncoveredNoDemandOptOut",
"uncoveredFilteredOutDemand",
"uncoveredBrokenPlacement",
"uncoveredNotPainted",
"availablePlacements",
"fillRate",
"placementImpressions",
"productImpressions",
"placementClicks",
"productClicks",
"clicks",
"placementImpressionsCTR",
"productImpressionsCTR",
"cpm",
"cpc",
"placementImpressionsRevenue",
"productClicksRevenue",
"revenue",
"nonDeliverablePlacements",
"deliverablePlacements",
"placementsWithCandidates",
"coveredPlacements",
"coverageRate"
],
"type": "string"
},
"description": "List of metrics to report on"
},
"startDate": {
"type": "string",
"description": "Start date",
"format": "date-time"
},
"supplyAccountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Supply account ids to report on"
},
"timezone": {
"type": "string",
"description": "Time zone : see criteo developer portal for supported time zones",
"default": "UTC"
}
},
"description": "Async Unfilled Placements report body request"
},
"AsyncUnfilledPlacementsReportRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AsyncUnfilledPlacementsReportResource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value"
},
"AsyncUnfilledPlacementsReportResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AsyncUnfilledPlacementsReport"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"AttributedTransactionsReportFilters": {
"type": "object",
"properties": {
"accountIds": {
"type": "array",
"items": {
"type": "string"
}
},
"campaignIds": {
"type": "array",
"items": {
"type": "string"
}
},
"lineItemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"mediaTypes": {
"type": "array",
"items": {
"enum": [
"unknown",
"video",
"display",
"all"
],
"type": "string"
}
}
},
"description": "Array-valued constraints for attributed-transactions reporting. At least one of accountIds, campaignIds, or lineItemIds is required."
},
"AudienceError": {
"required": [
"code",
"instance",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "(REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case."
},
"detail": {
"type": "string",
"description": "(RECOMMENDED) A human-readable explanation specific to this occurrence of the problem",
"nullable": true
},
"instance": {
"type": "string",
"description": "(REQUIRED) A URI reference that identifies the specific occurrence of the problem"
},
"source": {
"type": "object",
"description": "(OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s)",
"nullable": true
},
"stackTrace": {
"type": "array",
"items": {
"type": "string"
},
"description": "(NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology",
"nullable": true
},
"title": {
"type": "string",
"description": "(RECOMMENDED) A short, human-readable summary of the problem type",
"nullable": true
},
"traceId": {
"type": "string",
"description": "(REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.",
"nullable": true
},
"type": {
"enum": [
"access-control",
"authentication",
"authorization",
"availability",
"deprecation",
"quota",
"validation"
],
"type": "string",
"description": "(REQUIRED) The classification of the error"
}
},
"description": "Definition of an audience error"
},
"AudienceIdsUpdateModel202110": {
"required": [
"audienceIds"
],
"type": "object",
"properties": {
"audienceIds": {
"type": "array",
"items": {
"type": "string",
"description": "Audience ids that should be targeted",
"format": "long-id"
},
"description": "Audience ids that should be targeted"
}
},
"description": "Update model for updating audience target ids"
},
"AudienceIdsUpdateModel202110Request": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueTypeResourceOfAudienceIdsUpdateModel202110"
}
},
"description": "Data model for a value type input resource"
},
"AudienceTarget202110": {
"required": [
"scope",
"audienceIds"
],
"type": "object",
"properties": {
"audienceIds": {
"type": "array",
"items": {
"type": "string",
"description": "Audience ids that should be targeted",
"format": "long-id"
},
"description": "Audience ids that should be targeted"
},
"scope": {
"enum": [
"unknown",
"include",
"exclude"
],
"type": "string",
"description": "Scope of the audience target"
}
},
"description": "Identifies audience targeting for a line item"
},
"AudienceTarget202110Request": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueTypeResourceOfAudienceTarget202110"
}
},
"description": "Data model for a value type input resource"
},
"AudienceTarget202110Response": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueTypeResourceOfAudienceTarget202110"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
}
},
"description": "Data model for a value type resource outcome"
},
"AudienceWarning": {
"required": [
"code",
"detail",
"instance",
"type"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "(REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case."
},
"detail": {
"type": "string",
"description": "(REQUIRED) A human-readable explanation specific to this occurrence of the problem"
},
"instance": {
"type": "string",
"description": "(REQUIRED) A URI reference that identifies the specific occurrence of the problem"
},
"source": {
"type": "object",
"description": "(OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s)",
"nullable": true
},
"stackTrace": {
"type": "array",
"items": {
"type": "string"
},
"description": "(NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology",
"nullable": true
},
"title": {
"type": "string",
"description": "(RECOMMENDED) A short, human-readable summary of the problem type",
"nullable": true
},
"traceId": {
"type": "string",
"description": "(REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.",
"nullable": true
},
"type": {
"enum": [
"access-control",
"authentication",
"authorization",
"availability",
"deprecation",
"quota",
"validation"
],
"type": "string",
"description": "(REQUIRED) The classification of the error"
}
},
"description": "Definition of the warning"
},
"BalanceCampaign202110": {
"type": "object",
"description": "Campaigns related to the balance"
},
"BalanceCampaign202110ListRequest": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceOfBalanceCampaign202110"
}
}
},
"description": "A top-level object that encapsulates a Criteo API request for several entities"
},
"BalanceCampaign202110PagedListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceOfBalanceCampaign202110"
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
},
"metadata": {
"$ref": "#/components/schemas/PageMetadata"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
}
},
"description": "Data model for a paged list of response resources"
},
"BalanceHistoryChangeDataCaptureV1": {
"required": [
"changeDetails",
"changeType",
"dateOfModification",
"modifiedByUser"
],
"type": "object",
"properties": {
"changeDetails": {
"$ref": "#/components/schemas/ChangeDetailsV1"
},
"changeType": {
"enum": [
"BalanceCreated",
"BalanceAdded",
"BalanceRemoved",
"BalanceUncapped",
"BalanceCapped",
"EndDate",
"StartDate",
"BalanceName",
"PoNumber",
"ValueAdd",
"Unknown"
],
"type": "string",
"description": "Represent the type of change states of the history."
},
"dateOfModification": {
"type": "string",
"description": "Date when data change has occured.",
"format": "date-time"
},
"memo": {
"type": "string",
"description": "Memo associate with the insertion order modification.",
"nullable": true
},
"modifiedByUser": {
"type": "string",
"description": "Username who modified the insertion order."
}
},
"additionalProperties": false,
"description": "Data model represents the data change capture of balance history."
},
"BalanceResponseV2": {
"required": [
"name",
"startDate",
"balanceType",
"spendType",
"privateMarketBillingType"
],
"type": "object",
"properties": {
"balanceType": {
"enum": [
"unknown",
"capped",
"uncapped"
],
"type": "string",
"description": "Type of the balance."
},
"createdAt": {
"type": "string",
"description": "Creation time of the balance.",
"format": "date-time"
},
"deposited": {
"type": "number",
"description": "Amount of billable funds allotted to the balance.",
"format": "double",
"nullable": true
},
"endDate": {
"type": "string",
"description": "End date of the balance in the format YYYY-MM-DD.",
"nullable": true
},
"memo": {
"type": "string",
"description": "Memo.",
"nullable": true
},
"name": {
"type": "string",
"description": "Name of the balance."
},
"poNumber": {
"type": "string",
"description": "Purchase Order number.",
"nullable": true
},
"privateMarketBillingType": {
"enum": [
"notApplicable",
"billByRetailer",
"billByCriteo",
"unknown"
],
"type": "string",
"description": "Billing type for Private Market of the balance."
},
"remaining": {
"type": "number",
"description": "Amount of remaining funds of the balance.",
"format": "double",
"nullable": true
},
"spendType": {
"enum": [
"Onsite",
"Offsite",
"OffsiteAwareness"
],
"type": "string",
"description": "Spend Type of the balance."
},
"spent": {
"type": "number",
"description": "Amount of spent funds of the balance.",
"format": "double",
"nullable": true
},
"startDate": {
"type": "string",
"description": "Start date of the balance in the format YYYY-MM-DD."
},
"status": {
"enum": [
"unknown",
"scheduled",
"active",
"ended"
],
"type": "string",
"description": "Status of the balance."
},
"updatedAt": {
"type": "string",
"description": "Update time of the balance.",
"format": "date-time"
}
},
"description": "A Retail Media Balance used to determine the funds available for any or all campaigns in an account",
"nullable": true
},
"BalanceResponseV2PagedListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceOfBalanceResponseV2"
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
},
"metadata": {
"$ref": "#/components/schemas/PageMetadata"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
}
},
"description": "Data model for a paged list of response resources"
},
"BalanceResponseV2Response": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ResourceOfBalanceResponseV2"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single entity",
"nullable": true
},
"BatchStoreInventoryDeleteRequest": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeleteEntry"
}
}
},
"description": "Batch to plan removals in Store inventory"
},
"BatchStoreInventoryRequest": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InsertEntry"
}
}
},
"description": "Batch to be stored in Store inventories"
},
"BrandCatalogRequestV2": {
"type": "object",
"properties": {
"brandIdFilter": {
"type": "array",
"items": {
"type": "string",
"description": "The brand ids to filter the catalog by.",
"format": "long-id"
},
"description": "The brand ids to filter the catalog by.",
"nullable": true
},
"includeFields": {
"type": "array",
"items": {
"enum": [
"Unknown",
"Description",
"ImageUrl",
"GoogleCategory",
"RetailerName",
"Category",
"BrandName"
],
"type": "string"
},
"description": "Out of the optional fields, only the ones specified will be included in the catalog generated.",
"nullable": true
},
"modifiedAfter": {
"type": "string",
"description": "Only products modified after this time will be returned.",
"format": "date-time",
"nullable": true
},
"retailerIdFilter": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "The retailer ids to filter the catalog by.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request for a catalog under the specified format."
},
"BrandIdSearchRequest": {
"required": [
"retailerIds"
],
"type": "object",
"properties": {
"brandType": {
"enum": [
"uc",
"retailer",
"all"
],
"type": "string",
"description": "The type of brand, primarily where this brand belongs: UC, Retailer or All (both)"
},
"name": {
"type": "string",
"description": "The name of the brand(s) to be searched",
"nullable": true
},
"retailerIds": {
"minItems": 1,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "IDs of the retailers we want to limit the search to"
}
},
"description": "An object that represents the request of BrandIdSearch endpoint."
},
"BrandIdSearchResult": {
"required": [
"brandType",
"id",
"name",
"retailerIds"
],
"type": "object",
"properties": {
"brandType": {
"type": "string",
"description": "The type of the brand"
},
"id": {
"type": "string",
"description": "The brand id"
},
"name": {
"type": "string",
"description": "The name of the brand"
},
"retailerIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "The retailer ids associated to the brand"
}
},
"description": "An object that represents the result from a brand ID search.",
"nullable": true
},
"CampaignAttributesV202301": {
"required": [
"name",
"isAutoDailyPacing"
],
"type": "object",
"properties": {
"budget": {
"type": "number",
"format": "double",
"nullable": true
},
"clickAttributionScope": {
"enum": [
"unknown",
"sameSku",
"sameSkuCategory",
"sameSkuCategoryBrand"
],
"type": "string",
"nullable": true
},
"clickAttributionWindow": {
"enum": [
"7D",
"14D",
"30D",
"unknown"
],
"type": "string",
"default": "30D"
},
"companyName": {
"type": "string",
"nullable": true
},
"dailyPacing": {
"type": "number",
"format": "double",
"nullable": true
},
"drawableBalanceIds": {
"type": "array",
"items": {
"type": "string",
"format": "long-id"
}
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isAutoDailyPacing": {
"type": "boolean"
},
"monthlyPacing": {
"type": "number",
"format": "double",
"nullable": true
},
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"onBehalfCompanyName": {
"type": "string",
"nullable": true
},
"retailerId": {
"type": "integer",
"format": "int32"
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"type": {
"enum": [
"unknown",
"auction",
"preferred"
],
"type": "string",
"default": "auction"
},
"viewAttributionScope": {
"enum": [
"unknown",
"sameSku",
"sameSkuCategory",
"sameSkuCategoryBrand"
],
"type": "string",
"nullable": true
},
"viewAttributionWindow": {
"enum": [
"none",
"1D",
"7D",
"14D",
"30D",
"unknown"
],
"type": "string",
"default": "none"
}
},
"description": "An object that represents the available options to set when creating a Retail Media Campaign"
},
"CampaignAvailabilityV2": {
"type": "object",
"properties": {
"budgetModelAvailabilities": {
"type": "array",
"items": {
"enum": [
"unknown",
"criteoBudget",
"retailerBudget"
],
"type": "string",
"description": "Possible budget models for retail media campaigns"
},
"description": "The budget models available for this campaign type and buy type combination. Presence of a value indicates that budget model is available.",
"nullable": true
},
"buyType": {
"enum": [
"unknown",
"auction",
"preferredDeals",
"sponsorship",
"offsite"
],
"type": "string",
"description": "The buy type this object represents availability for",
"nullable": true
},
"campaignType": {
"enum": [
"unknown",
"sponsoredProducts",
"onsiteDisplay",
"offsite"
],
"type": "string",
"description": "The type of campaign this object represents availability for",
"nullable": true
},
"validCombinations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PageTypeCombinationV2"
},
"description": "PageType-PageEnvironmentType pairs which are supported for this campaign-buy type combination",
"nullable": true
}
},
"additionalProperties": false,
"description": "Information about the budget model availability for a specific campaign type and buy type combination, and page types and environments supported for that combination"
},
"CampaignBudgetOverrides": {
"required": [
"dailyBudgetOverrides",
"monthlyBudgetOverrides"
],
"type": "object",
"properties": {
"dailyBudgetOverrides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CampaignDailyBudgetOverride"
},
"description": "Campaign budget override daily part, chronological order restricted."
},
"monthlyBudgetOverrides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CampaignMonthlyBudgetOverride"
},
"description": "Campaign budget override monthly part, chronological order restricted."
}
},
"additionalProperties": false,
"description": "Campaign budget overrides including Monthly and Daily budget overrides.",
"nullable": true
},
"CampaignDailyBudgetOverride": {
"required": [
"duration",
"maxDailySpend"
],
"type": "object",
"properties": {
"duration": {
"type": "string",
"description": "The number of DAYs that the override is active from StartDate, e.g. \"1D\". Must end with 'D' or 'd'."
},
"maxDailySpend": {
"type": "number",
"description": "Daily budget override maximum daily spend amount.",
"format": "double"
},
"startDate": {
"type": "string",
"description": "Daily budget override start date, format \"yyyy-MM-dd\". If it is null, the StartDate would be the following date of the last item in the override sequence.",
"format": "date-time",
"nullable": true
},
"status": {
"enum": [
"Expired",
"Active",
"Upcoming"
],
"type": "string",
"description": "Daily budget override computed status.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Campaign daily budget override."
},
"CampaignMonthlyBudgetOverride": {
"required": [
"duration",
"maxMonthlySpend"
],
"type": "object",
"properties": {
"duration": {
"type": "string",
"description": "The number of MONTHs that the override is active from StartMonth, e.g. \"1M\". Must end with 'M' or 'm'."
},
"maxMonthlySpend": {
"type": "number",
"description": "Monthly budget override maximum monthly spend amount.",
"format": "double"
},
"startMonth": {
"type": "string",
"description": "Monthly budget override start month, format \"yyyy-MM\". If it is null, the StartMonth would be the following month of the last item in the override sequence.",
"format": "date-time",
"nullable": true
},
"status": {
"enum": [
"Expired",
"Active",
"Upcoming"
],
"type": "string",
"description": "Monthly budget override computed status.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Campaign monthly budget override."
},
"CampaignV202301": {
"required": [
"accountId",
"createdAt",
"updatedAt",
"name",
"isAutoDailyPacing"
],
"type": "object",
"properties": {
"accountId": {
"type": "string",
"format": "long-id"
},
"budget": {
"type": "number",
"format": "double",
"nullable": true
},
"budgetRemaining": {
"type": "number",
"format": "double",
"nullable": true
},
"budgetSpent": {
"type": "number",
"format": "double",
"nullable": true
},
"clickAttributionScope": {
"enum": [
"unknown",
"sameSku",
"sameSkuCategory",
"sameSkuCategoryBrand"
],
"type": "string",
"nullable": true
},
"clickAttributionWindow": {
"enum": [
"7D",
"14D",
"30D",
"unknown"
],
"type": "string",
"default": "30D"
},
"companyName": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"dailyPacing": {
"type": "number",
"format": "double",
"nullable": true
},
"drawableBalanceIds": {
"type": "array",
"items": {
"type": "string",
"format": "long-id"
}
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isAutoDailyPacing": {
"type": "boolean"
},
"monthlyPacing": {
"type": "number",
"format": "double",
"nullable": true
},
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"onBehalfCompanyName": {
"type": "string",
"nullable": true
},
"promotedBrandIds": {
"type": "array",
"items": {
"type": "string",
"format": "long-id"
}
},
"retailerId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"enum": [
"unknown",
"active",
"inactive",
"scheduled",
"ended"
],
"type": "string"
},
"type": {
"enum": [
"unknown",
"auction",
"preferred"
],
"type": "string",
"default": "auction"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"viewAttributionScope": {
"enum": [
"unknown",
"sameSku",
"sameSkuCategory",
"sameSkuCategoryBrand"
],
"type": "string",
"nullable": true
},
"viewAttributionWindow": {
"enum": [
"none",
"1D",
"7D",
"14D",
"30D",
"unknown"
],
"type": "string",
"default": "none"
}
},
"description": "A Retail Media Campaign used to represent an advertiser's marketing objective"
},
"CatalogStatusV2": {
"required": [
"createdAt",
"status"
],
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"description": "The time this catalog was created. Represented as a UTC ISO8601 string.",
"format": "date-time"
},
"fileSizeBytes": {
"type": "integer",
"description": "The size of this catalog in bytes. Available when this catalog reaches a success status.",
"format": "int32",
"nullable": true
},
"md5Checksum": {
"type": "string",
"description": "An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval.\r\nAvailable when this catalog reaches a success status.",
"nullable": true
},
"message": {
"type": "string",
"description": "An optional information message intended for developer consumption.",
"nullable": true
},
"rowCount": {
"type": "integer",
"description": "An indication of the number of products contained in this catalog. Available when\r\nthis catalog reaches a success status.",
"format": "int32",
"nullable": true
},
"status": {
"enum": [
"unknown",
"pending",
"success",
"failure",
"expired"
],
"type": "string",
"description": "An enumeration of the status of the catalog."
}
},
"additionalProperties": false,
"description": "The status of an asynchronous request to generate a catalog",
"nullable": true
},
"CategoriesSearchRequestV1": {
"type": "object",
"properties": {
"categoryIds": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "Categories search category ids criteria.",
"nullable": true
},
"textSubstring": {
"type": "string",
"description": "Categories search text substring criteria.",
"nullable": true
}
},
"description": "An object that represents the request of CategoriesSearch endpoint."
},
"Category202204": {
"required": [
"name",
"parentId",
"text"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Category Name"
},
"parentId": {
"type": "string",
"description": "Category ParentId"
},
"text": {
"type": "string",
"description": "Category Text"
}
},
"additionalProperties": false,
"description": "List of retailer's categories, including the full hierarchy of categories and their parent category ID",
"nullable": true
},
"Category202204ListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceOfCategory202204"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for several entities."
},
"ChangeDatesOfBalanceV2": {
"type": "object",
"properties": {
"endDate": {
"type": "string",
"description": "End date of the balance in the format YYYY-MM-DD."
},
"memo": {
"type": "string",
"description": "Memo."
},
"startDate": {
"type": "string",
"description": "Start date of the balance in the format YYYY-MM-DD."
}
},
"description": "An object that represents the available options to modify schedule of a balance."
},
"ChangeDatesOfBalanceV2Request": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ResourceOfChangeDatesOfBalanceV2"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single entity"
},
"ChangeDetailsV1": {
"type": "object",
"properties": {
"changeValue": {
"type": "string",
"description": "Change detail of a property of the insertion order.",
"nullable": true
},
"currentValue": {
"type": "string",
"description": "Current value of a property of the insertion order.",
"nullable": true
},
"previousValue": {
"type": "string",
"description": "Previous value of a property of the insertion order.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Change details of a property of the balance."
},
"ChoiceOption": {
"required": [
"dependentVariables",
"id"
],
"type": "object",
"properties": {
"dependentVariables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateVariable"
},
"description": "Template variables unblocked when the option is chosen"
},
"id": {
"type": "string",
"description": "The id of the option"
}
},
"additionalProperties": false,
"description": "An option given in a choice"
},
"ChoiceVariableSpecification": {
"required": [
"options"
],
"type": "object",
"properties": {
"maxSelected": {
"type": "integer",
"description": "The maximum number of selectable options",
"format": "int32",
"nullable": true
},
"minSelected": {
"type": "integer",
"description": "The minimum number of selectable options",
"format": "int32",
"nullable": true
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChoiceOption"
},
"description": "The available options"
}
},
"additionalProperties": false,
"description": "Specification of choice variable",
"nullable": true
},
"ChoiceVariableValue": {
"required": [
"chosenOptions"
],
"type": "object",
"properties": {
"chosenOptions": {
"type": "array",
"items": {
"type": "string"
},
"description": "The chosen options"
}
},
"additionalProperties": false,
"description": "A value of a template choice variable (among different accepted options)",
"nullable": true
},
"ColorVariableValue": {
"required": [
"color"
],
"type": "object",
"properties": {
"color": {
"pattern": "^#(([0-9a-fA-F]{2}){3}|([0-9a-fA-F]){3})$",
"type": "string",
"description": "The displayed color (HEX format)",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value of a template color variable",
"nullable": true
},
"CommonError": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "(REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case.",
"nullable": true
},
"detail": {
"type": "string",
"description": "(RECOMMENDED) A human-readable explanation specific to this occurrence of the problem.",
"nullable": true
},
"instance": {
"type": "string",
"description": "(REQUIRED) A URI reference that identifies the specific occurrence of the problem.",
"nullable": true
},
"source": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "(OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s)",
"nullable": true
},
"stackTrace": {
"type": "string",
"description": "(NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology",
"nullable": true
},
"title": {
"type": "string",
"description": "(RECOMMENDED) A short, human-readable summary of the problem type.",
"nullable": true
},
"traceId": {
"type": "string",
"description": "(REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.",
"nullable": true
},
"type": {
"enum": [
"unknown",
"access-control",
"authentication",
"authorization",
"availability",
"deprecation",
"quota",
"validation"
],
"type": "string",
"description": "(REQUIRED) The classification of the error.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A JSON:API Common error structure"
},
"CommonLineItem": {
"required": [
"name",
"type",
"startDate",
"targetRetailerId",
"campaignId"
],
"type": "object",
"properties": {
"budget": {
"type": "number",
"format": "double",
"nullable": true
},
"budgetRemaining": {
"type": "number",
"format": "double",
"nullable": true
},
"budgetSpent": {
"type": "number",
"format": "double"
},
"campaignId": {
"type": "string",
"format": "long-id"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD",
"format": "date",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"startDate": {
"type": "string",
"description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD",
"format": "date"
},
"status": {
"enum": [
"unknown",
"active",
"scheduled",
"draft",
"paused",
"budgetHit",
"ended",
"archived",
"noFunds"
],
"type": "string"
},
"targetRetailerId": {
"type": "string",
"format": "long-id"
},
"type": {
"enum": [
"unknown",
"auction",
"preferred"
],
"type": "string"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "A common line item to hold line item information shared between preferred and auction line items"
},
"CommonLineItemPagedListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceOfCommonLineItem"
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
},
"metadata": {
"$ref": "#/components/schemas/PageMetadata"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
}
},
"description": "Data model for a paged list of response resources"
},
"CommonLineItemResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ResourceOfCommonLineItem"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single entity"
},
"CommonProblem": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "A machine-readable error code, expressed as a string value.",
"nullable": true
},
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem",
"nullable": true
},
"instance": {
"type": "string",
"description": "A URI that identifies the specific occurrence of the problem.",
"nullable": true
},
"source": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A machine-readable structure to reference to the exact location(s) causing the error(s)",
"nullable": true
},
"stackTrace": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"description": "A short human-readable description of the problem type",
"nullable": true
},
"traceId": {
"type": "string",
"description": "The request correlation ID this problem comes from.",
"nullable": true
},
"traceIdentifier": {
"type": "string",
"description": "The request correlation ID this problem comes from. (deprecated, use traceId instead)",
"nullable": true
},
"type": {
"enum": [
"unknown",
"access-control",
"authentication",
"authorization",
"availability",
"deprecation",
"quota",
"validation"
],
"type": "string",
"description": "The problem's category.",
"nullable": true
}
},
"description": "Common problem object."
},
"CommonWarning": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "(REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case.",
"nullable": true
},
"detail": {
"type": "string",
"description": "(RECOMMENDED) A human-readable explanation specific to this occurrence of the problem.",
"nullable": true
},
"instance": {
"type": "string",
"description": "(REQUIRED) A URI reference that identifies the specific occurrence of the problem.",
"nullable": true
},
"source": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "(OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s)",
"nullable": true
},
"stackTrace": {
"type": "string",
"description": "(NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology",
"nullable": true
},
"title": {
"type": "string",
"description": "(RECOMMENDED) A short, human-readable summary of the problem type.",
"nullable": true
},
"traceId": {
"type": "string",
"description": "(REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.",
"nullable": true
},
"type": {
"enum": [
"unknown",
"access-control",
"authentication",
"authorization",
"availability",
"deprecation",
"quota",
"validation"
],
"type": "string",
"description": "(REQUIRED) The classification of the error.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A JSON:API Base common warning"
},
"CpcMinBidsRequest": {
"required": [
"skuIds"
],
"type": "object",
"properties": {
"skuIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sku id list for which minimum bid amounts are requested."
}
},
"additionalProperties": false,
"description": "Cpc Min Bids request object."
},
"CpcMinBidsResponse": {
"required": [
"overallMinBid",
"skuMinBids"
],
"type": "object",
"properties": {
"overallMinBid": {
"type": "number",
"description": "Overall minimum bid amount for the given list of sku ids.",
"format": "double"
},
"skuMinBids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SkuMinBid"
},
"description": "Minimum bid amounts for each of the given list of sku ids."
}
},
"additionalProperties": false,
"description": "Cpc Min Bids response object.",
"nullable": true
},
"CreateBalanceV2": {
"required": [
"name",
"startDate",
"spendType"
],
"type": "object",
"properties": {
"deposited": {
"type": "number",
"description": "Amount of billable funds allotted to the balance.",
"format": "double"
},
"endDate": {
"type": "string",
"description": "End date of the balance in the format YYYY-MM-DD.",
"nullable": true
},
"memo": {
"type": "string",
"description": "Memo",
"nullable": true
},
"name": {
"type": "string",
"description": "Name of the balance."
},
"poNumber": {
"type": "string",
"description": "Purchase Order number.",
"nullable": true
},
"spendType": {
"enum": [
"Onsite",
"Offsite",
"OffsiteAwareness"
],
"type": "string",
"description": "Type of the balance spend."
},
"startDate": {
"type": "string",
"description": "Start date of the balance in the format YYYY-MM-DD."
}
},
"description": "An object that represents the available options to set when creating a Retail Media Balance"
},
"CreateBalanceV2Request": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ResourceOfCreateBalanceV2"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single entity"
},
"Creative2": {
"required": [
"creativeFormatV2Type",
"environments",
"formatId",
"name",
"retailerId",
"status",
"templateId",
"templateName",
"templateVariableValues"
],
"type": "object",
"properties": {
"associatedLineItemIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associated Line Item Ids",
"nullable": true
},
"brandId": {
"type": "integer",
"description": "Brand Id",
"format": "int64",
"nullable": true
},
"creativeFormatV2Type": {
"enum": [
"Unknown",
"FlagShip",
"Showcase",
"SponsoredProducts",
"Butterfly",
"BundleBoost",
"IAB",
"Custom",
"DisplayPanel",
"DigitalShelfTalker"
],
"type": "string",
"description": "Creative format type"
},
"environments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PageTypeEnvironment2"
},
"description": "Environment type (e.g. mobile, web, app)"
},
"formatId": {
"type": "integer",
"description": "Format Id",
"format": "int32"
},
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"description": "Name"
},
"retailerId": {
"type": "integer",
"description": "Retailer Id",
"format": "int32"
},
"status": {
"enum": [
"Ready",
"InUse",
"Archived",
"Deleted"
],
"type": "string",
"description": "Creative Status"
},
"templateId": {
"type": "integer",
"description": "Template Id",
"format": "int32"
},
"templateName": {
"type": "string",
"description": "Template Name"
},
"templateVariableValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateVariableValue"
},
"description": "The template chosen values"
},
"updatedAt": {
"type": "string",
"description": "Updated at time",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "A creative entity",
"nullable": true
},
"Creative202110": {
"required": [
"name",
"retailerId",
"status"
],
"type": "object",
"properties": {
"associatedLineItemIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"brandId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string"
},
"retailerId": {
"type": "integer",
"format": "int32"
},
"status": {
"enum": [
"Ready",
"In_Use",
"Archived",
"Deleted"
],
"type": "string"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Metadata and usage info of a preferred deals creative",
"nullable": true
},
"Creative202110ListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceOfCreative202110"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for several entities."
},
"Creative202210": {
"required": [
"creativeFormatType",
"environments",
"formatId",
"name",
"retailerId",
"status",
"templateId",
"templateName",
"templateVariableValues"
],
"type": "object",
"properties": {
"associatedLineItemIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Associated Line Item Ids",
"nullable": true
},
"brandId": {
"type": "integer",
"description": "Brand Id",
"format": "int64",
"nullable": true
},
"creativeFormatType": {
"enum": [
"Unknown",
"FlagShip",
"Showcase",
"SponsoredProducts",
"Butterfly",
"BundleBoost",
"IAB",
"CUSTOM",
"DisplayPanel",
"DigitalShelfTalker"
],
"type": "string",
"description": "Creative format type"
},
"environments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PageTypeEnvironment202210"
},
"description": "Environment type (e.g. mobile, web, app)"
},
"formatId": {
"type": "integer",
"description": "Format Id",
"format": "int32"
},
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"description": "Name"
},
"retailerId": {
"type": "integer",
"description": "Retailer Id",
"format": "int32"
},
"status": {
"enum": [
"Ready",
"In_Use",
"Archived",
"Deleted"
],
"type": "string",
"description": "Creative Status"
},
"templateId": {
"type": "integer",
"description": "Template Id",
"format": "int32"
},
"templateName": {
"type": "string",
"description": "Template Name"
},
"templateVariableValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateVariableValue"
},
"description": "The template chosen values"
},
"updatedAt": {
"type": "string",
"description": "Updated at time",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "A creative entity",
"nullable": true
},
"Creative202210Response": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ResourceOfCreative202210"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for a single entity."
},
"Creative2ListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceOfCreative2"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for several entities."
},
"Creative2Response": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ResourceOfCreative2"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for a single entity."
},
"CreativeCreateModel202207": {
"required": [
"name",
"retailerId",
"templateId",
"templateVariableValues"
],
"type": "object",
"properties": {
"brandId": {
"type": "integer",
"description": "The brand associated to the creative",
"format": "int64",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the creative"
},
"retailerId": {
"type": "integer",
"description": "The retailer associated to the creative",
"format": "int32"
},
"templateId": {
"type": "integer",
"description": "The creative template used for this creative",
"format": "int32"
},
"templateVariableValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateVariableValue"
},
"description": "The template chosen values"
}
},
"additionalProperties": false,
"description": "Create model of a creative"
},
"CreativeUpdateModel202207": {
"required": [
"name",
"retailerId",
"templateId",
"templateVariableValues"
],
"type": "object",
"properties": {
"brandId": {
"type": "integer",
"description": "The brand associated to the creative",
"format": "int64"
},
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the creative"
},
"retailerId": {
"type": "integer",
"description": "The retailer associated to the creative",
"format": "int32"
},
"templateId": {
"type": "integer",
"description": "The creative template used for this creative",
"format": "int32"
},
"templateVariableValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateVariableValue"
},
"description": "The template chosen values"
}
},
"additionalProperties": false,
"description": "Update model of a creative"
},
"DailyLineItemBudgetOverride": {
"required": [
"duration"
],
"type": "object",
"properties": {
"duration": {
"type": "string",
"description": "The number of DAYs that the override is active from StartDate, e.g. \"1D\". Must end with 'D' or 'd'."
},
"maxDailySpend": {
"type": "number",
"description": "Daily budget override maximum daily spend amount.",
"format": "double",
"nullable": true
},
"startDate": {
"type": "string",
"description": "Daily budget override start date, format \"yyyy-MM-dd\". If it is null, the StartDate would be the following date of the last item in the override sequence.",
"format": "date-time",
"nullable": true
},
"status": {
"enum": [
"Expired",
"Active",
"Upcoming"
],
"type": "string",
"description": "Daily budget override computed status.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The details for a daily budget override"
},
"DataCompleteThrough": {
"type": "object",
"properties": {
"dateTime": {
"type": "string",
"description": "The instant through which data is complete, in the format \"yyyy-MM-dd HH:mm:ss\" in the timezone given by the {timezone} field.",
"nullable": true
},
"timezone": {
"type": "string",
"description": "IANA timezone for the {dateTime} field (e.g. \"UTC\", \"America/New_York\"). Matches the query timezone.",
"nullable": true
}
},
"description": "Data freshness: the instant through which report data is complete, expressed in the report's request timezone.",
"nullable": true
},
"DeleteEntry": {
"required": [
"attributes",
"type"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/StoreInventoryDelete"
},
"type": {
"enum": [
"Delete"
],
"type": "string"
}
},
"description": "Defines a reference to inventory"
},
"DemandManagedFee": {
"required": [
"rate"
],
"type": "object",
"properties": {
"rate": {
"maximum": 1,
"minimum": 0,
"type": "number",
"description": "decimal fee rate between 0 and 1",
"format": "double"
}
},
"additionalProperties": false,
"description": "settings for DSP fees",
"nullable": true
},
"EditableCampaignAttributesV202301": {
"required": [
"name",
"isAutoDailyPacing",
"clickAttributionWindow",
"viewAttributionWindow"
],
"type": "object",
"properties": {
"budget": {
"type": "number",
"format": "double",
"nullable": true
},
"clickAttributionScope": {
"enum": [
"unknown",
"sameSku",
"sameSkuCategory",
"sameSkuCategoryBrand"
],
"type": "string",
"nullable": true
},
"clickAttributionWindow": {
"enum": [
"7D",
"14D",
"30D",
"unknown"
],
"type": "string"
},
"companyName": {
"type": "string",
"nullable": true
},
"dailyPacing": {
"type": "number",
"format": "double",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isAutoDailyPacing": {
"type": "boolean"
},
"monthlyPacing": {
"type": "number",
"format": "double",
"nullable": true
},
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"onBehalfCompanyName": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"viewAttributionScope": {
"enum": [
"unknown",
"sameSku",
"sameSkuCategory",
"sameSkuCategoryBrand"
],
"type": "string",
"nullable": true
},
"viewAttributionWindow": {
"enum": [
"none",
"1D",
"7D",
"14D",
"30D",
"unknown"
],
"type": "string"
}
},
"description": "An object that represents the available options to set when editing a Retail Media Campaign"
},
"EntityResourceBrandIdSearchResult": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/BrandIdSearchResult"
},
"id": {
"type": "string",
"description": "Unique id of the entity.",
"nullable": true
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"description": "A domain entity exposed by the API, identified by a unique id."
},
"EntityResourceCategory202204": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Category202204"
},
"id": {
"type": "string",
"description": "Unique id of the entity.",
"nullable": true
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"description": "A domain entity exposed by the API, identified by a unique id."
},
"EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResourceBrandIdSearchResult"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"metadata": {
"$ref": "#/components/schemas/PagingOffsetLimitMetadata"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for several entities and metadata."
},
"EntityResourceCollectionOutcomeCategory202204": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResourceCategory202204"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for several entities."
},
"EntityResourceCollectionOutcomeCategory202204Metadata": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResourceCategory202204"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for several entities and metadata."
},
"EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResourceLineItemKeywordReviewReport"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"meta": {
"$ref": "#/components/schemas/Metadata"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for several entities and metadata."
},
"EntityResourceCollectionOutcomeOfRetailerResultV2AndMetadata": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResourceOfRetailerResultV2"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for several entities and metadata."
},
"EntityResourceCollectionOutcomeOfRetailMediaChildAccountAndMetadata": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResourceOfRetailMediaChildAccount"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for several entities and metadata."
},
"EntityResourceCollectionOutcomeOfSponsoredProductsLineItemAndMetadata": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResourceOfSponsoredProductsLineItem"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for several entities and metadata."
},
"EntityResourceLineItemKeywordReviewReport": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/LineItemKeywordReviewReport"
},
"id": {
"type": "string",
"description": "Unique id of the entity.",
"nullable": true
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A domain entity exposed by the API, identified by a unique id."
},
"EntityResourceOfCatalogStatusV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/CatalogStatusV2"
},
"id": {
"type": "string",
"description": "Unique id of the entity.",
"nullable": true
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A domain entity exposed by the API, identified by a unique id.",
"nullable": true
},
"EntityResourceOfRetailerResultV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RetailerResultV2"
},
"id": {
"type": "string",
"description": "Unique id of the entity.",
"nullable": true
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A domain entity exposed by the API, identified by a unique id."
},
"EntityResourceOfRetailMediaAccount": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ExternalRetailMediaAccount"
},
"id": {
"type": "string",
"description": "Unique id of the entity.",
"nullable": true
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A domain entity exposed by the API, identified by a unique id.",
"nullable": true
},
"EntityResourceOfRetailMediaChildAccount": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ExternalRetailMediaChildAccount"
},
"id": {
"type": "string",
"description": "Unique id of the entity.",
"nullable": true
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A domain entity exposed by the API, identified by a unique id."
},
"EntityResourceOfSponsoredProductsLineItem": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SponsoredProductsLineItem"
},
"id": {
"type": "string",
"description": "Unique id of the entity.",
"nullable": true
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A domain entity exposed by the API, identified by a unique id.",
"nullable": true
},
"EntityResourceOutcomeOfCatalogStatusV2": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EntityResourceOfCatalogStatusV2"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for a single entity."
},
"EntityResourceOutcomeOfRetailMediaAccount": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EntityResourceOfRetailMediaAccount"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for a single entity."
},
"EntityResourceOutcomeOfSponsoredProductsLineItem": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EntityResourceOfSponsoredProductsLineItem"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for a single entity."
},
"EntityResourceOutcomePartnerBillingReportStatusV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EntityResourcePartnerBillingReportStatusV1"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for a single entity."
},
"EntityResourcePartnerBillingReportStatusV1": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/PartnerBillingReportStatusV1"
},
"id": {
"type": "string",
"description": "Unique id of the entity.",
"nullable": true
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A domain entity exposed by the API, identified by a unique id.",
"nullable": true
},
"ExportReportColumn": {
"required": [
"name",
"role",
"type"
],
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Currency of the column",
"nullable": true
},
"deprecated": {
"type": "boolean",
"description": "Flag for deprecated column",
"nullable": true
},
"description": {
"type": "string",
"description": "Description of the exported column",
"nullable": true
},
"duration": {
"type": "string",
"description": "Duration of the column",
"nullable": true
},
"name": {
"type": "string",
"description": "Name of the exported column"
},
"role": {
"enum": [
"Dimension",
"Property",
"Interval",
"Metric"
],
"type": "string",
"description": "Role of the column"
},
"timezone": {
"type": "string",
"description": "Timezone of the column",
"nullable": true
},
"title": {
"type": "string",
"description": "Title of the exported column",
"nullable": true
},
"type": {
"enum": [
"Boolean",
"Number",
"Money",
"String",
"Date",
"DateTime",
"Interval",
"Duration"
],
"type": "string",
"description": "Type of the column"
}
},
"description": "Description of a column from an async report request"
},
"ExportReportMetaData": {
"type": "object",
"properties": {
"columns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExportReportColumn"
},
"nullable": true
},
"dataCompleteThrough": {
"$ref": "#/components/schemas/DataCompleteThrough"
},
"rows": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"description": "Metadata for a report response: data freshness, column descriptions, and row count.",
"nullable": true
},
"ExternalAccount": {
"required": [
"countries",
"currency",
"name",
"parentAccountLabel",
"timeZone",
"type"
],
"type": "object",
"properties": {
"companyName": {
"type": "string",
"nullable": true
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
},
"currency": {
"type": "string"
},
"name": {
"maxLength": 510,
"minLength": 0,
"type": "string"
},
"onBehalfCompanyName": {
"type": "string",
"nullable": true
},
"parentAccountLabel": {
"maxLength": 510,
"minLength": 0,
"type": "string"
},
"subtype": {
"enum": [
"unknown",
"brand",
"seller"
],
"type": "string",
"nullable": true
},
"timeZone": {
"type": "string"
},
"type": {
"enum": [
"unknown",
"supply",
"demand"
],
"type": "string"
}
},
"additionalProperties": false,
"description": "A Retail Media Account used to launch campaigns and line items",
"nullable": true
},
"ExternalBrand": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"maxLength": 120,
"minLength": 0,
"type": "string"
}
},
"additionalProperties": false,
"description": "A Retail Media Brand used to represent a collection of products sold under the same umbrella name",
"nullable": true
},
"ExternalCatalogRequest": {
"type": "object",
"properties": {
"brandIdFilter": {
"type": "array",
"items": {
"type": "string",
"format": "long-id"
},
"nullable": true
},
"format": {
"enum": [
"unknown",
"json-newline"
],
"type": "string",
"description": "An enumeration of Catalog formats",
"default": "json-newline"
}
},
"additionalProperties": false,
"description": "A request for a catalog under the specified format. Currently \"json-newline\" is supported."
},
"ExternalCatalogStatus": {
"required": [
"createdAt",
"currency",
"fileSizeBytes",
"md5Checksum",
"message",
"rowCount",
"status"
],
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"description": "The time this catalog was created. Represented as a UTC ISO8601 string.",
"format": "date-time"
},
"currency": {
"type": "string",
"description": "An ISO4217 representation of the currency products are listed under in this catalog.",
"nullable": true
},
"fileSizeBytes": {
"type": "integer",
"description": "The size of this catalog in bytes. Available when this catalog reaches a success status.",
"format": "int32",
"nullable": true
},
"md5Checksum": {
"type": "string",
"description": "An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval.\r\nAvailable when this catalog reaches a success status.",
"nullable": true
},
"message": {
"type": "string",
"description": "An optional information message intended for developer consumption.",
"nullable": true
},
"rowCount": {
"type": "integer",
"description": "An indication of the number of products contained in this catalog. Available when\r\nthis catalog reaches a success status.",
"format": "int32",
"nullable": true
},
"status": {
"enum": [
"unknown",
"pending",
"success",
"failure",
"expired"
],
"type": "string",
"description": "An enumeration of the status of the catalog."
}
},
"additionalProperties": false,
"description": "The status of an asynchronous request to generate a catalog",
"nullable": true
},
"ExternalRetailMediaAccount": {
"type": "object",
"properties": {
"companyName": {
"type": "string",
"description": "Paying entity name of ads for the Digital Services Act",
"nullable": true
},
"countryIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "list of countries associated with the account",
"nullable": true
},
"currencyId": {
"type": "string",
"description": "the currency for the account",
"nullable": true
},
"name": {
"type": "string",
"description": "account name",
"nullable": true
},
"onBehalfCompanyName": {
"type": "string",
"description": "On behalf entity name of ads for the Digital Services Act",
"nullable": true
},
"parentAccountLabel": {
"type": "string",
"description": "parent account label for the account",
"nullable": true
},
"subType": {
"enum": [
"Unknown",
"Brand",
"Seller"
],
"type": "string",
"description": "subtype for the account",
"nullable": true
},
"timeZone": {
"type": "string",
"description": "the timezone for the account",
"nullable": true
},
"type": {
"enum": [
"Unknown",
"Supply",
"Demand"
],
"type": "string",
"description": "Type for the account",
"nullable": true
}
},
"additionalProperties": false,
"description": "The details for a newly created account",
"nullable": true
},
"ExternalRetailMediaBrandAccountCreation": {
"type": "object",
"properties": {
"brands": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "list of brands to link to the new account",
"nullable": true
},
"companyName": {
"type": "string",
"description": "Display name for reporting the owning entity of ads for the Digital Services Act in the European Union",
"nullable": true
},
"name": {
"type": "string",
"description": "the name of the account, must be unique across all accounts",
"nullable": true
},
"onBehalfCompanyName": {
"type": "string",
"description": "On behalf entity name of ads for the Digital Services Act",
"nullable": true
}
},
"additionalProperties": false,
"description": "the initial set up and configuration options for a new private market demand brand account"
},
"ExternalRetailMediaBrands": {
"required": [
"brandIds"
],
"type": "object",
"properties": {
"brandIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"additionalProperties": false,
"description": "A collection of brand ids",
"nullable": true
},
"ExternalRetailMediaChildAccount": {
"type": "object",
"properties": {
"companyName": {
"type": "string",
"description": "Paying entity name of ads for the Digital Services Act",
"nullable": true
},
"countryIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "list of countries associated with the account",
"nullable": true
},
"currencyId": {
"type": "string",
"description": "the currency for the account",
"nullable": true
},
"name": {
"type": "string",
"description": "account name",
"nullable": true
},
"onBehalfCompanyName": {
"type": "string",
"description": "On behalf entity name of ads for the Digital Services Act",
"nullable": true
},
"subType": {
"enum": [
"Unknown",
"Brand",
"Seller"
],
"type": "string",
"description": "subtype for the account",
"nullable": true
},
"timeZone": {
"type": "string",
"description": "the timezone for the account",
"nullable": true
},
"type": {
"enum": [
"Unknown",
"Supply",
"Demand"
],
"type": "string",
"description": "Type for the account",
"nullable": true
}
},
"additionalProperties": false,
"description": "The details for a newly created account",
"nullable": true
},
"ExternalRetailMediaSeller": {
"required": [
"retailerId",
"sellerId"
],
"type": "object",
"properties": {
"retailerId": {
"type": "integer",
"description": "the retailer id",
"format": "int32"
},
"sellerId": {
"type": "string",
"description": "the seller id"
}
},
"additionalProperties": false,
"description": "used to define the exact seller linked with an account",
"nullable": true
},
"ExternalRetailMediaSellerAccountCreation": {
"required": [
"sellers"
],
"type": "object",
"properties": {
"companyName": {
"type": "string",
"description": "Display name for reporting the owning entity of ads for the Digital Services Act in the European Union",
"nullable": true
},
"name": {
"type": "string",
"description": "the name of the account, must be unique across all accounts",
"nullable": true
},
"onBehalfCompanyName": {
"type": "string",
"description": "On behalf entity name of ads for the Digital Services Act",
"nullable": true
},
"sellers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalRetailMediaSeller"
},
"description": "list of sellers to associate to the new account"
}
},
"additionalProperties": false,
"description": "the initial set up and configuration options for a new private market demand brand account"
},
"FilesVariablesSpecification": {
"required": [
"extensions"
],
"type": "object",
"properties": {
"extensions": {
"type": "array",
"items": {
"enum": [
"Unknown",
"Jpeg",
"Png",
"Gif",
"Pdf",
"Mp4"
],
"type": "string",
"description": "File extensions supported in templates"
},
"description": "The accepted file extensions"
},
"maxBytes": {
"type": "integer",
"description": "The maximum amount of bytes per file",
"format": "int32",
"nullable": true
},
"maxFile": {
"type": "integer",
"description": "The maximum amount of files required",
"format": "int32",
"nullable": true
},
"minFiles": {
"type": "integer",
"description": "The minimum amount of files requires",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Specification of a file variable",
"nullable": true
},
"FilesVariableValue": {
"required": [
"assetIds"
],
"type": "object",
"properties": {
"assetIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The assets representing the images to be displayed"
}
},
"additionalProperties": false,
"description": "A value of a template file variable (one or several files), like images in a creative",
"nullable": true
},
"FlightLeg": {
"required": [
"dayOfWeek",
"endTime",
"startTime"
],
"type": "object",
"properties": {
"dayOfWeek": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"everyday",
"weekdays",
"weekends"
],
"type": "string",
"description": "Enum for the days of the week."
},
"endTime": {
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$",
"type": "string",
"description": "Wall-clock time of day in HH:mm, 24-hour. No timezone."
},
"startTime": {
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$",
"type": "string",
"description": "Wall-clock time of day in HH:mm, 24-hour. No timezone."
}
},
"additionalProperties": false,
"description": "A leg of a flight schedule outlining which days and times the line item will run."
},
"FlightSchedule": {
"type": "object",
"properties": {
"legs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlightLeg"
},
"description": "A list of flight legs on which the line item will run.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A flight schedule for a line item.",
"nullable": true
},
"GrantConsentInput": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GrantConsentModelValueResource"
}
},
"description": "An object that encapsulates GrantConsentModel"
},
"GrantConsentModel": {
"required": [
"callbackUrl",
"clientId"
],
"type": "object",
"properties": {
"callbackState": {
"type": "string"
},
"callbackUrl": {
"type": "string"
},
"clientId": {
"type": "string"
}
},
"description": "An object that represents the required (ClientId and CallbackUrl) and optional (CallbackState) parameters when granting consents on behalf of a Private Market demand account"
},
"GrantConsentModelValueResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/GrantConsentModel"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"HyperlinkVariableValue": {
"required": [
"url"
],
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The url to redirect to",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value of a template hyperlink variable",
"nullable": true
},
"InputKeywords": {
"type": "object",
"properties": {
"negativeBroad": {
"type": "array",
"items": {
"type": "string"
},
"description": "The collection of supplied negative broad phrased",
"nullable": true
},
"negativeExact": {
"type": "array",
"items": {
"type": "string"
},
"description": "The collection of supplied negative exact phrase",
"nullable": true
},
"positiveExact": {
"type": "array",
"items": {
"type": "string"
},
"description": "The collection of supplied positive exact phrases",
"nullable": true
}
},
"additionalProperties": false,
"description": "Keywords submitted by the user binned by type after some cleanup has been performed"
},
"InputKeywordsModel": {
"type": "object",
"properties": {
"negativeBroad": {
"type": "array",
"items": {
"type": "string"
},
"description": "The collection of supplied negative broad phrases.",
"nullable": true
},
"negativeExact": {
"type": "array",
"items": {
"type": "string"
},
"description": "The collection of supplied negative exact phrases.",
"nullable": true
},
"positiveExact": {
"type": "array",
"items": {
"type": "string"
},
"description": "The collection of supplied positive exact phrases.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The keywords to be added or removed from a line item."
},
"InputResourceOfPreferredLineItemCreateModelV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/PreferredLineItemCreateModelV2"
},
"type": {
"type": "string"
}
},
"description": "Data model for a Resource"
},
"InsertEntry": {
"required": [
"attributes",
"type"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/StoreInventoryUpsert"
},
"type": {
"enum": [
"Upsert"
],
"type": "string"
}
},
"description": "Defines a pack of inventories"
},
"JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301": {
"required": [
"id",
"type"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/EditableCampaignAttributesV202301"
},
"id": {
"type": "string",
"format": "long-id"
},
"type": {
"type": "string"
}
},
"description": "A JSON:API wrapper class to format a with Id, Type, and\r\nAttributes properties"
},
"JsonApiBodyWithIdOfInt64AndAccountAndAccount": {
"required": [
"id",
"type"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ExternalAccount"
},
"id": {
"type": "string",
"format": "long-id"
},
"type": {
"type": "string"
}
},
"additionalProperties": false,
"description": "A JSON:API wrapper class to format a with external Id, Type, and\r\nAttributes properties"
},
"JsonApiBodyWithIdOfInt64AndBrandAndBrand": {
"required": [
"id",
"type"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ExternalBrand"
},
"id": {
"type": "string",
"format": "long-id"
},
"type": {
"type": "string"
}
},
"additionalProperties": false,
"description": "A JSON:API wrapper class to format a with external Id, Type, and\r\nAttributes properties"
},
"JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301": {
"required": [
"id",
"type"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/CampaignV202301"
},
"id": {
"type": "string",
"format": "long-id"
},
"type": {
"type": "string"
}
},
"description": "A JSON:API wrapper class to format a with Id, Type, and\r\nAttributes properties"
},
"JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus": {
"required": [
"id",
"type"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ExternalCatalogStatus"
},
"id": {
"type": "string",
"format": "long-id"
},
"type": {
"type": "string"
}
},
"additionalProperties": false,
"description": "A JSON:API wrapper class to format a with external Id, Type, and\r\nAttributes properties"
},
"JsonApiBodyWithLineItemBidMultipliersV2": {
"required": [
"type"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/LineItemBidMultipliersV2"
},
"type": {
"type": "string"
}
},
"description": "A JSON:API wrapper class to format a with Id, Type, and\r\nAttributes properties"
},
"JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301": {
"required": [
"type"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/CampaignAttributesV202301"
},
"type": {
"type": "string"
}
},
"description": "A JSON:API wrapper class to format a with Type, and\r\nAttributes properties"
},
"JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest": {
"required": [
"type"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ExternalCatalogRequest"
},
"type": {
"type": "string"
}
},
"additionalProperties": false,
"description": "A JSON:API wrapper class to format a with Type, and\r\nAttributes properties"
},
"JsonApiBodyWithoutIdOfSellerCatalogRequestAndSellerCatalogRequest": {
"required": [
"type"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SellerCatalogRequest"
},
"type": {
"type": "string"
}
},
"additionalProperties": false,
"description": "A JSON:API wrapper class to format a with Type, and\r\nAttributes properties"
},
"JsonApiPageResponseOfAccount": {
"required": [
"data",
"metadata"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonApiBodyWithIdOfInt64AndAccountAndAccount"
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonError"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/PageMetadata"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonWarning"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "A wrapper class to return a single page of with metadata"
},
"JsonApiPageResponseOfBrand": {
"required": [
"data",
"metadata"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonApiBodyWithIdOfInt64AndBrandAndBrand"
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonError"
},
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/PageMetadata"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonWarning"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "A wrapper class to return a single page of with metadata"
},
"JsonApiPageResponseOfCampaignV202301": {
"required": [
"metadata",
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301"
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonError"
}
},
"metadata": {
"$ref": "#/components/schemas/PageMetadata"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonWarning"
}
}
},
"description": "A wrapper class to return a single page of with metadata"
},
"JsonApiRequestOfCatalogRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest"
}
},
"additionalProperties": false,
"description": "A JSON:API wrapper class to format a with Type, and Attributes properties"
},
"JsonApiRequestOfSellerCatalogRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JsonApiBodyWithoutIdOfSellerCatalogRequestAndSellerCatalogRequest"
}
},
"additionalProperties": false,
"description": "A JSON:API wrapper class to format a with Type, and Attributes properties"
},
"JsonApiSingleResponseOfCampaignV202301": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonError"
}
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonWarning"
}
}
},
"description": "A JSON:API wrapper class to add one JSON:API within a data property"
},
"JsonApiSingleResponseOfCatalogStatus": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonError"
},
"nullable": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonWarning"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "A JSON:API wrapper class to add one JSON:API within a data property"
},
"JsonApiSingleResponseOfLineItemBidMultipliersV2": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JsonApiBodyWithLineItemBidMultipliersV2"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonError"
},
"nullable": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonWarning"
},
"nullable": true
}
},
"description": "A JSON:API wrapper class to add one JSON:API within a data property"
},
"KeywordDataModel": {
"type": "object",
"properties": {
"bid": {
"type": "number",
"description": "The bid to use when a positive keyword matches the shopper search phrase.",
"format": "double",
"nullable": true
},
"createdAt": {
"type": "string",
"description": "The time at which this keyword was created in UTC.",
"format": "date-time"
},
"inputKeywords": {
"$ref": "#/components/schemas/InputKeywordsModel"
},
"matchType": {
"enum": [
"PositiveExactMatch",
"NegativeExactMatch",
"NegativeBroadMatch"
],
"type": "string",
"description": "The matching algorithm to be used when comparing this keyword with the shopper search phrase."
},
"reviewState": {
"$ref": "#/components/schemas/ReviewStateModel"
},
"updatedAt": {
"type": "string",
"description": "The time at which this keyword was last modified in UTC.",
"format": "date-time"
}
},
"additionalProperties": false,
"description": "A single keyword and associated bid override."
},
"Keywords": {
"type": "object",
"properties": {
"bid": {
"type": "number",
"description": "The bid to use when a positive keyword matches the shopper search phrase",
"format": "double",
"nullable": true
},
"createdAt": {
"type": "string",
"description": "The time at which this keyword was created in UTC",
"format": "date-time"
},
"inputKeywords": {
"$ref": "#/components/schemas/InputKeywords"
},
"matchType": {
"enum": [
"PositiveExactMatch",
"NegativeExactMatch",
"NegativeBroadMatch",
"Unknown"
],
"type": "string",
"description": "The matching algorthim to be use when comparing this keyword with the shopper search phrase"
},
"reviewState": {
"enum": [
"InReview",
"Recommended",
"Approved",
"AutoApproved",
"Rejected",
"AutoRejected",
"Unkown"
],
"type": "string",
"description": "Review status of the keyword"
},
"updatedAt": {
"type": "string",
"description": "The time at which the keyword was last modified in UTC",
"format": "date-time"
}
},
"additionalProperties": false,
"description": "Data associated with a normalized keyword phrase"
},
"KeywordsModel": {
"type": "object",
"properties": {
"keywords": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/KeywordDataModel"
},
"description": "A dictionary of normalized keywords mapped to their properties.",
"nullable": true
},
"rank": {
"type": "array",
"items": {
"type": "string"
},
"description": "The top suggested keywords for products in this line item ranked by popularity score.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The keywords associated with a line item.",
"nullable": true
},
"KeywordsModelResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/KeywordsModel"
},
"id": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Resource object containing keywords associated with a line item.",
"nullable": true
},
"KeywordsModelResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/KeywordsModelResource"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmcaCommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmcaCommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "Response object containing keywords associated with a line item."
},
"LineItemBidMultipliersV2": {
"type": "object",
"properties": {
"category": {
"type": "number",
"description": "Categories Page Type Bid Multiplier",
"format": "double",
"nullable": true
},
"categoryMenu": {
"type": "number",
"description": "CategoryMenu Page Type Bid Multiplier",
"format": "double",
"nullable": true
},
"checkout": {
"type": "number",
"description": "Checkout Page Type Bid Multiplier",
"format": "double",
"nullable": true
},
"confirmation": {
"type": "number",
"description": "Confirmation Page Type Bid Multiplier",
"format": "double",
"nullable": true
},
"deals": {
"type": "number",
"description": "Deals Page Type Bid Multiplier",
"format": "double",
"nullable": true
},
"favorites": {
"type": "number",
"description": "Favorites Page Type Bid Multiplier",
"format": "double",
"nullable": true
},
"home": {
"type": "number",
"description": "Home Page Type Bid Multiplier",
"format": "double",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"merchandising": {
"type": "number",
"description": "Merchandising Page Type Bid Multiplier",
"format": "double",
"nullable": true
},
"productDetail": {
"type": "number",
"description": "ProductDetail Page Type Bid Multiplier",
"format": "double",
"nullable": true
},
"search": {
"type": "number",
"description": "Search Page Type Bid Multiplier",
"format": "double",
"nullable": true
},
"searchBar": {
"type": "number",
"description": "SearchBar Page Type Bid Multiplier",
"format": "double",
"nullable": true
}
},
"description": "The Bid Multiplier Entity of a LineItem",
"nullable": true
},
"LineItemBidMultipliersV2Request": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ResourceOfLineItemBidMultipliersV2"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single entity",
"nullable": true
},
"LineItemBidMultipliersV2Response": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ResourceOfLineItemBidMultipliersV2"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single entity",
"nullable": true
},
"LineItemBudgetOverrides": {
"required": [
"dailyLineItemBudgetOverrides",
"monthlyLineItemBudgetOverrides"
],
"type": "object",
"properties": {
"dailyLineItemBudgetOverrides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DailyLineItemBudgetOverride"
},
"description": "Line item budget override daily part, chronological order restricted."
},
"monthlyLineItemBudgetOverrides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MonthlyLineItemBudegetOverride"
},
"description": "Line item budget override monthly part, chronological order restricted."
}
},
"additionalProperties": false,
"description": "Line item budget overrides including Monthly and Daily budget overrides.",
"nullable": true
},
"LineItemCappingV2": {
"required": [
"type",
"count"
],
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"type": {
"enum": [
"unknown",
"day",
"session"
],
"type": "string",
"description": "Line Item Capping Type Enum"
}
},
"description": "Frequency Capping for a Preferred Line Item",
"nullable": true
},
"LineItemKeywordReviewReport": {
"required": [
"accountId",
"accountName",
"campaignId",
"campaignName",
"countKeywords",
"lineItemId",
"lineItemName",
"retailerId",
"retailerName"
],
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "External ID of the account containing the campaign containing the line item this report is for"
},
"accountName": {
"type": "string",
"description": "Name of the account containing the campaign containing the line item this report is for"
},
"campaignId": {
"type": "string",
"description": "External ID of the campaign containing the line item this report is for"
},
"campaignName": {
"type": "string",
"description": "Name of the campaign containing the line item this report is for"
},
"countKeywords": {
"type": "integer",
"description": "Number of PositiveExactMatch keywords on this line item that are in either \"InReview\" or \"Pending\" state",
"format": "int32"
},
"lineItemId": {
"type": "string",
"description": "External ID of the line item that this report is for"
},
"lineItemName": {
"type": "string",
"description": "Name of the line item that this report is for"
},
"retailerId": {
"type": "string",
"description": "Retailer ID connected to the line item this report is for"
},
"retailerName": {
"type": "string",
"description": "Name of the retailer connected to the line item this report is for"
}
},
"additionalProperties": false,
"description": "Reports on a line item which contains one or more actionable keyword reviews",
"nullable": true
},
"LineItemPageCategoryV2": {
"required": [
"categoryId"
],
"type": "object",
"properties": {
"categoryId": {
"type": "string"
},
"includeChildren": {
"type": "boolean",
"default": true
}
},
"description": "Category information for a preferred line item page"
},
"LineItemPageV2": {
"required": [
"pageType"
],
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItemPageCategoryV2"
},
"nullable": true
},
"pageType": {
"enum": [
"unknown",
"search",
"home",
"browse",
"checkout",
"category",
"productDetail",
"confirmation",
"merchandising",
"deals",
"favorites",
"searchBar",
"categoryMenu"
],
"type": "string",
"description": "Page Type Enum"
},
"searchKeywords": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"description": "Page information for a preferred line item",
"nullable": true
},
"LineItemProductStatus": {
"enum": [
"unknown",
"active",
"paused"
],
"type": "string",
"description": "The status of a promoted product in the context of the line item.",
"nullable": true
},
"ManagedServiceFee": {
"required": [
"onsiteDisplayEnabled",
"onsiteSponsoredProductsEnabled",
"rate"
],
"type": "object",
"properties": {
"onsiteDisplayEnabled": {
"type": "boolean",
"description": "whether fee is enabled for display campaigns"
},
"onsiteSponsoredProductsEnabled": {
"type": "boolean",
"description": "whether fee is enabled for sponsored product campaigns"
},
"rate": {
"maximum": 1,
"minimum": 0,
"type": "number",
"description": "decimal fee rate between 0 and 1",
"format": "double"
}
},
"additionalProperties": false,
"description": "settings for managed service fees",
"nullable": true
},
"MatchTypeModel": {
"enum": [
"PositiveExactMatch",
"NegativeExactMatch",
"NegativeBroadMatch"
],
"type": "string",
"description": "The match type of a keyword."
},
"Metadata": {
"required": [
"limit",
"offset"
],
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64",
"nullable": true
},
"limit": {
"type": "integer",
"description": "The number of elements to be returned.",
"format": "int32"
},
"offset": {
"type": "integer",
"description": "The (zero-based) starting offset in the collection.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Metadata related to the current request.",
"nullable": true
},
"MissedOpportunitiesReportFilters": {
"type": "object",
"properties": {
"accountIds": {
"type": "array",
"items": {
"type": "string"
}
},
"campaignIds": {
"type": "array",
"items": {
"type": "string"
}
},
"campaignTypes": {
"type": "array",
"items": {
"enum": [
"all",
"sponsoredProducts",
"onSiteDisplays"
],
"type": "string"
}
},
"lineItemIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Array-valued constraints for missed-opportunities reporting. At least one of accountIds, campaignIds, or lineItemIds is required."
},
"MonthlyLineItemBudegetOverride": {
"required": [
"duration",
"maxMonthlySpend"
],
"type": "object",
"properties": {
"duration": {
"type": "string",
"description": "The number of MONTHs that the override is active from StartMonth, e.g. \"1M\". Must end with 'M' or 'm'."
},
"maxMonthlySpend": {
"type": "number",
"description": "Monthly budget override maximum monthly spend amount.",
"format": "double"
},
"startMonth": {
"type": "string",
"description": "Monthly budget override start month, format \"yyyy-MM\". If it is null, the StartMonth would be the following month of the last item in the override sequence.",
"format": "date-time",
"nullable": true
},
"status": {
"enum": [
"Expired",
"Active",
"Upcoming"
],
"type": "string",
"description": "Monthly budget override computed status.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The details for a monthly budget override"
},
"NillableDecimal": {
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The value. If missing or null the value is set to \"null\"",
"format": "double",
"nullable": true
}
},
"description": "Placeholder object for value for which \"null\" is a valid business value",
"nullable": true
},
"NillableString": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The string's value. If missing or null the string's value is set to \"null\"",
"nullable": true
}
},
"description": "Placeholder object for string value for which \"null\" is a valid business value",
"nullable": true
},
"PageMetadata": {
"required": [
"currentPageIndex",
"currentPageSize"
],
"type": "object",
"properties": {
"currentPageIndex": {
"type": "integer",
"format": "int32"
},
"currentPageSize": {
"type": "integer",
"format": "int32"
},
"nextPage": {
"type": "string",
"nullable": true
},
"previousPage": {
"type": "string",
"nullable": true
},
"totalItemsAcrossAllPages": {
"type": "integer",
"format": "int64",
"nullable": true
},
"totalPages": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false,
"description": "Metadata related to the current request"
},
"PageOfBalanceHistoryChangeDataCaptureV1": {
"required": [
"data",
"meta"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BalanceHistoryChangeDataCaptureV1"
}
},
"meta": {
"$ref": "#/components/schemas/Metadata"
}
},
"additionalProperties": false,
"description": "A wrapper class to return a single page of items with metadata for offset and limit based paging."
},
"PageTypeCombinationV2": {
"type": "object",
"properties": {
"pageEnvironmentType": {
"enum": [
"unknown",
"web",
"mobile",
"app",
"lockout",
"mixed",
"ios",
"android"
],
"type": "string",
"description": "The page environment type supported for this campaign-buy type combination",
"nullable": true
},
"pageType": {
"enum": [
"unknown",
"search",
"home",
"checkout",
"category",
"productDetail",
"confirmation",
"merchandising",
"deals",
"favorites",
"searchbar",
"categoryMenu",
"aiAssistant"
],
"type": "string",
"description": "The page type supported for this campaign-buy type combination",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a combination of page type and page environment type for a specific campaign-buy type."
},
"PageTypeEnvironment2": {
"type": "object",
"properties": {
"environments": {
"type": "array",
"items": {
"enum": [
"Web",
"Mobile",
"App",
"Lockout",
"Mixed",
"iOS",
"Android"
],
"type": "string",
"description": "Creative format, defining where the creative can be served"
},
"description": "List of environments per PageType",
"nullable": true
},
"pageType": {
"enum": [
"Unknown",
"Search",
"Home",
"Browse",
"Checkout",
"Category",
"ProductDetail",
"Confirmation",
"Merchandising",
"Deals",
"Favorites",
"SearchBar",
"CategoryMenu"
],
"type": "string",
"description": "Creative PageType",
"nullable": true
}
},
"additionalProperties": false,
"description": "The PageType-Environment Tuples for creatives"
},
"PageTypeEnvironment202210": {
"type": "object",
"properties": {
"environments": {
"type": "array",
"items": {
"enum": [
"Web",
"Mobile",
"App",
"Lockout",
"Mixed",
"iOS",
"Android"
],
"type": "string",
"description": "Creative format, defining where the creative can be served"
},
"description": "List of environments per PageType",
"nullable": true
},
"pageType": {
"enum": [
"Search",
"Home",
"Browse",
"Checkout",
"Category",
"ProductDetail",
"Confirmation",
"Merchandising",
"Deals"
],
"type": "string",
"description": "Creative PageType",
"nullable": true
}
},
"additionalProperties": false,
"description": "The PageType-Environment Tuples for creatives"
},
"PagingOffsetLimitMetadata": {
"required": [
"limit",
"offset"
],
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64",
"nullable": true
},
"limit": {
"type": "integer",
"description": "The number of elements to be returned.",
"format": "int32"
},
"offset": {
"type": "integer",
"description": "The (zero-based) starting offset in the collection.",
"format": "int32"
}
},
"description": "Metadata for paging data.",
"nullable": true
},
"PartnerBillingReportRequestV1": {
"required": [
"endDate",
"startDate"
],
"type": "object",
"properties": {
"accountIds": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "On which accounts the report is created.",
"nullable": true
},
"endDate": {
"type": "string",
"description": "End date of the report (ISO 8601 format, e.g. YYYY-MM-DD).",
"format": "date"
},
"format": {
"enum": [
"json",
"csv"
],
"type": "string",
"description": "Format type of the report.",
"default": "json"
},
"retailerIds": {
"minItems": 1,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "On which retailers the report is created.",
"nullable": true
},
"startDate": {
"type": "string",
"description": "Start date of the report (ISO 8601 format, e.g. YYYY-MM-DD).",
"format": "date"
}
},
"additionalProperties": false,
"description": "The request object of a Partner Billing Report."
},
"PartnerBillingReportStatusV1": {
"required": [
"createdAt",
"status"
],
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"description": "The date when the report request is created.",
"format": "date-time"
},
"errorMessage": {
"type": "string",
"description": "Possible error message along with the status.",
"nullable": true
},
"status": {
"enum": [
"pending",
"success",
"failed",
"expired"
],
"type": "string",
"description": "Status of the report."
}
},
"additionalProperties": false,
"description": "Status info of a Partner Billing Report.",
"nullable": true
},
"PerformanceReportFilters": {
"type": "object",
"properties": {
"accountIds": {
"type": "array",
"items": {
"type": "string"
}
},
"activationPlatforms": {
"type": "array",
"items": {
"enum": [
"CommerceMax",
"PrivateMarket"
],
"type": "string"
}
},
"budgetModels": {
"type": "array",
"items": {
"enum": [
"CriteoBudget",
"RetailerBudget"
],
"type": "string"
}
},
"buyTypes": {
"type": "array",
"items": {
"enum": [
"auction",
"preferredDeals",
"sponsorship"
],
"type": "string"
}
},
"campaignIds": {
"type": "array",
"items": {
"type": "string"
}
},
"campaignTypes": {
"type": "array",
"items": {
"enum": [
"all",
"sponsoredProducts",
"onSiteDisplays"
],
"type": "string"
}
},
"lineItemIds": {
"type": "array",
"items": {
"type": "string"
}
},
"mediaTypes": {
"type": "array",
"items": {
"enum": [
"unknown",
"video",
"display",
"all"
],
"type": "string"
}
},
"salesChannels": {
"type": "array",
"items": {
"enum": [
"online",
"offline",
"all"
],
"type": "string"
}
},
"searchTermTargetings": {
"type": "array",
"items": {
"enum": [
"unknown",
"automatic",
"manual"
],
"type": "string"
}
},
"searchTermTypes": {
"type": "array",
"items": {
"enum": [
"unknown",
"searched",
"entered"
],
"type": "string"
}
},
"targetedKeywordTypes": {
"type": "array",
"items": {
"enum": [
"unknown",
"generic",
"branded",
"conquesting"
],
"type": "string"
}
}
},
"description": "Array-valued constraints for performance DSP analytics. At least one of accountIds, campaignIds, or lineItemIds is required."
},
"PostCampaignV202301": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301"
}
},
"description": "An object that represents the available options to set when creating a Retail Media Campaign"
},
"PreferredLineItemCreateModelV2": {
"required": [
"name",
"startDate",
"endDate",
"pacing",
"page",
"targetRetailerId",
"budget"
],
"type": "object",
"properties": {
"budget": {
"type": "number",
"format": "double"
},
"capping": {
"$ref": "#/components/schemas/LineItemCappingV2"
},
"creativeId": {
"type": "string",
"format": "long-id"
},
"endDate": {
"type": "string",
"description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD",
"format": "date"
},
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"pacing": {
"enum": [
"unknown",
"standard",
"accelerated"
],
"type": "string",
"description": "Line Item Pacing Enum"
},
"page": {
"$ref": "#/components/schemas/LineItemPageV2"
},
"startDate": {
"type": "string",
"description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD",
"format": "date"
},
"status": {
"enum": [
"unknown",
"active",
"scheduled",
"draft",
"paused",
"budgetHit",
"ended",
"archived",
"noFunds"
],
"type": "string",
"description": "Line Item Status Enum"
},
"targetRetailerId": {
"type": "string",
"format": "long-id"
}
},
"description": "Model used to create a preferred line item"
},
"PreferredLineItemCreateModelV2Request": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/InputResourceOfPreferredLineItemCreateModelV2"
}
},
"description": "Data model for a create input resource"
},
"PreferredLineItemUpdateModelV2": {
"required": [
"name",
"startDate",
"endDate",
"status"
],
"type": "object",
"properties": {
"budget": {
"type": "number",
"format": "double"
},
"capping": {
"$ref": "#/components/schemas/LineItemCappingV2"
},
"creativeId": {
"type": "string",
"format": "long-id"
},
"endDate": {
"type": "string",
"description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD",
"format": "date"
},
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"pacing": {
"enum": [
"unknown",
"standard",
"accelerated"
],
"type": "string",
"default": "accelerated"
},
"page": {
"$ref": "#/components/schemas/LineItemPageV2"
},
"startDate": {
"type": "string",
"description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD",
"format": "date"
},
"status": {
"enum": [
"unknown",
"active",
"scheduled",
"draft",
"paused",
"budgetHit",
"ended",
"archived",
"noFunds"
],
"type": "string",
"description": "Line Item Status Enum"
}
},
"description": "Model used to update a preferred line item"
},
"PreferredLineItemUpdateModelV2Request": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ResourceOfPreferredLineItemUpdateModelV2"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single entity"
},
"PreferredLineItemV2": {
"required": [
"name",
"startDate",
"status",
"targetRetailerId",
"budget",
"campaignId"
],
"type": "object",
"properties": {
"budget": {
"type": "number",
"format": "double"
},
"budgetRemaining": {
"type": "number",
"format": "double",
"nullable": true
},
"budgetSpent": {
"type": "number",
"format": "double",
"nullable": true
},
"campaignId": {
"type": "string",
"format": "long-id"
},
"capping": {
"$ref": "#/components/schemas/LineItemCappingV2"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"creativeId": {
"type": "string",
"description": "creative Id",
"format": "long-id",
"nullable": true
},
"endDate": {
"type": "string",
"description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD",
"format": "date",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"pacing": {
"enum": [
"unknown",
"standard",
"accelerated"
],
"type": "string",
"nullable": true
},
"page": {
"$ref": "#/components/schemas/LineItemPageV2"
},
"startDate": {
"type": "string",
"description": "Represents the Date as a year, month, and day in the format YYYY-MM-DD",
"format": "date"
},
"status": {
"enum": [
"unknown",
"active",
"scheduled",
"draft",
"paused",
"budgetHit",
"ended",
"archived",
"noFunds"
],
"type": "string",
"description": "Line Item Status Enum"
},
"targetRetailerId": {
"type": "string",
"format": "long-id"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"description": "A Retail Media Preferred Line Item used to hold bid settings for one or many promoted products on a single retailer"
},
"PreferredLineItemV2PagedListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceOfPreferredLineItemV2"
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
},
"metadata": {
"$ref": "#/components/schemas/PageMetadata"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
}
},
"description": "Data model for a paged list of response resources"
},
"PreferredLineItemV2Response": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ResourceOfPreferredLineItemV2"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single entity"
},
"PrivateMarketAccountFees": {
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "The account Id",
"nullable": true
},
"fees": {
"$ref": "#/components/schemas/PrivateMarketFees"
}
},
"additionalProperties": false,
"description": "The Fees for a Specific private market account",
"nullable": true
},
"PrivateMarketFees": {
"type": "object",
"properties": {
"demandManaged": {
"$ref": "#/components/schemas/DemandManagedFee"
},
"managedService": {
"$ref": "#/components/schemas/ManagedServiceFee"
}
},
"additionalProperties": false,
"description": "fees for a private market account",
"nullable": true
},
"ProductMetadata": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Total number of items available.",
"format": "int32",
"nullable": true
},
"limit": {
"type": "integer",
"description": "Maximum number of items in the response.",
"format": "int32",
"nullable": true
},
"offset": {
"type": "integer",
"description": "Zero based offset of the first item in the response.",
"format": "int32",
"nullable": true
},
"responseCount": {
"type": "integer",
"description": "Number of items in the response.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Metadata about the response. Used for pagination.",
"nullable": true
},
"ProductResourceOutcome": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmcaCommonProblem"
},
"nullable": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmcaCommonProblem"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "Outcome object containing errors and warnings."
},
"PromotedProduct": {
"type": "object",
"properties": {
"bidOverride": {
"type": "number",
"description": "The bid override for the promoted product for this line item. Ignored unless adding a product.",
"format": "decimal",
"nullable": true
},
"id": {
"type": "string",
"description": "A retailer defined SKU ID for the promoted product.",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/LineItemProductStatus"
}
},
"additionalProperties": false,
"description": "A promoted product.",
"nullable": true
},
"PromotedProductResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/PromotedProduct"
},
"id": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Resource object containing a promoted product."
},
"PromotedProductResourceCollectionInput": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PromotedProductResource"
}
}
},
"additionalProperties": false,
"description": "Request object containing promoted products to be appended, deleted, paused or unpaused."
},
"PromotedProductResourceCollectionOutcome": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PromotedProductResource"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmcaCommonProblem"
},
"nullable": true,
"readOnly": true
},
"meta": {
"$ref": "#/components/schemas/ProductMetadata"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmcaCommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "Outcome object containing promoted products."
},
"PutCampaignV202301": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301"
}
},
"description": "An object that represents the available options to set when editing a Retail Media Campaign"
},
"RecommendedCategoriesRequestV1": {
"required": [
"productIds"
],
"type": "object",
"properties": {
"productIds": {
"maxItems": 1000,
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "Sku id list."
}
},
"description": "An object that represents the request of RecommendCategories endpoint."
},
"RecommendedKeywordsRequestV1": {
"required": [
"productIds"
],
"type": "object",
"properties": {
"productIds": {
"maxItems": 1000,
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "Product Id list that the recommended keywords generated on."
}
},
"additionalProperties": false,
"description": "Request model of RecommendedKeywords"
},
"RecommendedKeywordsResponseV1": {
"required": [
"recommendedKeywords"
],
"type": "object",
"properties": {
"recommendedKeywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "Recommended keywords generated by given retailer Id and sku Ids."
}
},
"additionalProperties": false,
"description": "Response model of Recommended Keywords",
"nullable": true
},
"RecommendedKeywordsResult": {
"type": "object",
"properties": {
"keywords": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Keywords"
},
"description": "Dictionary of keywords to their keyword models",
"nullable": true
},
"recommendedKeywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "Collection of recommended keywords",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response model for recommended keywords",
"nullable": true
},
"ReportDataResponseResource": {
"type": "object",
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "object"
}
},
"description": "Data response format",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value",
"nullable": true
},
"ReportResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ReportDataResponseResource"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"meta": {
"$ref": "#/components/schemas/ExportReportMetaData"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"description": "Report response format"
},
"ResourceOfAddFundsToBalanceV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AddFundsToBalanceV2"
},
"id": {
"type": "string",
"description": "Id of the entity"
},
"type": {
"type": "string",
"description": "Canonical type name of the entity"
}
},
"description": "A class that represents a domain entity exposed by an API"
},
"ResourceOfBalanceCampaign202110": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/BalanceCampaign202110"
},
"id": {
"type": "string",
"description": "Id of the entity",
"nullable": true
},
"type": {
"type": "string",
"description": "Canonical type name of the entity",
"nullable": true
}
},
"description": "A class that represents a domain entity exposed by an API"
},
"ResourceOfBalanceResponseV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/BalanceResponseV2"
},
"id": {
"type": "string",
"description": "Id of the entity",
"nullable": true
},
"type": {
"type": "string",
"description": "Canonical type name of the entity",
"nullable": true
}
},
"description": "A class that represents a domain entity exposed by an API",
"nullable": true
},
"ResourceOfCategory202204": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Category202204"
},
"id": {
"type": "string",
"description": "Unique identifier of this resource.",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "A class that represents a domain entity exposed by an API."
},
"ResourceOfChangeDatesOfBalanceV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ChangeDatesOfBalanceV2"
},
"id": {
"type": "string",
"description": "Id of the entity"
},
"type": {
"type": "string",
"description": "Canonical type name of the entity"
}
},
"description": "A class that represents a domain entity exposed by an API"
},
"ResourceOfCommonLineItem": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/CommonLineItem"
},
"id": {
"type": "string",
"description": "Id of the entity",
"nullable": true
},
"type": {
"type": "string",
"description": "Canonical type name of the entity",
"nullable": true
}
},
"description": "A class that represents a domain entity exposed by an API"
},
"ResourceOfCreateBalanceV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/CreateBalanceV2"
},
"id": {
"type": "string",
"description": "Id of the entity"
},
"type": {
"type": "string",
"description": "Canonical type name of the entity"
}
},
"description": "A class that represents a domain entity exposed by an API"
},
"ResourceOfCreative2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Creative2"
},
"id": {
"type": "string",
"description": "Unique identifier of this resource.",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "A class that represents a domain entity exposed by an API.",
"nullable": true
},
"ResourceOfCreative202110": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Creative202110"
},
"id": {
"type": "string",
"description": "Unique identifier of this resource.",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "A class that represents a domain entity exposed by an API."
},
"ResourceOfCreative202210": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Creative202210"
},
"id": {
"type": "string",
"description": "Unique identifier of this resource.",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "A class that represents a domain entity exposed by an API.",
"nullable": true
},
"ResourceOfLineItemBidMultipliersV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/LineItemBidMultipliersV2"
},
"id": {
"type": "string",
"description": "Id of the entity",
"nullable": true
},
"type": {
"type": "string",
"description": "Canonical type name of the entity",
"nullable": true
}
},
"description": "A class that represents a domain entity exposed by an API",
"nullable": true
},
"ResourceOfPreferredLineItemUpdateModelV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/PreferredLineItemUpdateModelV2"
},
"id": {
"type": "string",
"description": "Id of the entity"
},
"type": {
"type": "string",
"description": "Canonical type name of the entity"
}
},
"description": "A class that represents a domain entity exposed by an API"
},
"ResourceOfPreferredLineItemV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/PreferredLineItemV2"
},
"id": {
"type": "string",
"description": "Id of the entity",
"nullable": true
},
"type": {
"type": "string",
"description": "Canonical type name of the entity",
"nullable": true
}
},
"description": "A class that represents a domain entity exposed by an API",
"nullable": true
},
"ResourceOfTemplate": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Template"
},
"id": {
"type": "string",
"description": "Unique identifier of this resource.",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "A class that represents a domain entity exposed by an API.",
"nullable": true
},
"ResourceOfUpdateBalanceModelV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/UpdateBalanceModelV2"
},
"id": {
"type": "string",
"description": "Id of the entity"
},
"type": {
"type": "string",
"description": "Canonical type name of the entity"
}
},
"description": "A class that represents a domain entity exposed by an API"
},
"ResourceOutcome": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmcaCommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmcaCommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "Outcome object containing errors and warnings."
},
"RetailerPages202110": {
"required": [
"pageTypes"
],
"type": "object",
"properties": {
"pageTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of valid pages for a retailer"
}
},
"additionalProperties": false,
"description": "Wraps a list of valid pages for a retailer"
},
"RetailerResultV2": {
"type": "object",
"properties": {
"campaignAvailabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CampaignAvailabilityV2"
},
"description": "A list of campaign availabilities for the retailer, each showing the budget models available for a specific campaign type and buy type combination",
"nullable": true
},
"name": {
"type": "string",
"description": "Name of the retailer",
"nullable": true
}
},
"additionalProperties": false,
"description": "The result of a query for the configuration of a retailer",
"nullable": true
},
"RetailerSearchRequestV2": {
"type": "object",
"properties": {
"retailerIdFilter": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional list of retailer IDs to filter the results",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for searching retailers"
},
"RetailMediaContactlistAmendment": {
"required": [
"attributes"
],
"type": "object",
"properties": {
"attributes": {
"required": [
"identifiers",
"operation"
],
"type": "object",
"properties": {
"identifiers": {
"type": "array",
"items": {
"type": "string"
},
"description": "The users to add or remove, each in the schema specified"
},
"identifierType": {
"enum": [
"Email",
"UserIdentifier",
"IdentityLink",
"Gum",
"CustomerId",
"PhoneNumber"
],
"type": "string",
"description": "What type of identifiers are used"
},
"operation": {
"enum": [
"add",
"remove"
],
"type": "string",
"description": "Whether to add or remove users"
}
},
"description": "Attributes of retail media contact list amendment"
},
"type": {
"type": "string",
"description": "User List",
"example": "AddRemoveContactlist"
}
},
"description": "Request data of retail media contact list amendment"
},
"RetailMediaContactlistAmendmentRequest": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RetailMediaContactlistAmendment"
}
},
"description": "Request of Retail Media contactlist"
},
"RetailMediaContactlistOperation": {
"required": [
"data",
"errors",
"warnings"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RetailMediaContactlistOperationResponseAttributes"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceError"
}
},
"type": {
"type": "string",
"description": "the name of the entity type",
"nullable": true,
"example": "AddRemoveContactlistResult"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudienceWarning"
}
}
},
"description": "Operation on Retail Media contact list"
},
"RetailMediaContactlistOperationResponseAttributes": {
"required": [
"contactListId",
"operation",
"requestDate"
],
"type": "object",
"properties": {
"contactListId": {
"type": "integer",
"description": "The affected user list id",
"format": "int64"
},
"identifierType": {
"type": "string",
"description": "The schema specified for of the identifiers",
"nullable": true
},
"nbInvalidIdentifiers": {
"type": "integer",
"description": "How many identifiers were invalid for the specified schema",
"format": "int32",
"nullable": true
},
"nbValidIdentifiers": {
"type": "integer",
"description": "How many identifiers were valid for the specified schema",
"format": "int32",
"nullable": true
},
"operation": {
"type": "string",
"description": "The action recorded"
},
"requestDate": {
"type": "string",
"description": "When the action was recorded",
"format": "date-time"
},
"sampleInvalidIdentifiers": {
"type": "array",
"items": {
"type": "string"
},
"description": "A sample of invalid identifiers if there is some",
"nullable": true
}
},
"description": "The attributes of Retail Media contact list operation"
},
"RetailMediaKeywordsReview": {
"required": [
"keywords"
],
"type": "object",
"properties": {
"keywords": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ReviewSetState"
}
}
},
"additionalProperties": false,
"description": "Request object for approval of keyword reviews, containing a list of Phrase-ReviewState pairs"
},
"RetailMediaKeywordsReviewResult": {
"required": [
"keywords"
],
"type": "object",
"properties": {
"keywords": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ReviewSetState"
}
}
},
"additionalProperties": false,
"description": "Response object for approval of keyword reviews, containing a list of Phrase-ReviewState pairs",
"nullable": true
},
"RetailMediaSeller": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "seller name",
"nullable": true
},
"retailerId": {
"type": "integer",
"description": "the retailer id",
"format": "int32",
"nullable": true
},
"sellerId": {
"type": "string",
"description": "the seller id",
"nullable": true
}
},
"additionalProperties": false,
"description": "used to define the exact seller linked with an account"
},
"ReviewSetState": {
"required": [
"phrase",
"reviewState"
],
"type": "object",
"properties": {
"phrase": {
"type": "string",
"description": "Normalized key phrase for keyword review to update"
},
"reviewState": {
"enum": [
"Unknown",
"InReview",
"Recommended",
"Approved",
"AutoApproved",
"Rejected",
"AutoRejected"
],
"type": "string",
"description": "Keyword review state to set for a phrase"
}
},
"additionalProperties": false,
"description": "A Phrase-ReviewState pair describing an update to a keyword review"
},
"ReviewStateModel": {
"enum": [
"InReview",
"Recommended",
"Approved",
"AutoApproved",
"Rejected",
"AutoRejected"
],
"type": "string",
"description": "The state of a keyword in the context of a line item."
},
"RmAlgebraNodeV1": {
"type": "object",
"properties": {
"and": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmAlgebraNodeV1"
},
"nullable": true
},
"audienceSegmentId": {
"type": "string",
"nullable": true
},
"not": {
"$ref": "#/components/schemas/RmAlgebraNodeV1"
},
"or": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmAlgebraNodeV1"
},
"nullable": true
}
},
"description": "Node in the audience algebra definition.",
"nullable": true
},
"RmAudienceEntityV1": {
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "Account associated to the audience",
"nullable": true
},
"algebra": {
"$ref": "#/components/schemas/RmAlgebraNodeV1"
},
"channels": {
"type": "array",
"items": {
"enum": [
"Unknown",
"Onsite",
"Offsite"
],
"type": "string"
},
"description": "Channels associated to the audience (read-only)",
"nullable": true
},
"createdAt": {
"type": "string",
"description": "ISO-8601 timestamp in UTC of audience creation (read-only)",
"format": "date-time",
"nullable": true
},
"createdById": {
"type": "string",
"description": "User that created the audience",
"nullable": true
},
"description": {
"type": "string",
"description": "Description of the audience",
"nullable": true
},
"name": {
"type": "string",
"description": "Name of the audience",
"nullable": true
},
"retailerId": {
"type": "string",
"description": "Retailer associated to the audience",
"nullable": true
},
"updatedAt": {
"type": "string",
"description": "ISO-8601 timestamp in UTC of audience update (read-only)",
"format": "date-time",
"nullable": true
}
},
"description": "Audience of people of interest for a marketer.",
"nullable": true,
"x-criteo-canonical": {
"infoType": "entity",
"name": "RetailMediaAudience",
"version": "v1"
}
},
"RmAudienceEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceEntityV1"
},
"id": {
"type": "string",
"description": "Id of the entity",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"description": "A class that represents a domain entity exposed by an API"
},
"RmAudienceEntityV1RmAudienceSearchMetadataV1ListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmAudienceEntityV1Resource"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"meta": {
"$ref": "#/components/schemas/RmAudienceSearchMetadataV1"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for several entities and metadata"
},
"RmAudienceSearchEntityV1": {
"type": "object",
"properties": {
"audienceIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of audience ids"
},
"audienceSegmentIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of segment ids (linked to the result audiences)"
},
"retailerIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of retailer ids"
}
},
"description": "Available filters to perform a search on audiences. If present, the filters are AND'ed together when applied."
},
"RmAudienceSearchEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceSearchEntityV1"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"RmAudienceSearchInputV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RmAudienceSearchEntityV1Resource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value."
},
"RmAudienceSearchMetadataV1": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Max item of the current page",
"format": "int32",
"nullable": true
},
"offset": {
"type": "integer",
"description": "Number of item to skip",
"format": "int32",
"nullable": true
},
"totalItems": {
"type": "integer",
"description": "Total number of items",
"format": "int32",
"nullable": true
}
},
"description": "Metadata for the audience search response.",
"nullable": true
},
"RmAudienceSegmentBulkCreateInputV1": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmAudienceSegmentCreateEntityV1Resource"
}
}
},
"description": "A top-level object that encapsulates a Criteo API request for several values."
},
"RmAudienceSegmentBulkDeleteInputV1": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmAudienceSegmentDeleteEntityV1Resource"
}
}
},
"description": "A top-level object that encapsulates a Criteo API request for several entities."
},
"RmAudienceSegmentBulkUpdateInputV1": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmAudienceSegmentUpdateEntityV1Resource"
}
}
},
"description": "A top-level object that encapsulates a Criteo API request for several entities."
},
"RmAudienceSegmentCreateEntityV1": {
"required": [
"name",
"retailerId"
],
"type": "object",
"properties": {
"contactList": {
"$ref": "#/components/schemas/RmContactListCreateV1"
},
"description": {
"type": "string",
"description": "Description of the segment"
},
"events": {
"$ref": "#/components/schemas/RmEventsCreateV1"
},
"name": {
"type": "string",
"description": "Name of the segment"
},
"retailerId": {
"type": "string",
"description": "Retailer associated to the segment"
}
},
"description": "Set of rules that defines specific people to target."
},
"RmAudienceSegmentCreateEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceSegmentCreateEntityV1"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"RmAudienceSegmentDeleteEntityV1": {
"type": "object",
"description": "Segment to delete",
"x-criteo-canonical": {
"infoType": "entity",
"name": "RetailMediaAudienceSegment",
"version": "v1"
}
},
"RmAudienceSegmentDeleteEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceSegmentDeleteEntityV1"
},
"id": {
"type": "string",
"description": "Id of the entity"
},
"type": {
"type": "string"
}
},
"description": "A class that represents a domain entity exposed by an API"
},
"RmAudienceSegmentEntityV1": {
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "Account associated to the segment",
"nullable": true
},
"channels": {
"type": "array",
"items": {
"enum": [
"Unknown",
"Onsite",
"Offsite"
],
"type": "string"
},
"description": "Channels associated to the segment (read-only)",
"nullable": true
},
"contactList": {
"$ref": "#/components/schemas/RmContactListV1"
},
"createdAt": {
"type": "string",
"description": "ISO-8601 timestamp in UTC of segment creation (read-only)",
"format": "date-time",
"nullable": true
},
"createdById": {
"type": "string",
"description": "User that created the segment",
"nullable": true
},
"description": {
"type": "string",
"description": "Description of the segment",
"nullable": true
},
"events": {
"$ref": "#/components/schemas/RmEventsV1"
},
"name": {
"type": "string",
"description": "Name of the segment",
"nullable": true
},
"retailerId": {
"type": "string",
"description": "Retailer associated to the segment",
"nullable": true
},
"type": {
"enum": [
"Unknown",
"ContactList",
"Events"
],
"type": "string",
"description": "Type of segment (read-only)",
"nullable": true
},
"updatedAt": {
"type": "string",
"description": "ISO-8601 timestamp in UTC of segment update (read-only)",
"format": "date-time",
"nullable": true
}
},
"description": "Set of rules that defines specific people to target.",
"nullable": true,
"x-criteo-canonical": {
"infoType": "entity",
"name": "RetailMediaAudienceSegment",
"version": "v1"
}
},
"RmAudienceSegmentEntityV1ListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmAudienceSegmentEntityV1Resource"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for several entities"
},
"RmAudienceSegmentEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceSegmentEntityV1"
},
"id": {
"type": "string",
"description": "Id of the entity",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"description": "A class that represents a domain entity exposed by an API"
},
"RmAudienceSegmentEntityV1RmAudienceSegmentSearchMetadataV1ListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmAudienceSegmentEntityV1Resource"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"meta": {
"$ref": "#/components/schemas/RmAudienceSegmentSearchMetadataV1"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for several entities and metadata"
},
"RmAudienceSegmentIdEntityV1": {
"type": "object",
"description": "Audience Segment entity only with its ID",
"nullable": true,
"x-criteo-canonical": {
"infoType": "entity",
"name": "RetailMediaAudienceSegment",
"version": "v1"
}
},
"RmAudienceSegmentIdEntityV1ListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmAudienceSegmentIdEntityV1Resource"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for several entities"
},
"RmAudienceSegmentIdEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceSegmentIdEntityV1"
},
"id": {
"type": "string",
"description": "Id of the entity",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"description": "A class that represents a domain entity exposed by an API"
},
"RmAudienceSegmentSearchEntityV1": {
"type": "object",
"properties": {
"audienceSegmentIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of segment ids"
},
"audienceSegmentTypes": {
"type": "array",
"items": {
"enum": [
"Unknown",
"ContactList",
"Events"
],
"type": "string"
},
"description": "List of segment types"
},
"retailerIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of retailer ids"
}
},
"description": "Available filters to perform a search on audience segments. If present, the filters are AND'ed together when applied."
},
"RmAudienceSegmentSearchEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceSegmentSearchEntityV1"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"RmAudienceSegmentSearchInputV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RmAudienceSegmentSearchEntityV1Resource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value."
},
"RmAudienceSegmentSearchMetadataV1": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Max item of the current page",
"format": "int32",
"nullable": true
},
"offset": {
"type": "integer",
"description": "Number of item to skip",
"format": "int32",
"nullable": true
},
"totalItems": {
"type": "integer",
"description": "Total number of items",
"format": "int32",
"nullable": true
}
},
"description": "Metadata for the audience segment search response.",
"nullable": true
},
"RmAudienceSegmentUpdateEntityV1": {
"type": "object",
"properties": {
"contactList": {
"$ref": "#/components/schemas/RmContactListUpdateV1"
},
"description": {
"$ref": "#/components/schemas/NillableString"
},
"events": {
"$ref": "#/components/schemas/RmEventsUpdateV1"
},
"name": {
"type": "string",
"description": "Name of the segment"
}
},
"description": "Set of rules that defines specific people to target.",
"x-criteo-canonical": {
"infoType": "entity",
"name": "RetailMediaAudienceSegment",
"version": "v1"
}
},
"RmAudienceSegmentUpdateEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceSegmentUpdateEntityV1"
},
"id": {
"type": "string",
"description": "Id of the entity"
},
"type": {
"type": "string"
}
},
"description": "A class that represents a domain entity exposed by an API"
},
"RmcaCommonProblem": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "A machine-readable error code, expressed as a string value.",
"nullable": true
},
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem",
"nullable": true
},
"instance": {
"type": "string",
"description": "A URI that identifies the specific occurrence of the problem.",
"nullable": true
},
"source": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A machine-readable structure to reference to the exact location(s) causing the error(s)",
"nullable": true
},
"stackTrace": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"description": "The problem's HTTP Status code.",
"format": "int32",
"nullable": true
},
"title": {
"type": "string",
"description": "A short human-readable description of the problem type",
"nullable": true
},
"traceId": {
"type": "string",
"description": "The request correlation ID this problem comes from.",
"nullable": true
},
"type": {
"enum": [
"unknown",
"access-control",
"authentication",
"authorization",
"availability",
"deprecation",
"quota",
"validation"
],
"type": "string",
"description": "The problem's category.",
"nullable": true
}
},
"additionalProperties": { },
"description": "Common problem object."
},
"RmContactListCreateV1": {
"type": "object",
"properties": {
"identifierType": {
"enum": [
"Email",
"UserIdentifier",
"IdentityLink",
"CustomerId",
"PhoneNumber"
],
"type": "string",
"description": "Indicates contact list type"
}
},
"description": "Settings to target users with your contact lists."
},
"RmContactListStatisticsEntityV1": {
"type": "object",
"properties": {
"matchRate": {
"type": "number",
"description": "Percentage of matched identifiers in the contact list.\r\nCan differ from matches/identifiers depending on the contact list type.",
"format": "double",
"nullable": true
},
"numberOfIdentifiers": {
"type": "integer",
"description": "Number of identifiers in the contact list.",
"format": "int32",
"nullable": true
},
"numberOfMatches": {
"type": "integer",
"description": "Number of matched identifiers in the contact list.",
"format": "int32",
"nullable": true
}
},
"description": "Contact list statistics.",
"nullable": true,
"x-criteo-canonical": {
"infoType": "entity",
"name": "ContactListStatistics",
"version": "v1"
}
},
"RmContactListStatisticsEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmContactListStatisticsEntityV1"
},
"id": {
"type": "string",
"description": "Id of the entity",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"description": "A class that represents a domain entity exposed by an API",
"nullable": true
},
"RmContactListStatisticsEntityV1Response": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RmContactListStatisticsEntityV1Resource"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single entity"
},
"RmContactListUpdateV1": {
"type": "object",
"description": "Settings to update the contact list of the segment"
},
"RmContactListV1": {
"type": "object",
"properties": {
"identifierType": {
"enum": [
"Unknown",
"Email",
"UserIdentifier",
"IdentityLink",
"CustomerId",
"PhoneNumber"
],
"type": "string",
"description": "Indicates contact list identifier's type",
"nullable": true
},
"isReadOnly": {
"type": "boolean",
"description": "Is the segment read-only",
"nullable": true
},
"sharingStatus": {
"enum": [
"Unknown",
"NotShared",
"SharedWithAll",
"SharedWithDemandAccounts"
],
"type": "string",
"description": "Indicates if the contact list is shared with other accounts",
"nullable": true
}
},
"description": "Settings to target users with your contact lists.",
"nullable": true
},
"RmEventsCreateV1": {
"required": [
"lookbackDays",
"shopperActivity"
],
"type": "object",
"properties": {
"brandIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Choose the brands your segment might be interested in"
},
"categoryIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Choose the categories your segment might be interested in"
},
"lookbackDays": {
"enum": [
"Last7Days",
"Last14Days",
"Last30Days",
"Last45Days",
"Last60Days",
"Last90Days",
"Last120Days",
"Last150Days",
"Last180Days"
],
"type": "string",
"description": "Number of days of the lookback windows"
},
"maxPrice": {
"type": "number",
"description": "Reach people who’ve shown interest in products with a maximum price",
"format": "double"
},
"minPrice": {
"type": "number",
"description": "Reach people who’ve shown interest in products with a minimum price",
"format": "double"
},
"shopperActivity": {
"enum": [
"View",
"Buy",
"AddToCart"
],
"type": "string",
"description": "Types of shopper activity."
}
},
"description": "Settings to target users based on their behavior"
},
"RmEventsUpdateV1": {
"type": "object",
"properties": {
"brandIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Choose the brands your segment might be interested in"
},
"categoryIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Choose the categories your segment might be interested in"
},
"lookbackDays": {
"enum": [
"Last7Days",
"Last14Days",
"Last30Days",
"Last45Days",
"Last60Days",
"Last90Days",
"Last120Days",
"Last150Days",
"Last180Days"
],
"type": "string",
"description": "Number of days of the lookback windows"
},
"maxPrice": {
"$ref": "#/components/schemas/NillableDecimal"
},
"minPrice": {
"$ref": "#/components/schemas/NillableDecimal"
},
"shopperActivity": {
"enum": [
"View",
"Buy",
"AddToCart"
],
"type": "string",
"description": "Types of shopper activity."
}
},
"description": "Settings to target users based on their behavior"
},
"RmEventsV1": {
"type": "object",
"properties": {
"brandIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of brand ids",
"nullable": true
},
"categoryIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of category ids",
"nullable": true
},
"lookbackDays": {
"enum": [
"Unknown",
"Last7Days",
"Last14Days",
"Last30Days",
"Last45Days",
"Last60Days",
"Last90Days",
"Last120Days",
"Last150Days",
"Last180Days"
],
"type": "string",
"description": "The number of days to look back",
"nullable": true
},
"maxPrice": {
"type": "number",
"description": "Maximum price of the products",
"format": "double",
"nullable": true
},
"minPrice": {
"type": "number",
"description": "Minimum price of the products",
"format": "double",
"nullable": true
},
"shopperActivity": {
"enum": [
"Unknown",
"View",
"Buy",
"AddToCart"
],
"type": "string",
"description": "Reach people who performed specific action",
"nullable": true
}
},
"description": "Settings to target users based on their behavior",
"nullable": true
},
"SdkApiRestCommonProblem": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "A machine-readable error code, expressed as a string value.",
"nullable": true
},
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem.",
"nullable": true
},
"instance": {
"type": "string",
"description": "A URI that identifies the specific occurrence of the problem.",
"nullable": true
},
"source": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A machine-readable structure to reference to the exact location(s) causing the error(s).",
"nullable": true
},
"stackTrace": {
"type": "string",
"description": "",
"nullable": true
},
"title": {
"type": "string",
"description": "A short human-readable description of the problem type.",
"nullable": true
},
"traceId": {
"type": "string",
"description": "The request correlation ID this problem comes from.",
"nullable": true
},
"type": {
"enum": [
"unknown",
"access-control",
"authentication",
"authorization",
"availability",
"deprecation",
"quota",
"validation"
],
"type": "string",
"description": "The problem's category.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Common problem object."
},
"Section": {
"required": [
"templateVariables"
],
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"templateVariables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateVariable"
}
},
"title": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Section object that hold template variables"
},
"SellerCatalogRequest": {
"required": [
"sellers"
],
"type": "object",
"properties": {
"sellers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SellerIdentifier"
},
"description": "A list of sellers to restrict the catalog to."
}
},
"additionalProperties": false,
"description": "Used to request a catalog of seller SKUs"
},
"SellerCatalogRequestV2": {
"type": "object",
"properties": {
"includeFields": {
"type": "array",
"items": {
"enum": [
"Unknown",
"Description",
"ImageUrl",
"GoogleCategory",
"RetailerName",
"Category",
"BrandName"
],
"type": "string"
},
"description": "Out of the optional fields, only the ones specified will be included in the catalog generated.",
"nullable": true
},
"modifiedAfter": {
"type": "string",
"description": "Only products modified after this time will be returned.",
"format": "date-time",
"nullable": true
},
"sellers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SellerIdentifierV2"
},
"description": "A list of sellers to restrict the catalog to.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Used to request a catalog of seller SKUs"
},
"SellerIdentifier": {
"required": [
"retailerId",
"sellerId"
],
"type": "object",
"properties": {
"retailerId": {
"type": "string",
"description": "The retailer Id that the seller operates under"
},
"sellerId": {
"type": "string",
"description": "The id for the seller based on the corresponding retailer"
}
},
"additionalProperties": false,
"description": "Identifies a Unique Seller"
},
"SellerIdentifierV2": {
"required": [
"retailerId",
"sellerId"
],
"type": "object",
"properties": {
"retailerId": {
"type": "string",
"description": "The retailer Id that the seller operates under"
},
"sellerId": {
"type": "string",
"description": "The id for the seller based on the corresponding retailer"
}
},
"additionalProperties": false,
"description": "Identifies a Unique Seller"
},
"SellerSearch": {
"required": [
"accountIds"
],
"type": "object",
"properties": {
"accountIds": {
"maxItems": 25,
"type": "array",
"items": {
"type": "string"
},
"description": "list of accounts to return seller information for. max length of 25"
},
"includeDetails": {
"type": "boolean",
"description": "whether to include additional fields beyond the sellerId and retailerId in the response.\r\nMay improve performance when set to false.",
"default": false
}
},
"additionalProperties": false,
"description": "request body for the seller search endpoint"
},
"SellerSearchResult": {
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "the id for the account",
"nullable": true
},
"sellers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RetailMediaSeller"
},
"description": "the details for mapped sellers for the account",
"nullable": true
}
},
"additionalProperties": false,
"description": "holds an AccountId and the mapped seller information for that account",
"nullable": true
},
"SetBidModel": {
"type": "object",
"properties": {
"bid": {
"type": "number",
"format": "double",
"nullable": true
},
"phrase": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "A single keyword and associated bid override"
},
"SetBidsModel": {
"type": "object",
"properties": {
"keywords": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SetBidModel"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "Data model containing keywords and their associated bid overrides"
},
"SetBidsModelRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SetBidsModelResource"
}
},
"additionalProperties": false,
"description": "Request object to set bid overrides for keywords associated with a line item"
},
"SetBidsModelResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SetBidsModel"
},
"id": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Resource object containing keywords and their associated bid overrides"
},
"SkuMinBid": {
"required": [
"minBid",
"skuId"
],
"type": "object",
"properties": {
"minBid": {
"type": "number",
"description": "Minimum bid amount value.",
"format": "double"
},
"skuId": {
"type": "string",
"description": "Sku id."
}
},
"additionalProperties": false,
"description": "An object represents the minimum bid amount value of a sku."
},
"SponsoredProductsLineItem": {
"required": [
"budgetRemaining",
"campaignId",
"createdAt",
"name",
"startDate",
"targetRetailerId",
"updatedAt"
],
"type": "object",
"properties": {
"bidStrategy": {
"enum": [
"manual",
"automated",
"unknown"
],
"type": "string",
"description": "Bid strategy for the line item.",
"nullable": true
},
"budget": {
"type": "number",
"description": "The total budget allocated for this line item.",
"format": "double",
"nullable": true
},
"budgetRemaining": {
"type": "number",
"description": "The amount of the budget that remains available.",
"format": "double",
"nullable": true
},
"budgetSpent": {
"type": "number",
"description": "The amount of the budget that has been spent so far.",
"format": "double",
"nullable": true
},
"campaignId": {
"type": "string",
"description": "The ID of the campaign this line item belongs to.",
"format": "long-id"
},
"createdAt": {
"type": "string",
"description": "The date and time when the line item was created.",
"format": "date-time"
},
"dailyPacing": {
"type": "number",
"description": "The daily pacing limit for budget spending.",
"format": "double",
"nullable": true
},
"endDate": {
"type": "string",
"description": "The date and time when the line item stops running.",
"format": "date-time",
"nullable": true
},
"flightSchedule": {
"$ref": "#/components/schemas/FlightSchedule"
},
"isAutoDailyPacing": {
"type": "boolean",
"description": "Indicates whether automatic daily pacing is enabled.",
"nullable": true
},
"keywordStrategy": {
"enum": [
"unknown",
"conquesting",
"genericAndBranded",
"genericBrandedAndConquesting"
],
"type": "string",
"description": "The keyword targeting strategy for this line item.",
"nullable": true
},
"maxBid": {
"type": "number",
"description": "The maximum bid amount allowed for this line item.",
"format": "double",
"nullable": true
},
"monthlyPacing": {
"type": "number",
"description": "The monthly pacing limit for budget spending.",
"format": "double",
"nullable": true
},
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The name of the line item."
},
"optimizationStrategy": {
"enum": [
"conversion",
"clicks",
"revenue",
"unknown"
],
"type": "string",
"description": "The optimization strategy for this line item.",
"nullable": true
},
"startDate": {
"type": "string",
"description": "The date and time when the line item starts running.",
"format": "date-time"
},
"status": {
"enum": [
"unknown",
"active",
"scheduled",
"draft",
"paused",
"budgetHit",
"ended",
"archived",
"noFunds"
],
"type": "string",
"description": "The current status of the line item.",
"nullable": true
},
"targetBid": {
"type": "number",
"description": "The target bid amount for the line item.",
"format": "double",
"nullable": true
},
"targetRetailerId": {
"type": "string",
"description": "The ID of the retailer targeted by this line item.",
"format": "long-id"
},
"updatedAt": {
"type": "string",
"description": "The date and time when the line item was last updated.",
"format": "date-time"
}
},
"additionalProperties": false,
"description": "Model of a retail media auction line item.",
"nullable": true
},
"SponsoredProductsLineItemCreateRequestModel": {
"required": [
"name",
"startDate",
"targetRetailerId"
],
"type": "object",
"properties": {
"bidStrategy": {
"enum": [
"manual",
"automated"
],
"type": "string",
"description": "The bidding strategy for this line item.\r\nDefault value is manual.",
"default": "manual"
},
"budget": {
"type": "number",
"description": "The total budget allocated for this line item.",
"format": "double",
"nullable": true
},
"dailyPacing": {
"type": "number",
"description": "The daily pacing limit for budget spending.",
"format": "double",
"nullable": true
},
"endDate": {
"type": "string",
"description": "The date and time when the line item stops running.",
"format": "date-time",
"nullable": true
},
"flightSchedule": {
"$ref": "#/components/schemas/FlightSchedule"
},
"isAutoDailyPacing": {
"type": "boolean",
"description": "Indicates whether automatic daily pacing is enabled.\r\nDefault value is false.",
"default": false
},
"keywordStrategy": {
"enum": [
"conquesting",
"genericAndBranded",
"genericBrandedAndConquesting"
],
"type": "string",
"description": "The keyword targeting strategy for this line item.",
"nullable": true
},
"maxBid": {
"type": "number",
"description": "The maximum bid amount allowed for this line item.",
"format": "double",
"nullable": true
},
"monthlyPacing": {
"type": "number",
"description": "The monthly pacing limit for budget spending.",
"format": "double",
"nullable": true
},
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The name of the line item."
},
"optimizationStrategy": {
"enum": [
"conversion",
"clicks",
"revenue"
],
"type": "string",
"description": "The optimization strategy to use for this line item.\r\nDefault value is Conversion.",
"default": "conversion"
},
"startDate": {
"type": "string",
"description": "The date and time when the line item starts running.",
"format": "date-time"
},
"targetBid": {
"type": "number",
"description": "The target bid amount for the line item.",
"format": "double",
"nullable": true
},
"targetRetailerId": {
"type": "string",
"description": "The ID of the retailer to target for this line item.",
"format": "long-id"
}
},
"additionalProperties": false,
"description": "Model to create a retail media auction line item"
},
"SponsoredProductsLineItemUpdateRequestModel": {
"required": [
"isAutoDailyPacing",
"name",
"startDate",
"status"
],
"type": "object",
"properties": {
"bidStrategy": {
"enum": [
"manual",
"automated"
],
"type": "string",
"description": "The bid strategy for the line item.",
"default": "manual"
},
"budget": {
"type": "number",
"description": "The total budget allocated for this line item.",
"format": "double",
"nullable": true
},
"dailyPacing": {
"type": "number",
"description": "The daily pacing amount for the line item.",
"format": "double",
"nullable": true
},
"endDate": {
"type": "string",
"description": "The date and time when the line item stops running.",
"format": "date-time",
"nullable": true
},
"flightSchedule": {
"$ref": "#/components/schemas/FlightSchedule"
},
"isAutoDailyPacing": {
"type": "boolean",
"description": "True if daily pacing is automatic, false if manual."
},
"maxBid": {
"type": "number",
"description": "The maximum bid amount for the line item.",
"format": "double",
"nullable": true
},
"monthlyPacing": {
"type": "number",
"description": "The monthly pacing amount for the line item.",
"format": "double",
"nullable": true
},
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The name of this line item."
},
"optimizationStrategy": {
"enum": [
"conversion",
"clicks",
"revenue"
],
"type": "string",
"description": "The optimization strategy for the line item.",
"default": "conversion"
},
"startDate": {
"type": "string",
"description": "The date and time when the line item starts running.",
"format": "date-time"
},
"status": {
"enum": [
"active",
"paused",
"draft"
],
"type": "string",
"description": "The current status of the line item."
},
"targetBid": {
"type": "number",
"description": "The target bid amount for the line item.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update a Sponsored Products Line Item."
},
"StatusResponse": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"nullable": true
},
"expiresAt": {
"type": "string",
"nullable": true
},
"fileSizeBytes": {
"type": "integer",
"format": "int64",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"md5CheckSum": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"rowCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"status": {
"enum": [
"pending",
"success",
"failure",
"expired"
],
"type": "string",
"nullable": true
}
},
"description": "Status of an async report request",
"nullable": true,
"x-criteo-canonical": {
"infoType": "entity"
}
},
"StatusResponseResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/StatusResponse"
},
"id": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"description": "A class that represents a domain entity exposed by an API",
"nullable": true
},
"StoreIdsUpdateModel202110": {
"required": [
"storeIds"
],
"type": "object",
"properties": {
"storeIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Store ids that should be targeted"
}
},
"description": "Update model for updating store target ids"
},
"StoreIdsUpdateModel202110Request": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueTypeResourceOfStoreIdsUpdateModel202110"
}
},
"description": "Data model for a value type input resource"
},
"StoreInventoryDelete": {
"required": [
"batchId",
"productId",
"storeId"
],
"type": "object",
"properties": {
"batchId": {
"type": "string",
"description": "Identifies this array entry"
},
"productId": {
"type": "string",
"description": " Identifies a product"
},
"storeId": {
"type": "string",
"description": "Identifies the store, for the customer"
}
},
"description": "References a store inventory to be deleted. See StoreInventoryUpsert"
},
"StoreInventoryUpsert": {
"required": [
"availability",
"batchId",
"price",
"productId",
"storeId"
],
"type": "object",
"properties": {
"availability": {
"enum": [
"backorder",
"in_stock",
"out_of_stock",
"preorder"
],
"type": "string",
"description": "Might be: In stock, Out of stock, Preorder, Backorder"
},
"batchId": {
"type": "string",
"description": "Identifies this array entry"
},
"price": {
"type": "string",
"description": "Product's price at this store"
},
"productId": {
"type": "string",
"description": " Identifies a product"
},
"salePrice": {
"type": "string",
"description": "The sale price of the product."
},
"storeId": {
"type": "string",
"description": "Identifies the store, for the customer"
}
},
"description": "Defines a store inventory to be upserted. Inspired from google spec.See https://developers.google.com/shopping-content/reference/rest/v2.1/localinventory/custombatch#LocalinventoryCustomBatchRequestEntry"
},
"StoreTarget202110": {
"required": [
"scope",
"storeIds"
],
"type": "object",
"properties": {
"scope": {
"enum": [
"unknown",
"include",
"exclude"
],
"type": "string",
"description": "Scope of the store target"
},
"storeIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Store ids that should be targeted"
}
},
"description": "Identifies store targeting for a line item"
},
"StoreTarget202110Request": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueTypeResourceOfStoreTarget202110"
}
},
"description": "Data model for a value type input resource"
},
"StoreTarget202110Response": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueTypeResourceOfStoreTarget202110"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"readOnly": true
}
},
"description": "Data model for a value type resource outcome"
},
"SyncAttributedTransactionsReport": {
"required": [
"accountId",
"endDate",
"startDate"
],
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "Account id to report on"
},
"campaignIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Campaign ids to filter"
},
"campaignType": {
"enum": [
"all",
"sponsoredProducts",
"onSiteDisplays"
],
"type": "string",
"description": "Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays",
"default": "all"
},
"clickAttributionWindow": {
"enum": [
"none",
"7D",
"14D",
"30D"
],
"type": "string",
"description": "Click attribution window",
"default": "none"
},
"dimensions": {
"type": "array",
"items": {
"enum": [
"purchasedDate",
"purchasedHour",
"advDate",
"advHour",
"daysDifference",
"campaignId",
"campaignName",
"lineItemId",
"lineItemName",
"advProductId",
"advProductGtin",
"advProductMpn",
"advProductName",
"advProductCategory",
"purchasedProductId",
"purchasedProductGtin",
"purchasedProductMpn",
"purchasedProductName",
"purchasedProductCategory",
"advEngagement",
"advToPurchasedProductRelationship",
"salesChannel",
"retailerName",
"pageTypeName",
"keyword",
"attributionWindow",
"saleSellerId",
"saleSellerName",
"activitySellerId",
"activitySellerName"
],
"type": "string"
},
"description": "List of dimensions to report on"
},
"endDate": {
"type": "string",
"description": "End date",
"format": "date-time"
},
"lineItemIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Line item ids to filter"
},
"mediaType": {
"enum": [
"unknown",
"video",
"display",
"all"
],
"type": "string",
"description": "Filter on the type of media: unknown, display, video",
"default": "all"
},
"metrics": {
"type": "array",
"items": {
"enum": [
"attributedUnits",
"attributedSales"
],
"type": "string"
},
"description": "List of metrics to report on"
},
"salesChannel": {
"enum": [
"online",
"offline",
"all"
],
"type": "string",
"description": "Filter on specific sales channel: offline or online",
"default": "all"
},
"startDate": {
"type": "string",
"description": "Start date",
"format": "date-time"
},
"timezone": {
"type": "string",
"description": "Time zone : see criteo developer portal for supported time zones",
"default": "UTC"
},
"viewAttributionWindow": {
"enum": [
"none",
"1D",
"7D",
"14D",
"30D"
],
"type": "string",
"description": "View attribution window",
"default": "none"
}
},
"description": "Attributed Transactions report body request"
},
"SyncAttributedTransactionsReportRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SyncAttributedTransactionsReportResource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value"
},
"SyncAttributedTransactionsReportResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SyncAttributedTransactionsReport"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"SyncCampaignsReport": {
"required": [
"accountId",
"endDate",
"startDate"
],
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "Account id to report on"
},
"campaignIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Campaign ids to filter"
},
"campaignType": {
"enum": [
"all",
"sponsoredProducts",
"onSiteDisplays"
],
"type": "string",
"description": "Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays",
"default": "all"
},
"clickAttributionWindow": {
"enum": [
"none",
"7D",
"14D",
"30D"
],
"type": "string",
"description": "Click attribution window",
"default": "none"
},
"dimensions": {
"type": "array",
"items": {
"enum": [
"date",
"hour",
"accountId",
"accountName",
"campaignId",
"campaignName",
"campaignTypeName",
"lineItemId",
"lineItemName",
"retailerId",
"retailerName",
"brandId",
"brandName",
"advProductCategory",
"advProductId",
"advProductName",
"salesChannel",
"environment",
"pageTypeName",
"pageCategory",
"servedCategory",
"taxonomyBreadcrumb"
],
"type": "string"
},
"description": "List of dimensions to report on"
},
"endDate": {
"type": "string",
"description": "End date",
"format": "date-time"
},
"metrics": {
"type": "array",
"items": {
"enum": [
"impressions",
"clicks",
"spend",
"attributedSales",
"attributedUnits",
"attributedOrders",
"assistedSales",
"assistedUnits",
"ctr",
"cpc",
"cpo",
"cpm",
"roas",
"uniqueVisitors",
"frequency"
],
"type": "string"
},
"description": "List of metrics to report on"
},
"reportType": {
"enum": [
"summary",
"pageType",
"productCategory",
"product",
"environment",
"servedCategory"
],
"type": "string",
"description": "Type of report, if no dimensions and metrics are provided, falls back to summary reportType",
"default": "summary"
},
"salesChannel": {
"enum": [
"online",
"offline",
"all"
],
"type": "string",
"description": "Filter on specific sales channel: offline or online",
"default": "all"
},
"startDate": {
"type": "string",
"description": "Start date",
"format": "date-time"
},
"timezone": {
"type": "string",
"description": "Time zone : see criteo developer portal for supported time zones",
"default": "UTC"
},
"viewAttributionWindow": {
"enum": [
"none",
"1D",
"7D",
"14D",
"30D"
],
"type": "string",
"description": "View attribution window",
"default": "none"
}
},
"description": "Campaigns report body request"
},
"SyncCampaignsReportRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SyncCampaignsReportResource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value"
},
"SyncCampaignsReportResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SyncCampaignsReport"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"SyncLineItemsReport": {
"required": [
"accountId",
"endDate",
"startDate"
],
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "Account id to report on"
},
"campaignIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Campaign ids to filter"
},
"campaignType": {
"enum": [
"all",
"sponsoredProducts",
"onSiteDisplays"
],
"type": "string",
"description": "Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays",
"default": "all"
},
"clickAttributionWindow": {
"enum": [
"none",
"7D",
"14D",
"30D"
],
"type": "string",
"description": "Click attribution window",
"default": "none"
},
"dimensions": {
"type": "array",
"items": {
"enum": [
"date",
"hour",
"accountId",
"accountName",
"campaignId",
"campaignName",
"campaignTypeName",
"lineItemId",
"lineItemName",
"retailerId",
"retailerName",
"brandId",
"brandName",
"advProductCategory",
"advProductId",
"advProductName",
"salesChannel",
"environment",
"pageTypeName",
"pageCategory",
"servedCategory",
"taxonomyBreadcrumb"
],
"type": "string"
},
"description": "List of dimensions to report on"
},
"endDate": {
"type": "string",
"description": "End date",
"format": "date-time"
},
"lineItemIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Line Item ids to filter"
},
"metrics": {
"type": "array",
"items": {
"enum": [
"impressions",
"clicks",
"spend",
"attributedSales",
"attributedUnits",
"attributedOrders",
"assistedSales",
"assistedUnits",
"ctr",
"cpc",
"cpo",
"cpm",
"roas",
"uniqueVisitors",
"frequency"
],
"type": "string"
},
"description": "List of metrics to report on"
},
"reportType": {
"enum": [
"summary",
"pageType",
"productCategory",
"product",
"environment",
"servedCategory"
],
"type": "string",
"description": "Type of report, if no dimensions and metrics are provided, falls back to summary reportType",
"default": "summary"
},
"salesChannel": {
"enum": [
"online",
"offline",
"all"
],
"type": "string",
"description": "Filter on specific sales channel: offline or online",
"default": "all"
},
"startDate": {
"type": "string",
"description": "Start date",
"format": "date-time"
},
"timezone": {
"type": "string",
"description": "Time zone : see criteo developer portal for supported time zones",
"default": "UTC"
},
"viewAttributionWindow": {
"enum": [
"none",
"1D",
"7D",
"14D",
"30D"
],
"type": "string",
"description": "View attribution window",
"default": "none"
}
},
"description": "Line Items report body request"
},
"SyncLineItemsReportRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SyncLineItemsReportResource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value"
},
"SyncLineItemsReportResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SyncLineItemsReport"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"SyncRealTimePerformanceReport": {
"required": [
"startDate"
],
"type": "object",
"properties": {
"accountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Account ids to filter (plural; base has AccountId for single account)."
},
"campaignIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Campaign ids to filter."
},
"dimensions": {
"type": "array",
"items": {
"enum": [
"date",
"hour",
"accountId",
"accountName",
"campaignId",
"campaignName",
"lineItemId",
"lineItemName",
"retailerId",
"retailerName"
],
"type": "string",
"description": "Dimensions supported by the real-time performance report (streaming + hourly stats).\r\nOnly these values are accepted; invalid values cause deserialization to fail."
},
"description": "List of dimensions to report on (real-time: at least one required). Only the supported dimension values are valid."
},
"endDate": {
"type": "string",
"description": "Optional end date/time (inclusive in the request timezone). If empty or not provided, no end date filter is applied.\r\nWhen provided, used as the inclusive upper bound for the report range.\r\nHides base Report.EndDate so this report can treat end date as optional (no [Required]).",
"format": "date-time"
},
"lineItemIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Line item ids to filter."
},
"metrics": {
"type": "array",
"items": {
"enum": [
"impressions",
"clicks",
"spend"
],
"type": "string",
"description": "Metrics supported by the real-time performance report (streaming + hourly stats).\r\nOnly these values are accepted; invalid values cause deserialization to fail."
},
"description": "List of metrics to report on (real-time: at least one required). Only the supported metric values are valid."
},
"retailerIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Retailer ids to filter. This is not used for security, so no need to check for > 0 elements"
},
"startDate": {
"type": "string",
"description": "Start date (real-time: must be within the last 7 days).",
"format": "date-time"
},
"timezone": {
"type": "string",
"description": "Time zone : see criteo developer portal for supported time zones",
"default": "UTC"
}
},
"description": "Real Time Performance report body request (one sheeter: startDate, endDate (optional), RetailerIds, accountIds, campaignIds, lineItemIds, dimensions, metrics, timezones).\r\nExtends SyncReport only (no default filters); adds entry filter arrays.\r\nDimensions and metrics are restricted to their supported enumerated values; invalid values cause deserialization to fail."
},
"SyncRealTimePerformanceReportRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SyncRealTimePerformanceReportResource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value"
},
"SyncRealTimePerformanceReportResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SyncRealTimePerformanceReport"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"Template": {
"required": [
"allCollectionsMandatory",
"createdAt",
"creativeFormat",
"name",
"sections",
"skuCollectionMin",
"skuPerCollectionMin",
"updatedAt"
],
"type": "object",
"properties": {
"allCollectionsMandatory": {
"type": "boolean",
"description": "Marks whether or not all collections are mandatory"
},
"createdAt": {
"type": "string",
"description": "The time at which the template was created",
"format": "date-time"
},
"creativeFormat": {
"enum": [
"Unknown",
"FlagShip",
"Showcase",
"SponsoredProducts",
"Butterfly",
"BundleBoost",
"IAB",
"CUSTOM",
"DisplayPanel",
"DigitalShelfTalker"
],
"type": "string",
"description": "The kind of creative this template can be used to build."
},
"displayableSkusMax": {
"type": "integer",
"description": "Maximum number of displayable skus",
"format": "int32",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"description": "The name of the template"
},
"sections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Section"
},
"description": "The sections holding various template variables"
},
"skuCollectionMax": {
"type": "integer",
"description": "Maximum number of skus in the collection",
"format": "int32",
"nullable": true
},
"skuCollectionMin": {
"type": "integer",
"description": "Minimum number of skus in the collection",
"format": "int32"
},
"skuPerCollectionMax": {
"type": "integer",
"description": "Maximum number of skus per collection",
"format": "int32",
"nullable": true
},
"skuPerCollectionMin": {
"type": "integer",
"description": "Minimum number of skus per collection",
"format": "int32"
},
"updatedAt": {
"type": "string",
"description": "The time at which the template was updated",
"format": "date-time"
}
},
"additionalProperties": false,
"description": "A template for creating creatives.",
"nullable": true
},
"TemplateListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceOfTemplate"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for several entities."
},
"TemplateResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ResourceOfTemplate"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for a single entity."
},
"TemplateVariable": {
"required": [
"id",
"required",
"type"
],
"type": "object",
"properties": {
"choiceVariableSpecification": {
"$ref": "#/components/schemas/ChoiceVariableSpecification"
},
"filesVariablesSpecification": {
"$ref": "#/components/schemas/FilesVariablesSpecification"
},
"id": {
"type": "string",
"description": "The id of the variable"
},
"required": {
"type": "boolean",
"description": "Whether the variable is required"
},
"textVariableSpecification": {
"$ref": "#/components/schemas/TextVariableSpecification"
},
"type": {
"enum": [
"Text",
"Choice",
"Color",
"Files",
"Hyperlink",
"Video"
],
"type": "string",
"description": "The type of the variable"
}
},
"additionalProperties": false,
"description": "A variable in a creative template"
},
"TemplateVariableValue": {
"required": [
"id"
],
"type": "object",
"properties": {
"choiceVariableValue": {
"$ref": "#/components/schemas/ChoiceVariableValue"
},
"colorVariableValue": {
"$ref": "#/components/schemas/ColorVariableValue"
},
"filesVariableValue": {
"$ref": "#/components/schemas/FilesVariableValue"
},
"hyperlinkVariableValue": {
"$ref": "#/components/schemas/HyperlinkVariableValue"
},
"id": {
"type": "string",
"description": "The id of the template variable the value is applied to"
},
"textVariableValue": {
"$ref": "#/components/schemas/TextVariableValue"
},
"videoVariableValue": {
"$ref": "#/components/schemas/VideoVariableValue"
}
},
"additionalProperties": false,
"description": "A value for a variable in a creative template."
},
"TextVariableSpecification": {
"type": "object",
"properties": {
"maxChars": {
"type": "integer",
"description": "The maximum amount of characters accepted for the text",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Specification of a text variable",
"nullable": true
},
"TextVariableValue": {
"required": [
"text"
],
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "The displayed text",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value of a template text variable",
"nullable": true
},
"UpdateBalanceModelV2": {
"type": "object",
"properties": {
"endDate": {
"type": "string",
"description": "End date of the balance in the format YYYY-MM-DD.",
"nullable": true
},
"memo": {
"type": "string",
"description": "Memo.",
"nullable": true
},
"name": {
"type": "string",
"description": "Name of the balance.",
"nullable": true
},
"poNumber": {
"type": "string",
"description": "Purchase Order number.",
"nullable": true
},
"startDate": {
"type": "string",
"description": "Start date of the balance in the format YYYY-MM-DD.",
"nullable": true
}
},
"description": "An object that represents the available options to set when updating a Retail Media Balance."
},
"UpdateBalanceModelV2Request": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ResourceOfUpdateBalanceModelV2"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single entity"
},
"ValueResourceAccountFeesSearchRequest": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AccountFeesSearchRequest"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceAccountFeesUpdateRequest": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AccountFeesUpdateRequest"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceBrandIdSearchRequest": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/BrandIdSearchRequest"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"description": "A value resource exposed by the API."
},
"ValueResourceCategoriesSearchRequestV1": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/CategoriesSearchRequestV1"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"description": "A value resource exposed by the API."
},
"ValueResourceCollectionInputOfRetailMediaSeller": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueResourceOfRetailMediaSeller"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for several value objects."
},
"ValueResourceCollectionOutcomeOfRetailMediaSeller": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueResourceOfRetailMediaSeller"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for several value objects."
},
"ValueResourceCollectionOutcomeOfSellerSearchResult": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueResourceOfSellerSearchResult"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for several value objects."
},
"ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueResourcePrivateMarketAccountFees"
},
"nullable": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for several value objects and metadata."
},
"ValueResourceCpcMinBidsRequest": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/CpcMinBidsRequest"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceCpcMinBidsResponse": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/CpcMinBidsResponse"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API.",
"nullable": true
},
"ValueResourceInputAccountFeesSearchRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceAccountFeesSearchRequest"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputAccountFeesUpdateRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceAccountFeesUpdateRequest"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputBrandIdSearchRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceBrandIdSearchRequest"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value objects."
},
"ValueResourceInputCategoriesSearchRequestV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceCategoriesSearchRequestV1"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value objects."
},
"ValueResourceInputCpcMinBidsRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceCpcMinBidsRequest"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value objects."
},
"ValueResourceInputOfBrandCatalogRequestV2": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfBrandCatalogRequestV2"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputOfCampaignBudgetOverrides": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfCampaignBudgetOverrides"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputOfLineItemBudgetOverrides": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfLineItemBudgetOverrides"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputOfRetailerSearchRequestV2": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfRetailerSearchRequestV2"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputOfRetailMediaBrandAccountCreation": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfRetailMediaBrandAccountCreation"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputOfRetailMediaBrands": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfRetailMediaBrands"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputOfRetailMediaSellerAccountCreation": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfRetailMediaSellerAccountCreation"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputOfSellerCatalogRequestV2": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfSellerCatalogRequestV2"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputOfSellerSearch": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfSellerSearch"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputOfSponsoredProductsLineItemCreateRequestModel": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfSponsoredProductsLineItemCreateRequestModel"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfSponsoredProductsLineItemUpdateRequestModel"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputPartnerBillingReportRequestV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourcePartnerBillingReportRequestV1"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputRecommendedCategoriesRequestV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceRecommendedCategoriesRequestV1"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value objects."
},
"ValueResourceInputRecommendedKeywordsRequestV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceRecommendedKeywordsRequestV1"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value objects."
},
"ValueResourceInputRetailMediaKeywordsReview": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceRetailMediaKeywordsReview"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceOfBrandCatalogRequestV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/BrandCatalogRequestV2"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceOfCampaignBudgetOverrides": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/CampaignBudgetOverrides"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API.",
"nullable": true
},
"ValueResourceOfLineItemBudgetOverrides": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/LineItemBudgetOverrides"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API.",
"nullable": true
},
"ValueResourceOfRecommendedKeywordsResult": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RecommendedKeywordsResult"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API.",
"nullable": true
},
"ValueResourceOfRetailerSearchRequestV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RetailerSearchRequestV2"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceOfRetailMediaBrandAccountCreation": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ExternalRetailMediaBrandAccountCreation"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceOfRetailMediaBrands": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ExternalRetailMediaBrands"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API.",
"nullable": true
},
"ValueResourceOfRetailMediaSeller": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ExternalRetailMediaSeller"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceOfRetailMediaSellerAccountCreation": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ExternalRetailMediaSellerAccountCreation"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceOfSellerCatalogRequestV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SellerCatalogRequestV2"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceOfSellerSearch": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SellerSearch"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceOfSellerSearchResult": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SellerSearchResult"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceOfSponsoredProductsLineItemCreateRequestModel": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SponsoredProductsLineItemCreateRequestModel"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceOfSponsoredProductsLineItemUpdateRequestModel": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SponsoredProductsLineItemUpdateRequestModel"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceOutcomeCpcMinBidsResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceCpcMinBidsResponse"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for a single value object."
},
"ValueResourceOutcomeOfCampaignBudgetOverrides": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfCampaignBudgetOverrides"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for a single value object."
},
"ValueResourceOutcomeOfLineItemBudgetOverrides": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfLineItemBudgetOverrides"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for a single value object."
},
"ValueResourceOutcomeOfRecommendedKeywordsResult": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfRecommendedKeywordsResult"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for a single value object."
},
"ValueResourceOutcomeOfRetailMediaBrands": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfRetailMediaBrands"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for a single value object."
},
"ValueResourceOutcomeRecommendedKeywordsResponseV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceRecommendedKeywordsResponseV1"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for a single value object."
},
"ValueResourceOutcomeRetailMediaKeywordsReviewResult": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceRetailMediaKeywordsReviewResult"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SdkApiRestCommonProblem"
},
"description": "Warnings that occured during this call.",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API response for a single value object."
},
"ValueResourcePartnerBillingReportRequestV1": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/PartnerBillingReportRequestV1"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourcePrivateMarketAccountFees": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/PrivateMarketAccountFees"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceRecommendedCategoriesRequestV1": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RecommendedCategoriesRequestV1"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"description": "A value resource exposed by the API."
},
"ValueResourceRecommendedKeywordsRequestV1": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RecommendedKeywordsRequestV1"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceRecommendedKeywordsResponseV1": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RecommendedKeywordsResponseV1"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API.",
"nullable": true
},
"ValueResourceRetailMediaKeywordsReview": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RetailMediaKeywordsReview"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceRetailMediaKeywordsReviewResult": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RetailMediaKeywordsReviewResult"
},
"type": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API.",
"nullable": true
},
"ValueTypeResourceOfAddToBasketIdsUpdateModel202110": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AddToBasketIdsUpdateModel202110"
},
"type": {
"type": "string"
}
},
"description": "Data model for a value type resource"
},
"ValueTypeResourceOfAddToBasketTarget202110": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AddToBasketTarget202110"
},
"type": {
"type": "string"
}
},
"description": "Data model for a value type resource"
},
"ValueTypeResourceOfAudienceIdsUpdateModel202110": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AudienceIdsUpdateModel202110"
},
"type": {
"type": "string"
}
},
"description": "Data model for a value type resource"
},
"ValueTypeResourceOfAudienceTarget202110": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AudienceTarget202110"
},
"type": {
"type": "string"
}
},
"description": "Data model for a value type resource"
},
"ValueTypeResourceOfStoreIdsUpdateModel202110": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/StoreIdsUpdateModel202110"
},
"type": {
"type": "string"
}
},
"description": "Data model for a value type resource"
},
"ValueTypeResourceOfStoreTarget202110": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/StoreTarget202110"
},
"type": {
"type": "string"
}
},
"description": "Data model for a value type resource"
},
"VideoVariableValue": {
"required": [
"duration",
"height",
"url",
"width"
],
"type": "object",
"properties": {
"duration": {
"minLength": 1,
"type": "string",
"description": "The video's duration"
},
"height": {
"type": "integer",
"description": "The video's height",
"format": "int32"
},
"url": {
"minLength": 1,
"type": "string",
"description": "The vast video url"
},
"width": {
"type": "integer",
"description": "The video's width",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A value of a template video variable",
"nullable": true
}
},
"securitySchemes": {
"oauth": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://api.criteo.com/oauth2/token",
"scopes": { }
},
"authorizationCode": {
"authorizationUrl": "https://api.criteo.com/oauth2",
"tokenUrl": "https://api.criteo.com/oauth2/token",
"scopes": { }
}
}
}
}
},
"security": [
{
"oauth": [ ]
}
],
"tags": [
{
"name": "Accounts"
},
{
"name": "Analytics"
},
{
"name": "Audience"
},
{
"name": "Balance"
},
{
"name": "Billing"
},
{
"name": "Campaign"
},
{
"name": "Catalog"
},
{
"name": "Gateway"
}
],
"x-samples-languages": [
"java",
"python",
"php",
"csharp",
"javascript",
"curl",
"ruby"
]
}