{
"openapi": "3.0.1",
"info": {
"title": "Criteo API",
"description": "Criteo API - RetailMedia",
"version": "Preview"
},
"servers": [
{
"url": "https://api.criteo.com"
}
],
"paths": {
"/preview/retail-media/account-management/accounts/{accountId}/private-market-child-accounts": {
"get": {
"tags": [
"Accounts"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/audience-segments": {
"patch": {
"tags": [
"Audience"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/audience-segments/{audience-segment-id}/contact-list": {
"get": {
"tags": [
"Audience"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/audience-segments/compute-sizes": {
"post": {
"tags": [
"Audience"
],
"summary": "/preview/retail-media/accounts/{account-id}/audience-segments/compute-sizes",
"description": "Gets the size of all segments. An error is returned for those whose size calculation is not supported.",
"operationId": "computeAudienceSegmentsSizes",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "Account id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSegmentComputeSizesInputV1"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success or partial success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSegmentSizeEntityV1ListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Audience_Manage"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/audience-segments/create": {
"post": {
"tags": [
"Audience"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/audience-segments/delete": {
"post": {
"tags": [
"Audience"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/audience-segments/estimate-size": {
"post": {
"tags": [
"Audience"
],
"summary": "/preview/retail-media/accounts/{account-id}/audience-segments/estimate-size",
"description": "Gets the size estimation of a non existent segment. An error is returned when size calculation is not supported.",
"operationId": "estimateAudienceSegmentSize",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSegmentEstimateSizeInputV1"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSegmentSizeEstimationV1Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Audience_Manage"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/audience-segments/search": {
"post": {
"tags": [
"Audience"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/audiences": {
"patch": {
"tags": [
"Audience"
],
"summary": "/preview/retail-media/accounts/{account-id}/audiences",
"description": "Updates the properties of all audiences with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.",
"operationId": "bulkUpdateAudience",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceBulkUpdateInputV1"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success or partial success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceEntityV1ListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Audience_Manage"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/audiences/compute-sizes": {
"post": {
"tags": [
"Audience"
],
"summary": "/preview/retail-media/accounts/{account-id}/audiences/compute-sizes",
"description": "Gets the size of all audiences. An error is returned for those whose size calculation is not supported.",
"operationId": "computeAudiencesSizes",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceComputeSizesInputV1"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success or partial success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSizeEntityV1ListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Audience_Manage"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/audiences/create": {
"post": {
"tags": [
"Audience"
],
"summary": "/preview/retail-media/accounts/{account-id}/audiences/create",
"description": "Creates all audiences with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.",
"operationId": "bulkCreateAudience",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Audience creation parameter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceBulkCreateInputV1"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success or partial success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceEntityV1ListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Audience_Manage"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/audiences/delete": {
"post": {
"tags": [
"Audience"
],
"summary": "/preview/retail-media/accounts/{account-id}/audiences/delete",
"description": "Deletes the audiences associated to the given IDs.",
"operationId": "bulkDeleteAudiences",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceBulkDeleteInputV1"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSegmentIdEntityV1ListResponse"
}
}
}
},
"204": {
"description": "Success or partial success",
"content": {
"application/json": { }
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Audience_Manage"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/audiences/estimate-size": {
"post": {
"tags": [
"Audience"
],
"summary": "/preview/retail-media/accounts/{account-id}/audiences/estimate-size",
"description": "Gets the size estimation of a non existent audience. An error is returned when size calculation is not supported.",
"operationId": "estimateAudienceSize",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "Account Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceEstimateSizeInputV1"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success or partial success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RmAudienceSizeEstimationV1Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Audience_Manage"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/audiences/search": {
"post": {
"tags": [
"Audience"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/balances/{balance-id}": {
"patch": {
"tags": [
"Balance"
],
"summary": "/preview/retail-media/accounts/{account-id}/balances/{balance-id}",
"description": "Modify a balance for the given account id",
"operationId": "UpdateBalanceV1",
"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/ValueResourceInputOfUpdateBalanceModelV1"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success"
}
},
"security": [
{
"oauth": [
"RetailMedia_Balance_Manage"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/creatives": {
"post": {
"tags": [
"Campaign"
],
"summary": "/preview/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/CreativeCreateModel2"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Creatives created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Creative2Response"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/creatives/{creative-id}": {
"get": {
"tags": [
"Campaign"
],
"summary": "/preview/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": "/preview/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/CreativeUpdateModel2"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Creative2Response"
}
}
}
},
"204": {
"description": "Creative updated"
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/creatives/search": {
"post": {
"tags": [
"Campaign"
],
"summary": "/preview/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": "limit",
"in": "query",
"description": "limit to paginated result",
"schema": {
"maximum": 500,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 50
}
},
{
"name": "offset",
"in": "query",
"description": "offset to paginated result",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
}
}
],
"requestBody": {
"description": "search request filter",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceInputCreativeSearchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Creatives found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceCollectionOutcomeCreativeSearchResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/preview/retail-media/accounts/{account-id}/line-items/cap-out-history": {
"post": {
"tags": [
"Campaign"
],
"summary": "/preview/retail-media/accounts/{account-id}/line-items/cap-out-history",
"description": "Get the cap out history for line items",
"operationId": "GetCapoutHistory",
"parameters": [
{
"name": "account-id",
"in": "path",
"description": "account id that own the lineitem",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "lineitem budgetcapout history object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputLineItemBudgetCapOutHistoryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceOutcomeLineItemBudgetCapOutHistoryResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/preview/retail-media/accounts/{accountId}/balances": {
"get": {
"tags": [
"Balance"
],
"summary": "/preview/retail-media/accounts/{accountId}/balances",
"description": "Gets page of balance objects for the given account id.",
"operationId": "GetPageOfBalancesV1",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The account to get balances for.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "The number of elements to be returned.",
"schema": {
"maximum": 500,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 25
}
},
{
"name": "limit-to-id",
"in": "query",
"description": "The balance ids which the result is limited to.",
"schema": {
"maxItems": 50,
"type": "array",
"items": {
"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/EntityResourceCollectionOutcomeBalanceV1AndMetadata"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Balance_Read"
]
}
]
}
},
"/preview/retail-media/accounts/{accountId}/grant-third-party-consent": {
"post": {
"tags": [
"ThirdPartyAccounts"
],
"summary": "/preview/retail-media/accounts/{accountId}/grant-third-party-consent",
"description": "Grant third-party consent to a business application on behalf of a Private Market demand account",
"operationId": "GrantThirdPartyConsent",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The demand account ID on which to grant consent",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The request input containing clientId, callbackURL, and callbackState",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantConsentInput"
}
}
},
"x-bodyName": "grantConsentInput"
},
"responses": {
"204": {
"description": "Success"
}
},
"security": [
{
"oauth": [
"RetailMedia_ThirdPartyAccounts_Manage"
]
}
]
}
},
"/preview/retail-media/accounts/{accountId}/retailers/search": {
"post": {
"tags": [
"Campaign"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/auction-line-items/{lineItemId}": {
"get": {
"tags": [
"Campaign"
],
"summary": "/preview/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": "/preview/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"
]
}
]
}
},
"/preview/retail-media/audience-segments/{audience-segment-id}/contact-list/add-remove": {
"post": {
"tags": [
"Audience"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/audience-segments/{audience-segment-id}/contact-list/clear": {
"post": {
"tags": [
"Audience"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/balances/{balanceId}": {
"get": {
"tags": [
"Balance"
],
"summary": "/preview/retail-media/balances/{balanceId}",
"description": "Get a balance for the given balance id.",
"operationId": "GetBalanceV1",
"parameters": [
{
"name": "balanceId",
"in": "path",
"description": "The balance id.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceOutcomeBalanceV1"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Balance_Read"
]
}
]
}
},
"/preview/retail-media/balances/{balanceId}/campaigns/append": {
"post": {
"tags": [
"Campaign"
],
"summary": "/preview/retail-media/balances/{balanceId}/campaigns/append",
"description": "Appends one or more campaigns to the specified balance",
"operationId": "AppendCampaignsToBalanceV1",
"parameters": [
{
"name": "balanceId",
"in": "path",
"description": "The balance to add campaigns from",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The balance campaign appending request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputAppendCampaignsRequestV1"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceOutcomeBalanceCampaignsV1"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/preview/retail-media/balances/{balanceId}/campaigns/delete": {
"post": {
"tags": [
"Campaign"
],
"summary": "/preview/retail-media/balances/{balanceId}/campaigns/delete",
"description": "Deletes one or more campaigns on the specified balance",
"operationId": "DeleteCampaignsFromBalanceV1",
"parameters": [
{
"name": "balanceId",
"in": "path",
"description": "The balance to remove campaigns from",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The balance campaign deleting request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputDeleteCampaignsRequestV1"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceOutcomeBalanceCampaignsV1"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/preview/retail-media/balances/{balanceId}/history": {
"get": {
"tags": [
"Balance"
],
"summary": "/preview/retail-media/balances/{balanceId}/history",
"description": "Gets the balance's historical change data.",
"operationId": "GetBalanceHistoryV1",
"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": 500,
"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/ValueResourceCollectionOutcomeBalanceHistoryChangeDataCaptureV1AndMetadata"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Balance_Read"
]
}
]
}
},
"/preview/retail-media/brands/search": {
"post": {
"tags": [
"Accounts"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/campaigns/{campaign-id}/preferred-line-items": {
"get": {
"tags": [
"Campaign"
],
"summary": "/preview/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": "/preview/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"
]
}
]
}
},
"/preview/retail-media/campaigns/{campaignId}/auction-line-items": {
"get": {
"tags": [
"Campaign"
],
"summary": "/preview/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": "/preview/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"
]
}
]
}
},
"/preview/retail-media/catalog/merchants/{merchantId}/store-inventory/delete": {
"post": {
"tags": [
"Catalog"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/catalog/merchants/{merchantId}/store-inventory/upsert": {
"post": {
"tags": [
"Catalog"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/catalog/products/batch": {
"post": {
"tags": [
"Catalog"
],
"summary": "/preview/retail-media/catalog/products/batch",
"description": "Used to publish a batch of operations to insert, update and deletes products.\n The batch is processed asynchronously.The response provides an operationToken which can be used to track\n the status of the report of the operation.",
"operationId": "SubmitCatalogProductsBatch",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductsCustomBatchRequest"
}
}
},
"required": true,
"x-bodyName": "body"
},
"responses": {
"202": {
"description": "Batch accepted. The status of the operation can be tracked using the report endpoint and the operationToken.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchAcceptedResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Catalog_Manage"
]
}
]
}
},
"/preview/retail-media/catalog/products/batch/report/{operation-token}": {
"get": {
"tags": [
"Catalog"
],
"summary": "/preview/retail-media/catalog/products/batch/report/{operation-token}",
"description": "Get the report of an asynchronous batch operation previously requested",
"operationId": "GetCatalogProductsBatchReport",
"parameters": [
{
"name": "operation-token",
"in": "path",
"description": "The token returned by the batch endpoint.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The report object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportOkResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Catalog_Read"
]
}
]
}
},
"/preview/retail-media/catalogs/{catalogId}/status": {
"get": {
"tags": [
"Campaign"
],
"summary": "/preview/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/EntityResourceOutcomeOfCatalogStatusV2"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/preview/retail-media/chatbot-catalogs/{catalogid}/product-recommendations": {
"post": {
"tags": [
"OnSiteRecommendation"
],
"summary": "/preview/retail-media/chatbot-catalogs/{catalogid}/product-recommendations",
"description": "Ask a chatbot for a product recommendation",
"operationId": "chatbotProductRecommendations",
"parameters": [
{
"name": "catalogid",
"in": "path",
"description": "the identifier of the catalog to query",
"required": true,
"schema": {
"title": "catalogid",
"type": "string",
"description": "the identifier of the catalog to query"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InbotDiscussionBodyModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageBodyModel"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_OnSiteRecommendation_Read"
]
}
]
}
},
"/preview/retail-media/insights/{insightId}/output": {
"get": {
"tags": [
"Analytics"
],
"summary": "/preview/retail-media/insights/{insightId}/output",
"description": "Returns the output of an async insight",
"operationId": "GetInsightReportOutput",
"parameters": [
{
"name": "insightId",
"in": "path",
"description": "The ID of the asynchronous insight report. Must be a valid ID format.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/preview/retail-media/insights/{insightId}/status": {
"get": {
"tags": [
"Analytics"
],
"summary": "/preview/retail-media/insights/{insightId}/status",
"description": "Returns the status of an async insight",
"operationId": "GetInsightReportStatus",
"parameters": [
{
"name": "insightId",
"in": "path",
"description": "The ID of the asynchronous insight report. Must be a valid ID format.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncInsightResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/preview/retail-media/insights/digital-shelf-intelligence": {
"post": {
"tags": [
"Analytics"
],
"summary": "/preview/retail-media/insights/digital-shelf-intelligence",
"description": "Generate a Digital Shelf Intelligence insight",
"operationId": "GenerateDigitalShelfIntelligenceInsight",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DigitalShelfIntelligenceInsightRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncInsightResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/preview/retail-media/insights/share-of-voice": {
"post": {
"tags": [
"Analytics"
],
"summary": "/preview/retail-media/insights/share-of-voice",
"description": "Generate a share of voice insight",
"operationId": "GenerateShareOfVoiceInsight",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShareOfVoiceInsightRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncInsightResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/preview/retail-media/line-items/{line-item-id}/product-buttons": {
"get": {
"tags": [
"Campaign"
],
"summary": "/preview/retail-media/line-items/{line-item-id}/product-buttons",
"description": "Get LineItem Product Buttons",
"operationId": "GetProductButtonsByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "LineItemId for productButton retrieval",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "ProductButtons found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductButtonResponseListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}": {
"delete": {
"tags": [
"Campaign"
],
"summary": "/preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}",
"description": "Delete Specific Product Button",
"operationId": "DeleteProductButtonByLineItemAndProductButtonId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "LineItemId for productButton delete",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "product-button-id",
"in": "path",
"description": "productButtonId used for delete",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "ProductButton deleted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductButtonResponseListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
},
"get": {
"tags": [
"Campaign"
],
"summary": "/preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}",
"description": "Get Specific Product Button",
"operationId": "GetProductButtonByLineItemAndProductButtonId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "LineItemId for productButton retrieval",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "product-button-id",
"in": "path",
"description": "productButtonId used for retrieval",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "ProductButton found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductButtonResponseListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
},
"put": {
"tags": [
"Campaign"
],
"summary": "/preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}",
"description": "Update Specific Product Button",
"operationId": "UpdateProductButtonByLineItemAndProductButtonId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "LineItemId for productButton update",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "product-button-id",
"in": "path",
"description": "productButtonId used for update",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Specific Product button update info",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductButtonRequestRequest"
}
}
},
"required": true,
"x-bodyName": "productButton"
},
"responses": {
"200": {
"description": "ProductButton updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductButtonResponseListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/preview/retail-media/line-items/{line-item-id}/product-buttons/create": {
"post": {
"tags": [
"Campaign"
],
"summary": "/preview/retail-media/line-items/{line-item-id}/product-buttons/create",
"description": "Add Specific Product Buttons",
"operationId": "AppendProductButtonByLineItemId",
"parameters": [
{
"name": "line-item-id",
"in": "path",
"description": "LineItemId for productButton retrieval",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "List of Product Buttons to append",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductButtonRequestListRequest"
}
}
},
"x-bodyName": "productButtons"
},
"responses": {
"200": {
"description": "ProductButtons added",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProductButtonResponseListResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Manage"
]
}
]
}
},
"/preview/retail-media/line-items/{line-item-id}/products": {
"get": {
"tags": [
"Campaign"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/line-items/{line-item-id}/products/append": {
"post": {
"tags": [
"Campaign"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/line-items/{line-item-id}/products/delete": {
"post": {
"tags": [
"Campaign"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/line-items/{line-item-id}/products/pause": {
"post": {
"tags": [
"Campaign"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/line-items/{line-item-id}/products/unpause": {
"post": {
"tags": [
"Campaign"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/me": {
"get": {
"tags": [
"Gateway"
],
"summary": "/preview/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": [ ]
}
]
}
},
"/preview/retail-media/preferred-line-items/{line-item-id}": {
"get": {
"tags": [
"Campaign"
],
"summary": "/preview/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": "/preview/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"
]
}
]
}
},
"/preview/retail-media/reports/{reportId}/output": {
"get": {
"tags": [
"Analytics"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/reports/{reportId}/status": {
"get": {
"tags": [
"Analytics"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/reports/accounts": {
"post": {
"tags": [
"Analytics"
],
"summary": "/preview/retail-media/reports/accounts",
"description": "Returns an asynchronous Accounts Report\r\n
\r\nThis endpoint is subject to specific rate limits.",
"operationId": "GenerateAsyncAccountsReportV2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncAccountsReportRequest"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncReportResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/preview/retail-media/reports/attributed-transactions": {
"post": {
"tags": [
"Analytics"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/reports/campaigns": {
"post": {
"tags": [
"Analytics"
],
"summary": "/preview/retail-media/reports/campaigns",
"description": "Return an asynchronous Campaigns Report\r\n
\r\nThis endpoint is subject to specific rate limits.",
"operationId": "GenerateAsyncCampaignsReportV2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncCampaignsReportRequest"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncReportResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/preview/retail-media/reports/fillrate": {
"post": {
"tags": [
"Analytics"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/reports/line-items": {
"post": {
"tags": [
"Analytics"
],
"summary": "/preview/retail-media/reports/line-items",
"description": "Returns an asynchronous Line Items Report\r\n
\r\nThis endpoint is subject to specific rate limits.",
"operationId": "GenerateAsyncLineItemsReportV2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncLineItemsReportRequest"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncReportResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/preview/retail-media/reports/missed-opportunities": {
"post": {
"tags": [
"Analytics"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/reports/offsite": {
"post": {
"tags": [
"Analytics"
],
"summary": "/preview/retail-media/reports/offsite",
"description": "Returns an asynchronous Offsite Report\r\n
\r\nThis endpoint is subject to specific rate limits.",
"operationId": "GenerateAsyncOffsiteReport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncOffsiteReportRequest"
}
}
},
"required": true,
"x-bodyName": "request"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncReportResponse"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Analytics_Read"
]
}
]
}
},
"/preview/retail-media/reports/performance": {
"post": {
"tags": [
"Analytics"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/reports/sync/attributed-transactions": {
"post": {
"tags": [
"Analytics"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/reports/sync/campaigns": {
"post": {
"tags": [
"Analytics"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/reports/sync/line-items": {
"post": {
"tags": [
"Analytics"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/reports/sync/real-time-performance": {
"post": {
"tags": [
"Analytics"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/reports/unfilled-placements": {
"post": {
"tags": [
"Analytics"
],
"summary": "/preview/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"
]
}
]
}
},
"/preview/retail-media/retailers/{retailer-id}/offers/update": {
"post": {
"tags": [
"Catalog"
],
"summary": "/preview/retail-media/retailers/{retailer-id}/offers/update",
"description": "Update one or more offers by replacing each offer's price and availability with the given values",
"operationId": "OfferUpdateV1",
"parameters": [
{
"name": "retailer-id",
"in": "path",
"description": "The retailer for which these offers will be updated",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Collection of offer price and availability updates to be applied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputUpdateOffersRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Outcome"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Catalog_Manage"
]
}
]
}
},
"/preview/retail-media/retailers/{retailer-id}/products/set-buy-box-winners": {
"post": {
"tags": [
"Catalog"
],
"summary": "/preview/retail-media/retailers/{retailer-id}/products/set-buy-box-winners",
"description": "Update the buy box winner for one or more products",
"operationId": "OfferSetBbwV1",
"parameters": [
{
"name": "retailer-id",
"in": "path",
"description": "The retailer for which these buy box winners will be set",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Updated buy box winners for one or more products",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputSetProductBuyBoxWinnersRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Outcome"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Catalog_Manage"
]
}
]
}
},
"/preview/retail-media/retailers/{retailerId}/compute-display-min-bid": {
"post": {
"tags": [
"Campaign"
],
"summary": "/preview/retail-media/retailers/{retailerId}/compute-display-min-bid",
"description": "Computes the min bid for relevant page types based on the provided information",
"operationId": "ComputeDisplayMinBidByRetailerId",
"parameters": [
{
"name": "retailerId",
"in": "path",
"description": "The retailer id",
"required": true,
"schema": {
"type": "string",
"format": "int32"
}
}
],
"requestBody": {
"description": "The details for what creatives and product ids to use to compute the min bids",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputDisplayAuctionMinBidRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceCollectionOutcomeDisplayAuctionMinBidResult"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_Campaign_Read"
]
}
]
}
},
"/preview/retail-media/third-party-accounts/{accountId}/brands/{brandId}/remove": {
"post": {
"tags": [
"ThirdPartyAccounts"
],
"summary": "/preview/retail-media/third-party-accounts/{accountId}/brands/{brandId}/remove",
"description": "Attempt to remove the provided brand from the account.",
"operationId": "RemoveThirdPartyAccountBrand",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "account id to remove brand from",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "brandId",
"in": "path",
"description": "brand to remove",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceOutcomeOfRetailMediaBrands"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_ThirdPartyAccounts_Manage"
]
}
]
}
},
"/preview/retail-media/third-party-accounts/{accountId}/brands/add": {
"post": {
"tags": [
"ThirdPartyAccounts"
],
"summary": "/preview/retail-media/third-party-accounts/{accountId}/brands/add",
"description": "add the provided brands to an account. This will not remove any existing brands.",
"operationId": "AddThirdPartyAccountBrands",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "account to add brands to",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "list of bands to add to an account",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputOfRetailMediaBrands"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceOutcomeOfRetailMediaBrands"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_ThirdPartyAccounts_Manage"
]
}
]
}
},
"/preview/retail-media/third-party-accounts/{accountId}/create-brand-account": {
"post": {
"tags": [
"ThirdPartyAccounts"
],
"summary": "/preview/retail-media/third-party-accounts/{accountId}/create-brand-account",
"description": "Create a private market demand brand account under a given parent account.",
"operationId": "CreateThirdPartyBrandAccount",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "parent supply account to create account under",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputOfRetailMediaBrandAccountCreationV2"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceOutcomeOfRetailMediaAccountV2"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_ThirdPartyAccounts_Manage"
]
}
]
}
},
"/preview/retail-media/third-party-accounts/{accountId}/create-seller-account": {
"post": {
"tags": [
"ThirdPartyAccounts"
],
"summary": "/preview/retail-media/third-party-accounts/{accountId}/create-seller-account",
"description": "Create a private market demand seller account under a given parent account.",
"operationId": "CreateThirdPartySellerAccount",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "parent supply account to create account under",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResourceInputOfRetailMediaSellerAccountCreationV2"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityResourceOutcomeOfRetailMediaAccountV2"
}
}
}
}
},
"security": [
{
"oauth": [
"RetailMedia_ThirdPartyAccounts_Manage"
]
}
]
}
},
"/preview/retail-media/third-party-accounts/{accountId}/sellers": {
"put": {
"tags": [
"ThirdPartyAccounts"
],
"summary": "/preview/retail-media/third-party-accounts/{accountId}/sellers",
"description": "Update the list of sellers mapped to the account. This will override any existing mappings.",
"operationId": "UpdateThirdPartyAccountSellers",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "accountId to update sellers for",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"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_ThirdPartyAccounts_Manage"
]
}
]
}
}
},
"components": {
"schemas": {
"AppendCampaignsRequestV1": {
"required": [
"ids"
],
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ids of the campaigns that are going to be appended to balance campaigns mapping."
}
},
"additionalProperties": false,
"description": "Request object for appending campaigns to balance campaigns mapping."
},
"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"
},
"AsyncAccountsReport": {
"required": [
"accountIds",
"endDate",
"startDate"
],
"type": "object",
"properties": {
"accountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Account Ids to report on"
},
"activationPlatforms": {
"type": "array",
"items": {
"enum": [
"CommerceMax",
"PrivateMarket"
],
"type": "string"
},
"description": "Filter on the activation platform: CommerceMax, PrivateMarket"
},
"aggregationLevel": {
"enum": [
"campaign",
"lineItem"
],
"type": "string",
"description": "Level of aggregation, if no dimensions and metrics are provided, falls back to campaign aggregationLevel",
"default": "campaign"
},
"budgetModels": {
"type": "array",
"items": {
"enum": [
"CriteoBudget",
"RetailerBudget"
],
"type": "string"
},
"description": "Filter on the budget model: CriteoBudget, RetailerBudget"
},
"buyTypes": {
"type": "array",
"items": {
"enum": [
"auction",
"preferredDeals",
"sponsorship"
],
"type": "string"
},
"description": "Filter on the buy type: auction, preferredDeals, sponsorship"
},
"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",
"mediaType",
"buyType",
"budgetModel",
"activationPlatform",
"environment",
"pageTypeName",
"pageCategory",
"servedCategory",
"taxonomyBreadcrumb",
"keyword",
"searchTerm",
"searchTermType",
"searchTermTargeting",
"creativeId",
"creativeName",
"creativeTypeId",
"creativeTypeName",
"creativeTemplateId",
"creativeTemplateName",
"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-compact"
},
"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": [
"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"
},
"description": "List of metrics to report on"
},
"reportType": {
"enum": [
"summary",
"pageType",
"keyword",
"productCategory",
"product",
"attributedTransactions",
"environment",
"servedCategory",
"capout"
],
"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"
},
"searchTermTargetings": {
"type": "array",
"items": {
"enum": [
"unknown",
"automatic",
"manual"
],
"type": "string"
},
"description": "Filter on the type of search term targeting: unknown, automatic, manual"
},
"searchTermTypes": {
"type": "array",
"items": {
"enum": [
"unknown",
"searched",
"entered"
],
"type": "string"
},
"description": "Filter on the type of search term type: unknown, searched, entered"
},
"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"
}
},
"description": "Async Accounts report body request"
},
"AsyncAccountsReportRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AsyncAccountsReportResource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value"
},
"AsyncAccountsReportResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AsyncAccountsReport"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"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"
},
"AsyncCampaignsReport": {
"required": [
"endDate",
"startDate"
],
"type": "object",
"properties": {
"activationPlatforms": {
"type": "array",
"items": {
"enum": [
"CommerceMax",
"PrivateMarket"
],
"type": "string"
},
"description": "Filter on the activation platform: CommerceMax, PrivateMarket"
},
"budgetModels": {
"type": "array",
"items": {
"enum": [
"CriteoBudget",
"RetailerBudget"
],
"type": "string"
},
"description": "Filter on the budget model: CriteoBudget, RetailerBudget"
},
"buyTypes": {
"type": "array",
"items": {
"enum": [
"auction",
"preferredDeals",
"sponsorship"
],
"type": "string"
},
"description": "Filter on the buy type: auction, preferredDeals, sponsorship"
},
"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",
"mediaType",
"buyType",
"budgetModel",
"activationPlatform",
"environment",
"pageTypeName",
"pageCategory",
"servedCategory",
"taxonomyBreadcrumb",
"keyword",
"searchTerm",
"searchTermType",
"searchTermTargeting",
"creativeId",
"creativeName",
"creativeTypeId",
"creativeTypeName",
"creativeTemplateId",
"creativeTemplateName",
"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-compact"
},
"id": {
"type": "string",
"description": "Campaign id to report on"
},
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Campaign ids to report on"
},
"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": [
"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"
},
"description": "List of metrics to report on"
},
"reportType": {
"enum": [
"summary",
"pageType",
"keyword",
"productCategory",
"product",
"attributedTransactions",
"environment",
"servedCategory",
"capout"
],
"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"
},
"searchTermTargetings": {
"type": "array",
"items": {
"enum": [
"unknown",
"automatic",
"manual"
],
"type": "string"
},
"description": "Filter on the type of search term targeting: unknown, automatic, manual"
},
"searchTermTypes": {
"type": "array",
"items": {
"enum": [
"unknown",
"searched",
"entered"
],
"type": "string"
},
"description": "Filter on the type of search term type: unknown, searched, entered"
},
"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"
}
},
"description": "Async Campaigns report body request"
},
"AsyncCampaignsReportRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AsyncCampaignsReportResource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value"
},
"AsyncCampaignsReportResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AsyncCampaignsReport"
},
"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"
},
"AsyncInsightResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/InsightStatusResponseResource"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"description": "Errors that occured during this call.",
"nullable": true,
"readOnly": true
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommonProblem"
},
"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."
},
"AsyncLineItemsReport": {
"required": [
"endDate",
"startDate"
],
"type": "object",
"properties": {
"activationPlatforms": {
"type": "array",
"items": {
"enum": [
"CommerceMax",
"PrivateMarket"
],
"type": "string"
},
"description": "Filter on the activation platform: CommerceMax, PrivateMarket"
},
"budgetModels": {
"type": "array",
"items": {
"enum": [
"CriteoBudget",
"RetailerBudget"
],
"type": "string"
},
"description": "Filter on the budget model: CriteoBudget, RetailerBudget"
},
"buyTypes": {
"type": "array",
"items": {
"enum": [
"auction",
"preferredDeals",
"sponsorship"
],
"type": "string"
},
"description": "Filter on the buy type: auction, preferredDeals, sponsorship"
},
"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",
"mediaType",
"buyType",
"budgetModel",
"activationPlatform",
"environment",
"pageTypeName",
"pageCategory",
"servedCategory",
"taxonomyBreadcrumb",
"keyword",
"searchTerm",
"searchTermType",
"searchTermTargeting",
"creativeId",
"creativeName",
"creativeTypeId",
"creativeTypeName",
"creativeTemplateId",
"creativeTemplateName",
"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-compact"
},
"id": {
"type": "string",
"description": "Line Item id to report on"
},
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Line Item ids to report on"
},
"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": [
"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"
},
"description": "List of metrics to report on"
},
"reportType": {
"enum": [
"summary",
"pageType",
"keyword",
"productCategory",
"product",
"attributedTransactions",
"environment",
"servedCategory",
"capout"
],
"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"
},
"searchTermTargetings": {
"type": "array",
"items": {
"enum": [
"unknown",
"automatic",
"manual"
],
"type": "string"
},
"description": "Filter on the type of search term targeting: unknown, automatic, manual"
},
"searchTermTypes": {
"type": "array",
"items": {
"enum": [
"unknown",
"searched",
"entered"
],
"type": "string"
},
"description": "Filter on the type of search term type: unknown, searched, entered"
},
"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"
}
},
"description": "Async Line Items report body request"
},
"AsyncLineItemsReportRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AsyncLineItemsReportResource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value"
},
"AsyncLineItemsReportResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AsyncLineItemsReport"
},
"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"
},
"AsyncOffsiteReport": {
"required": [
"accountIds",
"dimensions",
"endDate",
"metrics",
"startDate"
],
"type": "object",
"properties": {
"accountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Account ids to report on"
},
"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"
},
"creativeIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Creative ids to filter"
},
"dimensions": {
"minItems": 1,
"type": "array",
"items": {
"enum": [
"date",
"hour",
"daysDifference",
"advDate",
"advHour",
"campaignId",
"campaignName",
"lineItemId",
"lineItemName",
"retailerId",
"retailerName",
"billingType",
"environment",
"adFormatSize",
"ssp",
"publisher",
"inventoryType",
"mediaType",
"buyType",
"salesChannel",
"creativeId",
"creativeName"
],
"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-compact"
},
"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": {
"minItems": 1,
"type": "array",
"items": {
"enum": [
"audience",
"uniqueVisitors",
"reachRate",
"impressions",
"frequency",
"winRate",
"clicks",
"ctr",
"viewability",
"cpc",
"ecpm",
"cpm",
"spend",
"attributedUnits",
"attributedSales",
"roas",
"videoStarts",
"videosPlayedTo25",
"videosPlayedTo50",
"videosPlayedTo75",
"videosPlayedTo100",
"videoStartingRate",
"videoCompletionRate",
"videoCPC",
"videoCPCV",
"visits",
"qualifiedVisits",
"landingRate"
],
"type": "string"
},
"description": "List of metrics to report on"
},
"retailerIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Retailer ids to filter"
},
"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": "Async Offsite report body request"
},
"AsyncOffsiteReportRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AsyncOffsiteReportResource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value"
},
"AsyncOffsiteReportResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AsyncOffsiteReport"
},
"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"
},
"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"
},
"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"
},
"BalanceCampaignsV1": {
"required": [
"ids"
],
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ids of the campaigns that are mapped to the balance."
}
},
"additionalProperties": false,
"description": "Balance campaigns mapping object.",
"nullable": true
},
"BalanceHistoryChangeDataCaptureV1": {
"required": [
"changeDetails",
"changeType",
"dateOfModification",
"modifiedByUser"
],
"type": "object",
"properties": {
"changeDetails": {
"$ref": "#/components/schemas/ChangeDetailsV1"
},
"changeType": {
"enum": [
"balanceCreated",
"balanceAdded",
"balanceRemoved",
"balanceUncapped",
"balanceCapped",
"endDate",
"startDate",
"balanceName",
"retailerPoNumber",
"criteoPoNumber",
"retailerId",
"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.",
"nullable": true
},
"BalanceV1": {
"required": [
"balanceType",
"createdAt",
"deposited",
"name",
"privateMarketBillingType",
"remaining",
"spendType",
"spent",
"startDate",
"status",
"updatedAt"
],
"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"
},
"criteoPoNumber": {
"type": "string",
"description": "Criteo purchase order number.",
"nullable": true
},
"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."
},
"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"
},
"retailerId": {
"type": "string",
"description": "The billing retailer id.",
"nullable": true
},
"retailerPoNumber": {
"type": "string",
"description": "Retailer purchase order number.",
"nullable": true
},
"spendType": {
"enum": [
"onsite",
"offsite",
"offsiteAwareness",
"lockout",
"unknown"
],
"type": "string",
"description": "Spend Type of the balance."
},
"spent": {
"type": "number",
"description": "Amount of spent funds of the balance.",
"format": "double"
},
"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"
}
},
"additionalProperties": false,
"description": "A Retail Media Balance used to determine the funds available for any or all campaigns in an account.",
"nullable": true
},
"BatchAcceptedResponse": {
"required": [
"operationToken"
],
"type": "object",
"properties": {
"operationToken": {
"type": "string"
}
},
"description": "A batch was accepted. The report can be accessed using the reporting endpoint."
},
"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"
},
"BotMessage": {
"title": "BotMessage",
"type": "object",
"properties": {
"closing": {
"title": "Closing",
"type": "string",
"description": "closing remark from the bot",
"nullable": true
},
"opening": {
"title": "Opening",
"type": "string",
"description": "opening comment from the bot, introducing the list of recommended products if relevant.",
"nullable": true
},
"productRecos": {
"title": "Productrecos",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductRecommendation"
},
"description": "list of recommended products",
"nullable": true
}
},
"description": "bot structured answer to the user prompt",
"nullable": true
},
"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
},
"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"
},
"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
},
"ChangeDetailsV1": {
"type": "object",
"properties": {
"changeValue": {
"type": "string",
"description": "Change amount 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."
},
"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
},
"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."
},
"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
},
"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."
},
"CreativeCreateModel2": {
"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"
},
"CreativeSearchRequest": {
"type": "object",
"properties": {
"brandIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string"
},
"description": "Brand Id of the search filter",
"nullable": true
},
"creativeIds": {
"maxItems": 500,
"type": "array",
"items": {
"type": "string"
},
"description": "Search Id",
"nullable": true
},
"creativeName": {
"type": "string",
"description": "Name to search",
"nullable": true
},
"creativeTypes": {
"type": "array",
"items": {
"enum": [
"CommerceDisplay",
"CommerceVideo",
"StandardVideo",
"StandardDisplay"
],
"type": "string"
},
"description": "Creative type",
"nullable": true
},
"pageTypes": {
"type": "array",
"items": {
"enum": [
"Unknown",
"Search",
"Home",
"Browse",
"Checkout",
"Category",
"ProductDetail",
"Confirmation",
"Merchandising",
"Deals",
"Favorites",
"SearchBar",
"CategoryMenu"
],
"type": "string"
},
"description": "Page type",
"nullable": true
},
"retailerIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string"
},
"description": "RetailerId of the search filter",
"nullable": true
},
"templateIds": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string"
},
"description": "Id of the template this creative was created on",
"nullable": true
}
},
"additionalProperties": false,
"description": "Creative search request model"
},
"CreativeSearchResponse": {
"type": "object",
"properties": {
"brandId": {
"type": "string",
"description": "Brand Id of the search filter",
"nullable": true
},
"createdAt": {
"type": "string",
"description": "Time search is created",
"format": "date-time",
"nullable": true
},
"creativeType": {
"enum": [
"Unknown",
"CommerceDisplay",
"CommerceVideo",
"StandardVideo",
"StandardDisplay"
],
"type": "string",
"description": "Creative type",
"nullable": true
},
"lineItems": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of lineitems",
"nullable": true
},
"modifiedAt": {
"type": "string",
"description": "Time it's modified",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"description": "Name of the creative",
"nullable": true
},
"pageType": {
"type": "array",
"items": {
"enum": [
"Unknown",
"Search",
"Home",
"Browse",
"Checkout",
"Category",
"ProductDetail",
"Confirmation",
"Merchandising",
"Deals",
"Favorites",
"SearchBar",
"CategoryMenu"
],
"type": "string"
},
"description": "Page type",
"nullable": true
},
"preview": {
"type": "string",
"description": "Preview url of the creative",
"nullable": true
},
"retailerId": {
"type": "string",
"description": "RetailerId of the search filter",
"nullable": true
},
"status": {
"enum": [
"Ready",
"In Use",
"Archived"
],
"type": "string",
"description": "The search status",
"nullable": true
},
"templateId": {
"type": "string",
"description": "Template Id",
"nullable": true
}
},
"additionalProperties": false,
"description": "Creative search response model",
"nullable": true
},
"CreativeUpdateModel2": {
"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"
},
"CustomAttribute": {
"required": [
"name",
"value"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the attribute. Underscores will be replaced by spaces upon insertion."
},
"value": {
"type": "string",
"description": "The value of the attribute."
}
},
"description": "Defines a custom attribute of a product."
},
"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
},
"DeleteCampaignsRequestV1": {
"required": [
"ids"
],
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ids of the campaigns that are going to be deleted from balance campaigns mapping."
}
},
"additionalProperties": false,
"description": "Request object for deleting campaigns from balance campaigns mapping."
},
"DeleteEntry": {
"required": [
"attributes",
"type"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/StoreInventoryDelete"
},
"type": {
"enum": [
"Delete"
],
"type": "string"
}
},
"description": "Defines a reference to inventory"
},
"DigitalShelfIntelligenceInsight": {
"required": [
"accountId",
"aggregationLevel",
"endDate",
"metrics",
"startDate"
],
"type": "object",
"properties": {
"accountId": {
"type": "string"
},
"aggregationLevel": {
"enum": [
"brand",
"sku"
],
"type": "string"
},
"brandIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"categories": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time"
},
"format": {
"enum": [
"json",
"json-compact",
"json-newline",
"csv"
],
"type": "string",
"default": "json-compact"
},
"metrics": {
"minItems": 1,
"type": "array",
"items": {
"enum": [
"considerationIndex",
"listingPrice",
"pdpViewRank",
"salesIndex",
"salesRank",
"totalPdpPageViews",
"totalSalesOnline",
"totalSoldUnitsOnline"
],
"type": "string"
}
},
"retailerIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"skuIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SkuFilter"
},
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false,
"description": "Description of a Digital Shelf Intelligence insight"
},
"DigitalShelfIntelligenceInsightRequest": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DigitalShelfIntelligenceInsightResource"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"DigitalShelfIntelligenceInsightResource": {
"required": [
"attributes"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/DigitalShelfIntelligenceInsight"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"DisplayAuctionMinBidRequest": {
"type": "object",
"properties": {
"creativeIds": {
"maxItems": 50,
"minItems": 1,
"type": "array",
"items": {
"type": "string"
},
"description": "List of Creatives to use"
},
"productIds": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string"
},
"description": "List of potential product ids (SkuIds) to put in creatives",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents the list of creatives and respective product IDs to compute min bid for."
},
"DisplayAuctionMinBidResult": {
"type": "object",
"properties": {
"creativeId": {
"type": "string",
"description": "The creativeId for the creative",
"nullable": true
},
"minBid": {
"type": "number",
"description": "The minimum bid for the combination of page type, creative and categories",
"format": "double",
"nullable": true
},
"pageType": {
"enum": [
"unknown",
"search",
"home",
"checkout",
"category",
"productDetail",
"confirmation",
"merchandising",
"deals",
"favorites",
"searchBar",
"categoryMenu"
],
"type": "string",
"description": "Page type for the creative to display on",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents the min bid for a pageType and creative combination.",
"nullable": true
},
"EntityResourceBalanceV1": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/BalanceV1"
},
"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
},
"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."
},
"EntityResourceCollectionOutcomeBalanceV1AndMetadata": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResourceBalanceV1"
},
"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."
},
"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."
},
"EntityResourceCollectionOutcomeCreativeSearchResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResourceCreativeSearchResponse"
},
"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 entities."
},
"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."
},
"EntityResourceCreativeSearchRequest": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/CreativeSearchRequest"
},
"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."
},
"EntityResourceCreativeSearchResponse": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/CreativeSearchResponse"
},
"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."
},
"EntityResourceInputCreativeSearchRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EntityResourceCreativeSearchRequest"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single entity."
},
"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."
},
"EntityResourceOfRetailMediaAccountV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ExternalRetailMediaAccountV2"
},
"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
},
"EntityResourceOutcomeBalanceV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EntityResourceBalanceV1"
},
"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."
},
"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."
},
"EntityResourceOutcomeOfRetailMediaAccountV2": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EntityResourceOfRetailMediaAccountV2"
},
"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."
},
"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
},
"ExternalRetailMediaAccountV2": {
"type": "object",
"properties": {
"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
},
"payingCompanyName": {
"type": "string",
"description": "Paying 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
},
"ExternalRetailMediaBrandAccountCreationV2": {
"type": "object",
"properties": {
"brands": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "list of brands to link to the new account",
"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
},
"payingCompanyName": {
"type": "string",
"description": "Display name for reporting the owning entity of ads for the Digital Services Act in the European Union",
"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
},
"ExternalRetailMediaSellerAccountCreationV2": {
"required": [
"sellers"
],
"type": "object",
"properties": {
"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
},
"payingCompanyName": {
"type": "string",
"description": "Display name for reporting the owning entity of ads for the Digital Services Act in the European Union",
"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"
},
"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
},
"InbotDiscussion": {
"title": "InbotDiscussion",
"type": "object",
"properties": {
"messages": {
"title": "Messages",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Message"
},
"description": "ordered list of previous messages, alternating between user prompts and bot answers"
}
},
"description": "discussion between the user and the chatbot"
},
"InbotDiscussionBodyModel": {
"title": "InbotDiscussionBodyModel",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/InbotDiscussionDataInstanceModel"
}
},
"description": "an API recommendation message"
},
"InbotDiscussionDataInstanceModel": {
"title": "InbotDiscussionDataInstanceModel",
"required": [
"attributes"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/InbotDiscussion"
},
"type": {
"title": "Type",
"type": "string",
"default": "InbotDiscussion"
}
},
"description": "an API recommendation request"
},
"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"
},
"InsightStatusResponse": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"nullable": true
},
"expiresAt": {
"type": "string",
"nullable": true
},
"fileSizeBytes": {
"type": "integer",
"format": "int64",
"nullable": true
},
"md5CheckSum": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"rowCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"status": {
"enum": [
"Unknown",
"Pending",
"Success",
"Failure",
"Expired",
"Invalidated"
],
"type": "string",
"description": "Status of an async insight request",
"nullable": true
}
},
"additionalProperties": false,
"description": "Status of an async insight request",
"nullable": true
},
"InsightStatusResponseResource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/InsightStatusResponse"
},
"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
},
"Installment": {
"type": "object",
"properties": {
"amount": {
"$ref": "#/components/schemas/Price"
},
"months": {
"type": "integer",
"description": "The number of installments the buyer has to pay.",
"format": "int64"
}
},
"description": "Defines the installment of a product."
},
"LineItemBudgetCapOutHistory": {
"type": "object",
"properties": {
"capoutTimes": {
"type": "object",
"properties": {
"daily": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"nullable": true
},
"hourly": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"nullable": true
},
"monthly": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"nullable": true
},
"total": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "The dictionary of budget type to the list of cap out times up to 3 most recent cap out times",
"nullable": true
},
"lineItemId": {
"type": "string",
"description": "Line Item Id",
"nullable": true
}
},
"additionalProperties": false,
"description": "The cap out history for a line item"
},
"LineItemBudgetCapOutHistoryRequest": {
"required": [
"budgetTypes",
"lineItemIds"
],
"type": "object",
"properties": {
"budgetTypes": {
"type": "array",
"items": {
"enum": [
"total",
"daily",
"monthly",
"hourly"
],
"type": "string",
"description": "The budget type enum"
},
"description": "Budget Types to return cap out history"
},
"lineItemIds": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string"
},
"description": "Line Item Ids to return cap out history"
}
},
"additionalProperties": false,
"description": "The request body for cap out history of line item"
},
"LineItemBudgetCapOutHistoryResponse": {
"type": "object",
"properties": {
"lineItemBudgetCapOutHistories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItemBudgetCapOutHistory"
},
"description": "The list of line item budget cap out histories",
"nullable": true
}
},
"additionalProperties": false,
"description": "The response body for cap out history of line item",
"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
},
"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
},
"LoyaltyPoints": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters."
},
"pointsValue": {
"type": "integer",
"description": "The retailer's loyalty points in absolute value.",
"format": "int64"
},
"ratio": {
"type": "number",
"description": "The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.",
"format": "double"
}
},
"description": "Defines how a client earns loyalty points after buying this product."
},
"Message": {
"title": "Message",
"type": "object",
"properties": {
"botMessage": {
"$ref": "#/components/schemas/BotMessage"
},
"userMessage": {
"title": "Usermessage",
"type": "string",
"description": "user prompt",
"nullable": true
}
},
"description": "message of the discussion"
},
"MessageBodyModel": {
"title": "MessageBodyModel",
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MessageDataInstanceModel"
},
"errors": {
"title": "Errors",
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageError"
},
"nullable": true
}
},
"description": "error message"
},
"MessageDataInstanceModel": {
"title": "MessageDataInstanceModel",
"required": [
"attributes"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Message"
},
"type": {
"title": "Type",
"type": "string",
"default": "Message",
"nullable": true
}
},
"description": "an API answer message",
"nullable": true
},
"MessageError": {
"title": "MessageError",
"type": "object",
"properties": {
"code": {
"title": "Code",
"type": "string",
"description": "error code",
"nullable": true
},
"instance": {
"title": "Instance",
"type": "string",
"description": "specific occurrence of the problem",
"nullable": true
},
"traceId": {
"title": "Traceid",
"type": "string",
"description": "correlation ID, unique to each request",
"nullable": true
},
"type": {
"title": "Type",
"type": "string",
"description": "error category",
"nullable": true
}
},
"description": "error message"
},
"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."
},
"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
},
"NillableOfNullableOfDateOnly": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Underlying actual value",
"nullable": true
}
},
"additionalProperties": false,
"description": "represents a value that can be set to null explicitly",
"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
},
"OfferUpdate": {
"required": [
"availability",
"offerId",
"price"
],
"type": "object",
"properties": {
"availability": {
"enum": [
"outOfStock",
"preOrder",
"inStock",
"backOrder"
],
"type": "string"
},
"offerId": {
"type": "string"
},
"price": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false,
"description": "The state of a single offer after it is replaced as part of an Update operation"
},
"Outcome": {
"type": "object",
"properties": {
"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": "The outcome of an API call."
},
"PageMetadata": {
"required": [
"currentPageSize",
"currentPageIndex"
],
"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
}
},
"description": "Metadata related to the current request"
},
"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"
},
"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
},
"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."
},
"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"
},
"Price": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "The currency of the price."
},
"value": {
"type": "string",
"description": "The price represented as a number. See JSON's number specification for more details."
}
},
"description": "Defines a price."
},
"Product": {
"required": [
"channel",
"id",
"imageLink",
"link",
"title"
],
"type": "object",
"properties": {
"additionalImageLinks": {
"type": "array",
"items": {
"type": "string"
},
"description": "Additional URLs of images of the item."
},
"adsGrouping": {
"type": "string",
"description": "Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise."
},
"adsLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Similar to adsGrouping, but only works on CPC."
},
"adsRedirect": {
"type": "string",
"description": "Allows advertisers to override the item URL when the product is shown within the context of Product Ads."
},
"adult": {
"type": "boolean",
"description": "Set to true if the item is targeted towards adults. RECOMMENDED."
},
"ageGroup": {
"type": "string",
"description": "Target age group of the item."
},
"availability": {
"type": "string",
"description": "Availability status of the item. RECOMMENDED."
},
"availabilityDate": {
"type": "string",
"description": "The day a pre-ordered product becomes available for delivery, in ISO 8601 format."
},
"badge": {
"type": "string",
"description": "URL of a badge image to display on the product."
},
"brand": {
"type": "string",
"description": "Brand of the item. RECOMMENDED."
},
"channel": {
"enum": [
"online"
],
"type": "string",
"description": "The item's channel (online only)."
},
"color": {
"type": "string",
"description": "Color of the item."
},
"condition": {
"type": "string",
"description": "Condition or state of the item."
},
"contentLanguage": {
"type": "string",
"description": "The two-letter ISO 639-1 language code for the item."
},
"costOfGoodsSold": {
"$ref": "#/components/schemas/Price"
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttribute"
},
"description": "A list of custom (merchant-provided) attributes. This is useful for submitting attributes not explicitly exposed by the API. Declaring attributes explicitly exposed by the API using is forbidden"
},
"customLabel0": {
"type": "string",
"description": "Custom label 0 for custom grouping of items in a Shopping campaign."
},
"customLabel1": {
"type": "string",
"description": "Custom label 1 for custom grouping of items in a Shopping campaign."
},
"customLabel2": {
"type": "string",
"description": "Custom label 2 for custom grouping of items in a Shopping campaign."
},
"customLabel3": {
"type": "string",
"description": "Custom label 3 for custom grouping of items in a Shopping campaign."
},
"customLabel4": {
"type": "string",
"description": "Custom label 4 for custom grouping of items in a Shopping campaign."
},
"description": {
"type": "string",
"description": "Description of the item. RECOMMENDED. (5000 UTF8 characters max)."
},
"displayAdsId": {
"type": "string",
"description": "An identifier for an item for dynamic remarketing campaigns."
},
"displayAdsLink": {
"type": "string",
"description": "URL directly to your item's landing page for dynamic remarketing campaigns."
},
"displayAdsSimilarIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Advertiser-specified recommendations."
},
"displayAdsTitle": {
"type": "string",
"description": "Title of an item for dynamic remarketing campaigns."
},
"displayAdsValue": {
"type": "number",
"description": "Offer margin for dynamic remarketing campaigns.",
"format": "double"
},
"energyEfficiencyClass": {
"type": "string",
"description": "The energy efficiency class as defined in EU directive 2010/30/EU."
},
"excludedDestinations": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center)."
},
"expirationDate": {
"type": "string",
"description": "Date on which the item should expire, as specified upon insertion, in ISO 8601 format."
},
"externalSellerId": {
"type": "string",
"description": "The external id of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads."
},
"externalSellerName": {
"type": "string",
"description": "The external name of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads."
},
"filters": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Filter information of the product."
},
"gender": {
"type": "string",
"description": "Target gender of the item."
},
"googleProductCategory": {
"type": "string",
"description": "Google's category of the item (see Google product taxonomy). RECOMMENDED."
},
"gtin": {
"type": "string",
"description": "Global Trade Item Number (GTIN) of the item. RECOMMENDED."
},
"id": {
"type": "string",
"description": "A unique identifier for the item. Aka Product ID. Don’t use casing to make IDs unique."
},
"identifierExists": {
"type": "boolean",
"description": "False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada."
},
"imageLink": {
"type": "string",
"description": "URL of an image of the item. Supported formats: PNG, JPEG, GIF. (2000 UTF8 characters max). "
},
"includedDestinations": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations."
},
"installment": {
"$ref": "#/components/schemas/Installment"
},
"isBundle": {
"type": "boolean",
"description": "Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price."
},
"itemGroupId": {
"type": "string",
"description": "Shared identifier for all variants of the same product. RECOMMENDED. Don’t use casing to make IDs unique. (50 characters max)"
},
"kind": {
"type": "string",
"description": "Identifies what kind of resource this is."
},
"link": {
"type": "string",
"description": "URL directly linking to your item's page on your website. (1000 UTF8 characters max)."
},
"loyaltyPoints": {
"$ref": "#/components/schemas/LoyaltyPoints"
},
"material": {
"type": "string",
"description": "The material of which the item is made."
},
"maxEnergyEfficiencyClass": {
"type": "string",
"description": "The energy efficiency class as defined in EU directive 2010/30/EU."
},
"maxHandlingTime": {
"type": "integer",
"description": "Maximal product handling time (in business days).",
"format": "int64"
},
"minEnergyEfficiencyClass": {
"type": "string",
"description": "The energy efficiency class as defined in EU directive 2010/30/EU."
},
"minHandlingTime": {
"type": "integer",
"description": "Minimal product handling time (in business days).",
"format": "int64"
},
"mobileLink": {
"type": "string",
"description": "accounts.link to a mobile-optimized version of the landing page."
},
"mpn": {
"type": "string",
"description": "Manufacturer Part Number (MPN) of the item. RECOMMENDED."
},
"multipack": {
"type": "integer",
"description": "The number of identical products in a merchant-defined multipack. To avoid any overflow issue, pass it as a string.",
"format": "int64"
},
"numberOfReviews": {
"type": "integer",
"description": "The number of customer reviews for the product",
"format": "int32"
},
"offerId": {
"type": "string",
"description": "Not used by Criteo."
},
"pattern": {
"type": "string",
"description": "The item's pattern (e.g. polka dots)."
},
"price": {
"$ref": "#/components/schemas/Price"
},
"productRating": {
"type": "string",
"description": "The product rating for the product"
},
"productTypeKeys": {
"type": "array",
"items": {
"type": "string"
},
"description": "Category keys of the item (formatted as in productTypes)."
},
"productTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Categories of the item (formatted as in products data specification)."
},
"promotionIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The unique ID of a promotion."
},
"salePrice": {
"$ref": "#/components/schemas/Price"
},
"salePriceEffectiveDate": {
"type": "string",
"description": "Date range during which the item is on sale."
},
"sellerId": {
"type": "string",
"description": "(Deprecated Field) The external ID of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads."
},
"sellOnGoogleQuantity": {
"type": "integer",
"description": "The quantity of the product that is available for selling on Google. Supported only for online products.",
"format": "int64"
},
"shipping": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductShipping"
},
"description": "Shipping rules."
},
"shippingHeight": {
"$ref": "#/components/schemas/ProductShippingDimension"
},
"shippingLabel": {
"type": "string",
"description": "The shipping label of the product, used to group product in account-level shipping rules."
},
"shippingLength": {
"$ref": "#/components/schemas/ProductShippingDimension"
},
"shippingWeight": {
"$ref": "#/components/schemas/ProductShippingWeight"
},
"shippingWidth": {
"$ref": "#/components/schemas/ProductShippingDimension"
},
"sizes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Size of the item. RECOMMENDED. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same itemGroupId value."
},
"sizeSystem": {
"type": "string",
"description": "System in which the size is specified. Recommended for apparel items."
},
"sizeType": {
"type": "string",
"description": "The cut of the item. Recommended for apparel items."
},
"source": {
"type": "string",
"description": "The source of the offer, i.e., how the offer was created."
},
"targetCountry": {
"type": "string",
"description": "The CLDR territory code for the item."
},
"taxCategory": {
"type": "string",
"description": "The tax category of the product, used to configure detailed tax nexus in account-level tax settings."
},
"taxes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductTax"
},
"description": "Tax information."
},
"title": {
"type": "string",
"description": "Title of the item. (500 UTF8 characters max)."
},
"transitTimeLabel": {
"type": "string",
"description": "The transit time label of the product, used to group product in account-level transit time tables."
},
"unitPricingBaseMeasure": {
"$ref": "#/components/schemas/ProductUnitPricingBaseMeasure"
},
"unitPricingMeasure": {
"$ref": "#/components/schemas/ProductUnitPricingMeasure"
}
},
"description": "Defines a product to be inserted or updated."
},
"ProductButtonRequest": {
"required": [
"name",
"backgroundImage",
"isMandatory",
"skus"
],
"type": "object",
"properties": {
"backgroundImage": {
"type": "string",
"description": "URL of the background image"
},
"isMandatory": {
"type": "integer",
"description": "If the Product Button is Mandatory",
"format": "int32"
},
"name": {
"type": "string",
"description": "Name of the Product Button"
},
"skus": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of skus on the Product Button"
}
},
"description": "The Product Button entity used for Input"
},
"ProductButtonRequestListRequest": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceOfProductButtonRequest"
}
}
},
"description": "A top-level object that encapsulates a Criteo API request for several entities",
"nullable": true
},
"ProductButtonRequestRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ResourceOfProductButtonRequest"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single entity",
"nullable": true
},
"ProductButtonResponse": {
"required": [
"name",
"backgroundImage",
"rank",
"isMandatory",
"skus"
],
"type": "object",
"properties": {
"backgroundImage": {
"type": "string",
"description": "URL of the background image"
},
"isMandatory": {
"type": "integer",
"description": "If the Product Button is Mandatory",
"format": "int32"
},
"name": {
"type": "string",
"description": "Name of the Product Button"
},
"rank": {
"type": "integer",
"description": "Rank of the Product Button",
"format": "int32"
},
"skus": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of skus on the Product Button"
}
},
"description": "The Product Button entity"
},
"ProductButtonResponseListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceOfProductButtonResponse"
},
"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",
"nullable": true
},
"ProductBuyBoxWinner": {
"required": [
"offerId"
],
"type": "object",
"properties": {
"offerId": {
"type": "string"
}
},
"additionalProperties": false,
"description": "The new buy box winner for a product after it is updated as part of a SetBuyBoxWinner operation"
},
"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
},
"ProductRecommendation": {
"title": "ProductRecommendation",
"required": [
"rationale"
],
"type": "object",
"properties": {
"brand": {
"title": "Brand",
"type": "string",
"description": "brand of the product",
"nullable": true
},
"currency": {
"title": "Currency",
"type": "string",
"description": "currency of the price of the product",
"nullable": true
},
"description": {
"title": "Description",
"type": "string",
"description": "description of the product",
"nullable": true
},
"imageUrl": {
"title": "Imageurl",
"maxLength": 65536,
"minLength": 1,
"type": "string",
"description": "url of the product image",
"format": "uri",
"nullable": true
},
"name": {
"title": "Name",
"type": "string",
"description": "name of the product",
"nullable": true
},
"price": {
"title": "Price",
"type": "number",
"description": "numerical value of the price of the product",
"nullable": true
},
"rationale": {
"title": "Rationale",
"type": "string",
"description": "reason for this recommendation, given by the bot"
},
"url": {
"title": "Url",
"maxLength": 65536,
"minLength": 1,
"type": "string",
"description": "url of the product on the retailer website",
"format": "uri",
"nullable": true
}
},
"description": "recommendation data for a product"
},
"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."
},
"ProductsCustomBatchRequest": {
"required": [
"entries"
],
"type": "object",
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductsCustomBatchRequestEntry"
},
"description": "The request entries to be processed in the batch."
}
},
"description": "Defines a batch of operations."
},
"ProductsCustomBatchRequestEntry": {
"required": [
"merchantId",
"method"
],
"type": "object",
"properties": {
"batchId": {
"type": "integer",
"description": "An entry ID, unique within the batch request.",
"format": "int64"
},
"feedId": {
"type": "string",
"description": "Not used by Criteo."
},
"itemGroupId": {
"type": "string",
"description": "Deprecated (providing this information is no more needed, this field will be removed in next release). The itemGroupId of the product to delete. To be defined when the method is delete and the product is a variant."
},
"merchantId": {
"type": "integer",
"description": "The ID of the managing account. Criteo: the partnerId.",
"format": "int32"
},
"method": {
"enum": [
"delete",
"insert"
],
"type": "string",
"description": "The method of the batch entry."
},
"product": {
"$ref": "#/components/schemas/Product"
},
"productId": {
"type": "string",
"description": "The Product ID to delete. Only defined if the method is delete."
}
},
"description": "A product event for a batch request."
},
"ProductShipping": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "The CLDR territory code of the country to which an item will ship."
},
"locationGroupName": {
"type": "string",
"description": "The location where the shipping is applicable, represented by a location group name."
},
"locationId": {
"type": "integer",
"description": "The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.",
"format": "int64"
},
"postalCode": {
"type": "string",
"description": "The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length."
},
"price": {
"$ref": "#/components/schemas/Price"
},
"region": {
"type": "string",
"description": "The geographic region to which a shipping rate applies."
},
"service": {
"type": "string",
"description": "A free-form description of the service class or delivery speed."
}
},
"description": "Defines the shipping information of a product."
},
"ProductShippingDimension": {
"type": "object",
"properties": {
"unit": {
"type": "string",
"description": "The unit of value."
},
"value": {
"type": "number",
"description": "The dimension of the product used to calculate the shipping cost of the item.",
"format": "double"
}
},
"description": "Defines the shipping dimension of a product."
},
"ProductShippingWeight": {
"type": "object",
"properties": {
"unit": {
"type": "string",
"description": "The unit of value."
},
"value": {
"type": "number",
"description": "The weight of the product used to calculate the shipping cost of the item.",
"format": "double"
}
},
"description": "Defines the shipping weight of a product."
},
"ProductTax": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "The country within which the item is taxed, specified as a CLDR territory code."
},
"locationId": {
"type": "integer",
"description": "The numeric ID of a location that the tax rate applies to as defined in the AdWords API.",
"format": "int64"
},
"postalCode": {
"type": "string",
"description": "The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*."
},
"rate": {
"type": "number",
"description": "The percentage of tax rate that applies to the item price.",
"format": "double"
},
"region": {
"type": "string",
"description": "The geographic region to which the tax rate applies."
},
"taxShip": {
"type": "boolean",
"description": "Set to true if tax is charged on shipping."
}
},
"description": "Defines the tax information of a product."
},
"ProductUnitPricingBaseMeasure": {
"type": "object",
"properties": {
"unit": {
"type": "string",
"description": "The unit of the denominator."
},
"value": {
"type": "integer",
"description": "The denominator of the unit price.",
"format": "int64"
}
},
"description": "Defines a measurement."
},
"ProductUnitPricingMeasure": {
"type": "object",
"properties": {
"unit": {
"type": "string",
"description": "The unit of measure."
},
"value": {
"type": "number",
"description": "The measurement of an item.",
"format": "double"
}
},
"description": "Defines a measurement."
},
"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."
},
"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
},
"ReportDetailError": {
"required": [
"isServerRelated",
"message",
"type"
],
"type": "object",
"properties": {
"isServerRelated": {
"type": "boolean"
},
"message": {
"type": "string"
},
"type": {
"enum": [
"UnknownError",
"InvalidBigImageUrl",
"InvalidProductId",
"InvalidProductUrl",
"InvalidSmallImageUrl",
"JsonParsingIssue",
"MissingID",
"MissingImages",
"MissingName",
"MissingURL",
"NonAsciiId",
"OverlargeBigImage",
"OverlargeID",
"OverlargeSmallImage",
"OverlargeURL",
"ConfigurationError"
],
"type": "string"
}
},
"description": "An error on a batch operation."
},
"ReportDetailErrors": {
"required": [
"errors",
"productId"
],
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportDetailError"
}
},
"productId": {
"type": "string",
"description": "The product ID in lowercase"
}
},
"description": "A list of errors on a batch operation."
},
"ReportDetailWarning": {
"required": [
"isServerRelated",
"message",
"type"
],
"type": "object",
"properties": {
"isServerRelated": {
"type": "boolean"
},
"message": {
"type": "string"
},
"type": {
"enum": [
"OverlargeBadgeUrl",
"InvalidBadgeUrl"
],
"type": "string"
}
},
"description": "A warning on a batch operation."
},
"ReportDetailWarnings": {
"required": [
"productId",
"warnings"
],
"type": "object",
"properties": {
"productId": {
"type": "string"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportDetailWarning"
}
}
},
"description": "A list of warnings on a batch operation."
},
"ReportOkResponse": {
"required": [
"errorDetails",
"importRequestTimestamp",
"numberOfProductsDeleted",
"numberOfProductsInTheBatch",
"numberOfProductsUpserted",
"numberOfProductsWithErrors",
"numberOfProductsWithWarnings",
"status",
"warningDetails"
],
"type": "object",
"properties": {
"errorDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportDetailErrors"
},
"description": "The list of errors with details."
},
"importRequestTimestamp": {
"type": "string",
"description": "The date when the original batch request was sent.",
"format": "int64",
"nullable": true
},
"numberOfProductsDeleted": {
"type": "string",
"description": "The number of products deleted.",
"format": "int32",
"nullable": true
},
"numberOfProductsInTheBatch": {
"type": "string",
"description": "The number of products present in the batch.",
"format": "int32",
"nullable": true
},
"numberOfProductsUpserted": {
"type": "string",
"description": "The number of products upserted.",
"format": "int32",
"nullable": true
},
"numberOfProductsWithErrors": {
"type": "string",
"description": "The number of products with errors.",
"format": "int32",
"nullable": true
},
"numberOfProductsWithWarnings": {
"type": "string",
"description": "The number of products with Warnings.",
"format": "int32",
"nullable": true
},
"status": {
"enum": [
"ACCEPTED",
"IN_PROGRESS",
"VALIDATED",
"VALIDATED_WITH_ERRORS",
"FAILED"
],
"type": "string",
"description": "The status of the operation.\nThe operation is completed when the status is one of (VALIDATED,VALIDATED_WITH_ERRORS,FAILED)"
},
"warningDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportDetailWarnings"
},
"description": "The list of Warnings with details."
}
},
"description": "The report on a given operationToken is ready. The report is available for 4 days"
},
"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"
},
"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
},
"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
},
"ResourceOfProductButtonRequest": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ProductButtonRequest"
},
"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",
"nullable": true
},
"ResourceOfProductButtonResponse": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ProductButtonResponse"
},
"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
},
"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"
},
"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
},
"RmAudienceBulkCreateInputV1": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmAudienceCreateEntityV1Resource"
}
}
},
"description": "A top-level object that encapsulates a Criteo API request for several values."
},
"RmAudienceBulkDeleteInputV1": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmAudienceDeleteEntityV1Resource"
}
}
},
"description": "A top-level object that encapsulates a Criteo API request for several entities."
},
"RmAudienceBulkUpdateInputV1": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmAudienceUpdateEntityV1Resource"
}
}
},
"description": "A top-level object that encapsulates a Criteo API request for several entities."
},
"RmAudienceComputeSizeEntityV1": {
"required": [
"channel",
"ids"
],
"type": "object",
"properties": {
"channel": {
"enum": [
"Onsite",
"Offsite"
],
"type": "string",
"description": "Channel to compute the sizes for."
},
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ids of the segments whose size is requested."
}
},
"description": "Audience of people of interest for a marketer."
},
"RmAudienceComputeSizeEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceComputeSizeEntityV1"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"RmAudienceComputeSizesInputV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RmAudienceComputeSizeEntityV1Resource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value."
},
"RmAudienceCreateEntityV1": {
"required": [
"algebra",
"name",
"retailerId"
],
"type": "object",
"properties": {
"algebra": {
"$ref": "#/components/schemas/RmAlgebraNodeV1"
},
"description": {
"type": "string",
"description": "Description of the audience"
},
"name": {
"type": "string",
"description": "Name of the audience"
},
"retailerId": {
"type": "string",
"description": "Retailer associated to the audience"
}
},
"description": "Audience of people of interest for a marketer."
},
"RmAudienceCreateEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceCreateEntityV1"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"RmAudienceDeleteEntityV1": {
"type": "object",
"description": "Audience to delete",
"x-criteo-canonical": {
"infoType": "entity",
"name": "RetailMediaAudience",
"version": "v1"
}
},
"RmAudienceDeleteEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceDeleteEntityV1"
},
"id": {
"type": "string",
"description": "Id of the entity"
},
"type": {
"type": "string"
}
},
"description": "A class that represents a domain entity exposed by an API"
},
"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"
}
},
"RmAudienceEntityV1ListResponse": {
"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
},
"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"
},
"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"
},
"RmAudienceEstimateSizeEntityV1": {
"required": [
"algebra",
"channel",
"retailerId"
],
"type": "object",
"properties": {
"algebra": {
"$ref": "#/components/schemas/RmAlgebraNodeV1"
},
"channel": {
"enum": [
"Onsite",
"Offsite"
],
"type": "string",
"description": "Channel to estimate the size"
},
"retailerId": {
"type": "string",
"description": "Retailer id of the audience"
}
},
"description": "Audience of people of interest for a marketer."
},
"RmAudienceEstimateSizeEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceEstimateSizeEntityV1"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"RmAudienceEstimateSizeInputV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RmAudienceEstimateSizeEntityV1Resource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value."
},
"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."
},
"RmAudienceSegmentComputeSizeEntityV1": {
"required": [
"channel",
"ids"
],
"type": "object",
"properties": {
"channel": {
"enum": [
"Onsite",
"Offsite"
],
"type": "string",
"description": "Channel to compute the sizes for."
},
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ids of the segments whose size is requested."
}
},
"description": "Segment Ids and channel whose size was requested."
},
"RmAudienceSegmentComputeSizeEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceSegmentComputeSizeEntityV1"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"RmAudienceSegmentComputeSizesInputV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RmAudienceSegmentComputeSizeEntityV1Resource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value."
},
"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"
},
"RmAudienceSegmentEstimateSizeEntityV1": {
"required": [
"channel",
"events",
"retailerId"
],
"type": "object",
"properties": {
"channel": {
"enum": [
"Onsite",
"Offsite"
],
"type": "string",
"description": "Channel to estimate the size"
},
"events": {
"$ref": "#/components/schemas/RmEventsEstimationV1"
},
"retailerId": {
"type": "string",
"description": "Retailer id of the segment"
}
},
"description": "Set of rules that defines specific people to target."
},
"RmAudienceSegmentEstimateSizeEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceSegmentEstimateSizeEntityV1"
},
"type": {
"type": "string"
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value"
},
"RmAudienceSegmentEstimateSizeInputV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RmAudienceSegmentEstimateSizeEntityV1Resource"
}
},
"description": "A top-level object that encapsulates a Criteo API request for a single value."
},
"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
},
"RmAudienceSegmentSizeEntityV1": {
"type": "object",
"properties": {
"relativeSize": {
"type": "number",
"description": "Reach in number of users relative to the total users of a retailer (e.g. 0.5523 / 55.23% users)",
"format": "double",
"nullable": true
},
"size": {
"type": "integer",
"description": "Reach in absolute number of users (e.g. 150,300 users). It's not present when the user lacks permissions\r\nto view it.",
"format": "int64",
"nullable": true
}
},
"description": "id and size of the segment",
"nullable": true,
"x-criteo-canonical": {
"infoType": "entity",
"name": "RetailMediaAudienceSegment",
"version": "v1"
}
},
"RmAudienceSegmentSizeEntityV1ListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmAudienceSegmentSizeEntityV1Resource"
},
"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"
},
"RmAudienceSegmentSizeEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceSegmentSizeEntityV1"
},
"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"
},
"RmAudienceSegmentSizeEstimationV1": {
"type": "object",
"properties": {
"relativeSize": {
"type": "number",
"description": "Reach in number of users relative to the total users of a retailer (e.g. 0.5523 / 55.23% users)",
"format": "double",
"nullable": true
},
"size": {
"type": "integer",
"description": "Reach in absolute number of users (e.g. 150,300 users). It's not present when the user lacks permissions\r\nto view it.",
"format": "int64",
"nullable": true
}
},
"description": "Segment size estimation",
"nullable": true
},
"RmAudienceSegmentSizeEstimationV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceSegmentSizeEstimationV1"
},
"type": {
"type": "string",
"nullable": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value",
"nullable": true
},
"RmAudienceSegmentSizeEstimationV1Response": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RmAudienceSegmentSizeEstimationV1Resource"
},
"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"
},
"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"
},
"RmAudienceSizeEntityV1": {
"type": "object",
"properties": {
"relativeSize": {
"type": "number",
"description": "Reach in number of users relative to the total users of a retailer (e.g. 0.5523 / 55.23% users)",
"format": "double",
"nullable": true
},
"size": {
"type": "integer",
"description": "Reach in absolute number of users (e.g. 150,300 users). It's not present when the user lacks permissions\r\nto view it.",
"format": "int64",
"nullable": true
}
},
"description": "id and size of the audience",
"nullable": true,
"x-criteo-canonical": {
"infoType": "entity",
"name": "RetailMediaAudience",
"version": "v1"
}
},
"RmAudienceSizeEntityV1ListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RmAudienceSizeEntityV1Resource"
},
"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"
},
"RmAudienceSizeEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceSizeEntityV1"
},
"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"
},
"RmAudienceSizeEstimationV1": {
"type": "object",
"properties": {
"relativeSize": {
"type": "number",
"description": "Reach in number of users relative to the total users of a retailer (e.g. 0.5523 / 55.23% users)",
"format": "double",
"nullable": true
},
"size": {
"type": "integer",
"description": "Reach in absolute number of users (e.g. 150,300 users). It's not present when the user lacks permissions\r\nto view it.",
"format": "int64",
"nullable": true
}
},
"description": "Audience size estimation",
"nullable": true
},
"RmAudienceSizeEstimationV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceSizeEstimationV1"
},
"type": {
"type": "string",
"nullable": true
}
},
"description": "A top-level object that encapsulates a Criteo API response for a single value",
"nullable": true
},
"RmAudienceSizeEstimationV1Response": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/RmAudienceSizeEstimationV1Resource"
},
"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"
},
"RmAudienceUpdateEntityV1": {
"type": "object",
"properties": {
"algebra": {
"$ref": "#/components/schemas/RmAlgebraNodeV1"
},
"description": {
"$ref": "#/components/schemas/NillableString"
},
"name": {
"type": "string",
"description": "Name of the audience"
}
},
"description": "Audience of people of interest for a marketer.",
"x-criteo-canonical": {
"infoType": "entity",
"name": "RetailMediaAudience",
"version": "v1"
}
},
"RmAudienceUpdateEntityV1Resource": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/RmAudienceUpdateEntityV1"
},
"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"
},
"RmEventsEstimationV1": {
"required": [
"lookbackDays",
"shopperActivity"
],
"type": "object",
"properties": {
"brandIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"categoryIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"lookbackDays": {
"enum": [
"Last7Days",
"Last14Days",
"Last30Days",
"Last45Days",
"Last60Days",
"Last90Days",
"Last120Days",
"Last150Days",
"Last180Days"
],
"type": "string"
},
"maxPrice": {
"type": "number",
"format": "double"
},
"minPrice": {
"type": "number",
"format": "double"
},
"shopperActivity": {
"enum": [
"View",
"Buy",
"AddToCart"
],
"type": "string"
}
},
"description": "Settings to target users based on the shopping events"
},
"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."
},
"SetProductBuyBoxWinnersRequest": {
"required": [
"productBuyBoxWinners"
],
"type": "object",
"properties": {
"productBuyBoxWinners": {
"maxItems": 5000,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductBuyBoxWinner"
}
}
},
"additionalProperties": false,
"description": "The request passed by the caller of the SetBuyBoxWinners endpoint"
},
"ShareOfVoiceInsight": {
"required": [
"accountId",
"dimensions",
"endDate",
"metrics",
"startDate"
],
"type": "object",
"properties": {
"accountId": {
"type": "string"
},
"accountIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"activationPlatforms": {
"type": "array",
"items": {
"enum": [
"commerceMax",
"privateMarket"
],
"type": "string"
},
"nullable": true
},
"aggregationLevel": {
"enum": [
"category",
"keyword"
],
"type": "string",
"default": "category"
},
"brandIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"budgetModels": {
"type": "array",
"items": {
"enum": [
"criteoBudget",
"retailerBudget"
],
"type": "string"
},
"nullable": true
},
"campaignType": {
"enum": [
"all",
"onsiteSponsoredProducts",
"onsiteDisplay"
],
"type": "string",
"default": "all"
},
"dimensions": {
"minItems": 1,
"type": "array",
"items": {
"enum": [
"date",
"accountId",
"accountName",
"retailerId",
"retailerName",
"brandId",
"brandName",
"campaignId",
"campaignName",
"buyType",
"skuId",
"skuName",
"lineItemId",
"lineItemName",
"pageTypeId",
"pageTypeName",
"productGtin",
"productMpn",
"productCategory",
"servedCategory",
"keyword",
"keywordType",
"campaignType",
"creativeType",
"adFormat",
"creativeName",
"environment",
"budgetModel",
"activationPlatform"
],
"type": "string"
}
},
"endDate": {
"type": "string",
"format": "date-time"
},
"format": {
"enum": [
"json",
"json-compact",
"json-newline",
"csv"
],
"type": "string",
"default": "json-compact"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"keywordTypes": {
"type": "array",
"items": {
"enum": [
"unknown",
"generic",
"branded",
"conquesting"
],
"type": "string"
},
"nullable": true
},
"metrics": {
"minItems": 1,
"type": "array",
"items": {
"enum": [
"impressions",
"clicks",
"grossClicks",
"spend",
"cpc",
"ctr",
"cpm",
"roas",
"attributedSales",
"attributedUnits",
"assistedUnits",
"assistedSales",
"exposedUsers",
"impressionShare",
"clickShare",
"invalidClicks"
],
"type": "string"
}
},
"retailerIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"servedCategories": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false,
"description": "Description of a Share of voice insight"
},
"ShareOfVoiceInsightRequest": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ShareOfVoiceInsightResource"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ShareOfVoiceInsightResource": {
"required": [
"attributes"
],
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ShareOfVoiceInsight"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"SkuFilter": {
"required": [
"retailerId",
"retailerSkuIds"
],
"type": "object",
"properties": {
"retailerId": {
"type": "string"
},
"retailerSkuIds": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"description": "The filters to apply"
},
"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
},
"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"
},
"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"
},
"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."
},
"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
},
"UpdateBalanceModelV1": {
"type": "object",
"properties": {
"endDate": {
"$ref": "#/components/schemas/NillableOfNullableOfDateOnly"
},
"memo": {
"type": "string",
"description": "Memo.",
"nullable": true
},
"name": {
"type": "string",
"description": "Name of the balance.",
"nullable": true
},
"retailerPoNumber": {
"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
}
},
"additionalProperties": false,
"description": "An object that represents the available options to set when updating a Retail Media Balance."
},
"UpdateOffersRequest": {
"required": [
"offerUpdates"
],
"type": "object",
"properties": {
"offerUpdates": {
"maxItems": 5000,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/OfferUpdate"
}
}
},
"additionalProperties": false,
"description": "The request passed by the caller of the Update endpoint"
},
"ValueResourceAppendCampaignsRequestV1": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/AppendCampaignsRequestV1"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceBalanceCampaignsV1": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/BalanceCampaignsV1"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API.",
"nullable": true
},
"ValueResourceBalanceHistoryChangeDataCaptureV1": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/BalanceHistoryChangeDataCaptureV1"
},
"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."
},
"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."
},
"ValueResourceCollectionOutcomeBalanceHistoryChangeDataCaptureV1AndMetadata": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueResourceBalanceHistoryChangeDataCaptureV1"
},
"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."
},
"ValueResourceCollectionOutcomeDisplayAuctionMinBidResult": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValueResourceDisplayAuctionMinBidResult"
},
"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."
},
"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."
},
"ValueResourceDeleteCampaignsRequestV1": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/DeleteCampaignsRequestV1"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceDisplayAuctionMinBidRequest": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/DisplayAuctionMinBidRequest"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceDisplayAuctionMinBidResult": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/DisplayAuctionMinBidResult"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceInputAppendCampaignsRequestV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceAppendCampaignsRequestV1"
}
},
"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."
},
"ValueResourceInputDeleteCampaignsRequestV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceDeleteCampaignsRequestV1"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputDisplayAuctionMinBidRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceDisplayAuctionMinBidRequest"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputLineItemBudgetCapOutHistoryRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceLineItemBudgetCapOutHistoryRequest"
}
},
"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."
},
"ValueResourceInputOfRetailMediaBrandAccountCreationV2": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfRetailMediaBrandAccountCreationV2"
}
},
"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."
},
"ValueResourceInputOfRetailMediaSellerAccountCreationV2": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfRetailMediaSellerAccountCreationV2"
}
},
"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."
},
"ValueResourceInputOfUpdateBalanceModelV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceOfUpdateBalanceModelV1"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputSetProductBuyBoxWinnersRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceSetProductBuyBoxWinnersRequest"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceInputUpdateOffersRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceUpdateOffersRequest"
}
},
"additionalProperties": false,
"description": "A top-level object that encapsulates a Criteo API request for a single value object."
},
"ValueResourceLineItemBudgetCapOutHistoryRequest": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/LineItemBudgetCapOutHistoryRequest"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceLineItemBudgetCapOutHistoryResponse": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/LineItemBudgetCapOutHistoryResponse"
},
"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."
},
"ValueResourceOfRetailMediaBrandAccountCreationV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ExternalRetailMediaBrandAccountCreationV2"
},
"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."
},
"ValueResourceOfRetailMediaSellerAccountCreationV2": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/ExternalRetailMediaSellerAccountCreationV2"
},
"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."
},
"ValueResourceOfUpdateBalanceModelV1": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/UpdateBalanceModelV1"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceOutcomeBalanceCampaignsV1": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceBalanceCampaignsV1"
},
"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."
},
"ValueResourceOutcomeLineItemBudgetCapOutHistoryResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ValueResourceLineItemBudgetCapOutHistoryResponse"
},
"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."
},
"ValueResourceSetProductBuyBoxWinnersRequest": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/SetProductBuyBoxWinnersRequest"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"ValueResourceUpdateOffersRequest": {
"type": "object",
"properties": {
"attributes": {
"$ref": "#/components/schemas/UpdateOffersRequest"
},
"type": {
"type": "string",
"description": "Type of the resource.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A value resource exposed by the API."
},
"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": "Campaign"
},
{
"name": "Catalog"
},
{
"name": "Gateway"
},
{
"name": "OnSiteRecommendation"
},
{
"name": "ThirdPartyAccounts"
}
],
"x-samples-languages": [
"java",
"python",
"php",
"csharp",
"javascript",
"curl",
"ruby"
]
}