openapi: 3.0.1
info:
  title: Criteo Accounts Campaign API
  description: Criteo API - RetailMedia
  version: 2026-07
servers:
- url: https://api.criteo.com
security:
- oauth: []
tags:
- name: Campaign
paths:
  /2026-07/retail-media/accounts/{account-id}/campaigns:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/accounts/{account-id}/campaigns
      description: Gets page of campaign objects for the given account id
      operationId: GetCampaignsByAccountId
      parameters:
      - name: account-id
        in: path
        description: The given account id
        required: true
        schema:
          type: string
      - name: limitToId
        in: query
        description: The ids that you would like to limit your result set to
        schema:
          type: array
          items:
            type: string
      - name: pageIndex
        in: query
        description: The 0 indexed page index you would like to receive given the page size
        schema:
          maximum: 2147483647
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: pageSize
        in: query
        description: The maximum number of items you would like to receive in this request
        schema:
          maximum: 2147483647
          minimum: 1
          type: integer
          format: int32
          default: 25
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiPageResponseOfCampaignV202301'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/accounts/{account-id}/campaigns
      description: Creates a new campaign with the specified settings
      operationId: CreateCampaignsByAccountId
      parameters:
      - name: account-id
        in: path
        description: The given account id
        required: true
        schema:
          type: string
      requestBody:
        description: The campaign settings to create a campaign with
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCampaignV202301'
        required: true
        x-bodyName: campaign
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiSingleResponseOfCampaignV202301'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/accounts/{account-id}/creatives:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/accounts/{account-id}/creatives
      description: Get account creatives
      operationId: GetAccountCreatives
      parameters:
      - name: account-id
        in: path
        description: External account id to retrieve creatives for
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Creatives found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Creative202110ListResponse'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/accounts/{account-id}/creatives
      description: Create a creative for an account
      operationId: CreateCreative
      parameters:
      - name: account-id
        in: path
        description: External account id to create a creative for
        required: true
        schema:
          type: string
      requestBody:
        description: The creative to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreativeCreateModel202207'
        required: true
      responses:
        '201':
          description: Creatives created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Creative202210Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/accounts/{account-id}/creatives/{creative-id}:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/accounts/{account-id}/creatives/{creative-id}
      description: Get the specified creative
      operationId: GetCreative
      parameters:
      - name: account-id
        in: path
        description: External account id to retrieve creatives for
        required: true
        schema:
          type: string
      - name: creative-id
        in: path
        description: Creative to get
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Creatives found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Creative2Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
    put:
      tags:
      - Campaign
      summary: /2026-07/retail-media/accounts/{account-id}/creatives/{creative-id}
      description: Update a creative
      operationId: UpdateCreative
      parameters:
      - name: account-id
        in: path
        description: External account id containing the creative
        required: true
        schema:
          type: string
      - name: creative-id
        in: path
        description: Creative to update
        required: true
        schema:
          type: string
      requestBody:
        description: The creative to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreativeUpdateModel202207'
        required: true
      responses:
        '201':
          description: Creative updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Creative202210Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/accounts/{account-id}/creatives/search:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/accounts/{account-id}/creatives/search
      description: Get account creatives
      operationId: SearchAccountCreatives
      parameters:
      - name: account-id
        in: path
        description: External account id to retrieve creatives for
        required: true
        schema:
          type: string
      - name: creative-ids
        in: query
        description: Creatives to filter by
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Creatives found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Creative2ListResponse'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/accounts/{account-id}/keywords/in-review-report:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/accounts/{account-id}/keywords/in-review-report
      description: Generate a list of reports for line items which contain one or more actionable keyword reviews
      operationId: GetKeywordInReviewReport
      parameters:
      - name: account-id
        in: path
        description: The account to generate a report for
        required: true
        schema:
          type: string
          format: int64
      - name: limit
        in: query
        description: Number of items per page
        schema:
          maximum: 50
          minimum: 1
          type: integer
          format: int32
          default: 25
      - name: offset
        in: query
        description: Offset for pagination
        schema:
          maximum: 2147483647
          minimum: 0
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/accounts/{account-id}/line-items:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/accounts/{account-id}/line-items
      description: Gets page of line item objects for the given account id
      operationId: GetLineItemsByAccountId
      parameters:
      - name: account-id
        in: path
        description: The given account id
        required: true
        schema:
          type: string
      - name: limitToCampaignId
        in: query
        description: The campaign ids that you would like to limit your result set to
        schema:
          type: array
          items:
            type: string
      - name: limitToId
        in: query
        description: The ids that you would like to limit your result set to
        schema:
          type: array
          items:
            type: string
      - name: limitToType
        in: query
        description: The campaign types that you would like to limit your result set to
        schema:
          enum:
          - Unknown
          - Auction
          - Preferred
          type: string
          nullable: true
      - name: pageIndex
        in: query
        description: The 0 indexed page index you would like to receive given the page size
        schema:
          maximum: 2147483647
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: pageSize
        in: query
        description: The maximum number of items you would like to receive in this request
        schema:
          maximum: 2147483647
          minimum: 1
          type: integer
          format: int32
          default: 25
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonLineItemPagedListResponse'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/accounts/{accountId}/brand-catalog-export:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/accounts/{accountId}/brand-catalog-export
      description: Create a request for a Catalog available to the indicated account.
      operationId: CreateBrandCatalogExport
      parameters:
      - name: accountId
        in: path
        description: The account to request the catalog for.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputOfBrandCatalogRequestV2'
        required: true
      responses:
        '200':
          description: Catalog request successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityResourceOutcomeOfCatalogStatusV2'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/accounts/{accountId}/brands:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/accounts/{accountId}/brands
      description: Gets page of retailer objects that are associated with the given account
      operationId: GetBrandsByAccountId
      parameters:
      - name: accountId
        in: path
        description: The given account id
        required: true
        schema:
          type: string
      - name: limitToId
        in: query
        description: The ids that you would like to limit your result set to
        schema:
          type: array
          items:
            type: string
      - name: pageIndex
        in: query
        description: The 0 indexed page index you would like to receive given the page size
        schema:
          type: integer
          format: int32
          default: 0
      - name: pageSize
        in: query
        description: The maximum number of items you would like to receive in this request
        schema:
          type: integer
          format: int32
          default: 25
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiPageResponseOfBrand'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/accounts/{accountId}/catalogs:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/accounts/{accountId}/catalogs
      description: Create a request for a Catalog available to the indicated account.
      operationId: CatalogApi_PostApiV1ExternalAccountCatalogsByAccountId
      parameters:
      - name: accountId
        in: path
        description: The account to request the catalog for.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonApiRequestOfCatalogRequest'
        required: true
      responses:
        '200':
          description: Catalog request successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiSingleResponseOfCatalogStatus'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/accounts/{accountId}/catalogs/sellers:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/accounts/{accountId}/catalogs/sellers
      description: Create a request for a Catalog available to the indicated account.
      operationId: Catalog_PostApiExternalV1AccountCatalogsSellersByAccountId
      parameters:
      - name: accountId
        in: path
        description: The account to request the catalog for.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonApiRequestOfSellerCatalogRequest'
        required: true
      responses:
        '200':
          description: Catalog request successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiSingleResponseOfCatalogStatus'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/accounts/{accountId}/retailers/search:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/accounts/{accountId}/retailers/search
      description: Searches for retailers associated with the specified account and returns budget model availability for each retailer
      operationId: SearchAccountRetailers
      parameters:
      - name: accountId
        in: path
        description: The external account identifier
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: The maximum number of items to return. Must be between 1 and 10. Default is 5.
        schema:
          maximum: 10
          minimum: 1
          type: integer
          format: int32
          default: 5
      - name: offset
        in: query
        description: The number of items to skip before starting to collect the result set. Default is 0.
        schema:
          maximum: 2147483647
          minimum: 0
          type: integer
          format: int32
          default: 0
      requestBody:
        description: The search request containing filtering parameters
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputOfRetailerSearchRequestV2'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityResourceCollectionOutcomeOfRetailerResultV2AndMetadata'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/accounts/{accountId}/seller-catalog-export:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/accounts/{accountId}/seller-catalog-export
      description: Create a request for a Catalog available to the indicated account.
      operationId: CreateSellerCatalogExport
      parameters:
      - name: accountId
        in: path
        description: The account to request the catalog for.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputOfSellerCatalogRequestV2'
        required: true
      responses:
        '200':
          description: Catalog request successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityResourceOutcomeOfCatalogStatusV2'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/assets:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/assets
      description: Creates an asset
      operationId: CreateAsset
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
              - AssetFile
              properties:
                AssetFile:
                  type: string
                  description: The asset binary content
                  format: binary
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetResponse'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/auction-line-items/{lineItemId}:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/auction-line-items/{lineItemId}
      description: Gets a sponsored product line item by its id.
      operationId: GetAuctionLineItem
      parameters:
      - name: lineItemId
        in: path
        description: The id of the line item
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityResourceOutcomeOfSponsoredProductsLineItem'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
    put:
      tags:
      - Campaign
      summary: /2026-07/retail-media/auction-line-items/{lineItemId}
      description: Updates a Sponsored Products Line Item given a line item id and a request.
      operationId: UpdateAuctionLineItem
      parameters:
      - name: lineItemId
        in: path
        description: The external line item ID of the sponsored products line item.
        required: true
        schema:
          type: string
      requestBody:
        description: An update request containing all details of the requested update.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityResourceOutcomeOfSponsoredProductsLineItem'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/balances/{balance-id}/campaigns/append:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/balances/{balance-id}/campaigns/append
      description: appends one or more campaigns to the specified balance
      operationId: AppendCampaignsByBalanceId
      parameters:
      - name: balance-id
        in: path
        description: The balance to add campaigns from
        required: true
        schema:
          type: string
      requestBody:
        description: The campaigns to append
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BalanceCampaign202110ListRequest'
        x-bodyName: campaigns
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceCampaign202110PagedListResponse'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/balances/{balance-id}/campaigns/delete:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/balances/{balance-id}/campaigns/delete
      description: Removes one or more campaigns on the specified balance
      operationId: DeleteCampaignsByBalanceId
      parameters:
      - name: balance-id
        in: path
        description: The balance to remove campaigns from
        required: true
        schema:
          type: string
      requestBody:
        description: The campaigns to append
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BalanceCampaign202110ListRequest'
        x-bodyName: campaigns
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceCampaign202110PagedListResponse'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/campaigns/{campaign-id}/preferred-line-items:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/campaigns/{campaign-id}/preferred-line-items
      description: Gets page of preferred line item objects for the given campaign id
      operationId: GetPreferredLineItemsByCampaignId
      parameters:
      - name: campaign-id
        in: path
        description: The given campaign id
        required: true
        schema:
          type: string
      - name: limitToId
        in: query
        description: The ids that you would like to limit your result set to
        schema:
          type: array
          items:
            type: string
      - name: pageIndex
        in: query
        description: The 0 indexed page index you would like to receive given the page size
        schema:
          maximum: 2147483647
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: pageSize
        in: query
        description: The maximum number of items you would like to receive in this request
        schema:
          maximum: 2147483647
          minimum: 1
          type: integer
          format: int32
          default: 25
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreferredLineItemV2PagedListResponse'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/campaigns/{campaign-id}/preferred-line-items
      description: Creates a new preferred line item with the specified settings
      operationId: CreatePreferredLineItemByCampaignId
      parameters:
      - name: campaign-id
        in: path
        description: The given campaign id
        required: true
        schema:
          type: string
      requestBody:
        description: The line item settings to create a line item with
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreferredLineItemCreateModelV2Request'
        required: true
        x-bodyName: lineItem
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreferredLineItemV2Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/campaigns/{campaignId}:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/campaigns/{campaignId}
      description: Gets the campaign for the given campaign id
      operationId: GetCampaignByCampaignId
      parameters:
      - name: campaignId
        in: path
        description: The given campaign id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiSingleResponseOfCampaignV202301'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
    put:
      tags:
      - Campaign
      summary: /2026-07/retail-media/campaigns/{campaignId}
      description: Updates the campaign for the given campaign id
      operationId: UpdateCampaignByCampaignId
      parameters:
      - name: campaignId
        in: path
        description: The given campaign id
        required: true
        schema:
          type: string
      requestBody:
        description: The campaign settings to update that campaign with
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutCampaignV202301'
        required: true
        x-bodyName: campaign
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiSingleResponseOfCampaignV202301'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/campaigns/{campaignId}/auction-line-items:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/campaigns/{campaignId}/auction-line-items
      description: Gets a page of sponsored product line items by campaign id.
      operationId: GetAuctionLineItemsByCampaign
      parameters:
      - name: campaignId
        in: path
        description: The id of the campaign
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: The number of elements to be returned on a page.
        schema:
          maximum: 500
          minimum: 1
          type: integer
          format: int32
          default: 25
      - name: limitToIds
        in: query
        description: The ids to limit the auction line item results to
        schema:
          type: array
          items:
            type: string
      - name: offset
        in: query
        description: The (zero-based) starting offset into the collection.
        schema:
          maximum: 2147483647
          minimum: 0
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityResourceCollectionOutcomeOfSponsoredProductsLineItemAndMetadata'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/campaigns/{campaignId}/auction-line-items
      description: Creates new auction line item with the specified settings
      operationId: CreateAuctionLineItem
      parameters:
      - name: campaignId
        in: path
        description: The given campaign id
        required: true
        schema:
          type: string
      requestBody:
        description: The line item settings to create a line item with
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputOfSponsoredProductsLineItemCreateRequestModel'
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityResourceOutcomeOfSponsoredProductsLineItem'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/campaigns/{campaignId}/campaign-budget-overrides:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/campaigns/{campaignId}/campaign-budget-overrides
      description: Get current campaign budget overrides by given campaign id.
      operationId: GetCampaignBudgetOverrides
      parameters:
      - name: campaignId
        in: path
        description: Campaign id.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeOfCampaignBudgetOverrides'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
    put:
      tags:
      - Campaign
      summary: /2026-07/retail-media/campaigns/{campaignId}/campaign-budget-overrides
      description: Update campaign budget overrides by given campaign id and new campaign budget overrides settings.
      operationId: UpdateCampaignBudgetOverrides
      parameters:
      - name: campaignId
        in: path
        description: Campaign id.
        required: true
        schema:
          type: string
      requestBody:
        description: New campaign budget overrides settings value resource input.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputOfCampaignBudgetOverrides'
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeOfCampaignBudgetOverrides'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/catalogs/{catalogId}/output:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/catalogs/{catalogId}/output
      description: "Output the indicated catalog. Catalogs are only available for retrieval when their associated status request\r\nis at a Success status.\r\nProduces application/x-json-stream CatalogProduct json objects (first introduced in the 2021-07 version)."
      operationId: GetCatalogOutput
      parameters:
      - name: catalogId
        in: path
        description: A catalog ID returned from an account catalog request.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Catalog download initiated.
          content:
            application/x-json-stream:
              schema:
                type: string
                format: binary
        '204':
          description: Catalog has expired.
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/catalogs/{catalogId}/status:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/catalogs/{catalogId}/status
      description: Check the status of a catalog request.
      operationId: GetCatalogStatus
      parameters:
      - name: catalogId
        in: path
        description: A catalog ID returned from an account catalog request.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Catalog request found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiSingleResponseOfCatalogStatus'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/categories:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/categories
      description: Endpoint to search categories by text and retailer.
      operationId: CategorySearch_GetApiExternalV1Categories
      parameters:
      - name: pageIndex
        in: query
        description: The start position in the overall list of matches. Must be zero or greater.
        schema:
          maximum: 500
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: pageSize
        in: query
        description: The maximum number of results to return with each call. Must be greater than zero.
        schema:
          maximum: 100
          minimum: 1
          type: integer
          format: int32
          default: 100
      - name: retailerId
        in: query
        description: The retailer id for which Categories fetched
        schema:
          type: integer
          format: int32
      - name: textSubstring
        in: query
        description: Query string to search across Categories
        schema:
          type: string
      responses:
        '200':
          description: Categories found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Category202204ListResponse'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/categories/{categoryId}:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/categories/{categoryId}
      description: Endpoint to search for a specific category by categoryId.
      operationId: GetCategory
      parameters:
      - name: categoryId
        in: path
        description: ID of the desired category
        required: true
        schema:
          type: string
          format: int32
      responses:
        '200':
          description: Retrieval completed and category is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Category202204'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/line-items/{externalLineItemId}/keywords/recommended:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/line-items/{externalLineItemId}/keywords/recommended
      description: Retrieves a collection of recommended keywords for a line item
      operationId: GetRecommendedKeywords
      parameters:
      - name: externalLineItemId
        in: path
        description: The line item identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeOfRecommendedKeywordsResult'
      deprecated: true
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/line-items/{id}/keywords:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/line-items/{id}/keywords
      description: Fetch keywords associated with the specified line item
      operationId: FetchKeywords
      parameters:
      - name: id
        in: path
        description: ID of the line item
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeywordsModelResponse'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/line-items/{id}/keywords/add-remove:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/line-items/{id}/keywords/add-remove
      description: Add or Remove keywords from the line item in bulk
      operationId: AddRemoveKeywords
      parameters:
      - name: id
        in: path
        description: ID of the line item
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddRemoveKeywordsModelRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOutcome'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/line-items/{id}/keywords/set-bid:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/line-items/{id}/keywords/set-bid
      description: Set bid overrides for associated keywords to the given line item in bulk
      operationId: SetKeywordBids
      parameters:
      - name: id
        in: path
        description: ID of the line item
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetBidsModelRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOutcome'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/line-items/{line-item-id}:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/line-items/{line-item-id}
      description: Gets the line item for the given line item id
      operationId: GetLineItemsByCampaignId
      parameters:
      - name: line-item-id
        in: path
        description: The given line item id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonLineItemResponse'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/line-items/{line-item-id}/bid-multipliers:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/line-items/{line-item-id}/bid-multipliers
      description: Fetch all bid multipliers for a given line item
      operationId: GetBidMultipliersByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: LineItemId for bid multiplier retrieval
        required: true
        schema:
          type: string
      responses:
        '200':
          description: BidMultipliers Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiSingleResponseOfLineItemBidMultipliersV2'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
    put:
      tags:
      - Campaign
      summary: /2026-07/retail-media/line-items/{line-item-id}/bid-multipliers
      description: Updates the bid multipliers for a given line item
      operationId: UpdateBidMultipliersByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: LineItemId for bid multiplier retrieval
        required: true
        schema:
          type: string
      requestBody:
        description: New Bid Multipliers to be set
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LineItemBidMultipliersV2Request'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: BidMultipliers Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LineItemBidMultipliersV2Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/line-items/{line-item-id}/keywords/review:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/line-items/{line-item-id}/keywords/review
      description: Update the status of keyword reviews under a line item
      operationId: UpdateKeywordReviews
      parameters:
      - name: line-item-id
        in: path
        description: The line item to update keyword review statuses for
        required: true
        schema:
          type: string
          format: int64
      requestBody:
        description: Request object containing a list of Phrase-ReviewState pairs to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputRetailMediaKeywordsReview'
        x-bodyName: keywordReviewSetStateRequest
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeRetailMediaKeywordsReviewResult'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/line-items/{line-item-id}/products:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/line-items/{line-item-id}/products
      description: Retrieve a page of promoted products for a line item
      operationId: FetchPromotedProducts
      parameters:
      - name: fields
        in: query
        description: "A comma separated list of attribute names from the response model to compute and return.\r\n            Valid values are `status` and `bidOverride` in any order. Defaults to `status`."
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum page size to fetch. Defaults to 500.
        schema:
          type: integer
          format: int32
      - name: line-item-id
        in: path
        description: ID of the line item.
        required: true
        schema:
          type: string
      - name: offset
        in: query
        description: Offset of the first item to fetch. Defaults to zero.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Promoted products associated with the line item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromotedProductResourceCollectionOutcome'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/line-items/{line-item-id}/products/append:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/line-items/{line-item-id}/products/append
      description: Append a collection of promoted products to a line item
      operationId: AppendPromotedProducts
      parameters:
      - name: line-item-id
        in: path
        description: ID of the line item
        required: true
        schema:
          type: string
      requestBody:
        description: Request body whose {data} contains an array of promoted products.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromotedProductResourceCollectionInput'
      responses:
        '200':
          description: Promoted products appended to the line item with warnings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductResourceOutcome'
        '204':
          description: Promoted products appended to the line item
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/line-items/{line-item-id}/products/delete:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/line-items/{line-item-id}/products/delete
      description: Remove a collection of promoted products from a line item
      operationId: DeletePromotedProducts
      parameters:
      - name: line-item-id
        in: path
        description: ID of the line item
        required: true
        schema:
          type: string
      requestBody:
        description: Request body whose {data} contains an array of promoted products.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromotedProductResourceCollectionInput'
      responses:
        '204':
          description: Promoted products removed from the line item
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/line-items/{line-item-id}/products/pause:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/line-items/{line-item-id}/products/pause
      description: Pause a collection of promoted products associated with a line item
      operationId: PausePromotedProducts
      parameters:
      - name: line-item-id
        in: path
        description: ID of the line item
        required: true
        schema:
          type: string
      requestBody:
        description: Request body whose {data} contains an array of promoted products.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromotedProductResourceCollectionInput'
      responses:
        '204':
          description: Promoted products paused
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/line-items/{line-item-id}/products/unpause:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/line-items/{line-item-id}/products/unpause
      description: Un-pause a collection of promoted products associated with a line item
      operationId: UnpausePromotedProducts
      parameters:
      - name: line-item-id
        in: path
        description: ID of the line item
        required: true
        schema:
          type: string
      requestBody:
        description: Request body whose {data} contains an array of promoted products.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromotedProductResourceCollectionInput'
      responses:
        '204':
          description: Promoted products un-paused
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/line-items/{lineItemId}/line-item-budget-overrides:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/line-items/{lineItemId}/line-item-budget-overrides
      description: Gets a collection of monthly and daily budget overrides for the provided line item.
      operationId: GetLineItemBudgetOverrides
      parameters:
      - name: lineItemId
        in: path
        description: The line item id to get budget overrides for.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeOfLineItemBudgetOverrides'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
    put:
      tags:
      - Campaign
      summary: /2026-07/retail-media/line-items/{lineItemId}/line-item-budget-overrides
      description: Update line item budget overrides by given external line item id and new line item budget overrides settings.
      operationId: UpdateLineItemBudgetOverrides
      parameters:
      - name: lineItemId
        in: path
        description: Line item external id.
        required: true
        schema:
          type: string
      requestBody:
        description: New line item budget overrides settings value resource input.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputOfLineItemBudgetOverrides'
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeOfLineItemBudgetOverrides'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/preferred-line-items/{line-item-id}:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/preferred-line-items/{line-item-id}
      description: Gets the preferred line item for the given line item id
      operationId: GetPreferredLineItemsByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: The given line item id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreferredLineItemV2Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
    put:
      tags:
      - Campaign
      summary: /2026-07/retail-media/preferred-line-items/{line-item-id}
      description: Updates the preferred line item for the given line item id
      operationId: UpdatePreferredLineItemByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: The given line item id
        required: true
        schema:
          type: string
      requestBody:
        description: The line item settings to create a line item with
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreferredLineItemUpdateModelV2Request'
        required: true
        x-bodyName: lineItem
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreferredLineItemV2Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket
      description: This endpoint gets the add to basket target on the specified line item.
      operationId: GetAddToBasketTargetsByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: The line item to interact with
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddToBasketTarget202110Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
    put:
      tags:
      - Campaign
      summary: /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket
      description: This endpoint sets the scope of the add to basket target on the specified line item.
      operationId: PutAddToBasketTargetByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: The line item to interact with
        required: true
        schema:
          type: string
      requestBody:
        description: The add to basket target to set the scope for
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddToBasketTarget202110Request'
        required: true
        x-bodyName: addToBasketTarget
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddToBasketTarget202110Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/append:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/append
      description: This endpoint appends one or more add to basket ids to targeting on the specified line item.  The resulting state of the add to basket target is returned.
      operationId: AppendAddToBasketTargetsByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: The line item to interact with
        required: true
        schema:
          type: string
      requestBody:
        description: Ids to append to the target
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddToBasketIdsUpdateModel202110Request'
        x-bodyName: idsToAppend
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddToBasketTarget202110Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/delete:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/delete
      description: This endpoint removes one or more add to basket ids from targeting on the specified line item.  The resulting state of the add to basket target is returned.
      operationId: DeleteAddToBasketTargetsByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: The line item to interact with
        required: true
        schema:
          type: string
      requestBody:
        description: Ids to remove from the target
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddToBasketIdsUpdateModel202110Request'
        x-bodyName: idsToRemove
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddToBasketTarget202110Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences
      description: This endpoint gets the audience target on the specified line item.
      operationId: GetAudienceTargetsByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: The line item to interact with
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceTarget202110Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
    put:
      tags:
      - Campaign
      summary: /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences
      description: This endpoint sets the scope of the audience target on the specified line item.
      operationId: PutAudienceTargetsByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: The line item to interact with
        required: true
        schema:
          type: string
      requestBody:
        description: The audience target to set the scope for
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceTarget202110Request'
        required: true
        x-bodyName: audienceTarget
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceTarget202110Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/append:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/append
      description: This endpoint appends one or more audiences ids to targeting on the specified line item.  The resulting state of the audience target is returned.
      operationId: AppendAudienceTargetsByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: The line item to interact with
        required: true
        schema:
          type: string
      requestBody:
        description: Audience ids to append to the target
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceIdsUpdateModel202110Request'
        x-bodyName: idsToAppend
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceTarget202110Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/delete:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/delete
      description: This endpoint removes one or more audiences ids from targeting on the specified line item.  The resulting state of the audience target is returned.
      operationId: DeleteAudienceTargetsByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: The line item to interact with
        required: true
        schema:
          type: string
      requestBody:
        description: Audience ids to remove from the target
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceIdsUpdateModel202110Request'
        x-bodyName: idsToRemove
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceTarget202110Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores
      description: This endpoint gets the store target on the specified line item.
      operationId: GetStoreTargetsByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: The line item to interact with
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreTarget202110Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
    put:
      tags:
      - Campaign
      summary: /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores
      description: This endpoint sets the scope of the store target on the specified line item.
      operationId: PutStoreTargetByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: The line item to interact with
        required: true
        schema:
          type: string
      requestBody:
        description: The store target to set the scope for
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreTarget202110Request'
        required: true
        x-bodyName: storeTarget
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreTarget202110Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores/append:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores/append
      description: This endpoint appends one or more store ids to targeting on the specified line item.  The resulting state of the store target is returned.
      operationId: AppendStoreTargetsByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: The line item to interact with
        required: true
        schema:
          type: string
      requestBody:
        description: Store ids to append to the target
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreIdsUpdateModel202110Request'
        x-bodyName: idsToAppend
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreTarget202110Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores/delete:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores/delete
      description: This endpoint removes one or more store ids from targeting on the specified line item.  The resulting state of the store target is returned.
      operationId: DeleteStoreTargetByLineItemId
      parameters:
      - name: line-item-id
        in: path
        description: The line item to interact with
        required: true
        schema:
          type: string
      requestBody:
        description: Store ids to remove from the target
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StoreIdsUpdateModel202110Request'
        x-bodyName: idsToRemove
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StoreTarget202110Response'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/retailers/{retailer-id}/templates:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/retailers/{retailer-id}/templates
      description: Get retailer creative templates
      operationId: GetRetailerCreativeTemplates
      parameters:
      - name: retailer-id
        in: path
        description: External retailer id to retrieve creative templates for
        required: true
        schema:
          type: string
          format: int32
      responses:
        '200':
          description: Templates found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateListResponse'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/retailers/{retailer-id}/templates/{template-id}:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/retailers/{retailer-id}/templates/{template-id}
      description: Gets the template for the specified retailer id and template id
      operationId: GetCreativeTemplate
      parameters:
      - name: retailer-id
        in: path
        description: Retailer Id
        required: true
        schema:
          type: string
          format: int32
      - name: template-id
        in: path
        description: Template Id
        required: true
        schema:
          type: string
          format: int32
      responses:
        '200':
          description: Template found for the retailer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateResponse'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/retailers/{retailerId}/categories/search:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/retailers/{retailerId}/categories/search
      description: Search a retailer categories by given text substring and category ids.
      operationId: SearchCategory
      parameters:
      - name: limit
        in: query
        description: Limit of the search result.
        schema:
          maximum: 500
          minimum: 1
          type: integer
          format: int32
          default: 50
      - name: offset
        in: query
        description: Offset of the search result.
        schema:
          maximum: 2147483647
          minimum: 0
          type: integer
          format: int32
          default: 0
      - name: retailerId
        in: path
        description: Retailer id.
        required: true
        schema:
          type: string
          format: int32
      requestBody:
        description: Request of categories search.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputCategoriesSearchRequestV1'
        x-bodyName: request
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityResourceCollectionOutcomeCategory202204Metadata'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/retailers/{retailerId}/cpc-min-bids:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/retailers/{retailerId}/cpc-min-bids
      description: Get overall and individual minimum bid amount for given retailer id and sku id list.
      operationId: GetCpcMinBidsBySkuIdsV1
      parameters:
      - name: retailerId
        in: path
        description: Retailer Id.
        required: true
        schema:
          type: string
          format: int32
      requestBody:
        description: Cpc minimum bid amount request object.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputCpcMinBidsRequest'
        required: true
        x-bodyName: cpcMinBidsRequest
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeCpcMinBidsResponse'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
  /2026-07/retail-media/retailers/{retailerId}/pages:
    get:
      tags:
      - Campaign
      summary: /2026-07/retail-media/retailers/{retailerId}/pages
      description: Get the page types available for the given retailer
      operationId: RetailerApi_GetApi202110ExternalRetailerPagesByRetailerId
      parameters:
      - name: retailerId
        in: path
        description: The retailers to fetch pages for
        required: true
        schema:
          type: string
          format: int32
      responses:
        '200':
          description: Pages fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetailerPages202110'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/retailers/{retailerId}/recommend-categories:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/retailers/{retailerId}/recommend-categories
      description: Endpoint to get recommended categories by given retailer id and sku id list.
      operationId: GetRecommendedCategories
      parameters:
      - name: retailerId
        in: path
        description: Retailer id.
        required: true
        schema:
          type: string
          format: int32
      requestBody:
        description: Request of recommended categories.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputRecommendedCategoriesRequestV1'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityResourceCollectionOutcomeCategory202204'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
  /2026-07/retail-media/retailers/{retailerId}/recommend-keywords:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/retailers/{retailerId}/recommend-keywords
      description: Recommend keywords by given retailer id and sku ids.
      operationId: RecommendedKeywords
      parameters:
      - name: retailerId
        in: path
        description: Retailer id.
        required: true
        schema:
          type: string
      requestBody:
        description: Request of recommended keywords.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputRecommendedKeywordsRequestV1'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeRecommendedKeywordsResponseV1'
      security:
      - oauth:
        - RetailMedia_Campaign_Read
components:
  schemas:
    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.
    JsonApiRequestOfSellerCatalogRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JsonApiBodyWithoutIdOfSellerCatalogRequestAndSellerCatalogRequest'
      additionalProperties: false
      description: A JSON:API wrapper class to format a <typeparamref name="TAttributes" /> with Type, and Attributes properties
    InputKeywords:
      type: object
      properties:
        negativeBroad:
          type: array
          items:
            type: string
          description: The collection of supplied negative broad phrased
          nullable: true
        negativeExact:
          type: array
          items:
            type: string
          description: The collection of supplied negative exact phrase
          nullable: true
        positiveExact:
          type: array
          items:
            type: string
          description: The collection of supplied positive exact phrases
          nullable: true
      additionalProperties: false
      description: Keywords submitted by the user binned by type after some cleanup has been performed
    AudienceTarget202110:
      required:
      - scope
      - audienceIds
      type: object
      properties:
        audienceIds:
          type: array
          items:
            type: string
            description: Audience ids that should be targeted
            format: long-id
          description: Audience ids that should be targeted
        scope:
          enum:
          - unknown
          - include
          - exclude
          type: string
          description: Scope of the audience target
      description: Identifies audience targeting for a line item
    InputResourceOfPreferredLineItemCreateModelV2:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/PreferredLineItemCreateModelV2'
        type:
          type: string
      description: Data model for a Resource
    JsonApiBodyWithIdOfInt64AndBrandAndBrand:
      required:
      - id
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/ExternalBrand'
        id:
          type: string
          format: long-id
        type:
          type: string
      additionalProperties: false
      description: "A JSON:API wrapper class to format a <typeparamref name=\"TAttributes\" /> with external Id, Type, and\r\nAttributes properties"
    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
    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
    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
    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.
    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
    JsonApiSingleResponseOfCampaignV202301:
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonError'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonWarning'
      description: A JSON:API wrapper class to add one JSON:API <typeparamref name="T" /> within a data property
    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
    Category202204ListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceOfCategory202204'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for several entities.
    SellerCatalogRequestV2:
      type: object
      properties:
        includeFields:
          type: array
          items:
            enum:
            - Unknown
            - Description
            - ImageUrl
            - GoogleCategory
            - RetailerName
            - Category
            - BrandName
            type: string
          description: Out of the optional fields, only the ones specified will be included in the catalog generated.
          nullable: true
        modifiedAfter:
          type: string
          description: Only products modified after this time will be returned.
          format: date-time
          nullable: true
        sellers:
          type: array
          items:
            $ref: '#/components/schemas/SellerIdentifierV2'
          description: A list of sellers to restrict the catalog to.
          nullable: true
      additionalProperties: false
      description: Used to request a catalog of seller SKUs
    SellerCatalogRequest:
      required:
      - sellers
      type: object
      properties:
        sellers:
          type: array
          items:
            $ref: '#/components/schemas/SellerIdentifier'
          description: A list of sellers to restrict the catalog to.
      additionalProperties: false
      description: Used to request a catalog of seller SKUs
    RecommendedKeywordsResponseV1:
      required:
      - recommendedKeywords
      type: object
      properties:
        recommendedKeywords:
          type: array
          items:
            type: string
          description: Recommended keywords generated by given retailer Id and sku Ids.
      additionalProperties: false
      description: Response model of Recommended Keywords
      nullable: true
    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
    BrandCatalogRequestV2:
      type: object
      properties:
        brandIdFilter:
          type: array
          items:
            type: string
            description: The brand ids to filter the catalog by.
            format: long-id
          description: The brand ids to filter the catalog by.
          nullable: true
        includeFields:
          type: array
          items:
            enum:
            - Unknown
            - Description
            - ImageUrl
            - GoogleCategory
            - RetailerName
            - Category
            - BrandName
            type: string
          description: Out of the optional fields, only the ones specified will be included in the catalog generated.
          nullable: true
        modifiedAfter:
          type: string
          description: Only products modified after this time will be returned.
          format: date-time
          nullable: true
        retailerIdFilter:
          type: array
          items:
            type: integer
            format: int32
          description: The retailer ids to filter the catalog by.
          nullable: true
      additionalProperties: false
      description: A request for a catalog under the specified format.
    ValueResourceCpcMinBidsResponse:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CpcMinBidsResponse'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
      nullable: true
    LineItemPageCategoryV2:
      required:
      - categoryId
      type: object
      properties:
        categoryId:
          type: string
        includeChildren:
          type: boolean
          default: true
      description: Category information for a preferred line item page
    EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EntityResourceLineItemKeywordReviewReport'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          nullable: true
          readOnly: true
        meta:
          $ref: '#/components/schemas/Metadata'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          nullable: true
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for several entities and metadata.
    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
    ValueResourceCpcMinBidsRequest:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CpcMinBidsRequest'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
    JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301:
      required:
      - id
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/EditableCampaignAttributesV202301'
        id:
          type: string
          format: long-id
        type:
          type: string
      description: "A JSON:API wrapper class to format a <typeparamref name=\"TAttributes\" /> with Id, Type, and\r\nAttributes properties"
    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
    SetBidModel:
      type: object
      properties:
        bid:
          type: number
          format: double
          nullable: true
        phrase:
          maxLength: 255
          minLength: 0
          type: string
          nullable: true
      additionalProperties: false
      description: A single keyword and associated bid override
    AudienceTarget202110Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueTypeResourceOfAudienceTarget202110'
      description: Data model for a value type input resource
    LineItemProductStatus:
      enum:
      - unknown
      - active
      - paused
      type: string
      description: The status of a promoted product in the context of the line item.
      nullable: true
    Template:
      required:
      - allCollectionsMandatory
      - createdAt
      - creativeFormat
      - name
      - sections
      - skuCollectionMin
      - skuPerCollectionMin
      - updatedAt
      type: object
      properties:
        allCollectionsMandatory:
          type: boolean
          description: Marks whether or not all collections are mandatory
        createdAt:
          type: string
          description: The time at which the template was created
          format: date-time
        creativeFormat:
          enum:
          - Unknown
          - FlagShip
          - Showcase
          - SponsoredProducts
          - Butterfly
          - BundleBoost
          - IAB
          - CUSTOM
          - DisplayPanel
          - DigitalShelfTalker
          type: string
          description: The kind of creative this template can be used to build.
        displayableSkusMax:
          type: integer
          description: Maximum number of displayable skus
          format: int32
          nullable: true
        id:
          type: string
          nullable: true
        name:
          type: string
          description: The name of the template
        sections:
          type: array
          items:
            $ref: '#/components/schemas/Section'
          description: The sections holding various template variables
        skuCollectionMax:
          type: integer
          description: Maximum number of skus in the collection
          format: int32
          nullable: true
        skuCollectionMin:
          type: integer
          description: Minimum number of skus in the collection
          format: int32
        skuPerCollectionMax:
          type: integer
          description: Maximum number of skus per collection
          format: int32
          nullable: true
        skuPerCollectionMin:
          type: integer
          description: Minimum number of skus per collection
          format: int32
        updatedAt:
          type: string
          description: The time at which the template was updated
          format: date-time
      additionalProperties: false
      description: A template for creating creatives.
      nullable: true
    JsonApiPageResponseOfCampaignV202301:
      required:
      - metadata
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonError'
        metadata:
          $ref: '#/components/schemas/PageMetadata'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonWarning'
      description: A wrapper class to return a single page of <typeparamref name="T" /> with metadata
    ValueTypeResourceOfAudienceTarget202110:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceTarget202110'
        type:
          type: string
      description: Data model for a value type resource
    KeywordDataModel:
      type: object
      properties:
        bid:
          type: number
          description: The bid to use when a positive keyword matches the shopper search phrase.
          format: double
          nullable: true
        createdAt:
          type: string
          description: The time at which this keyword was created in UTC.
          format: date-time
        inputKeywords:
          $ref: '#/components/schemas/InputKeywordsModel'
        matchType:
          enum:
          - PositiveExactMatch
          - NegativeExactMatch
          - NegativeBroadMatch
          type: string
          description: The matching algorithm to be used when comparing this keyword with the shopper search phrase.
        reviewState:
          $ref: '#/components/schemas/ReviewStateModel'
        updatedAt:
          type: string
          description: The time at which this keyword was last modified in UTC.
          format: date-time
      additionalProperties: false
      description: A single keyword and associated bid override.
    JsonApiSingleResponseOfCatalogStatus:
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonError'
          nullable: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonWarning'
          nullable: true
      additionalProperties: false
      description: A JSON:API wrapper class to add one JSON:API <typeparamref name="T" /> within a data property
    JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301:
      required:
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CampaignAttributesV202301'
        type:
          type: string
      description: "A JSON:API wrapper class to format a <typeparamref name=\"TAttributes\" /> with Type, and\r\nAttributes properties"
    ValueTypeResourceOfStoreTarget202110:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/StoreTarget202110'
        type:
          type: string
      description: Data model for a value type resource
    Category202204:
      required:
      - name
      - parentId
      - text
      type: object
      properties:
        name:
          type: string
          description: Category Name
        parentId:
          type: string
          description: Category ParentId
        text:
          type: string
          description: Category Text
      additionalProperties: false
      description: List of retailer's categories, including the full hierarchy of categories and their parent category ID
      nullable: true
    CommonLineItemPagedListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceOfCommonLineItem'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        metadata:
          $ref: '#/components/schemas/PageMetadata'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: Data model for a paged list of response resources
    LineItemBidMultipliersV2Response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfLineItemBidMultipliersV2'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single entity
      nullable: true
    CampaignV202301:
      required:
      - accountId
      - createdAt
      - updatedAt
      - name
      - isAutoDailyPacing
      type: object
      properties:
        accountId:
          type: string
          format: long-id
        budget:
          type: number
          format: double
          nullable: true
        budgetRemaining:
          type: number
          format: double
          nullable: true
        budgetSpent:
          type: number
          format: double
          nullable: true
        clickAttributionScope:
          enum:
          - unknown
          - sameSku
          - sameSkuCategory
          - sameSkuCategoryBrand
          type: string
          nullable: true
        clickAttributionWindow:
          enum:
          - 7D
          - 14D
          - 30D
          - unknown
          type: string
          default: 30D
        companyName:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        dailyPacing:
          type: number
          format: double
          nullable: true
        drawableBalanceIds:
          type: array
          items:
            type: string
            format: long-id
        endDate:
          type: string
          format: date-time
          nullable: true
        isAutoDailyPacing:
          type: boolean
        monthlyPacing:
          type: number
          format: double
          nullable: true
        name:
          maxLength: 255
          minLength: 0
          type: string
        onBehalfCompanyName:
          type: string
          nullable: true
        promotedBrandIds:
          type: array
          items:
            type: string
            format: long-id
        retailerId:
          type: integer
          format: int32
          nullable: true
        startDate:
          type: string
          format: date-time
          nullable: true
        status:
          enum:
          - unknown
          - active
          - inactive
          - scheduled
          - ended
          type: string
        type:
          enum:
          - unknown
          - auction
          - preferred
          type: string
          default: auction
        updatedAt:
          type: string
          format: date-time
        viewAttributionScope:
          enum:
          - unknown
          - sameSku
          - sameSkuCategory
          - sameSkuCategoryBrand
          type: string
          nullable: true
        viewAttributionWindow:
          enum:
          - none
          - 1D
          - 7D
          - 14D
          - 30D
          - unknown
          type: string
          default: none
      description: A Retail Media Campaign used to represent an advertiser's marketing objective
    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
    ValueResourceOutcomeRetailMediaKeywordsReviewResult:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceRetailMediaKeywordsReviewResult'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          nullable: true
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single value object.
    ValueResourceOutcomeOfRecommendedKeywordsResult:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfRecommendedKeywordsResult'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          nullable: true
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single value object.
    Creative202210Response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfCreative202210'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single entity.
    LineItemKeywordReviewReport:
      required:
      - accountId
      - accountName
      - campaignId
      - campaignName
      - countKeywords
      - lineItemId
      - lineItemName
      - retailerId
      - retailerName
      type: object
      properties:
        accountId:
          type: string
          description: External ID of the account containing the campaign containing the line item this report is for
        accountName:
          type: string
          description: Name of the account containing the campaign containing the line item this report is for
        campaignId:
          type: string
          description: External ID of the campaign containing the line item this report is for
        campaignName:
          type: string
          description: Name of the campaign containing the line item this report is for
        countKeywords:
          type: integer
          description: Number of PositiveExactMatch keywords on this line item that are in either "InReview" or "Pending" state
          format: int32
        lineItemId:
          type: string
          description: External ID of the line item that this report is for
        lineItemName:
          type: string
          description: Name of the line item that this report is for
        retailerId:
          type: string
          description: Retailer ID connected to the line item this report is for
        retailerName:
          type: string
          description: Name of the retailer connected to the line item this report is for
      additionalProperties: false
      description: Reports on a line item which contains one or more actionable keyword reviews
      nullable: true
    StoreTarget202110:
      required:
      - scope
      - storeIds
      type: object
      properties:
        scope:
          enum:
          - unknown
          - include
          - exclude
          type: string
          description: Scope of the store target
        storeIds:
          type: array
          items:
            type: string
          description: Store ids that should be targeted
      description: Identifies store targeting for a line item
    EntityResourceCollectionOutcomeCategory202204:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EntityResourceCategory202204'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities.
    KeywordsModel:
      type: object
      properties:
        keywords:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/KeywordDataModel'
          description: A dictionary of normalized keywords mapped to their properties.
          nullable: true
        rank:
          type: array
          items:
            type: string
          description: The top suggested keywords for products in this line item ranked by popularity score.
          nullable: true
      additionalProperties: false
      description: The keywords associated with a line item.
      nullable: true
    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.
    JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest:
      required:
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/ExternalCatalogRequest'
        type:
          type: string
      additionalProperties: false
      description: "A JSON:API wrapper class to format a <typeparamref name=\"TAttributes\" /> with Type, and\r\nAttributes properties"
    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.
    ResourceOutcome:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/RmcaCommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/RmcaCommonProblem'
          nullable: true
          readOnly: true
      additionalProperties: false
      description: Outcome object containing errors and warnings.
    StoreIdsUpdateModel202110Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueTypeResourceOfStoreIdsUpdateModel202110'
      description: Data model for a value type input resource
    CampaignMonthlyBudgetOverride:
      required:
      - duration
      - maxMonthlySpend
      type: object
      properties:
        duration:
          type: string
          description: The number of MONTHs that the override is active from StartMonth, e.g. "1M". Must end with 'M' or 'm'.
        maxMonthlySpend:
          type: number
          description: Monthly budget override maximum monthly spend amount.
          format: double
        startMonth:
          type: string
          description: Monthly budget override start month, format "yyyy-MM". If it is null, the StartMonth would be the following month of the last item in the override sequence.
          format: date-time
          nullable: true
        status:
          enum:
          - Expired
          - Active
          - Upcoming
          type: string
          description: Monthly budget override computed status.
          nullable: true
      additionalProperties: false
      description: Campaign monthly budget override.
    ValueResourceInputRecommendedCategoriesRequestV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceRecommendedCategoriesRequestV1'
      description: A top-level object that encapsulates a Criteo API request for a single value objects.
    TemplateResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfTemplate'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single entity.
    ValueResourceInputOfBrandCatalogRequestV2:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfBrandCatalogRequestV2'
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API request for a single value object.
    TemplateVariable:
      required:
      - id
      - required
      - type
      type: object
      properties:
        choiceVariableSpecification:
          $ref: '#/components/schemas/ChoiceVariableSpecification'
        filesVariablesSpecification:
          $ref: '#/components/schemas/FilesVariablesSpecification'
        id:
          type: string
          description: The id of the variable
        required:
          type: boolean
          description: Whether the variable is required
        textVariableSpecification:
          $ref: '#/components/schemas/TextVariableSpecification'
        type:
          enum:
          - Text
          - Choice
          - Color
          - Files
          - Hyperlink
          - Video
          type: string
          description: The type of the variable
      additionalProperties: false
      description: A variable in a creative template
    FilesVariablesSpecification:
      required:
      - extensions
      type: object
      properties:
        extensions:
          type: array
          items:
            enum:
            - Unknown
            - Jpeg
            - Png
            - Gif
            - Pdf
            - Mp4
            type: string
            description: File extensions supported in templates
          description: The accepted file extensions
        maxBytes:
          type: integer
          description: The maximum amount of bytes per file
          format: int32
          nullable: true
        maxFile:
          type: integer
          description: The maximum amount of files required
          format: int32
          nullable: true
        minFiles:
          type: integer
          description: The minimum amount of files requires
          format: int32
          nullable: true
      additionalProperties: false
      description: Specification of a file variable
      nullable: true
    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
    SellerIdentifier:
      required:
      - retailerId
      - sellerId
      type: object
      properties:
        retailerId:
          type: string
          description: The retailer Id that the seller operates under
        sellerId:
          type: string
          description: The id for the seller based on the corresponding retailer
      additionalProperties: false
      description: Identifies a Unique Seller
    BalanceCampaign202110PagedListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceOfBalanceCampaign202110'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        metadata:
          $ref: '#/components/schemas/PageMetadata'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: Data model for a paged list of response resources
    EditableCampaignAttributesV202301:
      required:
      - name
      - isAutoDailyPacing
      - clickAttributionWindow
      - viewAttributionWindow
      type: object
      properties:
        budget:
          type: number
          format: double
          nullable: true
        clickAttributionScope:
          enum:
          - unknown
          - sameSku
          - sameSkuCategory
          - sameSkuCategoryBrand
          type: string
          nullable: true
        clickAttributionWindow:
          enum:
          - 7D
          - 14D
          - 30D
          - unknown
          type: string
        companyName:
          type: string
          nullable: true
        dailyPacing:
          type: number
          format: double
          nullable: true
        endDate:
          type: string
          format: date-time
          nullable: true
        isAutoDailyPacing:
          type: boolean
        monthlyPacing:
          type: number
          format: double
          nullable: true
        name:
          maxLength: 255
          minLength: 0
          type: string
        onBehalfCompanyName:
          type: string
          nullable: true
        startDate:
          type: string
          format: date-time
          nullable: true
        viewAttributionScope:
          enum:
          - unknown
          - sameSku
          - sameSkuCategory
          - sameSkuCategoryBrand
          type: string
          nullable: true
        viewAttributionWindow:
          enum:
          - none
          - 1D
          - 7D
          - 14D
          - 30D
          - unknown
          type: string
      description: An object that represents the available options to set when editing a Retail Media Campaign
    ExternalCatalogStatus:
      required:
      - createdAt
      - currency
      - fileSizeBytes
      - md5Checksum
      - message
      - rowCount
      - status
      type: object
      properties:
        createdAt:
          type: string
          description: The time this catalog was created. Represented as a UTC ISO8601 string.
          format: date-time
        currency:
          type: string
          description: An ISO4217 representation of the currency products are listed under in this catalog.
          nullable: true
        fileSizeBytes:
          type: integer
          description: The size of this catalog in bytes. Available when this catalog reaches a success status.
          format: int32
          nullable: true
        md5Checksum:
          type: string
          description: "An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval.\r\nAvailable when this catalog reaches a success status."
          nullable: true
        message:
          type: string
          description: An optional information message intended for developer consumption.
          nullable: true
        rowCount:
          type: integer
          description: "An indication of the number of products contained in this catalog. Available when\r\nthis catalog reaches a success status."
          format: int32
          nullable: true
        status:
          enum:
          - unknown
          - pending
          - success
          - failure
          - expired
          type: string
          description: An enumeration of the status of the catalog.
      additionalProperties: false
      description: The status of an asynchronous request to generate a catalog
      nullable: true
    SellerIdentifierV2:
      required:
      - retailerId
      - sellerId
      type: object
      properties:
        retailerId:
          type: string
          description: The retailer Id that the seller operates under
        sellerId:
          type: string
          description: The id for the seller based on the corresponding retailer
      additionalProperties: false
      description: Identifies a Unique Seller
    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.
    StoreTarget202110Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueTypeResourceOfStoreTarget202110'
      description: Data model for a value type input resource
    JsonApiBodyWithoutIdOfSellerCatalogRequestAndSellerCatalogRequest:
      required:
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/SellerCatalogRequest'
        type:
          type: string
      additionalProperties: false
      description: "A JSON:API wrapper class to format a <typeparamref name=\"TAttributes\" /> with Type, and\r\nAttributes properties"
    ChoiceVariableSpecification:
      required:
      - options
      type: object
      properties:
        maxSelected:
          type: integer
          description: The maximum number of selectable options
          format: int32
          nullable: true
        minSelected:
          type: integer
          description: The minimum number of selectable options
          format: int32
          nullable: true
        options:
          type: array
          items:
            $ref: '#/components/schemas/ChoiceOption'
          description: The available options
      additionalProperties: false
      description: Specification of choice variable
      nullable: true
    Asset:
      required:
      - fileExtension
      type: object
      properties:
        fileExtension:
          type: string
          description: 'The file extension that is asset is representing. Example: jpg, png, gif or pdf.'
        fileLocation:
          type: string
          description: A url pointing towards the static file the asset represents.
          nullable: true
      description: Handles pointing towards binary content that advertisers can use later on, for example in their creatives.
      nullable: true
      x-criteo-canonical:
        infoType: entity
        name: RetailMediaAsset
        version: '202110'
    AddRemoveKeywordsModelResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AddRemoveKeywordsModel'
        id:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
      additionalProperties: false
      description: Resource object containing keywords to be added or removed from a line item
    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.
    JsonApiBodyWithLineItemBidMultipliersV2:
      required:
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/LineItemBidMultipliersV2'
        type:
          type: string
      description: "A JSON:API wrapper class to format a <typeparamref name=\"TAttributes\" /> with Id, Type, and\r\nAttributes properties"
    EntityResourceCategory202204:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Category202204'
        id:
          type: string
          description: Unique id of the entity.
          nullable: true
        type:
          type: string
          description: Type of the resource.
          nullable: true
      description: A domain entity exposed by the API, identified by a unique id.
    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
    ResourceOfBalanceCampaign202110:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/BalanceCampaign202110'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          description: Canonical type name of the entity
          nullable: true
      description: A class that represents a domain entity exposed by an API
    KeywordsModelResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/KeywordsModelResource'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/RmcaCommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/RmcaCommonProblem'
          nullable: true
          readOnly: true
      additionalProperties: false
      description: Response object containing keywords associated with a line item.
    BalanceCampaign202110:
      type: object
      description: Campaigns related to the balance
    ValueResourceOfSellerCatalogRequestV2:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/SellerCatalogRequestV2'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
    LineItemBidMultipliersV2:
      type: object
      properties:
        category:
          type: number
          description: Categories Page Type Bid Multiplier
          format: double
          nullable: true
        categoryMenu:
          type: number
          description: CategoryMenu Page Type Bid Multiplier
          format: double
          nullable: true
        checkout:
          type: number
          description: Checkout Page Type Bid Multiplier
          format: double
          nullable: true
        confirmation:
          type: number
          description: Confirmation Page Type Bid Multiplier
          format: double
          nullable: true
        deals:
          type: number
          description: Deals Page Type Bid Multiplier
          format: double
          nullable: true
        favorites:
          type: number
          description: Favorites Page Type Bid Multiplier
          format: double
          nullable: true
        home:
          type: number
          description: Home Page Type Bid Multiplier
          format: double
          nullable: true
        id:
          type: string
          nullable: true
        merchandising:
          type: number
          description: Merchandising Page Type Bid Multiplier
          format: double
          nullable: true
        productDetail:
          type: number
          description: ProductDetail Page Type Bid Multiplier
          format: double
          nullable: true
        search:
          type: number
          description: Search Page Type Bid Multiplier
          format: double
          nullable: true
        searchBar:
          type: number
          description: SearchBar Page Type Bid Multiplier
          format: double
          nullable: true
      description: The Bid Multiplier Entity of a LineItem
      nullable: true
    BalanceCampaign202110ListRequest:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceOfBalanceCampaign202110'
      description: A top-level object that encapsulates a Criteo API request for several entities
    Section:
      required:
      - templateVariables
      type: object
      properties:
        description:
          type: string
          nullable: true
        templateVariables:
          type: array
          items:
            $ref: '#/components/schemas/TemplateVariable'
        title:
          type: string
          nullable: true
      additionalProperties: false
      description: Section object that hold template variables
    ResourceOfTemplate:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Template'
        id:
          type: string
          description: Unique identifier of this resource.
          nullable: true
        type:
          type: string
          nullable: true
      additionalProperties: false
      description: A class that represents a domain entity exposed by an API.
      nullable: true
    ValueResourceOfBrandCatalogRequestV2:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/BrandCatalogRequestV2'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
    ExternalBrand:
      required:
      - name
      type: object
      properties:
        name:
          maxLength: 120
          minLength: 0
          type: string
      additionalProperties: false
      description: A Retail Media Brand used to represent a collection of products sold under the same umbrella name
      nullable: true
    ReviewSetState:
      required:
      - phrase
      - reviewState
      type: object
      properties:
        phrase:
          type: string
          description: Normalized key phrase for keyword review to update
        reviewState:
          enum:
          - Unknown
          - InReview
          - Recommended
          - Approved
          - AutoApproved
          - Rejected
          - AutoRejected
          type: string
          description: Keyword review state to set for a phrase
      additionalProperties: false
      description: A Phrase-ReviewState pair describing an update to a keyword review
    ResourceOfCreative202210:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Creative202210'
        id:
          type: string
          description: Unique identifier of this resource.
          nullable: true
        type:
          type: string
          nullable: true
      additionalProperties: false
      description: A class that represents a domain entity exposed by an API.
      nullable: true
    CommonLineItemResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfCommonLineItem'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single entity
    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.
    ExternalCatalogRequest:
      type: object
      properties:
        brandIdFilter:
          type: array
          items:
            type: string
            format: long-id
          nullable: true
        format:
          enum:
          - unknown
          - json-newline
          type: string
          description: An enumeration of Catalog formats
          default: json-newline
      additionalProperties: false
      description: A request for a catalog under the specified format. Currently "json-newline" is supported.
    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.
    AddRemoveKeywordsModelRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AddRemoveKeywordsModelResource'
      additionalProperties: false
      description: Request object to add or remove keywords from a line item
    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.
    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
    RetailMediaKeywordsReviewResult:
      required:
      - keywords
      type: object
      properties:
        keywords:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/ReviewSetState'
      additionalProperties: false
      description: Response object for approval of keyword reviews, containing a list of Phrase-ReviewState pairs
      nullable: true
    AudienceTarget202110Response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueTypeResourceOfAudienceTarget202110'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: Data model for a value type resource outcome
    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.
    Creative202110:
      required:
      - name
      - retailerId
      - status
      type: object
      properties:
        associatedLineItemIds:
          type: array
          items:
            type: string
          nullable: true
        brandId:
          type: integer
          format: int64
          nullable: true
        id:
          type: string
          nullable: true
        name:
          type: string
        retailerId:
          type: integer
          format: int32
        status:
          enum:
          - Ready
          - In_Use
          - Archived
          - Deleted
          type: string
        updatedAt:
          type: string
          format: date-time
          nullable: true
      additionalProperties: false
      description: Metadata and usage info of a preferred deals creative
      nullable: true
    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
    ValueResourceOutcomeCpcMinBidsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceCpcMinBidsResponse'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          nullable: true
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single value object.
    CampaignDailyBudgetOverride:
      required:
      - duration
      - maxDailySpend
      type: object
      properties:
        duration:
          type: string
          description: The number of DAYs that the override is active from StartDate, e.g. "1D". Must end with 'D' or 'd'.
        maxDailySpend:
          type: number
          description: Daily budget override maximum daily spend amount.
          format: double
        startDate:
          type: string
          description: Daily budget override start date, format "yyyy-MM-dd". If it is null, the StartDate would be the following date of the last item in the override sequence.
          format: date-time
          nullable: true
        status:
          enum:
          - Expired
          - Active
          - Upcoming
          type: string
          description: Daily budget override computed status.
          nullable: true
      additionalProperties: false
      description: Campaign daily budget override.
    ValueResourceRecommendedKeywordsRequestV1:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/RecommendedKeywordsRequestV1'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
    KeywordsModelResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/KeywordsModel'
        id:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
      additionalProperties: false
      description: Resource object containing keywords associated with a line item.
      nullable: true
    PostCampaignV202301:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301'
      description: An object that represents the available options to set when creating a Retail Media Campaign
    ValueResourceOfCampaignBudgetOverrides:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CampaignBudgetOverrides'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
      nullable: true
    PreferredLineItemCreateModelV2Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/InputResourceOfPreferredLineItemCreateModelV2'
      description: Data model for a create input resource
    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
    ReviewStateModel:
      enum:
      - InReview
      - Recommended
      - Approved
      - AutoApproved
      - Rejected
      - AutoRejected
      type: string
      description: The state of a keyword in the context of a line item.
    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
    InputKeywordsModel:
      type: object
      properties:
        negativeBroad:
          type: array
          items:
            type: string
          description: The collection of supplied negative broad phrases.
          nullable: true
        negativeExact:
          type: array
          items:
            type: string
          description: The collection of supplied negative exact phrases.
          nullable: true
        positiveExact:
          type: array
          items:
            type: string
          description: The collection of supplied positive exact phrases.
          nullable: true
      additionalProperties: false
      description: The keywords to be added or removed from a line item.
    AddRemoveKeywordsModel:
      type: object
      properties:
        keywords:
          type: array
          items:
            $ref: '#/components/schemas/AddRemoveKeywordModel'
          nullable: true
      additionalProperties: false
      description: Data model containing keywords to be added or removed from a line item
    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
    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.
    AddToBasketTarget202110Response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueTypeResourceOfAddToBasketTarget202110'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: Data model for a value type resource outcome
    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
    CategoriesSearchRequestV1:
      type: object
      properties:
        categoryIds:
          minItems: 1
          type: array
          items:
            type: string
          description: Categories search category ids criteria.
          nullable: true
        textSubstring:
          type: string
          description: Categories search text substring criteria.
          nullable: true
      description: An object that represents the request of CategoriesSearch endpoint.
    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.
    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.
    AddToBasketIdsUpdateModel202110:
      type: object
      properties:
        categoryIds:
          type: array
          items:
            type: string
          description: Category ids that add to basket should target
        productIds:
          type: array
          items:
            type: string
          description: Product ids that add to basket should target
      description: Update model for updating add to basket target ids
    ResourceOfCategory202204:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Category202204'
        id:
          type: string
          description: Unique identifier of this resource.
          nullable: true
        type:
          type: string
          nullable: true
      additionalProperties: false
      description: A class that represents a domain entity exposed by an API.
    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
    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
    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
    TextVariableSpecification:
      type: object
      properties:
        maxChars:
          type: integer
          description: The maximum amount of characters accepted for the text
          format: int32
          nullable: true
      additionalProperties: false
      description: Specification of a text variable
      nullable: true
    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.
    CampaignBudgetOverrides:
      required:
      - dailyBudgetOverrides
      - monthlyBudgetOverrides
      type: object
      properties:
        dailyBudgetOverrides:
          type: array
          items:
            $ref: '#/components/schemas/CampaignDailyBudgetOverride'
          description: Campaign budget override daily part, chronological order restricted.
        monthlyBudgetOverrides:
          type: array
          items:
            $ref: '#/components/schemas/CampaignMonthlyBudgetOverride'
          description: Campaign budget override monthly part, chronological order restricted.
      additionalProperties: false
      description: Campaign budget overrides including Monthly and Daily budget overrides.
      nullable: true
    JsonApiRequestOfCatalogRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest'
      additionalProperties: false
      description: A JSON:API wrapper class to format a <typeparamref name="TAttributes" /> with Type, and Attributes properties
    StoreIdsUpdateModel202110:
      required:
      - storeIds
      type: object
      properties:
        storeIds:
          type: array
          items:
            type: string
          description: Store ids that should be targeted
      description: Update model for updating store target ids
    LineItemBidMultipliersV2Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfLineItemBidMultipliersV2'
      description: A top-level object that encapsulates a Criteo API request for a single entity
      nullable: true
    TemplateListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceOfTemplate'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for several entities.
    AssetResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Asset'
        id:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API
      nullable: true
    ValueResourceInputCategoriesSearchRequestV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceCategoriesSearchRequestV1'
      description: A top-level object that encapsulates a Criteo API request for a single value objects.
    ValueResourceOutcomeOfLineItemBudgetOverrides:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfLineItemBudgetOverrides'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          nullable: true
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single value object.
    Creative202110ListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceOfCreative202110'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for several entities.
    ValueTypeResourceOfAddToBasketTarget202110:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AddToBasketTarget202110'
        type:
          type: string
      description: Data model for a value type resource
    Creative2ListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceOfCreative2'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for several entities.
    PageTypeEnvironment202210:
      type: object
      properties:
        environments:
          type: array
          items:
            enum:
            - Web
            - Mobile
            - App
            - Lockout
            - Mixed
            - iOS
            - Android
            type: string
            description: Creative format, defining where the creative can be served
          description: List of environments per PageType
          nullable: true
        pageType:
          enum:
          - Search
          - Home
          - Browse
          - Checkout
          - Category
          - ProductDetail
          - Confirmation
          - Merchandising
          - Deals
          type: string
          description: Creative PageType
          nullable: true
      additionalProperties: false
      description: The PageType-Environment Tuples for creatives
    StoreTarget202110Response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueTypeResourceOfStoreTarget202110'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: Data model for a value type resource outcome
    LineItemBudgetOverrides:
      required:
      - dailyLineItemBudgetOverrides
      - monthlyLineItemBudgetOverrides
      type: object
      properties:
        dailyLineItemBudgetOverrides:
          type: array
          items:
            $ref: '#/components/schemas/DailyLineItemBudgetOverride'
          description: Line item budget override daily part, chronological order restricted.
        monthlyLineItemBudgetOverrides:
          type: array
          items:
            $ref: '#/components/schemas/MonthlyLineItemBudegetOverride'
          description: Line item budget override monthly part, chronological order restricted.
      additionalProperties: false
      description: Line item budget overrides including Monthly and Daily budget overrides.
      nullable: true
    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.
    EntityResourceLineItemKeywordReviewReport:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/LineItemKeywordReviewReport'
        id:
          type: string
          description: Unique id of the entity.
          nullable: true
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A domain entity exposed by the API, identified by a unique id.
    RecommendedKeywordsRequestV1:
      required:
      - productIds
      type: object
      properties:
        productIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
          description: Product Id list that the recommended keywords generated on.
      additionalProperties: false
      description: Request model of RecommendedKeywords
    AddToBasketTarget202110:
      required:
      - scope
      type: object
      properties:
        categoryIds:
          type: array
          items:
            type: string
          description: Category ids that add to basket should target
        productIds:
          type: array
          items:
            type: string
          description: Product ids that add to basket should target
        scope:
          enum:
          - unknown
          - include
          - exclude
          type: string
          description: Scope of the add to basket target
      description: Identifies add to basket targeting for a line item
    ChoiceOption:
      required:
      - dependentVariables
      - id
      type: object
      properties:
        dependentVariables:
          type: array
          items:
            $ref: '#/components/schemas/TemplateVariable'
          description: Template variables unblocked when the option is chosen
        id:
          type: string
          description: The id of the option
      additionalProperties: false
      description: An option given in a choice
    AssetResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AssetResource'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single entity
    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.
    CreativeUpdateModel202207:
      required:
      - name
      - retailerId
      - templateId
      - templateVariableValues
      type: object
      properties:
        brandId:
          type: integer
          description: The brand associated to the creative
          format: int64
        id:
          type: string
          nullable: true
        name:
          type: string
          description: The name of the creative
        retailerId:
          type: integer
          description: The retailer associated to the creative
          format: int32
        templateId:
          type: integer
          description: The creative template used for this creative
          format: int32
        templateVariableValues:
          type: array
          items:
            $ref: '#/components/schemas/TemplateVariableValue'
          description: The template chosen values
      additionalProperties: false
      description: Update model of a creative
    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
    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.
    PageMetadata:
      required:
      - currentPageIndex
      - currentPageSize
      type: object
      properties:
        currentPageIndex:
          type: integer
          format: int32
        currentPageSize:
          type: integer
          format: int32
        nextPage:
          type: string
          nullable: true
        previousPage:
          type: string
          nullable: true
        totalItemsAcrossAllPages:
          type: integer
          format: int64
          nullable: true
        totalPages:
          type: integer
          format: int64
          nullable: true
      additionalProperties: false
      description: Metadata related to the current request
    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.
    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
    ValueResourceRecommendedCategoriesRequestV1:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/RecommendedCategoriesRequestV1'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      description: A value resource exposed by the API.
    JsonApiSingleResponseOfLineItemBidMultipliersV2:
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JsonApiBodyWithLineItemBidMultipliersV2'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonError'
          nullable: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonWarning'
          nullable: true
      description: A JSON:API wrapper class to add one JSON:API <typeparamref name="T" /> within a data property
    AddToBasketTarget202110Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueTypeResourceOfAddToBasketTarget202110'
      description: Data model for a value type input resource
    MonthlyLineItemBudegetOverride:
      required:
      - duration
      - maxMonthlySpend
      type: object
      properties:
        duration:
          type: string
          description: The number of MONTHs that the override is active from StartMonth, e.g. "1M". Must end with 'M' or 'm'.
        maxMonthlySpend:
          type: number
          description: Monthly budget override maximum monthly spend amount.
          format: double
        startMonth:
          type: string
          description: Monthly budget override start month, format "yyyy-MM". If it is null, the StartMonth would be the following month of the last item in the override sequence.
          format: date-time
          nullable: true
        status:
          enum:
          - Expired
          - Active
          - Upcoming
          type: string
          description: Monthly budget override computed status.
          nullable: true
      additionalProperties: false
      description: The details for a monthly budget override
    RecommendedCategoriesRequestV1:
      required:
      - productIds
      type: object
      properties:
        productIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
          description: Sku id list.
      description: An object that represents the request of RecommendCategories endpoint.
    Creative202210:
      required:
      - creativeFormatType
      - environments
      - formatId
      - name
      - retailerId
      - status
      - templateId
      - templateName
      - templateVariableValues
      type: object
      properties:
        associatedLineItemIds:
          type: array
          items:
            type: string
          description: Associated Line Item Ids
          nullable: true
        brandId:
          type: integer
          description: Brand Id
          format: int64
          nullable: true
        creativeFormatType:
          enum:
          - Unknown
          - FlagShip
          - Showcase
          - SponsoredProducts
          - Butterfly
          - BundleBoost
          - IAB
          - CUSTOM
          - DisplayPanel
          - DigitalShelfTalker
          type: string
          description: Creative format type
        environments:
          type: array
          items:
            $ref: '#/components/schemas/PageTypeEnvironment202210'
          description: Environment type (e.g. mobile, web, app)
        formatId:
          type: integer
          description: Format Id
          format: int32
        id:
          type: string
          nullable: true
        name:
          type: string
          description: Name
        retailerId:
          type: integer
          description: Retailer Id
          format: int32
        status:
          enum:
          - Ready
          - In_Use
          - Archived
          - Deleted
          type: string
          description: Creative Status
        templateId:
          type: integer
          description: Template Id
          format: int32
        templateName:
          type: string
          description: Template Name
        templateVariableValues:
          type: array
          items:
            $ref: '#/components/schemas/TemplateVariableValue'
          description: The template chosen values
        updatedAt:
          type: string
          description: Updated at time
          format: date-time
          nullable: true
      additionalProperties: false
      description: A creative entity
      nullable: true
    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
    ValueResourceOfRecommendedKeywordsResult:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/RecommendedKeywordsResult'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
      nullable: true
    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
    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
    ValueResourceInputOfSellerCatalogRequestV2:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfSellerCatalogRequestV2'
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API request for a single value object.
    CpcMinBidsRequest:
      required:
      - skuIds
      type: object
      properties:
        skuIds:
          type: array
          items:
            type: string
          description: Sku id list for which minimum bid amounts are requested.
      additionalProperties: false
      description: Cpc Min Bids request object.
    ValueResourceInputCpcMinBidsRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceCpcMinBidsRequest'
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API request for a single value objects.
    CommonLineItem:
      required:
      - name
      - type
      - startDate
      - targetRetailerId
      - campaignId
      type: object
      properties:
        budget:
          type: number
          format: double
          nullable: true
        budgetRemaining:
          type: number
          format: double
          nullable: true
        budgetSpent:
          type: number
          format: double
        campaignId:
          type: string
          format: long-id
        createdAt:
          type: string
          format: date-time
        endDate:
          type: string
          description: Represents the Date as a year, month, and day in the format YYYY-MM-DD
          format: date
          nullable: true
        id:
          type: string
          nullable: true
        name:
          maxLength: 255
          minLength: 0
          type: string
        startDate:
          type: string
          description: Represents the Date as a year, month, and day in the format YYYY-MM-DD
          format: date
        status:
          enum:
          - unknown
          - active
          - scheduled
          - draft
          - paused
          - budgetHit
          - ended
          - archived
          - noFunds
          type: string
        targetRetailerId:
          type: string
          format: long-id
        type:
          enum:
          - unknown
          - auction
          - preferred
          type: string
        updatedAt:
          type: string
          format: date-time
      description: A common line item to hold line item information shared between preferred and auction line items
    SkuMinBid:
      required:
      - minBid
      - skuId
      type: object
      properties:
        minBid:
          type: number
          description: Minimum bid amount value.
          format: double
        skuId:
          type: string
          description: Sku id.
      additionalProperties: false
      description: An object represents the minimum bid amount value of a sku.
    RetailerPages202110:
      required:
      - pageTypes
      type: object
      properties:
        pageTypes:
          type: array
          items:
            type: string
          description: List of valid pages for a retailer
      additionalProperties: false
      description: Wraps a list of valid pages for a retailer
    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
    ValueResourceOutcomeOfCampaignBudgetOverrides:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfCampaignBudgetOverrides'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          nullable: true
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single value object.
    ValueResourceCategoriesSearchRequestV1:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CategoriesSearchRequestV1'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      description: A value resource exposed by the API.
    ValueTypeResourceOfAudienceIdsUpdateModel202110:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceIdsUpdateModel202110'
        type:
          type: string
      description: Data model for a value type resource
    ValueResourceRetailMediaKeywordsReviewResult:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/RetailMediaKeywordsReviewResult'
        type:
          type: string
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
      nullable: true
    AudienceIdsUpdateModel202110Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueTypeResourceOfAudienceIdsUpdateModel202110'
      description: Data model for a value type input resource
    EntityResourceCollectionOutcomeCategory202204Metadata:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EntityResourceCategory202204'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          nullable: true
          readOnly: true
        metadata:
          $ref: '#/components/schemas/Metadata'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities and metadata.
    AudienceIdsUpdateModel202110:
      required:
      - audienceIds
      type: object
      properties:
        audienceIds:
          type: array
          items:
            type: string
            description: Audience ids that should be targeted
            format: long-id
          description: Audience ids that should be targeted
      description: Update model for updating audience target ids
    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
    ResourceOfCreative202110:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Creative202110'
        id:
          type: string
          description: Unique identifier of this resource.
          nullable: true
        type:
          type: string
          nullable: true
      additionalProperties: false
      description: A class that represents a domain entity exposed by an API.
    AddToBasketIdsUpdateModel202110Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueTypeResourceOfAddToBasketIdsUpdateModel202110'
      description: Data model for a value type input resource
    PreferredLineItemUpdateModelV2Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfPreferredLineItemUpdateModelV2'
      description: A top-level object that encapsulates a Criteo API request for a single entity
    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.
    ValueResourceOutcomeRecommendedKeywordsResponseV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceRecommendedKeywordsResponseV1'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          nullable: true
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single value object.
    JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus:
      required:
      - id
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/ExternalCatalogStatus'
        id:
          type: string
          format: long-id
        type:
          type: string
      additionalProperties: false
      description: "A JSON:API wrapper class to format a <typeparamref name=\"TAttributes\" /> with external Id, Type, and\r\nAttributes properties"
    ValueResourceInputOfLineItemBudgetOverrides:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfLineItemBudgetOverrides'
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API request for a single value object.
    ValueResourceRetailMediaKeywordsReview:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/RetailMediaKeywordsReview'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
    RetailMediaKeywordsReview:
      required:
      - keywords
      type: object
      properties:
        keywords:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/ReviewSetState'
      additionalProperties: false
      description: Request object for approval of keyword reviews, containing a list of Phrase-ReviewState pairs
    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.
    ValueTypeResourceOfAddToBasketIdsUpdateModel202110:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AddToBasketIdsUpdateModel202110'
        type:
          type: string
      description: Data model for a value type resource
    ResourceOfCommonLineItem:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CommonLineItem'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          description: Canonical type name of the entity
          nullable: true
      description: A class that represents a domain entity exposed by an API
    SetBidsModelResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/SetBidsModel'
        id:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
      additionalProperties: false
      description: Resource object containing keywords and their associated bid overrides
    RecommendedKeywordsResult:
      type: object
      properties:
        keywords:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Keywords'
          description: Dictionary of keywords to their keyword models
          nullable: true
        recommendedKeywords:
          type: array
          items:
            type: string
          description: Collection of recommended keywords
          nullable: true
      additionalProperties: false
      description: Response model for recommended keywords
      nullable: true
    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
    ValueResourceOfLineItemBudgetOverrides:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/LineItemBudgetOverrides'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
      nullable: true
    AddRemoveKeywordModel:
      type: object
      properties:
        isDeleted:
          type: boolean
        matchType:
          $ref: '#/components/schemas/MatchTypeModel'
        phrase:
          maxLength: 255
          minLength: 0
          type: string
          nullable: true
      additionalProperties: false
      description: A single keyword to be added or removed
    ValueResourceInputOfCampaignBudgetOverrides:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfCampaignBudgetOverrides'
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API request for a single value object.
    ResourceOfLineItemBidMultipliersV2:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/LineItemBidMultipliersV2'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          description: Canonical type name of the entity
          nullable: true
      description: A class that represents a domain entity exposed by an API
      nullable: true
    CommonError:
      type: object
      properties:
        code:
          type: string
          description: (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case.
          nullable: true
        detail:
          type: string
          description: (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem.
          nullable: true
        instance:
          type: string
          description: (REQUIRED) A URI reference that identifies the specific occurrence of the problem.
          nullable: true
        source:
          type: object
          additionalProperties:
            type: string
          description: (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s)
          nullable: true
        stackTrace:
          type: string
          description: (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology
          nullable: true
        title:
          type: string
          description: (RECOMMENDED) A short, human-readable summary of the problem type.
          nullable: true
        traceId:
          type: string
          description: (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.
          nullable: true
        type:
          enum:
          - unknown
          - access-control
          - authentication
          - authorization
          - availability
          - deprecation
          - quota
          - validation
          type: string
          description: (REQUIRED) The classification of the error.
          nullable: true
      additionalProperties: false
      description: A JSON:API Common error structure
    CommonWarning:
      type: object
      properties:
        code:
          type: string
          description: (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case.
          nullable: true
        detail:
          type: string
          description: (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem.
          nullable: true
        instance:
          type: string
          description: (REQUIRED) A URI reference that identifies the specific occurrence of the problem.
          nullable: true
        source:
          type: object
          additionalProperties:
            type: string
          description: (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s)
          nullable: true
        stackTrace:
          type: string
          description: (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology
          nullable: true
        title:
          type: string
          description: (RECOMMENDED) A short, human-readable summary of the problem type.
          nullable: true
        traceId:
          type: string
          description: (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.
          nullable: true
        type:
          enum:
          - unknown
          - access-control
          - authentication
          - authorization
          - availability
          - deprecation
          - quota
          - validation
          type: string
          description: (REQUIRED) The classification of the error.
          nullable: true
      additionalProperties: false
      description: A JSON:API Base common warning
    CreativeCreateModel202207:
      required:
      - name
      - retailerId
      - templateId
      - templateVariableValues
      type: object
      properties:
        brandId:
          type: integer
          description: The brand associated to the creative
          format: int64
          nullable: true
        id:
          type: string
          nullable: true
        name:
          type: string
          description: The name of the creative
        retailerId:
          type: integer
          description: The retailer associated to the creative
          format: int32
        templateId:
          type: integer
          description: The creative template used for this creative
          format: int32
        templateVariableValues:
          type: array
          items:
            $ref: '#/components/schemas/TemplateVariableValue'
          description: The template chosen values
      additionalProperties: false
      description: Create model of a creative
    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
    PutCampaignV202301:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301'
      description: An object that represents the available options to set when editing a Retail Media Campaign
    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.
    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
    CpcMinBidsResponse:
      required:
      - overallMinBid
      - skuMinBids
      type: object
      properties:
        overallMinBid:
          type: number
          description: Overall minimum bid amount for the given list of sku ids.
          format: double
        skuMinBids:
          type: array
          items:
            $ref: '#/components/schemas/SkuMinBid'
          description: Minimum bid amounts for each of the given list of sku ids.
      additionalProperties: false
      description: Cpc Min Bids response object.
      nullable: true
    ValueResourceInputRetailMediaKeywordsReview:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceRetailMediaKeywordsReview'
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API request for a single value object.
    Keywords:
      type: object
      properties:
        bid:
          type: number
          description: The bid to use when a positive keyword matches the shopper search phrase
          format: double
          nullable: true
        createdAt:
          type: string
          description: The time at which this keyword was created in UTC
          format: date-time
        inputKeywords:
          $ref: '#/components/schemas/InputKeywords'
        matchType:
          enum:
          - PositiveExactMatch
          - NegativeExactMatch
          - NegativeBroadMatch
          - Unknown
          type: string
          description: The matching algorthim to be use when comparing this keyword with the shopper search phrase
        reviewState:
          enum:
          - InReview
          - Recommended
          - Approved
          - AutoApproved
          - Rejected
          - AutoRejected
          - Unkown
          type: string
          description: Review status of the keyword
        updatedAt:
          type: string
          description: The time at which the keyword was last modified in UTC
          format: date-time
      additionalProperties: false
      description: Data associated with a normalized keyword phrase
    JsonApiPageResponseOfBrand:
      required:
      - data
      - metadata
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/JsonApiBodyWithIdOfInt64AndBrandAndBrand'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonError'
          nullable: true
        metadata:
          $ref: '#/components/schemas/PageMetadata'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonWarning'
          nullable: true
      additionalProperties: false
      description: A wrapper class to return a single page of <typeparamref name="T" /> with metadata
    CampaignAttributesV202301:
      required:
      - name
      - isAutoDailyPacing
      type: object
      properties:
        budget:
          type: number
          format: double
          nullable: true
        clickAttributionScope:
          enum:
          - unknown
          - sameSku
          - sameSkuCategory
          - sameSkuCategoryBrand
          type: string
          nullable: true
        clickAttributionWindow:
          enum:
          - 7D
          - 14D
          - 30D
          - unknown
          type: string
          default: 30D
        companyName:
          type: string
          nullable: true
        dailyPacing:
          type: number
          format: double
          nullable: true
        drawableBalanceIds:
          type: array
          items:
            type: string
            format: long-id
        endDate:
          type: string
          format: date-time
          nullable: true
        isAutoDailyPacing:
          type: boolean
        monthlyPacing:
          type: number
          format: double
          nullable: true
        name:
          maxLength: 255
          minLength: 0
          type: string
        onBehalfCompanyName:
          type: string
          nullable: true
        retailerId:
          type: integer
          format: int32
        startDate:
          type: string
          format: date-time
          nullable: true
        type:
          enum:
          - unknown
          - auction
          - preferred
          type: string
          default: auction
        viewAttributionScope:
          enum:
          - unknown
          - sameSku
          - sameSkuCategory
          - sameSkuCategoryBrand
          type: string
          nullable: true
        viewAttributionWindow:
          enum:
          - none
          - 1D
          - 7D
          - 14D
          - 30D
          - unknown
          type: string
          default: none
      description: An object that represents the available options to set when creating a Retail Media Campaign
    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.
    ValueResourceInputRecommendedKeywordsRequestV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceRecommendedKeywordsRequestV1'
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API request for a single value objects.
    DailyLineItemBudgetOverride:
      required:
      - duration
      type: object
      properties:
        duration:
          type: string
          description: The number of DAYs that the override is active from StartDate, e.g. "1D". Must end with 'D' or 'd'.
        maxDailySpend:
          type: number
          description: Daily budget override maximum daily spend amount.
          format: double
          nullable: true
        startDate:
          type: string
          description: Daily budget override start date, format "yyyy-MM-dd". If it is null, the StartDate would be the following date of the last item in the override sequence.
          format: date-time
          nullable: true
        status:
          enum:
          - Expired
          - Active
          - Upcoming
          type: string
          description: Daily budget override computed status.
          nullable: true
      additionalProperties: false
      description: The details for a daily budget override
    ValueResourceRecommendedKeywordsResponseV1:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/RecommendedKeywordsResponseV1'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
      nullable: true
    SetBidsModelRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SetBidsModelResource'
      additionalProperties: false
      description: Request object to set bid overrides for keywords associated with a line item
    MatchTypeModel:
      enum:
      - PositiveExactMatch
      - NegativeExactMatch
      - NegativeBroadMatch
      type: string
      description: The match type of a keyword.
    ValueTypeResourceOfStoreIdsUpdateModel202110:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/StoreIdsUpdateModel202110'
        type:
          type: string
      description: Data model for a value type resource
    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.
    SetBidsModel:
      type: object
      properties:
        keywords:
          type: array
          items:
            $ref: '#/components/schemas/SetBidModel'
          nullable: true
      additionalProperties: false
      description: Data model containing keywords and their associated bid overrides
    JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301:
      required:
      - id
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CampaignV202301'
        id:
          type: string
          format: long-id
        type:
          type: string
      description: "A JSON:API wrapper class to format a <typeparamref name=\"TAttributes\" /> with Id, Type, and\r\nAttributes properties"
  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: {}
x-samples-languages:
- java
- python
- php
- csharp
- javascript
- curl
- ruby