openapi: 3.2.0
info:
  title: Criteo Campaign API
  version: 2026-07
  description: 'Operations tagged Campaign across 2 of this provider''s published API definitions: criteo-marketing-solutions-api-openapi.yml, criteo-retail-media-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.criteo.com
security:
- oauth: []
tags:
- name: Campaign
paths:
  /2026-07/marketing-solutions/ad-sets:
    patch:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/ad-sets
      description: Patch a list of AdSets.
      operationId: PatchAdSets
      requestBody:
        description: List of adsets to patch.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestsPatchAdSetV26Q1'
        required: true
        x-bodyName: adSets
      responses:
        '200':
          description: Patched attributes for adSets specified in the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponsesAdSetIdV26Q1'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    post:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/ad-sets
      description: Create an ad set with the provided parameters
      operationId: CreateAdSet
      requestBody:
        description: the ad sets to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAdSetV26Q1Request'
        required: true
        x-bodyName: adSet
      responses:
        '201':
          description: The ad set that has been created and errors / warnings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseReadAdSetV26Q1'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/ad-sets/{ad-set-id}:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/ad-sets/{ad-set-id}
      description: Get the data for the specified ad set
      operationId: GetAdSet
      parameters:
      - name: ad-set-id
        in: path
        description: Id of the ad set
        required: true
        schema:
          type: string
      responses:
        '200':
          description: data for the ad set
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseReadAdSetV26Q1'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/ad-sets/{ad-set-id}/audience:
    put:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/ad-sets/{ad-set-id}/audience
      description: Link or unlink an audience with an ad set
      operationId: UpdateAdSetAudience
      parameters:
      - name: ad-set-id
        in: path
        description: The ad set ID.
        required: true
        schema:
          type: string
      requestBody:
        description: Ad set-Audience update request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdSetAudienceLinkInputEntityV1'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdSetAudienceLinkEntityV1Response'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/ad-sets/{ad-set-id}/category-bids:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/ad-sets/{ad-set-id}/category-bids
      description: Get the Category Bids for all valid Categories associated to an Ad Set
      operationId: GetAdSetCategoryBids
      parameters:
      - name: ad-set-id
        in: path
        description: Id of the Ad Set
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of Category Bids for all valid Categories associated to an Ad Set.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdSetCategoryBidListResponse'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    patch:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/ad-sets/{ad-set-id}/category-bids
      description: 'Update the Category Bids for given Categories associated to an Ad Set

        Patch Category Bids for one or more Categories in a single request. Partial success policy is followed.'
      operationId: PatchAdSetCategoryBids
      parameters:
      - name: ad-set-id
        in: path
        description: Id of the Ad Set
        required: true
        schema:
          type: string
      requestBody:
        description: Collection of category bids to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchAdSetCategoryBidListRequest'
        required: true
        x-bodyName: categoryBidsToUpdate
      responses:
        '200':
          description: List of updated Category Bids for given Categories associated to an Ad Set, used for partial successes as well.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchAdSetCategoryBidResultListResponse'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers
      description: Get the Display Multipliers for all valid Categories associated to an Ad Set
      operationId: GetDisplayMultipliers
      parameters:
      - name: ad-set-id
        in: path
        description: Id of the Ad Set
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of Display Multipliers for all valid Categories associated to an Ad Set.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdSetDisplayMultiplierListResponse'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    patch:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers
      description: 'Update the Display Multipliers for given Categories associated to an Ad Set

        Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed.'
      operationId: PatchDisplayMultipliers
      parameters:
      - name: ad-set-id
        in: path
        description: Id of the Ad Set
        required: true
        schema:
          type: string
      requestBody:
        description: List of display multiplier values to change
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchAdSetDisplayMultiplierListRequest'
        required: true
        x-bodyName: displayMultipliersToUpdate
      responses:
        '200':
          description: List of updated Display Multipliers for given Categories associated to an Ad Set. Make sure to check the error field in the response since a partial success will result in a 200 response code.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchAdSetDisplayMultiplierResultListResponse'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/ad-sets/search:
    post:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/ad-sets/search
      description: "Search for ad sets based on provided criteria.\nThis returns the full configuration of ad sets matching those criteria.\nField projection can be used if only a subset of fields is required, instead of the full configuration.\n            \nIf specific fields are precised in the user prompt, use meta.fields field projection in order to query only the value of these fields, else, provide every field."
      operationId: SearchAdSets
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdSetSearchRequestV26Q1'
        x-bodyName: request
      responses:
        '200':
          description: data for the ad sets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponsesReadAdSetV26Q1'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/ad-sets/start:
    post:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/ad-sets/start
      description: Start the specified list of ad sets
      operationId: StartAdSets
      requestBody:
        description: All the ad sets to start
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestsAdSetId'
        x-bodyName: adSets
      responses:
        '200':
          description: List of ad sets that have been started and errors / warnings by ad set
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponsesAdSetId'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/ad-sets/stop:
    post:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/ad-sets/stop
      description: Stop the specified list of ad sets
      operationId: StopAdSets
      requestBody:
        description: All the ad sets to stop
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestsAdSetId'
        x-bodyName: adSets
      responses:
        '200':
          description: List of ad sets that have been stopped and errors / warnings by ad set
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponsesAdSetId'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/campaigns:
    patch:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/campaigns
      description: "Patch a list of Campaigns.\n            \nA campaign, or in other words a marketing campaign, is an entity that defines advertising objectives and success criteria."
      operationId: PatchCampaigns
      requestBody:
        description: List of campaigns to patch.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchCampaignListRequest'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: List of patched campaigns.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchResultCampaignListResponse'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    post:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/campaigns
      description: "Create the specified campaign\n            \nA campaign, or in other words a marketing campaign, is an entity that defines advertising objectives and success criteria."
      operationId: CreateCampaign
      requestBody:
        description: the campaigns to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCampaignRequest'
        required: true
        x-bodyName: marketingCampaign
      responses:
        '201':
          description: The campaign that has been created and errors / warnings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignV23Q1Response'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/campaigns/{campaign-id}:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/campaigns/{campaign-id}
      description: "Get the data for the specified campaign.\n            \nA campaign, or in other words a marketing campaign, is an entity that defines advertising objectives and success criteria."
      operationId: GetCampaign
      parameters:
      - name: campaign-id
        in: path
        description: ID of the marketing campaign; This field is required.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the data of the specified marketing campaign.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignV23Q1Response'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/campaigns/search:
    post:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/campaigns/search
      description: "Search endpoint for campaigns\n            \nA campaign, or in other words a marketing campaign, is an entity that defines advertising objectives and success criteria."
      operationId: SearchCampaigns
      requestBody:
        description: Filters for searching for campaigns
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CampaignSearchRequestV23Q1'
        x-bodyName: request
      responses:
        '200':
          description: Returns a list of marketing campaigns' data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignV23Q1ListResponse'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers
      description: Get the collection of advertisers associated with the user.
      operationId: GetMarketplaceAdvertisers
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AdvertiserInfoMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}
      description: Get an advertiser.
      operationId: GetMarketplaceAdvertiser
      parameters:
      - name: advertiserId
        in: path
        description: Id of the advertiser
        required: true
        schema:
          type: string
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdvertiserInfoMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/ad-preview:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/ad-preview
      description: "Get a preview of an HTML ad with products belonging to the provided seller\n• <b>advertiserId</b>: Valid crp advertiserId, seller belongs to provided advertiser<br />\n• <b>sellerId</b>: Products from given SellerId will fill the ad preview, must be existing crp sellerId<br />\n• <b>height</b>: height may be supplied to request a specific ad preview height. Default height: 250<br />\n• <b>width</b>: width may be supplied to request a specific ad preview width. Default width: 300<br />\n            \nAd preview api calls are capped to 1000 per day per advertiser by default. Current usage, limit, and period can be found using v2/crp/advertisers/preview-limit"
      operationId: GetMarketplaceSellerAdPreview
      parameters:
      - name: advertiserId
        in: path
        description: Id of the advertiser
        required: true
        schema:
          type: string
          format: int32
      - name: campaignId
        in: query
        description: Seller CampaignId
        schema:
          type: integer
          format: int32
      - name: height
        in: query
        description: Height of the ad to display
        schema:
          type: integer
          format: int32
      - name: sellerId
        in: query
        description: Id of the seller
        required: true
        schema:
          type: integer
          format: int64
      - name: width
        in: query
        description: Width of the ad to display
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/adsets:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/adsets
      description: Get the collection of adsets associated with the advertiserId.
      operationId: GetMarketplaceAdSetsByAdvertiser
      parameters:
      - name: advertiserId
        in: path
        description: Id of the advertiser
        required: true
        schema:
          type: string
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AdvertiserAdsetMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/budgets:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/budgets
      description: Get CRP budgets for a specific advertiser
      operationId: GetMarketplaceBudgetsByAdvertiser
      parameters:
      - name: advertiserId
        in: path
        description: Id of the advertiser
        required: true
        schema:
          type: string
          format: int32
      - name: budgetId
        in: query
        description: Return only budgets with given Id
        schema:
          type: integer
          format: int64
      - name: endAfterDate
        in: query
        description: "Return budgets that end after the given date using the `yyyy-MM-DD` format.\n            If param is not provided, default behavior is to only return budgets that have not yet ended."
        schema:
          type: string
          format: date-time
      - name: sellerId
        in: query
        description: Return only budgets belonging to given sellerId
        schema:
          type: integer
          format: int64
      - name: startBeforeDate
        in: query
        description: Return budgets that start on or before the given date using the `yyyy-MM-DD` format.
        schema:
          type: string
          format: date-time
      - name: status
        in: query
        description: Return only budgets with the given status.
        schema:
          enum:
          - Archived
          - Current
          - Scheduled
          type: string
      - name: type
        in: query
        description: Return only budgets with the given budget type.
        schema:
          type: string
      - name: withBalance
        in: query
        description: Return only budgets with the given status.
        schema:
          type: boolean
      - name: withSpend
        in: query
        description: Return budgets with any positive spend.
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SellerBudgetMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/campaigns:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/campaigns
      description: Get the collection of CRP campaigns associated with the advertiserId.
      operationId: GetMarketplaceCampaignsByAdvertiser
      parameters:
      - name: advertiserId
        in: path
        description: Id of the advertiser
        required: true
        schema:
          type: string
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AdvertiserCampaignMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/seller-campaigns:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/seller-campaigns
      description: Get CRP seller campaigns for a specific advertiser
      operationId: GetMarketplaceSellerCampaignsByAdvertiser
      parameters:
      - name: advertiserId
        in: path
        description: Id of the advertiser
        required: true
        schema:
          type: string
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SellerCampaignMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/sellers:
    post:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/sellers
      description: Create new sellers for an advertiser
      operationId: GetMarketplaceSellersByAdvertiser
      parameters:
      - name: advertiserId
        in: path
        description: Id of the advertiser
        required: true
        schema:
          type: string
          format: int32
      - name: partnerId
        in: query
        description: Id of the partner
        schema:
          type: integer
          format: int32
      requestBody:
        description: Names of the sellers to associate with new Ids
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
        required: true
        x-bodyName: sellerNames
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SellerBase'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/preview-limit:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/advertisers/preview-limit
      description: Get the collection of advertisers preview limits associated with the authorized user.
      operationId: GetMarketplaceAdvertiserPreviewLimits
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AdvertiserQuotaMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/budgets:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/budgets
      description: "Return a collection of budgets filtered by optional filter parameters, **including archived budgets**. This is the endpoint to use when investigating past budget history.\n            \nBy default, budgets whose endDate is in the past are excluded. Use `endAfterDate` to retrieve archived budgets (e.g. `endAfterDate=2025-01-01` returns all budgets ending after that date). Use `sellerId` to filter to a specific seller — omitting it on large advertisers causes timeouts.\n            \n<b>Date filter.</b> To find budgets that were active on a specific date, set both `startBeforeDate` and `endAfterDate` to that day.\n            \n<b>Spend.</b> If `endAfterDate` is supplied, the spend excludes spend that happened after that date. For daily budgets, only the spend for the final day is displayed."
      operationId: GetMarketplaceSellerBudgets
      parameters:
      - name: advertiserId
        in: query
        description: Return only budgets belonging to the specified advertiser
        schema:
          type: integer
          format: int32
      - name: campaignId
        in: query
        description: Return only budgets that pay for a given campaign.
        schema:
          type: integer
          format: int32
      - name: endAfterDate
        in: query
        description: "Return budgets that end after the given date using the `yyyy-MM-DD` format.\n             If param is not provided, default behavior is to only return budgets that have not yet ended."
        schema:
          type: string
          format: date-time
      - name: sellerId
        in: query
        description: Return only budgets belonging to the given seller.
        schema:
          type: string
      - name: startBeforeDate
        in: query
        description: Return budgets that start on or before the given date using the `yyyy-MM-DD` format.
        schema:
          type: string
          format: date-time
      - name: status
        in: query
        description: Return only budgets with the given status.
        schema:
          enum:
          - Archived
          - Current
          - Scheduled
          type: string
      - name: type
        in: query
        description: Return only budgets with the given budget type.
        schema:
          type: string
      - name: withBalance
        in: query
        description: Return only budgets with the given status.
        schema:
          type: boolean
      - name: withSpend
        in: query
        description: Return budgets with any positive spend.
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SellerBudgetMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    patch:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/budgets
      description: "Modify one or more existing active budgets to change their limitations or status.\nAll three types of budgets can be modified.\n            \nThe following constraints apply when modifying an existing budget.\n            \n• <b>campaignIds</b>: a non-empty subset of the original campaign ids MAY be supplied<br />\n• <b>amount</b>: an amount MAY be supplied only if the type is not Uncapped and if supplied it MUST be non-negative<br />\n• <b>startDate</b>: a future start date MAY be supplied for budgets that have not yet started<br />\n• <b>endDate</b>: an end date MAY be supplied and if supplied MUST be a future date greater than the start date<br />\n            \nOther attributes MUST NOT be supplied.\n            \nAdding new campaigns to a budget is not allowed. In addition, reducing the amount for\na Capped budget to a value less than the current spend not allowed."
      operationId: UpdateMarketplaceSellerBudgets
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UpdateSellerBudgetMessage'
        required: true
        x-bodyName: updateSellerBudgets
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SellerBudgetMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    post:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/budgets
      description: "Create one or more new budgets to enable spending with the given limitations.\nAll three types of budgets can be created this way.\n            \nThe following constraints apply when creating a new budget.\n            \n• <b>sellerId</b>: the seller MUST be supplied<br />\n• <b>campaignIds</b>: a non-empty array of campaign ids MUST be supplied<br />\n• <b>budgetType</b>: a budget type MUST be supplied<br />\n• <b>amount</b>: an amount MAY be supplied only if the type is not Uncapped and if supplied it MUST be non-negative<br />\n• <b>startDate</b>: a future start date MUST be supplied<br />\n• <b>endDate</b>: an end date MAY be supplied and if supplied MUST be greater than the start date<br />\n            \nOther attributes MUST NOT be supplied."
      operationId: CreateMarketplaceSellerBudgets
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CreateSellerBudgetMapiMessage'
        required: true
        x-bodyName: createSellerBudgets
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SellerBudgetMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/budgets/{budgetId}:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/budgets/{budgetId}
      description: "Return a budget. For example,\n            \n    {\n        \"id\": \"1759183\",\n        \"sellerId\": \"321392\",\n        \"campaignIds\": [\n            143962\n        ],\n        \"budgetType\": \"Capped\",\n        \"amount\": 1000,\n        \"startDate\": \"2021-01-11\",\n        \"endDate\": \"2021-01-12\",\n        \"spend\": null,\n        \"status\": \"Active\"\n    }\n            \nA budget limits the spend of a seller for one or more campaigns.\n            \nThere are three types of budget:<br /><b>Uncapped</b> budgets put no limit on the total amount of spend.<br /><b>Capped</b> budgets limit the total spend to a fixed amount.<br /><b>Daily</b> budgets limit daily spend to a fixed amount.<br />\n            \nIn addition, budgets can limit the spend to a specific range of dates using\nthe start and end date attributes. Finally a budget must be active to be used.\n            \n<b>Spend</b> approximates the current spend against this budget. There may be a lag\nbetween when an ad is clicked and the time it accrues to the spend. Daily budgets\nshow spend against the most recent day only."
      operationId: GetMarketplaceSellerBudget
      parameters:
      - name: budgetId
        in: path
        description: Id of the budget.
        required: true
        schema:
          type: string
          format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SellerBudgetMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    patch:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/budgets/{budgetId}
      description: "Modify an existing active budget to change its limitations or status.\nAll three types of budgets can be modified.\n            \nSee the additional restrictions listed in the PATCH budgets endpoint."
      operationId: UpdateMarketplaceSellerBudget
      parameters:
      - name: budgetId
        in: path
        description: Id of the budget
        required: true
        schema:
          type: string
          format: int64
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSellerBudgetMessageBase'
        required: true
        x-bodyName: message
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SellerBudgetMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns
      description: 'Return a collection of seller campaigns filtered by optional filter parameters.

        If all parameters are omitted the entire collection to which the user has

        access is returned. Returned sellers must satisfy all supplied filter

        criteria if multiple parameters are used.'
      operationId: GetMarketplaceSellerCampaigns
      parameters:
      - name: advertiserId
        in: query
        description: Return only seller belonging to the specified advertiser
        schema:
          type: integer
          format: int32
      - name: budgetStatus
        in: query
        description: Return only seller campaigns whose budget has the given status.
        schema:
          enum:
          - Archived
          - Current
          - Scheduled
          type: string
      - name: campaignId
        in: query
        description: Return only seller campaigns associated with the given campaign.
        schema:
          type: integer
          format: int32
      - name: sellerId
        in: query
        description: Return only seller campaigns belonging to the given seller.
        schema:
          type: string
      - name: sellerStatus
        in: query
        description: Return only seller campaigns for sellers with the given status.
        schema:
          enum:
          - Inactive
          - Active
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SellerCampaignMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    patch:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns
      description: "Patching a collection of seller campaigns allows their bids to be modified.\nEach bid must be a non-negative value. Setting the bid to zero will make a seller campaign inactive.\n            \nThe currency used for bids will be the default currency of the campaign."
      operationId: UpdateMarketplaceSellerCampaigns
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/SellerCampaignUpdate'
        required: true
        x-bodyName: campaignMessages
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SellerCampaignMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId}:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId}
      description: "Return details for a seller campaign. For example,\n            \n    {\n        \"id\": \"543210.123456\",\n        \"sellerId\": \"543210\",\n        \"campaignId\": 123456,\n        \"bid\": 1.55,\n        \"suspendedSince\": \"2018-07-30T15:15:24.813\",\n        \"suspensionReasons\": [\n            \"NoMoreBudget\"\n        ]\n    }\n            \nAn active seller campaign is one for which the value of <b>suspendedSince</b> is null and\nthe <b>bid</b> is positive. The currency of the bid is the <b>bidCurrency</b> of the\nassociated campaign.\n            \nAny active seller campaign must also have an active total (capped or uncapped) budget.\nIt may optionally have an active daily budget as well to further limit spending.\n            \nSuspension reasons:\n- ManuallyStopped: The Seller-Campaign has been manually paused. This is not related to the other suspension reasons.\n- NoBudgetDefined: No valid budget has been linked to the Seller-Campaign.\n- NoCpcDefined: No CPC has been set for the Seller-Campaign.\n- NoMoreBudget: The current budget of the Seller-Campaign has been exhausted.\n- RemovedFromCatalog: All the products of the Seller-Campaign have been deleted from the catalog.\n- NotYetStarted: The Seller-Campaign has just been created and has not yet been processed."
      operationId: GetMarketplaceSellerCampaign
      parameters:
      - name: sellerCampaignId
        in: path
        description: Composite id of the seller campaign in the format `{sellerId}.{campaignId}`, e.g. `2578464.187625`.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SellerCampaignMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    patch:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId}
      description: "Patching a seller campaign allows the bid to be modified. The bid must be a non-negative value.\nSetting the bid to zero will make a seller campaign inactive.\n            \nThe currency used for bids will be the default currency of the campaign."
      operationId: UpdateMarketplaceSellerCampaign
      parameters:
      - name: bid
        in: query
        description: The new bid for the seller campaign.
        schema:
          type: number
          format: double
      - name: sellerCampaignId
        in: path
        description: Composite id of the seller campaign to update in the format `{sellerId}.{campaignId}`, e.g. `2578464.187625`.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SellerCampaignMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId}/budgets:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId}/budgets
      description: "Return a collection of budgets for this seller campaign filtered by optional filter parameters.\nIf all parameters are omitted the entire collection to which the user has\naccess is returned, except those whose endDate is in the past. Returned budgets must satisfy all supplied filter\ncriteria if multiple parameters are used.\n            \nSee the budgets endpoint for additional details."
      operationId: GetMarketplaceBudgetsBySellerCampaign
      parameters:
      - name: endAfterDate
        in: query
        description: "Return budgets that end after the given date using the `yyyy-MM-DD` format.\n             If param is not provided, default behavior is to only return budgets that have not yet ended."
        schema:
          type: string
          format: date-time
      - name: sellerCampaignId
        in: path
        description: 'Return only budgets belonging to the given seller campaign. Format: `{sellerId}.{campaignId}`, e.g. `2578464.187625`.'
        required: true
        schema:
          type: string
      - name: startBeforeDate
        in: query
        description: Return budgets that start on or before the given date using the `yyyy-MM-DD` format.
        schema:
          type: string
          format: date-time
      - name: status
        in: query
        description: Return only budgets with the given status.
        schema:
          enum:
          - Archived
          - Current
          - Scheduled
          type: string
      - name: type
        in: query
        description: Return only budgets with the given budget type.
        schema:
          type: string
      - name: withBalance
        in: query
        description: Return only budgets with a positive balance.
        schema:
          type: boolean
      - name: withSpend
        in: query
        description: Return budgets with a positive spend.
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SellerBudgetMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/sellers:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/sellers
      description: 'Return a collection of sellers filtered by optional filter parameters.

        If all parameters are omitted the entire collection to which the user has

        access is returned. Returned sellers must satisfy all supplied filter

        criteria if multiple parameters are used.'
      operationId: GetMarketplaceSellers
      parameters:
      - name: advertiserId
        in: query
        description: Return only sellers belonging to the specified advertiser
        schema:
          type: integer
          format: int32
      - name: campaignId
        in: query
        description: Return only sellers belonging to the specified campaign
        schema:
          type: integer
          format: int32
      - name: sellerName
        in: query
        description: Return only sellers with the matching name.
        schema:
          type: string
      - name: sellerStatus
        in: query
        description: Return only sellers with specific status.
        schema:
          enum:
          - Inactive
          - Active
          type: string
      - name: withBudgetStatus
        in: query
        description: Return only sellers with specific budget status.
        schema:
          enum:
          - Archived
          - Current
          - Scheduled
          type: string
      - name: withProducts
        in: query
        description: Return only sellers with or without products in catalog.
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SellerBase'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId}:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId}
      description: "Return details for the selected seller. For example,\n            \n    {\n        \"id\" : \"123456\"\n        \"sellerName\": \"HBogart\",\n    }"
      operationId: GetMarketplaceSeller
      parameters:
      - name: sellerId
        in: path
        description: Id of the seller.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SellerBase'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId}/budgets:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId}/budgets
      description: Return current (non-archived) budgets for this seller. Budgets whose endDate is in the past are excluded by default. To retrieve archived or past budgets, use the `/budgets` endpoint (GetMarketplaceSellerBudgets) with the `endAfterDate` filter instead.
      operationId: GetMarketplaceBudgetsBySeller
      parameters:
      - name: campaignId
        in: query
        description: Return only budgets that pay for a given campaign.
        schema:
          type: integer
          format: int32
      - name: endAfterDate
        in: query
        description: "Return budgets that end after the given date using the `yyyy-MM-DD` format.\n            If param is not provided, default behavior is to only return budgets that have not yet ended."
        schema:
          type: string
          format: date-time
      - name: sellerId
        in: path
        description: Return only budgets belonging to the given seller.
        required: true
        schema:
          type: string
      - name: startBeforeDate
        in: query
        description: Return budgets that start on or before the given date using the `yyyy-MM-DD` format.
        schema:
          type: string
          format: date-time
      - name: status
        in: query
        description: Return only budgets with the given status.
        schema:
          enum:
          - Archived
          - Current
          - Scheduled
          type: string
      - name: type
        in: query
        description: Return only budgets with the given budget type.
        schema:
          type: string
      - name: withBalance
        in: query
        description: Return only budgets with the given status.
        schema:
          type: boolean
      - name: withSpend
        in: query
        description: Return budgets with any positive spend.
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SellerBudgetMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId}/seller-campaigns:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId}/seller-campaigns
      description: 'Return a collection of seller campaigns for this seller filtered by optional filter parameters.

        If all parameters are omitted the entire collection to which the user has

        access is returned. Returned sellers must satisfy all supplied filter

        criteria if multiple parameters are used. See the seller campaigns endpoint for additional details.'
      operationId: GetMarketplaceSellerCampaignsBySeller
      parameters:
      - name: budgetStatus
        in: query
        description: Return only seller campaigns whose budget has the given status.
        schema:
          enum:
          - Archived
          - Current
          - Scheduled
          type: string
      - name: campaignId
        in: query
        description: Return only seller campaigns associated with the given campaign.
        schema:
          type: integer
          format: int32
      - name: sellerId
        in: path
        description: Return only seller campaigns belonging to the given seller.
        required: true
        schema:
          type: string
      - name: sellerStatus
        in: query
        description: Return only seller campaigns for sellers with the given status.
        schema:
          enum:
          - Inactive
          - Active
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SellerCampaignMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    post:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId}/seller-campaigns
      description: Associate an existing Seller with an existing Campaign allowing for budget creation
      operationId: CreateMarketplaceSellerCampaignsBySeller
      parameters:
      - name: sellerId
        in: path
        description: Supply a generated Id of an existing Seller
        required: true
        schema:
          type: string
      requestBody:
        description: Supply the campaign Id and bid to create the mapping
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSellerCampaignMessageMapi'
        required: true
        x-bodyName: sellerCampaign
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SellerCampaignMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Manage
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/stats/campaigns:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/stats/campaigns
      description: "## Dimensions\n            \nGet performance statistics aggregated for _campaigns_. The campaign id appears\nin the output as the first column.\n            \nAggregation can be done by `hour`, `day`, `month`, or `year` aligned with the user timezone\nif provided. The aggregation interval size is controlled by `intervalSize`. The time\ninterval appears in the output as the second column.\n            \n## Metrics\n            \nThe metrics reported by this endpoint are\n            \n.  | Metric Group | Description\n---|--------------|------------\nA | impressions | Number of times product is shown in a banner\nB | clicks | Number of clicks on product\nC | cost | Amount spent for clicks on products\nD | saleUnits | Number of products sold attributed to clicks\nE | revenue | Revenue generated by sales\nF | CR = Conversion Rate | salesUnits / clicks\nG | CPO = Cost Per Order | cost / salesUnits\nH | COS = Cost of Sale | cost / revenue\nI | ROAS = Return On Add Spend | revenue / cost\n            \nThe last six metrics can be computed in two ways depending on the policy to count only\nthe sales that result from clicks on the same sellers product in a banner\n(same-seller) or not (any-seller).  Reporting can be controlled by `clickAttributionPolicy`.\n            \nThe 9 (or 15) metric values appear in the output as the final 9 (or 15) columns.\n            \n## Filtering\n            \nThe results can be filtered by campaign, date or count.\n            \nFiltering the results to events associated with a specific campaign is done by setting\nthe `campaignId` filter parameter to the desired value.\n            \nFiltering the results to events\nthat happened in a time interval is done by setting the `startDate` and\n`endDate` filter parameters using the `yyyy-MM-DD` format. The start date\nincludes all events timestamped since the beginning of that day while the end\ndate includes events until the end of day. The maximum duration of the date\nrange is 1 year. If the aggregation interval is `hour`, then the maximum\nduration of the date range is 31 days. Note that month and year aggregate values\nmay contain partial data for the interval if filtering by date.\n            \nFiltering the results to a maximum number of data rows is done by setting the\n`count` filter parameter. When combined with startDate this can be used to perform\nsimple pagination.\n            \n## Response Format\n            \nThe representation format can be specified by MIME values in the Accept header.\nFor now the only supported values for the accept header is `application/json` and\n`text/csv`.\n            \n```json\n{\n   \"columns\": [ \"campaignId\", \"month\", \"impressions\", \"clicks\", \"cost\", \"saleUnits\", \"revenue\", \"cr\", \"cpo\", \"cos\", \"roas\" ],\n   \"data\": [\n       [168423, \"2019-05-01\", 3969032, 13410, 1111.295, 985, 190758099, 0.073, 1.128, 0.000, 171653.880 ],\n       [168423, \"2019-06-01\", 8479603, 25619, 2190.705, 740, 152783656, 0.028, 2.960, 0.000, 69741.775 ]\n       ],\n   \"rows\": 2\n}\n```\n            \nThe JSON result is an object with three fields (`columns`, `data`, and `rows`). The\n“columns” array acts as the header for the data rows. The categorical dimension\ncolumn comes first and consists of the campaign id.\nThe interval column comes next and defines the aggregation period.  The interval size is\ndetermined by the `intervalSize` parameter. This is followed by either nine or\nfifteen metrics columns. The first three metrics (impressions, clicks, and cost)\nalways appear. The remaining depend on the `clickAttributionPolicy` parameter.\n            \nThe “data” array contains data rows whose values match the entries in the\n“columns” array. Id dimensions are numbers while name and date dimensions are strings. The metrics are JSON objects\nwhose type is number. Some of these are natural numbers (e.g. clicks and\nimpressions) whereas others are decimal values. A divide by zero yields null. The\ncurrency is assumed to be the local currency established by the advertiser.\n            \nThe “row” value is a count of the number of rows in the data array, and can be\nused to check the integrity of the data.\n            \nFurther information on the campaign or seller (e.g. the seller name) can be\nobtained from the existing V1 or V2 endpoints using the campaign and/or seller\nID values."
      operationId: GetMarketplaceCampaignsStats
      parameters:
      - name: advertiserId
        in: query
        description: Filter metrics to this advertiser. Strongly recommended — omitting this on large accounts causes timeouts.
        schema:
          type: integer
          format: int32
      - name: campaignId
        in: query
        description: Show only metrics for this campaign (default all campaigns)
        schema:
          type: string
      - name: clickAttributionPolicy
        in: query
        description: Specify the click attribution policy for salesUnits, revenue, CR, CPO, COS, and ROAS
        schema:
          enum:
          - Both
          - SameSeller
          - AnySeller
          type: string
          default: AnySeller
      - name: count
        in: query
        description: Return up to the first count rows of data (default is all rows)
        schema:
          type: integer
          format: int32
      - name: endDate
        in: query
        description: Filter out all events that occur after date (default is today’s date)
        schema:
          type: string
          format: date-time
      - name: intervalSize
        in: query
        description: Specify the aggregation interval for events used to compute stats (default is "day")
        schema:
          enum:
          - Hour
          - Day
          - Month
          - Year
          type: string
          default: Day
      - name: startDate
        in: query
        description: Filter out all events that occur before date (default is the value of `endDate`)
        schema:
          type: string
          format: date-time
      - name: timeZoneId
        in: query
        description: Specify the timezone used in the aggregations (IANA code).
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatsReportMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/stats/seller-campaigns:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/stats/seller-campaigns
      description: "## Dimensions\n            \nGet performance statistics aggregated for _seller campaigns_.The campaign id, seller id, and\nseller name appear in the first three columns of the output. These are followed by the interval\nsize column.\n            \nAggregation can be done by `hour`, `day`, `month`, or `year` aligned with the user timezone if\nprovided. The aggregation interval size is controlled by `intervalSize`. The remaining columns\nare metrics.\n            \n## Metrics\n            \nThe metrics reported by this endpoint are\n            \n.  | Metric Group | Description\n---|--------------|------------\nA | impressions | Number of times product is shown in a banner\nB | clicks | Number of clicks on product\nC | cost | Amount spent for clicks on products\nD | saleUnits | Number of products sold attributed to clicks\nE | revenue | Revenue generated by sales\nF | CR = Conversion Rate | salesUnits / clicks\nG | CPO = Cost Per Order | cost / salesUnits\nH | COS = Cost of Sale | cost / revenue\nI | ROAS = Return On Add Spend | revenue / cost\n            \nThe last six metrics can be computed in two ways depending on the policy to count only\nthe sales that result from clicks on the same sellers product in a banner\n(same-seller) or not (any-seller).  Reporting can be controlled by `clickAttributionPolicy`.\n            \nThe 9 (or 15) metric values appear in the output as the final 9 (or 15) columns.\n            \n## Filtering\n            \nThe results can be filtered by date or count.\n            \nFiltering the results to events associated with a specific campaign is done by setting\nthe `campaignId` filter parameter to the desired value.\n            \nFiltering the results to events associated with a specific seller is done by setting\nthe `sellerId` filter parameter to the desired value.\n            \nFiltering the results to events\nthat happened in a time interval is done by setting the `startDate` and\n`endDate` filter parameters using the `yyyy-MM-DD` format. The start date\nincludes all events timestamped since the beginning of that day while the end\ndate includes events until the end of day. The maximum duration of the date\nrange is 1 year. If the aggregation interval is `hour`, then the maximum\nduration of the date range is 31 days. Note that month and year aggregate values\nmay contain partial data for the interval if filtering by date.\n            \nFiltering the results to a maximum number of data rows is done by setting the\n`count` filter parameter. When combined with startDate this can be used to perform\nsimple pagination.\n            \n## Response Format\n            \nThe representation format can be specified by MIME values in the Accept header.\nFor now the only supported values for the accept header is `application/json` and\n`text/csv`.\n            \n```json\n{\n    \"columns\": [\n        \"campaignId\", \"sellerId\", \"sellerName\", \"month\", \"impressions\", \"clicks\", \"cost\", \"saleUnits\", \"revenue\", \"cr\", \"cpo\", \"cos\", \"roas\"\n    ],\n    \"data\": [\n        [168423, 1110222, \"118883955\", \"2019-05-01\", 14542, 48, 3.36, 0, 0.0, 0.0, null, null, 0.0],\n        [168423, 1110222, \"118883955\", \"2019-06-01\", 16619, 53, 3.71, 0, 0.0, 0.0, null, null, 0.0],\n        [168423, 1110225, \"117980027\", \"2019-05-01\", 12502, 48, 3.36, 0, 0.0, 0.0, null, null, 0.0],\n        [168423, 1110225, \"117980027\", \"2019-06-01\", 20266, 53, 3.71, 0, 0.0, 0.0, null, null, 0.0]\n    ],\n    \"rows\": 4\n}\n```\n            \nThe JSON result is an object with three fields (`columns`, `data`, and `rows`). The\n“columns” array acts as the header for the data rows. The categorical dimension\ncolumns come first and include the campaign id, seller id, and seller name.\nThe interval column comes next and defines the aggregation period. The interval size is\ndetermined by the `intervalSize` parameter. This is followed by either nine or\nfifteen metrics columns. The first three metrics (impressions, clicks, and cost)\nalways appear. The remaining depend on the `clickAttributionPolicy` parameter.\n            \nThe “data” array contains data rows whose values match the entries in the\n“columns” array. Id dimensions are numbers while name and date dimensions are strings. The metrics are JSON objects\nwhose type is number. Some of these are natural numbers (e.g. clicks and\nimpressions) whereas others are decimal values. A divide by zero yields null. The\ncurrency is assumed to be the local currency established by the advertiser.\n            \nThe “row” value is a count of the number of rows in the data array, and can be\nused to check the integrity of the data.\n            \nFurther information on the campaign or seller (e.g. the seller name) can be\nobtained from the existing V1 or V2 endpoints using the campaign and/or seller\nID values."
      operationId: GetMarketplaceSellerCampaignsStats
      parameters:
      - name: advertiserId
        in: query
        description: Filter metrics to this advertiser. Strongly recommended — omitting this on large accounts causes timeouts.
        schema:
          type: integer
          format: int32
      - name: campaignId
        in: query
        description: Show only metrics for this campaign (default all campaigns)
        schema:
          type: string
      - name: clickAttributionPolicy
        in: query
        description: Specify the click attribution policy for salesUnits, revenue, CR, CPO, COS, and ROAS
        schema:
          enum:
          - Both
          - SameSeller
          - AnySeller
          type: string
          default: AnySeller
      - name: count
        in: query
        description: Return up to the first count rows of data (default is all rows)
        schema:
          type: integer
          format: int32
      - name: endDate
        in: query
        description: Filter out all events that occur after date (default is today’s date)
        schema:
          type: string
          format: date-time
      - name: intervalSize
        in: query
        description: Specify the aggregation interval for events used to compute stats (default is "day")
        schema:
          enum:
          - Hour
          - Day
          - Month
          - Year
          type: string
          default: Day
      - name: sellerId
        in: query
        description: Show only metrics for this seller (default all sellers)
        schema:
          type: string
      - name: startDate
        in: query
        description: Filter out all events that occur before date (default is the value of `endDate`)
        schema:
          type: string
          format: date-time
      - name: timeZoneId
        in: query
        description: Specify the timezone used in the aggregations (IANA code).
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatsReportMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /2026-07/marketing-solutions/marketplace-performance-outcomes/stats/sellers:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/stats/sellers
      description: "## Dimensions\n            \nGet performance statistics aggregated for _sellers_. The seller id appears\nin the output in the first column and the seller name appears in the second.\n            \nAggregation can be done by `hour`, `day`, `month`, or `year` aligned with the user timezone\nif provided. The aggregation interval size is controlled by `intervalSize`. The time interval\nappears in the output as the second column.\n            \n## Metrics\n            \nThe metrics reported by this endpoint are\n            \n.  | Metric Group | Description\n---|--------------|------------\nA | impressions | Number of times product is shown in a banner\nB | clicks | Number of clicks on product\nC | cost | Amount spent for clicks on products\nD | saleUnits | Number of products sold attributed to clicks\nE | revenue | Revenue generated by sales\nF | CR = Conversion Rate | salesUnits / clicks\nG | CPO = Cost Per Order | cost / salesUnits\nH | COS = Cost of Sale | cost / revenue\nI | ROAS = Return On Add Spend | revenue / cost\n            \nThe last six metrics can be computed in two ways depending on the policy to count only\nthe sales that result from clicks on the same sellers product in a banner\n(same-seller) or not (any-seller).  Reporting can be controlled by `clickAttributionPolicy`.\n            \nThe 9 (or 15) metric values appear in the output as the final 9 (or 15) columns.\n            \n## Filtering\n            \nThe results can be filtered by seller id, date or count.\n            \nFiltering the results to events associated with a specific seller is done by setting\nthe `sellerId` filter parameter to the desired value.\n            \nFiltering the results to events\nthat happened in a time interval is done by setting the `startDate` and\n`endDate` filter parameters using the `yyyy-MM-DD` format. The start date\nincludes all events timestamped since the beginning of that day while the end\ndate includes events until the end of day. The maximum duration of the date\nrange is 1 year. If the aggregation interval is `hour`, then the maximum\nduration of the date range is 31 days. Note that month and year aggregate values\nmay contain partial data for the interval if filtering by date.\n            \nFiltering the results to a maximum number of data rows is done by setting the\n`count` filter parameter. When combined with startDate this can be used to perform\nsimple pagination.\n            \n## Response Format\n            \nThe representation format can be specified by MIME values in the Accept header.\nFor now the only supported values for the accept header is `application/json` and\n`text/csv`.\n            \n```json\n{\n    \"columns\": [\"sellerId\", \"sellerName\", \"month\", \"impressions\", \"clicks\", \"cost\", \"saleUnits\", \"revenue\", \"cr\", \"cpo\", \"cos\", \"roas\"],\n    \"data\": [\n       [1200972, \"sellerA\", \"2019-05-01\", 14542, 48, 3.36, 0, 0.0, 0.0, null, null, 0.0],\n       [1200972, \"sellerA\", \"2019-06-01\", 16619, 53, 3.71, 0, 0.0, 0.0, null, null, 0.0],\n       [1200974, \"sellerB\", \"2019-05-01\", 10102, 47, 3.29, 3, 396000.0, 0.063, 1.096, 8.308E-6, 120364.741],\n       [1200974, \"sellerB\", \"2019-06-01\", 11576, 54, 3.78, 1, 132000.0, 0.018, 3.78, 2.863E-5, 34920.634]\n    ],\n    \"rows\": 4\n}\n```\n            \nThe JSON result is an object with three fields (`columns`, `data`, and `rows`). The\n“columns” array acts as the header for the data rows. The categorical dimension\ncolumns come first and include the seller id and seller name.\nThe interval column comes next and defines the aggregation period. The interval size is\ndetermined by the `intervalSize` parameter. This is followed by either nine or\nfifteen metrics columns. The first three metrics (impressions, clicks, and cost)\nalways appear. The remaining metrics depend on the `clickAttributionPolicy` parameter.\n            \nThe “data” array contains data rows whose values match the entries in the\n“columns” array. Id dimensions are numbers while name and date dimensions are strings. The metrics are JSON objects\nwhose type is number. Some of these are natural numbers (e.g. clicks and\nimpressions) whereas others are decimal values. A divide by zero yields null. The\ncurrency is assumed to be the local currency established by the advertiser.\n            \nThe “row” value is a count of the number of rows in the data array, and can be\nused to check the integrity of the data.\n            \nFurther information on the campaign or seller (e.g. the seller name) can be\nobtained from the existing V1 or V2 endpoints using the campaign and/or seller\nID values."
      operationId: GetMarketplaceSellersStats
      parameters:
      - name: advertiserId
        in: query
        description: Filter metrics to this advertiser. Strongly recommended — omitting this on large accounts causes timeouts.
        schema:
          type: integer
          format: int32
      - name: clickAttributionPolicy
        in: query
        description: Specify the click attribution policy for salesUnits, revenue, CR, CPO, COS, and ROAS
        schema:
          enum:
          - Both
          - SameSeller
          - AnySeller
          type: string
          default: AnySeller
      - name: count
        in: query
        description: Return up to the first count rows of data (default is all rows)
        schema:
          type: integer
          format: int32
      - name: endDate
        in: query
        description: Filter out all events that occur after date (default is today’s date)
        schema:
          type: string
          format: date-time
      - name: intervalSize
        in: query
        description: Specify the aggregation interval for events used to compute stats (default is "day")
        schema:
          enum:
          - Hour
          - Day
          - Month
          - Year
          type: string
          default: Day
      - name: sellerId
        in: query
        description: Show only metrics for this seller (default all sellers)
        schema:
          type: string
      - name: startDate
        in: query
        description: Filter out all events that occur before date (default is the value of `endDate`)
        schema:
          type: string
          format: date-time
      - name: timeZoneId
        in: query
        description: Specify the timezone used in the aggregations (IANA code).
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatsReportMessage'
      security:
      - oauth:
        - MarketingSolutions_Campaign_Read
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
          - 'null'
      - 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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /2026-07/retail-media/balances/{balanceId}/campaigns/append:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/balances/{balanceId}/campaigns/append
      description: Appends one or more campaigns to the specified balance
      operationId: AppendCampaignsToBalanceV1
      parameters:
      - name: balanceId
        in: path
        description: The balance to add campaigns from
        required: true
        schema:
          type: string
      requestBody:
        description: The balance campaign appending request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputAppendCampaignsRequestV1'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeBalanceCampaignsV1'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
    servers:
    - url: https://api.criteo.com
  /2026-07/retail-media/balances/{balanceId}/campaigns/delete:
    post:
      tags:
      - Campaign
      summary: /2026-07/retail-media/balances/{balanceId}/campaigns/delete
      description: Deletes one or more campaigns on the specified balance
      operationId: DeleteCampaignsFromBalanceV1
      parameters:
      - name: balanceId
        in: path
        description: The balance to remove campaigns from
        required: true
        schema:
          type: string
      requestBody:
        description: The balance campaign deleting request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputDeleteCampaignsRequestV1'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeBalanceCampaignsV1'
      security:
      - oauth:
        - RetailMedia_Campaign_Manage
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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

        is at a Success status.

        Produces 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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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.\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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
  /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
    servers:
    - url: https://api.criteo.com
components:
  schemas:
    PatchResultCampaignReadResource:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
          readOnly: true
        type:
          type:
          - string
          - 'null'
          readOnly: true
          example: Campaign
      description: read model data for resources
    BudgetAutomation:
      type: object
      properties:
        budgetConfiguration:
          $ref: '#/components/schemas/BudgetAutomationConfiguration'
        enabled:
          type: boolean
          description: 'Whether budget automation is active for this marketing campaign.

            - true: budget automation is enabled and "budgetConfiguration" must be provided with a valid objective.

            - false (default when omitted): budget automation is disabled; "budgetConfiguration" is ignored if provided.'
      description: 'Budget automation, lets users configure budgets once at the campaign level while Criteo dynamically routes spend toward the best-performing ad sets.

        If "enabled" is omitted and only "budgetConfiguration" is provided, "enabled" defaults to false — budget automation will not be activated.

        To activate budget automation at creation, "enabled" must be explicitly set to true along with a valid "budgetConfiguration".

        If the entire "budgetAutomation" object is omitted from the create request, the campaign is created with budget automation disabled.'
    CampaignV23Q1:
      type:
      - object
      - 'null'
      properties:
        advertiserId:
          type:
          - string
          - 'null'
          description: Advertiser id of the campaign (string-encoded integer)
        budgetAutomation:
          $ref: '#/components/schemas/CampaignBudgetAutomationV23Q1'
        goal:
          enum:
          - unspecified
          - acquisition
          - retention
          type:
          - string
          - 'null'
          description: "Goal of the campaign\n            \nSerialized values are {unspecified}, {acquisition} and {retention}.\n            \nAcquisition and retention are defined as follows:\n- Acquisition: campaign with the goal of acquiring new customers. The success of an acquisition campaign is measured by the number of new customers it brings.\n- Retention: campaign with the goal of retaining existing customers. The success of a retention campaign is measured by the number of existing customers it retains."
        id:
          type:
          - string
          - 'null'
          description: Id of the entity (duplicate of the parent id).
        name:
          type:
          - string
          - 'null'
          description: Name of the campaign
        scheduledSpendLimits:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CampaignScheduledSpendLimitV23Q1'
          description: Spend limits scheduled to become active in the future. Empty when the campaign has no scheduled spend limits.
        spendLimit:
          $ref: '#/components/schemas/CampaignSpendLimitV23Q1'
      description: "Campaign read model\n            \nThe {id} field is the campaign identifier (string-encoded integer)."
    PatchCampaignScheduledSpendLimitCreation:
      required:
      - spendLimitType
      - startDate
      type: object
      properties:
        spendLimitAmount:
          $ref: '#/components/schemas/NillableDecimal'
        spendLimitRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          type:
          - string
          - 'null'
          description: 'The period over which the campaign spend limit is applied.

            When spendLimitType is "capped", this is "daily", "monthly", or "lifetime".

            When spendLimitType is "uncapped", this is "undefined".'
        spendLimitType:
          enum:
          - capped
          - uncapped
          type:
          - string
          - 'null'
          description: 'Controls whether the campaign has a spend limit.

            "capped" returns a non-null spendLimitAmount.value and a spendLimitRenewal of "daily", "monthly", or "lifetime".

            "uncapped" returns spendLimitAmount.value as null and spendLimitRenewal as "undefined".'
        startDate:
          type:
          - string
          - 'null'
          description: Advertiser-local calendar date when the scheduled spend limit becomes active, for example "2026-09-01".
          format: date
      description: 'Scheduled spend-limit creation.

        The startDate is an advertiser-local calendar date, for example 2026-09-01.

        When spendLimitType is "capped": spendLimitAmount and spendLimitRenewal are required.

        When spendLimitType is "uncapped": spendLimitAmount.value is null and spendLimitRenewal is "undefined".

        All scheduled spend limits for the campaign must use the same spendLimitRenewal as the active spend limit.

        When spendLimitRenewal is "monthly", startDate must be the first day of the month.'
    PatchAdSetCategoryBidResultListResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PatchAdSetCategoryBidResultResource'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: Data model for a list of response resources
    ReadModelAdSetIdV26Q1:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AdSetIdV26Q1'
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
          readOnly: true
        type:
          type:
          - string
          - 'null'
          readOnly: true
          example: AdSetIdV26Q1
      description: read model data for resources
    ReadAdSetAttributionConfigurationV26Q1:
      type:
      - object
      - 'null'
      properties:
        attributionMethod:
          enum:
          - unknown
          - criteoAttribution
          - lastClick
          - postClick
          - sftp
          - googleAnalytics
          type:
          - string
          - 'null'
          description: "Ad set attribution method.\nThis defines how certain events (visits, clicks, sales...) are attributed to the ad set.\n            \nPossible values:\n- unknown\n- criteoAttribution (default attribution method)\n- lastClick\n- postClick\n- sftp\n- googleAnalytics (requires Google Analytics integration)"
        lookbackWindow:
          enum:
          - unknown
          - 30M
          - 24H
          - 7D
          - 30D
          type:
          - string
          - 'null'
          description: The lookback window. Optional, should be specified only for attribution methods PostClick and LastClick.
      description: "Read model for an ad set's attribution configuration.\n            \nThe lookback window is only set for ad sets with an attribution method that is postClick or lastClick.\nIt will be null with any other attribution method."
    ResponsesAdSetIdV26Q1:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ReadModelAdSetIdV26Q1'
          readOnly: true
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: List of output resources
    RequestsPatchAdSetV26Q1:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/WriteModelPatchAdSetV26Q1'
      description: List of input resources
    PatchCampaignScheduledSpendLimitUpdate:
      required:
      - id
      - spendLimitType
      - startDate
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Identifier of the scheduled spend limit to update.
        spendLimitAmount:
          $ref: '#/components/schemas/NillableDecimal'
        spendLimitRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          type:
          - string
          - 'null'
          description: 'The period over which the campaign spend limit is applied.

            When spendLimitType is "capped", this is "daily", "monthly", or "lifetime".

            When spendLimitType is "uncapped", this is "undefined".'
        spendLimitType:
          enum:
          - capped
          - uncapped
          type:
          - string
          - 'null'
          description: 'Controls whether the campaign has a spend limit.

            "capped" returns a non-null spendLimitAmount.value and a spendLimitRenewal of "daily", "monthly", or "lifetime".

            "uncapped" returns spendLimitAmount.value as null and spendLimitRenewal as "undefined".'
        startDate:
          type:
          - string
          - 'null'
          description: Advertiser-local calendar date when the scheduled spend limit becomes active, for example "2026-09-01".
          format: date
      description: 'Scheduled spend-limit update.

        Updates are full replacements: id, startDate, spendLimitType, and the capped or uncapped spend-limit values must describe the complete desired state.

        The startDate is an advertiser-local calendar date, for example 2026-09-01.

        All scheduled spend limits for the campaign must use the same spendLimitRenewal as the active spend limit.

        When spendLimitRenewal is "monthly", startDate must be the first day of the month.'
    PatchAdSetV26Q1:
      type: object
      properties:
        attributionConfiguration:
          $ref: '#/components/schemas/PatchAdSetAttributionConfigurationV26Q1'
        bidding:
          $ref: '#/components/schemas/PatchAdSetBiddingV26Q1'
        budget:
          $ref: '#/components/schemas/PatchAdSetBudgetV26Q1'
        name:
          type:
          - string
          - 'null'
          description: Name of the ad set.
        scheduledBudget:
          $ref: '#/components/schemas/PatchAdSetScheduledBudgetV26Q1'
        scheduling:
          $ref: '#/components/schemas/PatchAdSetSchedulingV26Q1'
        targeting:
          $ref: '#/components/schemas/AdSetTargetingV26Q1'
      description: Model for patching an ad set.
    WriteModelAdSetId:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
        type:
          type:
          - string
          - 'null'
          description: Canonical type name of the entity
          example: AdSetId
      description: write model data for resources
    CreateAdSetGeoLocationV26Q1:
      type: object
      properties:
        countries:
          $ref: '#/components/schemas/AdSetTargetingRuleV26Q1'
        subdivisions:
          $ref: '#/components/schemas/AdSetTargetingRuleV26Q1'
        zipCodes:
          $ref: '#/components/schemas/AdSetTargetingRuleV26Q1'
      description: Geolocation configuration of the ad set
    AdvertiserInfoMessage:
      type: object
      properties:
        advertiserName:
          type: string
          description: Display name of the advertiser
        currencyName:
          type: string
          description: Currency used by the advertiser for bids and budgets (e.g. USD, EUR)
        id:
          type: integer
          description: Unique advertiser identifier
          format: int32
        timeZoneId:
          type:
          - string
          - 'null'
          description: IANA timezone identifier for the advertiser (e.g. UTC, Asia/Tokyo)
      description: Data representing an advertiser. An advertiser is the top-level entity that owns campaigns, sellers, and budgets.
      example:
        id: 9703
        advertiserName: MyCarDealers CO
        currencyName: USD
        timeZoneId: UTC
    CreateAdSetAttributionConfigurationV26Q1:
      type: object
      properties:
        attributionMethod:
          enum:
          - unknown
          - criteoAttribution
          - lastClick
          - postClick
          - sftp
          - googleAnalytics
          type: string
          description: The attribution method.
        lookbackWindow:
          enum:
          - unknown
          - 30M
          - 24H
          - 7D
          - 30D
          type:
          - string
          - 'null'
          description: The lookback window. Optional, should be specified only for attribution methods PostClick and LastClick.
      description: Create model for an ad set's attribution configuration.
    CreateAdSetV26Q1Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreateAdSetV26Q1Resource'
      description: Data model for an input resources
    CampaignBudgetAutomationV23Q1:
      type:
      - object
      - 'null'
      properties:
        automatedBudgetConfiguration:
          $ref: '#/components/schemas/AutomatedBudgetConfigurationV23Q1'
        enabled:
          type:
          - boolean
          - 'null'
          description: Whether budget automation is enabled for this campaign. This field is always present in the response.
      description: 'Budget automation, also known as automated budget or budget pacing, lets users configure KPIs and budgets once at the campaign level while Criteo dynamically routes spend toward the best-performing ad sets.

        When enabled is false, automatedBudgetConfiguration is null.

        When enabled is true, automatedBudgetConfiguration.adSetOptimizationObjective is expected.'
    PatchAdSetCategoryBid:
      type: object
      properties:
        bidAmount:
          type: number
          description: The Bid amount applied to the given Category associated to an Ad Set. At most 4 decimals are supported. Additional decimals are rounded.
          format: double
      description: Category Bid to update for a given combination of Ad Set and Category.
    UpdateSellerBudgetMessageBase:
      type: object
      properties:
        amount:
          type: string
        campaignIds:
          type: array
          items:
            type: integer
            format: int32
        endDate:
          type: string
        isSuspended:
          type: boolean
        startDate:
          type: string
          format: date-time
      description: Base data used to update a seller's budget
    ReadAdSetScheduleV26Q1:
      type:
      - object
      - 'null'
      properties:
        activationStatus:
          enum:
          - 'on'
          - 'off'
          type:
          - string
          - 'null'
          description: Activation status of the ad set, i.e. whether the consumer wants it to deliver
        deliveryStatus:
          enum:
          - draft
          - inactive
          - live
          - notLive
          - pausing
          - paused
          - scheduled
          - ended
          - notDelivering
          - archived
          type:
          - string
          - 'null'
          description: "Delivery status of the ad set, i.e. whether the ad set is delivering.\n            \nPossible values:\n- draft\n- inactive\n- live\n- notLive\n- pausing\n- paused\n- scheduled\n- ended\n- notDelivering\n- archived"
        endDate:
          $ref: '#/components/schemas/NillableDateTime'
        startDate:
          $ref: '#/components/schemas/NillableDateTime'
      description: Ad set schedule read model
    PatchMarketingCampaignBudgetAutomation:
      type: object
      properties:
        budgetConfiguration:
          $ref: '#/components/schemas/BudgetAutomationConfiguration'
        enabled:
          type: boolean
          description: Whether budget automation is enabled for this campaign. This field is always present in the response.
      description: 'Budget automation, lets users configure budgets once at the campaign level while Criteo dynamically routes spend toward the best-performing ad sets.

        Only provided fields are updated; omitted fields are left unchanged.

        If "enabled" is omitted and only "budgetConfiguration" is provided, "enabled" defaults to false — budget automation will not be activated.

        To activate budget automation, "enabled" must be explicitly set to true along with a valid "budgetConfiguration".

        To deactivate, set "enabled" to false; "budgetConfiguration" can be omitted.'
    AdSetIdV26Q1:
      type:
      - object
      - 'null'
      description: ad set id model
    StatsReportMessage:
      type: object
      properties:
        columns:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of column names for the report (e.g. campaignId, sellerId, day, impressions, clicks, cost, etc.)
        data:
          type:
          - array
          - 'null'
          items:
            type: array
            items: {}
          description: Array of data rows, each row is an array of values matching the columns order
        links:
          type:
          - object
          - 'null'
          description: Pagination links (empty object if no pagination)
        rows:
          type:
          - integer
          - 'null'
          description: Total number of data rows in the report
          format: int32
      description: A tabular stats report with column headers and data rows. Each row in 'data' is an array of values matching the order of 'columns'.
      example:
        columns:
        - campaignId
        - sellerId
        - sellerName
        - day
        - impressions
        - clicks
        - cost
        - saleUnits
        - revenue
        - cr
        - cpo
        - cos
        - roas
        data:
        - - 436017
          - 10656107
          - AutoShop NYC
          - '2026-04-01'
          - 75
          - 1
          - 0.05
          - 0
          - 0
          - 0
          - null
          - null
          - 0
        rows: 1
        links: {}
    ReadAdSetBiddingV26Q1:
      type:
      - object
      - 'null'
      properties:
        bidAmount:
          type:
          - number
          - 'null'
          description: 'Decimal value target relating to the `adSetObjective` specified.

            May be `null` for objectives that do not require a target value.

            At most 4 decimals are supported. Additional decimals are rounded.'
          format: double
        costController:
          enum:
          - COS
          - maxCPC
          - CPI
          - CPM
          - CPO
          - CPSV
          - CPV
          - dailyBudget
          - targetCPM
          type:
          - string
          - 'null'
          description: "Cost controller for the ad set.\n            \nPossible values:\n- COS\n- maxCPC\n- CPI\n- CPM\n- CPO\n- CPSV\n- CPV\n- dailyBudget\n- targetCPM"
      description: Ad set bidding read configuration.
    AdSetTargetingV26Q1:
      type:
      - object
      - 'null'
      properties:
        deliveryLimitations:
          $ref: '#/components/schemas/AdSetDeliveryLimitationsV26Q1'
        frequencyCapping:
          type:
          - object
          - 'null'
          properties:
            value:
              $ref: '#/components/schemas/AdSetFrequencyCappingV26Q1'
        geoLocation:
          $ref: '#/components/schemas/AdSetGeoLocationV26Q1'
      description: ad set targeting model
    PatchAdSetCategoryBidResultResource:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
        type:
          type:
          - string
          - 'null'
          description: Canonical type name of the entity
          example: AdSetCategoryBid
      description: Data model for a Resource
    AutomatedBudgetConfigurationV23Q1:
      type:
      - object
      - 'null'
      properties:
        adSetOptimizationObjective:
          enum:
          - conversions
          - revenue
          - visits
          - videoViews
          type:
          - string
          - 'null'
          description: 'Optimization objective used to automate budget allocation across ad sets.

            Expected when budgetAutomation.enabled is true.

            Possible values are "conversions", "revenue", "visits", and "videoViews".'
      description: Detailed configuration used when campaign budget automation is enabled.
    PatchAdSetDisplayMultiplierListRequest:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PatchAdSetDisplayMultiplierResource'
      description: Data model for a list of input resources
    PatchAdSetScheduledBudgetUpdateV26Q1:
      required:
      - id
      type: object
      properties:
        budgetAmount:
          $ref: '#/components/schemas/NillableDecimal'
        budgetDeliverySmoothing:
          enum:
          - accelerated
          - standard
          type:
          - string
          - 'null'
          description: 'Pacing strategy for spending the budget within a renewal period. Only applicable when budgetStrategy is "capped".

            - "accelerated": spend pacing is based on delivery efficiency rather than the full budget period.

            - "standard": spread spending evenly over the renewal period.

            When budgetStrategy is "uncapped", this field is not set (null in read responses, omit in create/patch requests).'
        budgetDeliveryWeek:
          enum:
          - undefined
          - mondayToSunday
          - tuesdayToMonday
          - wednesdayToTuesday
          - thursdayToWednesday
          - fridayToThursday
          - saturdayToFriday
          - sundayToSaturday
          type:
          - string
          - 'null'
          description: 'Defines which day-of-week boundaries are used for weekly budget renewal. Only applicable when budgetStrategy is "capped", budgetRenewal is "weekly", and budgetDeliverySmoothing is "standard".

            - "mondayToSunday", "tuesdayToMonday", etc.: the day range over which the weekly budget is paced. Changing this value on the active budget also propagates to all scheduled budgets of the same ad set.

            - "undefined": used when budgetStrategy is "uncapped", when budgetRenewal is not "weekly", or when budgetDeliverySmoothing is "accelerated".'
        budgetRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          - weekly
          type:
          - string
          - 'null'
          description: 'The period over which the budget is spent.

            - "daily", "monthly", "weekly": budget resets at the start of each period.

            - "lifetime": budget covers the entire ad set duration without resetting.

            - "undefined": only used when budgetStrategy is "uncapped" (no renewal applies). Required for capped budgets (must not be "undefined").'
        budgetStrategy:
          enum:
          - capped
          - uncapped
          type:
          - string
          - 'null'
          description: 'Controls whether the ad set has a spending limit.

            - "capped": spending is limited to budgetAmount. Requires budgetAmount (non-null), budgetRenewal (not "undefined"), and budgetDeliverySmoothing (not null).

            - "uncapped": no spending limit. budgetAmount is null, budgetRenewal is "undefined", and budgetDeliverySmoothing is null.'
        id:
          type:
          - string
          - 'null'
          description: Identifier of the scheduled budget to update.
        pacingBehavior:
          enum:
          - undefined
          - targetFullBudget
          - targetAverageDailyBudget
          type:
          - string
          - 'null'
          description: 'Controls how a standard capped budget is paced.

            - "targetFullBudget": spend toward the full budget amount within the renewal period.

            - "targetAverageDailyBudget": spend toward an average daily amount. Only supported for capped, standard, monthly budgets.

            - "undefined": no explicit pacing behavior. Required for uncapped budgets and accelerated budgets.'
        startDate:
          type:
          - string
          - 'null'
          description: 'New advertiser-local calendar date when the scheduled budget becomes active. Must be strictly in the future

            and unique among the ad set''s scheduled budgets.'
          format: date
      description: 'A patch of an existing scheduled budget of the ad set, identified by its "id".

        Only provided fields are updated; omitted fields are left unchanged.

        Switching to "uncapped": set budgetStrategy to "uncapped" and budgetAmount.value to null. The explicit null triggers the transition and automatically clears budgetRenewal, budgetDeliverySmoothing, budgetDeliveryWeek, and pacingBehavior.

        Switching to "capped": set budgetStrategy to "capped", budgetAmount.value to a positive number, budgetRenewal to a period, budgetDeliverySmoothing to a pacing strategy and pacingBehavior if budgetDeliverySmoothing is standard.

        Manual scheduled budget changes are not supported when the linked marketing campaign has budget automation enabled.'
    PatchAdSetCategoryBidListRequest:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PatchAdSetCategoryBidResource'
      description: Data model for a list of input resources
    AdSetAudienceLinkInputEntityV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AdSetAudienceLinkEntityV1Resource'
      description: Input to set audience ad set link.
    AdSetDisplayMultiplierResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AdSetDisplayMultiplier'
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
        type:
          type:
          - string
          - 'null'
          description: Canonical type name of the entity
          example: AdSetDisplayMultiplier
      description: Data model for a Resource
    NillableDecimal:
      type:
      - object
      - 'null'
      properties:
        value:
          type:
          - number
          - 'null'
          format: double
      description: structure that encapsulates an object that have valid business null values. If the structure is provided (i.e. not null), then the value in it, even null, is provided.
    CreateSellerBudgetMapiMessage:
      type: object
      properties:
        amount:
          type: string
          description: Budget amount as a string (e.g. '100.50')
        budgetType:
          type: string
          description: 'Type of budget: ''Daily'' (daily cap), ''Capped'' (lifetime with fixed amount), or ''Uncapped'' (lifetime with no limit)'
        campaignIds:
          type: array
          items:
            type: integer
            format: int32
          description: List of campaign IDs this budget applies to
        endDate:
          type: string
          description: 'Budget end date as a string (format: YYYY-MM-DD), or empty string for open-ended'
        sellerId:
          type: string
          description: Identifier of the seller this budget is for
        startDate:
          type: string
          description: Budget start date. Time component is ignored.
          format: date-time
      description: Data used to create a seller's budget
    PatchAdSetAttributionConfigurationV26Q1:
      type: object
      properties:
        attributionMethod:
          enum:
          - unknown
          - criteoAttribution
          - lastClick
          - postClick
          - sftp
          - googleAnalytics
          type:
          - string
          - 'null'
          description: The attribution method.
        lookbackWindow:
          enum:
          - unknown
          - 30M
          - 24H
          - 7D
          - 30D
          type:
          - string
          - 'null'
          description: The lookback window. Optional, should be specified only for attribution methods PostClick and LastClick.
      description: Patch model for an ad set's attribution configuration.
    AdSetCategoryBidResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AdSetCategoryBid'
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
        type:
          type:
          - string
          - 'null'
          description: Canonical type name of the entity
          example: AdSetCategoryBid
      description: Data model for a Resource
    AdSetAudienceLinkEntityV1:
      type:
      - object
      - 'null'
      properties:
        audienceId:
          type:
          - string
          - 'null'
      description: Link Audience with an ad set
      x-criteo-canonical:
        infoType: entity
        name: AdSetAudience
        version: v1
    PatchCampaignSpendLimit:
      type: object
      properties:
        spendLimitAmount:
          $ref: '#/components/schemas/NillableDecimal'
        spendLimitRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          type:
          - string
          - 'null'
          description: 'The period over which the campaign spend limit is applied.

            When spendLimitType is "capped", this is "daily", "monthly", or "lifetime".

            When spendLimitType is "uncapped", this is "undefined".'
        spendLimitType:
          enum:
          - capped
          - uncapped
          type:
          - string
          - 'null'
          description: 'Controls whether the campaign has a spend limit.

            "capped" returns a non-null spendLimitAmount.value and a spendLimitRenewal of "daily", "monthly", or "lifetime".

            "uncapped" returns spendLimitAmount.value as null and spendLimitRenewal as "undefined".'
      description: 'Spend limit configuration for a marketing campaign (patch).

        Only provided fields are updated; omitted fields are left unchanged.

        When spendLimitType is "capped": spendLimitAmount and spendLimitRenewal are required.

        When spendLimitType is "uncapped": spendLimitAmount is null and spendLimitRenewal is "undefined".'
    CampaignV23Q1Resource:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/CampaignV23Q1'
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
        type:
          type:
          - string
          - 'null'
          description: Canonical type name of the entity
          example: Campaign
      description: Data model for a Resource
    PatchCampaignScheduledSpendLimit:
      type: object
      properties:
        scheduledSpendLimitCreations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PatchCampaignScheduledSpendLimitCreation'
          description: Scheduled spend limits to create.
        scheduledSpendLimitDeletions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PatchCampaignScheduledSpendLimitDeletion'
          description: Scheduled spend limits to delete.
        scheduledSpendLimitUpdates:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PatchCampaignScheduledSpendLimitUpdate'
          description: Scheduled spend limits to update.
      description: 'Scheduled spend-limit operations for a marketing campaign (patch).

        Create, update, and delete operations are applied together by the backend.'
    ReadAdSetScheduledBudgetV26Q1:
      type: object
      properties:
        budgetAmount:
          type:
          - number
          - 'null'
          description: Maximum budget amount in the advertiser's currency per renewal period. Non-null when capped. null when uncapped.
          format: double
        budgetDeliverySmoothing:
          enum:
          - accelerated
          - standard
          type:
          - string
          - 'null'
          description: 'Pacing strategy for spending the budget within a renewal period. Only applicable when budgetStrategy is "capped".

            - "accelerated": spend pacing is based on delivery efficiency rather than the full budget period.

            - "standard": spread spending evenly over the renewal period.

            When budgetStrategy is "uncapped", this field is not set (null in read responses, omit in create/patch requests).'
        budgetDeliveryWeek:
          enum:
          - undefined
          - mondayToSunday
          - tuesdayToMonday
          - wednesdayToTuesday
          - thursdayToWednesday
          - fridayToThursday
          - saturdayToFriday
          - sundayToSaturday
          type:
          - string
          - 'null'
          description: 'Defines which day-of-week boundaries are used for weekly budget renewal. Only applicable when budgetStrategy is "capped", budgetRenewal is "weekly", and budgetDeliverySmoothing is "standard".

            - "mondayToSunday", "tuesdayToMonday", etc.: the day range over which the weekly budget is paced. Changing this value on the active budget also propagates to all scheduled budgets of the same ad set.

            - "undefined": used when budgetStrategy is "uncapped", when budgetRenewal is not "weekly", or when budgetDeliverySmoothing is "accelerated".'
        budgetRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          - weekly
          type:
          - string
          - 'null'
          description: 'The period over which the budget is spent.

            - "daily", "monthly", "weekly": budget resets at the start of each period.

            - "lifetime": budget covers the entire ad set duration without resetting.

            - "undefined": only used when budgetStrategy is "uncapped" (no renewal applies). Required for capped budgets (must not be "undefined").'
        budgetStrategy:
          enum:
          - capped
          - uncapped
          type:
          - string
          - 'null'
          description: 'Controls whether the ad set has a spending limit.

            - "capped": spending is limited to budgetAmount. Requires budgetAmount (non-null), budgetRenewal (not "undefined"), and budgetDeliverySmoothing (not null).

            - "uncapped": no spending limit. budgetAmount is null, budgetRenewal is "undefined", and budgetDeliverySmoothing is null.'
        id:
          type:
          - string
          - 'null'
          description: Identifier of the scheduled budget.
        pacingBehavior:
          enum:
          - undefined
          - targetFullBudget
          - targetAverageDailyBudget
          type:
          - string
          - 'null'
          description: 'Controls how a standard capped budget is paced.

            - "targetFullBudget": spend toward the full budget amount within the renewal period.

            - "targetAverageDailyBudget": spend toward an average daily amount. Only supported for capped, standard, monthly budgets.

            - "undefined": no explicit pacing behavior. Use for uncapped or accelerated budgets, or omit pacingBehavior.'
        startDate:
          type:
          - string
          - 'null'
          description: Advertiser-local calendar date when the scheduled budget becomes active.
          format: date
      description: 'A budget configuration scheduled to replace the ad set''s active budget on the specified "startDate".

        It contains the same fields as the active budget, plus the scheduled budget identifier and start date.'
    PatchAdSetDisplayMultiplierResultResource:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
        type:
          type:
          - string
          - 'null'
          description: Canonical type name of the entity
          example: AdSetDisplayMultiplier
      description: Data model for a Resource
    PatchAdSetScheduledBudgetV26Q1:
      type: object
      properties:
        scheduledBudgetCreations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PatchAdSetScheduledBudgetCreationV26Q1'
        scheduledBudgetDeletions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PatchAdSetScheduledBudgetDeletionV26Q1'
        scheduledBudgetUpdates:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PatchAdSetScheduledBudgetUpdateV26Q1'
      description: Scheduled budget patch model for an ad set. Groups the operations (Create, Update, Delete) on the ad set's scheduled budget.
    PatchCampaignListRequest:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PatchCampaignWriteResource'
      description: List of input resources
    AdSetAudienceLinkEntityV1Resource:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/AdSetAudienceLinkEntityV1'
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
        type:
          type:
          - string
          - 'null'
      description: A class that represents a domain entity exposed by an API
    CampaignScheduledSpendLimitV23Q1:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Identifier of the scheduled spend limit, for example "12345".
        spendLimitAmount:
          $ref: '#/components/schemas/NillableDecimal'
        spendLimitRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          type:
          - string
          - 'null'
          description: 'The period over which the campaign spend limit is applied.

            - "daily", "monthly", and "lifetime" are valid when spendLimitType is "capped".

            - "undefined" is returned when spendLimitType is "uncapped".'
        spendLimitType:
          enum:
          - capped
          - uncapped
          type:
          - string
          - 'null'
          description: 'Controls whether the campaign has a spend limit.

            - "capped": a spend limit applies, spendLimitAmount.value is non-null, and spendLimitRenewal is "daily", "monthly", or "lifetime".

            - "uncapped": no spend limit applies, spendLimitAmount.value is null, and spendLimitRenewal is "undefined".'
        startDate:
          type:
          - string
          - 'null'
          description: Advertiser-local calendar date when the scheduled spend limit becomes active, for example "2026-08-01".
          format: date
      description: A campaign spend limit scheduled to become active on the specified "startDate".
    ReadModelAdSetId:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
          readOnly: true
        type:
          type:
          - string
          - 'null'
          readOnly: true
          example: AdSetId
      description: read model data for resources
    ResponseReadAdSetV26Q1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ReadModelReadAdSetV26Q1'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: output resource
    PatchResultCampaignListResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PatchResultCampaignReadResource'
          readOnly: true
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: List of output resources
    ReadAdSetV26Q1:
      type:
      - object
      - 'null'
      properties:
        advertiserId:
          type:
          - string
          - 'null'
          description: 'Advertiser id of the campaign this ad set belongs to

            This value is a string-encoded integer.'
        attributionConfiguration:
          $ref: '#/components/schemas/ReadAdSetAttributionConfigurationV26Q1'
        bidding:
          $ref: '#/components/schemas/ReadAdSetBiddingV26Q1'
        budget:
          $ref: '#/components/schemas/ReadAdSetBudgetV26Q1'
        campaignId:
          type:
          - string
          - 'null'
          description: "Campaign id this ad set belongs to.\n            \nThis is a key to a MarketingCampaign entity, which can be retrieved using the MarketingCampaigns endpoints.\nThis value is a string-encoded integer."
        datasetId:
          type:
          - string
          - 'null'
          description: 'Dataset id of this ad set

            This value is a string-encoded integer.'
        destinationEnvironment:
          enum:
          - undefined
          - web
          - app
          type:
          - string
          - 'null'
          description: "The environment that an ad click will lead a user to.\n            \nPossible values:\n- undefined: the ad set does not specify its destination environment\n- web: the ad set lead users to a web page\n- app: the ad set lead users to an app"
        mediaType:
          enum:
          - display
          - video
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
          description: Name of the ad set
        objective:
          enum:
          - customAction
          - clicks
          - conversions
          - displays
          - appPromotion
          - revenue
          - storeConversions
          - value
          - reach
          - visits
          - videoViews
          type:
          - string
          - 'null'
          description: "Ad set objective.\n            \nPossible values:\n- customAction (previously \"Actions\")\n- clicks\n- conversions\n- displays\n- appPromotion (previously \"Installs\")\n- revenue\n- storeConversions\n- value\n- reach (previously \"ViewedImpressions\")\n- visits\n- videoViews (previously \"CompletedVideoViews\")"
        schedule:
          $ref: '#/components/schemas/ReadAdSetScheduleV26Q1'
        scheduledBudgets:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ReadAdSetScheduledBudgetV26Q1'
        targeting:
          $ref: '#/components/schemas/AdSetTargetingV26Q1'
        videoChannel:
          enum:
          - olv
          - ctv
          type:
          - string
          - 'null'
      description: "Ad set read model.\n            \nThe ad set is the configuration unit that defines ads delivery. Its binds together the objective, budget,\nscheduling, targeting options and ads."
    CreateAdSetBiddingV26Q1:
      required:
      - costController
      type: object
      properties:
        bidAmount:
          type:
          - number
          - 'null'
          description: Decimal value target relating to the `bidStrategy` specified. May be `null` for strategies that do not require a target value. At most 4 decimals are supported. Additional decimals are rounded.
          format: double
        costController:
          enum:
          - COS
          - maxCPC
          - CPI
          - CPM
          - CPO
          - CPSV
          - CPV
          - dailyBudget
          - targetCPM
          type: string
          description: How spend is controlled
      description: ad set bidding create model
    PatchAdSetCategoryBidResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/PatchAdSetCategoryBid'
        id:
          type: string
          description: Id of the entity
        type:
          type: string
          description: Canonical type name of the entity
          example: AdSetCategoryBid
      description: Data model for a Resource
    PatchCampaignWriteResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/PatchCampaign'
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
        type:
          type:
          - string
          - 'null'
          description: Canonical type name of the entity
          example: Campaign
      description: write model data for resources
    CreateAdSetTargetingV26Q1:
      required:
      - frequencyCapping
      type: object
      properties:
        deliveryLimitations:
          $ref: '#/components/schemas/AdSetDeliveryLimitationsV26Q1'
        frequencyCapping:
          $ref: '#/components/schemas/AdSetFrequencyCappingV26Q1'
        geoLocation:
          $ref: '#/components/schemas/CreateAdSetGeoLocationV26Q1'
      description: Targeting configuration of the ad set
    CampaignV23Q1Response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CampaignV23Q1Resource'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: Data model for response resource
    RequestsAdSetId:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/WriteModelAdSetId'
      description: List of input resources
    AdvertiserQuotaMessage:
      type: object
      properties:
        advertiserId:
          type:
          - integer
          - 'null'
          format: int32
        quotaEndDate:
          type:
          - string
          - 'null'
          format: date-time
        quotaLimit:
          type:
          - integer
          - 'null'
          format: int32
        quotaStartDate:
          type:
          - string
          - 'null'
          format: date-time
        quotaUsed:
          type:
          - integer
          - 'null'
          format: int32
      description: Data representing an advertiser's quota
    CampaignV23Q1ListResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CampaignV23Q1Resource'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: Data model for a list of response resources
    WriteModelPatchAdSetV26Q1:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/PatchAdSetV26Q1'
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
        type:
          type:
          - string
          - 'null'
          description: Canonical type name of the entity
          example: PatchAdSetV26Q1
      description: write model data for resources
    PatchAdSetDisplayMultiplierResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/PatchAdSetDisplayMultiplier'
        id:
          type: string
          description: Id of the entity
        type:
          type: string
          description: Canonical type name of the entity
          example: AdSetDisplayMultiplier
      description: Data model for a Resource
    ReadModelReadAdSetV26Q1:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/ReadAdSetV26Q1'
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
          readOnly: true
        type:
          type:
          - string
          - 'null'
          readOnly: true
          example: ReadAdSetV26Q1
      description: read model data for resources
    AdSetDisplayMultiplierListResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AdSetDisplayMultiplierResource'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: Data model for a list of response resources
    PatchAdSetDisplayMultiplier:
      type: object
      properties:
        displayMultiplier:
          type: number
          description: Any positive decimal value. To remove the impact of the Display Multiplier set it to 1. At most 4 decimals are supported. Additional decimals are rounded.
          format: double
      description: Display Multiplier to update for a given combination of Ad Set and Category.
    PatchCampaignScheduledSpendLimitDeletion:
      required:
      - id
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Identifier of the scheduled spend limit to delete.
      description: Scheduled spend-limit deletion.
    CreateAdSetBudgetV26Q1:
      required:
      - budgetStrategy
      type: object
      properties:
        budgetAmount:
          type:
          - number
          - 'null'
          description: Maximum budget amount in the advertiser's currency per renewal period. Required non-null when capped. Must be null when uncapped.
          format: double
        budgetDeliverySmoothing:
          enum:
          - accelerated
          - standard
          type: string
          description: 'Pacing strategy for spending the budget within a renewal period. Only applicable when budgetStrategy is "capped".

            - "accelerated": spend pacing is based on delivery efficiency rather than the full budget period.

            - "standard": spread spending evenly over the renewal period.

            When budgetStrategy is "uncapped", this field is not set (null in read responses, omit in create/patch requests).'
        budgetDeliveryWeek:
          enum:
          - undefined
          - mondayToSunday
          - tuesdayToMonday
          - wednesdayToTuesday
          - thursdayToWednesday
          - fridayToThursday
          - saturdayToFriday
          - sundayToSaturday
          type: string
          description: 'Defines which day-of-week boundaries are used for weekly budget renewal. Only applicable when budgetStrategy is "capped", budgetRenewal is "weekly", and budgetDeliverySmoothing is "standard".

            - "mondayToSunday", "tuesdayToMonday", etc.: the day range over which the weekly budget is paced. Changing this value on the active budget also propagates to all scheduled budgets of the same ad set.

            - "undefined": used when budgetStrategy is "uncapped", when budgetRenewal is not "weekly", or when budgetDeliverySmoothing is "accelerated".'
        budgetRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          - weekly
          type: string
          description: 'The period over which the budget is spent.

            - "daily", "monthly", "weekly": budget resets at the start of each period.

            - "lifetime": budget covers the entire ad set duration without resetting.

            - "undefined": only used when budgetStrategy is "uncapped" (no renewal applies). Required for capped budgets (must not be "undefined").'
        budgetStrategy:
          enum:
          - capped
          - uncapped
          type: string
          description: 'Controls whether the ad set has a spending limit.

            - "capped": spending is limited to budgetAmount. Requires budgetAmount (non-null), budgetRenewal (not "undefined"), and budgetDeliverySmoothing (not null).

            - "uncapped": no spending limit. budgetAmount is null, budgetRenewal is "undefined", and budgetDeliverySmoothing is null.'
        pacingBehavior:
          enum:
          - undefined
          - targetFullBudget
          - targetAverageDailyBudget
          type: string
          description: 'Controls how a standard capped budget is paced.

            - "targetFullBudget": spend toward the full budget amount within the renewal period.

            - "targetAverageDailyBudget": spend toward an average daily amount. Only supported for capped, standard, monthly budgets.

            - "undefined": no explicit pacing behavior. Required for uncapped budgets and accelerated budgets.'
      description: 'Budget create model for an ad set.

        For "capped": budgetAmount (required, non-null), budgetRenewal (required, not "undefined"), and budgetDeliverySmoothing (required) must all be provided.

        pacingBehavior is optional; "targetAverageDailyBudget" is only supported for capped, standard, monthly budgets.

        For "uncapped": budgetAmount must be null, budgetRenewal must be "undefined", budgetDeliverySmoothing, budgetDeliveryWeek, and pacingBehavior must be omitted or "undefined".

        For marketing campaigns with budget automation enabled, omit this object.

        In that case, the ad set budget is initialized from the marketing campaign spend limit amount and renewal period.'
    AdSetDeliveryStatus:
      enum:
      - Running
      - Archived
      - NotRunning
      type: string
      description: Status of an ad set's delivery
    NillableAdSetTargetingRuleV26Q1:
      type:
      - object
      - 'null'
      properties:
        value:
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/AdSetTargetingRuleV26Q1'
      description: structure that encapsulates an object that have valid business null values. If the structure is provided (i.e. not null), then the value in it, even null, is provided.
    ResponsesReadAdSetV26Q1:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ReadModelReadAdSetV26Q1'
          readOnly: true
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: List of output resources
    AdSetSearchRequestMetadataV26Q1:
      type: object
      properties:
        fields:
          type:
          - array
          - 'null'
          items:
            enum:
            - Name
            - AdvertiserId
            - DatasetId
            - CampaignId
            - DestinationEnvironment
            - Objective
            - Schedule
            - Bidding
            - Targeting
            - Budget
            - MediaType
            - VideoChannel
            - AttributionConfiguration
            type: string
            description: "Fields that can be projected when searching ad sets.\n            \nPossible values:\n- Name\n- AdvertiserId\n- DatasetId\n- CampaignId\n- DestinationEnvironment\n- Objective\n- Schedule\n- Bidding\n- Targeting\n- Budget\n- MediaType\n- VideoChannel\n- AttributionConfiguration"
          description: 'List of fields to include in the response. If null or omitted, all fields are returned.

            When only a subset of fields is projected, non-projected fields will have default values (e.g. null, 0, or enum defaults) which may not reflect the actual ad set state. Do not interpret non-projected fields as meaningful data.'
      description: Optional metadata for searching ad sets
    CampaignSearchRequestV23Q1:
      type: object
      properties:
        filters:
          $ref: '#/components/schemas/CampaignSearchFiltersV23Q1'
      description: Request payload for the campaign search endpoint.
    AdvertiserCampaignMessage:
      type: object
      properties:
        adSetDeliveryStatus:
          enum:
          - Running
          - Archived
          - NotRunning
          type: string
          description: Human-readable delivery status of the campaign's ad set
          readOnly: true
        campaignName:
          type: string
          description: Display name of the campaign
        id:
          type: integer
          description: Unique campaign identifier
          format: int32
        status:
          enum:
          - 0
          - 1
          - 2
          type:
          - integer
          - 'null'
          description: 'Numeric delivery status: 0 = Running, 1 = Archived, 2 = NotRunning'
      description: Data representing a campaign for an advertiser. A campaign groups seller-campaigns and defines delivery settings.
      example:
        id: 436017
        campaignName: Sponsored Products - Main
        adSetDeliveryStatus: Running
        status: 0
      x-readonly-adSetDeliveryStatus: true
    AdSetCategoryBidListResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AdSetCategoryBidResource'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: Data model for a list of response resources
    AdSetSearchRequestV26Q1:
      type: object
      properties:
        filters:
          $ref: '#/components/schemas/AdSetSearchFilterV26Q1'
        meta:
          $ref: '#/components/schemas/AdSetSearchRequestMetadataV26Q1'
      description: request payload of the search endpoint
      example:
        filters:
          advertiserIds:
          - '12345'
    SellerCampaignProductSet:
      type:
      - object
      - 'null'
      properties:
        productSetNumberOfProducts:
          type:
          - integer
          - 'null'
          description: Number of products matching the product set rules
          format: int32
        productSetStatus:
          type:
          - string
          - 'null'
          description: Status of the product set (e.g. Active, Pending)
        rules:
          type:
          - array
          - 'null'
          items:
            type: object
          description: Array of product set filtering rules
      description: Product set targeting configuration for a seller-campaign
    SellerCampaignUpdate:
      type: object
      properties:
        bid:
          type: number
          description: New cost-per-click bid. Set to 0 to stop delivery.
          format: double
        id:
          type: string
          description: Seller-campaign identifier in format {sellerId}.{campaignId}
      description: Data used to update a Seller-Campaign's Bid.
    PatchAdSetScheduledBudgetCreationV26Q1:
      required:
      - startDate
      type: object
      properties:
        budgetAmount:
          type:
          - number
          - 'null'
          description: 'Maximum budget amount in the advertiser''s currency per renewal period.

            Required when budgetStrategy is "capped"; must be omitted when budgetStrategy is "uncapped".'
          format: double
        budgetDeliverySmoothing:
          enum:
          - accelerated
          - standard
          type:
          - string
          - 'null'
          description: 'Pacing strategy for spending the budget within a renewal period. Only applicable when budgetStrategy is "capped".

            - "accelerated": spend pacing is based on delivery efficiency rather than the full budget period.

            - "standard": spread spending evenly over the renewal period.

            When budgetStrategy is "uncapped", this field is not set (null in read responses, omit in create/patch requests).'
        budgetDeliveryWeek:
          enum:
          - undefined
          - mondayToSunday
          - tuesdayToMonday
          - wednesdayToTuesday
          - thursdayToWednesday
          - fridayToThursday
          - saturdayToFriday
          - sundayToSaturday
          type:
          - string
          - 'null'
          description: 'Defines which day-of-week boundaries are used for weekly budget renewal. Only applicable when budgetStrategy is "capped", budgetRenewal is "weekly", and budgetDeliverySmoothing is "standard".

            - "mondayToSunday", "tuesdayToMonday", etc.: the day range over which the weekly budget is paced. Changing this value on the active budget also propagates to all scheduled budgets of the same ad set.

            - "undefined": used when budgetStrategy is "uncapped", when budgetRenewal is not "weekly", or when budgetDeliverySmoothing is "accelerated".'
        budgetRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          - weekly
          type:
          - string
          - 'null'
          description: 'The period over which the budget is spent.

            - "daily", "monthly", "weekly": budget resets at the start of each period.

            - "lifetime": budget covers the entire ad set duration without resetting.

            - "undefined": only used when budgetStrategy is "uncapped" (no renewal applies). Required for capped budgets (must not be "undefined").'
        budgetStrategy:
          enum:
          - capped
          - uncapped
          type:
          - string
          - 'null'
          description: 'Controls whether the ad set has a spending limit.

            - "capped": spending is limited to budgetAmount. Requires budgetAmount (non-null), budgetRenewal (not "undefined"), and budgetDeliverySmoothing (not null).

            - "uncapped": no spending limit. budgetAmount is null, budgetRenewal is "undefined", and budgetDeliverySmoothing is null.'
        pacingBehavior:
          enum:
          - undefined
          - targetFullBudget
          - targetAverageDailyBudget
          type:
          - string
          - 'null'
          description: 'Controls how a standard capped budget is paced.

            - "targetFullBudget": spend toward the full budget amount within the renewal period.

            - "targetAverageDailyBudget": spend toward an average daily amount. Only supported for capped, standard, monthly budgets.

            - "undefined": no explicit pacing behavior. Required for uncapped budgets and accelerated budgets.'
        startDate:
          type: string
          description: Advertiser-local calendar date when the scheduled budget becomes active. Required, strictly in the future.
          format: date
      description: 'A budget configuration to schedule on the ad set, becoming active on the specified "startDate".

        It contains the same fields as an active-budget patch, plus the required start date.

        The start date must be strictly in the future and unique among the ad set''s scheduled budgets.

        Creating an "uncapped" scheduled budget: set budgetStrategy to "uncapped" and omit budgetAmount.

        Creating a "capped" scheduled budget: set budgetStrategy to "capped", budgetAmount to a positive number, budgetRenewal to a period, budgetDeliverySmoothing to a pacing strategy and pacingBehavior if budgetDeliverySmoothing is standard.

        Manual scheduled budget changes are not supported when the linked marketing campaign has budget automation enabled.'
    CreateCampaignSpendLimit:
      required:
      - spendLimitType
      type: object
      properties:
        spendLimitAmount:
          type:
          - number
          - 'null'
          description: Maximum spend amount in the advertiser's currency per renewal period. Non-null when capped. null when uncapped.
          format: double
        spendLimitRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          type: string
          description: 'The period over which the spend limit is consumed.

            - "daily", "monthly": spend limit resets at the start of each period.

            - "lifetime": spend limit covers the entire campaign duration without resetting.

            - "undefined": only used when spendLimitType is "uncapped" (no renewal applies).'
        spendLimitType:
          enum:
          - capped
          - uncapped
          type: string
          description: 'Controls whether the campaign has a spending limit.

            - "capped": spending is limited to spendLimitAmount. Requires spendLimitAmount (non-null) and spendLimitRenewal (not "undefined").

            - "uncapped": no spending limit. spendLimitAmount is null and spendLimitRenewal is "undefined".'
      description: 'Spend limit configuration for a marketing campaign. Controls how much can be spent and the renewal cadence.

        When spendLimitType is "capped": spendLimitAmount and spendLimitRenewal are required.

        When spendLimitType is "uncapped": spendLimitAmount is null and spendLimitRenewal is "undefined".'
    SellerBudgetStatusV2:
      enum:
      - Archived
      - Current
      - Scheduled
      type: string
      description: Status of a seller budget
    CreateAdSetV26Q1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CreateAdSetV26Q1'
        type:
          type: string
          description: Canonical type name of the entity
          example: AdSet
      description: Data model for a Resource
    CommonProblem:
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
          description: A machine-readable error code, expressed as a string value.
        detail:
          type:
          - string
          - 'null'
          description: A human-readable explanation specific to this occurrence of the problem
        instance:
          type:
          - string
          - 'null'
          description: A URI that identifies the specific occurrence of the problem.
        source:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
          description: A machine-readable structure to reference to the exact location(s) causing the error(s)
        stackTrace:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
          description: A short human-readable description of the problem type
        traceId:
          type:
          - string
          - 'null'
          description: The request correlation ID this problem comes from.
        traceIdentifier:
          type:
          - string
          - 'null'
          description: The request correlation ID this problem comes from. (deprecated, use traceId instead)
        type:
          enum:
          - unknown
          - access-control
          - authentication
          - authorization
          - availability
          - deprecation
          - quota
          - validation
          type:
          - string
          - 'null'
          description: The problem's category.
      description: Common problem object.
    ResponsesAdSetId:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ReadModelAdSetId'
          readOnly: true
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: List of output resources
    CreateCampaignRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreateCampaignResource'
      description: Data model for an input resources
    PatchAdSetDisplayMultiplierResultListResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PatchAdSetDisplayMultiplierResultResource'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: Data model for a list of response resources
    AdvertiserAdsetMessage:
      type: object
      properties:
        adsetId:
          type: integer
          format: int32
        adsetName:
          type: string
        advertiserId:
          type: integer
          format: int32
        isCoa:
          type: boolean
        partnerId:
          type: integer
          format: int32
        status:
          $ref: '#/components/schemas/AdSetDeliveryStatus'
      description: Data representing an advertiser's adset
    SellerBase:
      type: object
      properties:
        id:
          type: string
          description: Unique seller identifier
        sellerName:
          type: string
          description: Display name of the seller (merchant)
      description: The seller represents the merchant selling products on the advertiser's marketplace platform.
      example:
        id: '10656107'
        sellerName: AutoShop NYC
    CreateSellerCampaignMessageMapi:
      type: object
      properties:
        bid:
          type: number
          description: Initial cost-per-click bid in the advertiser's currency
          format: double
        campaignId:
          type: integer
          description: ID of the campaign to associate the seller with. Must be an existing campaign.
          format: int32
      description: Data used to create a seller's campaign
    CampaignSpendLimitV23Q1:
      type:
      - object
      - 'null'
      properties:
        spendLimitAmount:
          $ref: '#/components/schemas/NillableDecimal'
        spendLimitRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          type:
          - string
          - 'null'
          description: 'The period over which the campaign spend limit is applied.

            When spendLimitType is "capped", this is "daily", "monthly", or "lifetime".

            When spendLimitType is "uncapped", this is "undefined".'
        spendLimitType:
          enum:
          - capped
          - uncapped
          type:
          - string
          - 'null'
          description: 'Controls whether the campaign has a spend limit.

            "capped" returns a non-null spendLimitAmount.value and a spendLimitRenewal of "daily", "monthly", or "lifetime".

            "uncapped" returns spendLimitAmount.value as null and spendLimitRenewal as "undefined".'
      description: Campaign spend-limit configuration. A capped spend limit restricts campaign spending per renewal period. An uncapped spend limit does not impose a spending ceiling.
    NillableDateTime:
      type:
      - object
      - 'null'
      properties:
        value:
          type:
          - string
          - 'null'
          format: date-time
      description: structure that encapsulates an object that have valid business null values. If the structure is provided (i.e. not null), then the value in it, even null, is provided.
    AdSetDeliveryLimitationsV26Q1:
      type:
      - object
      - 'null'
      properties:
        devices:
          type:
          - array
          - 'null'
          items:
            enum:
            - other
            - desktop
            - mobile
            - tablet
            type: string
            description: "Targeted device type.\n            \nPossible values:\n- other\n- desktop\n- mobile\n- tablet"
          description: "List of devices which the ad set should target.\n            \nNo limitation if the list is empty."
        environments:
          type:
          - array
          - 'null'
          items:
            enum:
            - web
            - inApp
            type: string
            description: "Targeted environment type.\n            \nNote: this is very different from AdSetDestinationEnvironment: this parameter defines a delivery limitation,\nnot an impression's destination.\n            \nPossible values:\n- web\n- inApp"
          description: "List of environments which the ad set should target.\n            \nNo limitation if the list is empty."
        operatingSystems:
          type:
          - array
          - 'null'
          items:
            enum:
            - android
            - ios
            - unknown
            type: string
            description: "Targeted operating system.\n            \nPossible values:\n- android\n- ios\n- unknown"
          description: "List of operating systems which the ad set should target.\n            \nNo limitation if the list is empty."
      description: Delivery limitations for an ad set.
    AdSetCategoryBid:
      type:
      - object
      - 'null'
      properties:
        bidAmount:
          type:
          - number
          - 'null'
          description: The Bid amount applied to the given Category associated to an Ad Set. At most 4 decimals are supported. Additional decimals are rounded.
          format: double
        categoryName:
          type:
          - string
          - 'null'
          description: The name of the Category to which the Category Bid has been applied.
      description: Category Bid information about a Category for a given Ad Set.
    CreateAdSetV26Q1:
      required:
      - bidding
      - campaignId
      - datasetId
      - mediaType
      - name
      - objective
      - schedule
      - targeting
      - trackingCode
      type: object
      properties:
        attributionConfiguration:
          $ref: '#/components/schemas/CreateAdSetAttributionConfigurationV26Q1'
        bidding:
          $ref: '#/components/schemas/CreateAdSetBiddingV26Q1'
        budget:
          $ref: '#/components/schemas/CreateAdSetBudgetV26Q1'
        campaignId:
          type:
          - string
          - 'null'
          description: Campaign id this ad set belongs to
        datasetId:
          type: string
          description: Dataset id of this ad set
        mediaType:
          enum:
          - display
          - video
          type: string
          description: Media type for the ad set
        name:
          type:
          - string
          - 'null'
          description: Name of the ad set
        objective:
          enum:
          - customAction
          - clicks
          - conversions
          - displays
          - appPromotion
          - revenue
          - storeConversions
          - value
          - reach
          - visits
          - videoViews
          type: string
          description: Objective of the ad set
        schedule:
          $ref: '#/components/schemas/CreateAdSetScheduleV26Q1'
        targeting:
          $ref: '#/components/schemas/CreateAdSetTargetingV26Q1'
        trackingCode:
          type:
          - string
          - 'null'
          description: The click tracking code associated to this Ad Set.
      description: ad set create model
      example:
        name: test adset
        datasetId: '108002'
        campaignId: '358313'
        objective: conversions
        schedule:
          startDate: '2026-04-04T16:21:06.3537890+02:00'
          endDate: '2026-04-13T16:21:06.3537917+02:00'
        bidding:
          costController: dailyBudget
        targeting:
          deliveryLimitations:
            environments:
            - web
            devices:
            - desktop
            operatingSystems:
            - android
          geoLocation:
            countries:
              operand: in
              values:
              - FR
              - IT
          frequencyCapping:
            frequency: daily
            maximumImpressions: 1000
        budget:
          budgetStrategy: capped
          budgetRenewal: weekly
          budgetDeliverySmoothing: standard
          budgetDeliveryWeek: mondayToSunday
          pacingBehavior: targetFullBudget
          budgetAmount: 1000
        trackingCode: Test123
        mediaType: display
        attributionConfiguration:
          attributionMethod: criteoAttribution
    BudgetAutomationConfiguration:
      type:
      - object
      - 'null'
      properties:
        adSetObjectives:
          enum:
          - conversions
          - revenue
          - visits
          - videoViews
          type: string
          description: 'The ad set optimization objective for budget automation. Determines how the automated budget allocates spend across ad sets in the campaign.

            - "conversions": optimize for conversion events.

            - "revenue": optimize for revenue.

            - "visits": optimize for site visits.

            - "videoViews": optimize for completed video views.'
      description: 'Configuration for budget automation. Only meaningful when "enabled" is true.

        When "enabled" is false or omitted, this field is ignored.'
    PatchAdSetBiddingV26Q1:
      type: object
      properties:
        bidAmount:
          $ref: '#/components/schemas/NillableDecimal'
      description: Ad set bidding patch model
    PatchAdSetBudgetV26Q1:
      type: object
      properties:
        budgetAmount:
          $ref: '#/components/schemas/NillableDecimal'
        budgetDeliverySmoothing:
          enum:
          - accelerated
          - standard
          type:
          - string
          - 'null'
          description: 'Pacing strategy for spending the budget within a renewal period. Only applicable when budgetStrategy is "capped".

            - "accelerated": spend pacing is based on delivery efficiency rather than the full budget period.

            - "standard": spread spending evenly over the renewal period.

            When budgetStrategy is "uncapped", this field is not set (null in read responses, omit in create/patch requests).'
        budgetDeliveryWeek:
          enum:
          - undefined
          - mondayToSunday
          - tuesdayToMonday
          - wednesdayToTuesday
          - thursdayToWednesday
          - fridayToThursday
          - saturdayToFriday
          - sundayToSaturday
          type:
          - string
          - 'null'
          description: 'Defines which day-of-week boundaries are used for weekly budget renewal. Only applicable when budgetStrategy is "capped", budgetRenewal is "weekly", and budgetDeliverySmoothing is "standard".

            - "mondayToSunday", "tuesdayToMonday", etc.: the day range over which the weekly budget is paced. Changing this value on the active budget also propagates to all scheduled budgets of the same ad set.

            - "undefined": used when budgetStrategy is "uncapped", when budgetRenewal is not "weekly", or when budgetDeliverySmoothing is "accelerated".'
        budgetRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          - weekly
          type:
          - string
          - 'null'
          description: 'The period over which the budget is spent.

            - "daily", "monthly", "weekly": budget resets at the start of each period.

            - "lifetime": budget covers the entire ad set duration without resetting.

            - "undefined": only used when budgetStrategy is "uncapped" (no renewal applies). Required for capped budgets (must not be "undefined").'
        budgetStrategy:
          enum:
          - capped
          - uncapped
          type:
          - string
          - 'null'
          description: 'Controls whether the ad set has a spending limit.

            - "capped": spending is limited to budgetAmount. Requires budgetAmount (non-null), budgetRenewal (not "undefined"), and budgetDeliverySmoothing (not null).

            - "uncapped": no spending limit. budgetAmount is null, budgetRenewal is "undefined", and budgetDeliverySmoothing is null.'
        pacingBehavior:
          enum:
          - undefined
          - targetFullBudget
          - targetAverageDailyBudget
          type:
          - string
          - 'null'
          description: 'Controls how a standard capped budget is paced.

            - "targetFullBudget": spend toward the full budget amount within the renewal period.

            - "targetAverageDailyBudget": spend toward an average daily amount. Only supported for capped, standard, monthly budgets.

            - "undefined": no explicit pacing behavior. Required for uncapped budgets and accelerated budgets.'
      description: 'Budget patch model for an ad set. Only provided fields are updated; omitted fields are left unchanged.

        Switching to "uncapped": set budgetStrategy to "uncapped" and budgetAmount.value to null. Other budget fields (budgetRenewal, budgetDeliverySmoothing, budgetDeliveryWeek, and pacingBehavior) are automatically cleared.

        Switching to "capped": set budgetStrategy to "capped", budgetAmount.value to a positive number, budgetRenewal to a period, and budgetDeliverySmoothing to a pacing strategy.

        pacingBehavior can only be set for capped budgets using standard delivery smoothing; "targetAverageDailyBudget" also requires monthly renewal.

        Manual budget updates are not supported when the linked marketing campaign has budget automation enabled.'
    AdSetFrequencyCappingV26Q1:
      type:
      - object
      - 'null'
      properties:
        frequency:
          enum:
          - hourly
          - daily
          - lifetime
          - advanced
          type:
          - string
          - 'null'
          description: "Period on which impression limitation is calculated.\n            \nPossible values:\n- hourly\n- daily\n- lifetime\n- advanced"
        maximumImpressions:
          type:
          - integer
          - 'null'
          description: Maximum impressions for the specified period.
          format: int32
      description: "Ad set frequency capping.\n            \nSettings that can limit the number of impression by viewer and by period."
    CreateCampaign:
      required:
      - advertiserId
      - goal
      - name
      - spendLimit
      type: object
      properties:
        advertiserId:
          type:
          - string
          - 'null'
          description: Advertiser ID this campaign belongs to (string-encoded integer).
        budgetAutomation:
          $ref: '#/components/schemas/BudgetAutomation'
        goal:
          enum:
          - Unspecified
          - Acquisition
          - Retention
          type: string
          description: "Goal of the campaign\n            \nSerialized values are {Unspecified}, {Acquisition} and {Retention}.\n            \nAcquisition and retention are defined as follows:\n- Acquisition: campaign with the goal of acquiring new customers. The success of an acquisition campaign is measured by the number of new customers it brings.\n- Retention: campaign with the goal of retaining existing customers. The success of a retention campaign is measured by the number of existing customers it retains."
        name:
          type:
          - string
          - 'null'
          description: Name of the campaign
        spendLimit:
          $ref: '#/components/schemas/CreateCampaignSpendLimit'
      description: Campaign create model.
    CreateAdSetScheduleV26Q1:
      required:
      - startDate
      type: object
      properties:
        endDate:
          type:
          - string
          - 'null'
          format: date-time
        startDate:
          type: string
          format: date-time
      description: ad set schedule create model
    PatchCampaign:
      type: object
      properties:
        budgetAutomation:
          $ref: '#/components/schemas/PatchMarketingCampaignBudgetAutomation'
        scheduledSpendLimit:
          $ref: '#/components/schemas/PatchCampaignScheduledSpendLimit'
        spendLimit:
          $ref: '#/components/schemas/PatchCampaignSpendLimit'
      description: 'Campaign patch model.

        The campaign identifier is provided in the resource {id} field (string-encoded integer) and is required.'
    AdSetTargetingRuleV26Q1:
      type: object
      properties:
        operand:
          enum:
          - undefined
          - in
          - notIn
          type: string
        values:
          type:
          - array
          - 'null'
          items:
            type: string
      description: ad set targeting rule model
    CampaignSearchFiltersV23Q1:
      type: object
      properties:
        advertiserIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Advertiser IDs to filter on (string-encoded integers).
        campaignIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Campaign IDs to filter on (string-encoded integers).
      description: "Filters for searching campaigns.\n            \nMultiple filters are combined with an implicit AND operation.\nIdentifiers are string-encoded integers; invalid values are ignored.\nIf no filter is provided (both arrays are null or empty), the search returns all accessible campaigns."
    UpdateSellerBudgetMessage:
      type: object
      properties:
        amount:
          type: string
        budgetId:
          type: integer
          format: int64
        campaignIds:
          type: array
          items:
            type: integer
            format: int32
        endDate:
          type: string
        isSuspended:
          type: boolean
        startDate:
          type: string
          format: date-time
      description: Data used to update a seller's budget
    PatchAdSetScheduledBudgetDeletionV26Q1:
      required:
      - id
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Identifier of the scheduled budget to delete.
      description: Deletion of an existing scheduled budget of the ad set, identified by its "id".
    AdSetGeoLocationV26Q1:
      type:
      - object
      - 'null'
      properties:
        countries:
          $ref: '#/components/schemas/NillableAdSetTargetingRuleV26Q1'
        subdivisions:
          $ref: '#/components/schemas/NillableAdSetTargetingRuleV26Q1'
        zipCodes:
          $ref: '#/components/schemas/NillableAdSetTargetingRuleV26Q1'
      description: Ad set geolocation options.
    SellerBudgetMessage:
      type: object
      properties:
        amount:
          type:
          - number
          - 'null'
          description: Budget amount in the advertiser's currency
          format: double
        budgetType:
          type: string
          description: 'Type of budget: ''Daily'' (daily cap), ''Capped'' (lifetime with fixed amount), or ''Uncapped'' (lifetime with no limit)'
        campaignIds:
          type: array
          items:
            type: integer
            format: int32
          description: List of campaign IDs this budget applies to
        endDate:
          type: string
          description: 'End date of the budget period (format: YYYY-MM-DD), or empty string if open-ended'
        id:
          type: string
          description: Unique budget identifier
        isSuspended:
          type: boolean
          description: Whether the budget has been manually suspended by the partner
        sellerId:
          type: string
          description: Identifier of the seller this budget belongs to
        spend:
          type:
          - number
          - 'null'
          description: Amount spent against this budget so far, or null if not available
          format: double
        startDate:
          type: string
          description: 'Start date of the budget period (format: YYYY-MM-DD)'
          format: date
        status:
          $ref: '#/components/schemas/SellerBudgetStatusV2'
      description: A budget defines spending constraints for a seller across one or more campaigns. Each seller can have one active budget per time period.
      example:
        id: '16501666'
        sellerId: '10656107'
        campaignIds:
        - 436017
        budgetType: Capped
        amount: 462.47
        endDate: '2026-04-30'
        spend: 117.59
        status: Current
        isSuspended: false
    PatchAdSetSchedulingV26Q1:
      type: object
      properties:
        endDate:
          $ref: '#/components/schemas/NillableDateTime'
        startDate:
          $ref: '#/components/schemas/NillableDateTime'
      description: Model for patching ad set scheduling.
    SellerCampaignMessage:
      type: object
      properties:
        bid:
          type:
          - number
          - 'null'
          description: Cost-per-click bid in the advertiser's currency. Null means no CPC is defined (seller-campaign will be suspended with NoCpcDefined). Set to 0 to stop delivery.
          format: double
        campaignId:
          type: integer
          description: Identifier of the campaign this seller participates in
          format: int32
        id:
          type: string
          description: Composite identifier in format {sellerId}.{campaignId}
          readOnly: true
        productSet:
          $ref: '#/components/schemas/SellerCampaignProductSet'
        sellerId:
          type: string
          description: Unique identifier of the seller (merchant)
        suspendedSince:
          type:
          - string
          - 'null'
          description: Timestamp when the seller-campaign was suspended. Null means the seller-campaign is active.
          format: date-time
        suspensionReasons:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SellerCampaignSuspensionReason'
          description: List of reasons why the seller-campaign is suspended. Null means the seller-campaign is active.
      description: A seller-campaign links a seller to a campaign, defining the CPC bid. A seller can participate in multiple campaigns, and a campaign can have multiple sellers.
      example:
        id: '10656107.248287'
        sellerId: '10656107'
        campaignId: 248287
        bid: 0.15
        suspendedSince: '2021-03-03T15:14:25.7970000+00:00'
        suspensionReasons:
        - NoBudgetDefined
      x-readonly-id: true
    AdSetAudienceLinkEntityV1Response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AdSetAudienceLinkEntityV1Resource'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single entity
    AdSetDisplayMultiplier:
      type:
      - object
      - 'null'
      properties:
        categoryName:
          type:
          - string
          - 'null'
          description: The name of the Category to which the given for which the Display Multiplier has been applied.
        displayMultiplier:
          type:
          - number
          - 'null'
          description: The Display Multiplier applied to the given Category associated to an Ad Set.
          format: double
      description: Display Multiplier information about a Category for a given Ad Set.
    AdSetSearchFilterV26Q1:
      type: object
      properties:
        adSetIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Ad set ids to filter on. Ids are string-encoded integers.
        advertiserIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: 'Advertiser ids which ad sets belongs to (indirectly via their marketing campaign).

            Ids are string-encoded integers.'
        campaignIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Campaign ids to filter on. Ids are string-encoded integers.
      description: "Filter on ad set ids.\n            \nMultiple filters are combined with an implicit AND operation.\nIdentifiers are string-encoded integers; invalid values are ignored.\nIf no filter is provided (both arrays are null or empty), the search returns all accessible campaigns."
    CreateCampaignResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CreateCampaign'
        type:
          type: string
          description: Canonical type name of the entity
          example: Campaign
      description: Data model for a Resource
    SellerCampaignSuspensionReason:
      enum:
      - NoMoreBudget
      - ManuallyStopped
      - NoBudgetDefined
      - NoCpcDefined
      - RemovedFromCatalog
      - NotYetStarted
      - NoMoreDailyBudget
      - Other
      type: string
      description: 'Reason why a seller-campaign is suspended. Values: ManuallyStopped (manually paused by the partner), NoBudgetDefined (no valid budget linked), NoCpcDefined (no CPC bid set), NoMoreBudget (lifetime budget fully spent), NoMoreDailyBudget (daily budget limit reached), RemovedFromCatalog (all products removed from catalog), NotYetStarted (newly created, not yet processed), Other (internal issue preventing delivery).'
    ReadAdSetBudgetV26Q1:
      type:
      - object
      - 'null'
      properties:
        budgetAmount:
          type:
          - number
          - 'null'
          description: Maximum budget amount in the advertiser's currency per renewal period. Required non-null when capped. Must be null when uncapped.
          format: double
        budgetDeliverySmoothing:
          enum:
          - accelerated
          - standard
          type:
          - string
          - 'null'
          description: 'Pacing strategy for spending the budget within a renewal period. Only applicable when budgetStrategy is "capped".

            - "accelerated": spend pacing is based on delivery efficiency rather than the full budget period.

            - "standard": spread spending evenly over the renewal period.

            When budgetStrategy is "uncapped", this field is not set (null in read responses, omit in create/patch requests).'
        budgetDeliveryWeek:
          enum:
          - undefined
          - mondayToSunday
          - tuesdayToMonday
          - wednesdayToTuesday
          - thursdayToWednesday
          - fridayToThursday
          - saturdayToFriday
          - sundayToSaturday
          type:
          - string
          - 'null'
          description: 'Defines which day-of-week boundaries are used for weekly budget renewal. Only applicable when budgetStrategy is "capped", budgetRenewal is "weekly", and budgetDeliverySmoothing is "standard".

            - "mondayToSunday", "tuesdayToMonday", etc.: the day range over which the weekly budget is paced. Changing this value on the active budget also propagates to all scheduled budgets of the same ad set.

            - "undefined": used when budgetStrategy is "uncapped", when budgetRenewal is not "weekly", or when budgetDeliverySmoothing is "accelerated".'
        budgetRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          - weekly
          type:
          - string
          - 'null'
          description: 'The period over which the budget is spent.

            - "daily", "monthly", "weekly": budget resets at the start of each period.

            - "lifetime": budget covers the entire ad set duration without resetting.

            - "undefined": only used when budgetStrategy is "uncapped" (no renewal applies). Required for capped budgets (must not be "undefined").'
        budgetStrategy:
          enum:
          - capped
          - uncapped
          type:
          - string
          - 'null'
          description: 'Controls whether the ad set has a spending limit.

            - "capped": spending is limited to budgetAmount. Requires budgetAmount (non-null), budgetRenewal (not "undefined"), and budgetDeliverySmoothing (not null).

            - "uncapped": no spending limit. budgetAmount is null, budgetRenewal is "undefined", and budgetDeliverySmoothing is null.'
        pacingBehavior:
          enum:
          - undefined
          - targetFullBudget
          - targetAverageDailyBudget
          type:
          - string
          - 'null'
          description: 'Controls how a standard capped budget is paced.

            - "targetFullBudget": spend toward the full budget amount within the renewal period.

            - "targetAverageDailyBudget": spend toward an average daily amount. Only supported for capped, standard, monthly budgets.

            - "undefined": no explicit pacing behavior. Required for uncapped budgets and accelerated budgets.'
      description: 'Budget configuration for an ad set. Controls how much can be spent and how spending is paced.

        When budgetStrategy is "capped": budgetAmount, budgetRenewal, and budgetDeliverySmoothing are all set.

        When budgetStrategy is "uncapped": budgetAmount is null, budgetRenewal is "undefined", budgetDeliverySmoothing is null, budgetDeliveryWeek is "undefined", and pacingBehavior is "undefined".'
    SetBidsModelResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/SetBidsModel'
        id:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: Resource object containing keywords and their associated bid overrides
    CommonWarning:
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
          description: (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case.
        detail:
          type:
          - string
          - 'null'
          description: (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem.
        instance:
          type:
          - string
          - 'null'
          description: (REQUIRED) A URI reference that identifies the specific occurrence of the problem.
        source:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
          description: (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s)
        stackTrace:
          type:
          - string
          - 'null'
          description: (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology
        title:
          type:
          - string
          - 'null'
          description: (RECOMMENDED) A short, human-readable summary of the problem type.
        traceId:
          type:
          - string
          - 'null'
          description: (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.
        type:
          enum:
          - unknown
          - access-control
          - authentication
          - authorization
          - availability
          - deprecation
          - quota
          - validation
          type:
          - string
          - 'null'
          description: (REQUIRED) The classification of the error.
      additionalProperties: false
      description: A JSON:API Base common warning
    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
    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.
    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.
    ResourceOfCategory202204:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Category202204'
        id:
          type:
          - string
          - 'null'
          description: Unique identifier of this resource.
        type:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: A class that represents a domain entity exposed by an API.
    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
    Creative202210:
      required:
      - creativeFormatType
      - environments
      - formatId
      - name
      - retailerId
      - status
      - templateId
      - templateName
      - templateVariableValues
      type:
      - object
      - 'null'
      properties:
        associatedLineItemIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Associated Line Item Ids
        brandId:
          type:
          - integer
          - 'null'
          description: Brand Id
          format: int64
        creativeFormatType:
          enum:
          - Unknown
          - FlagShip
          - Showcase
          - SponsoredProducts
          - Butterfly
          - BundleBoost
          - IAB
          - CUSTOM
          - DisplayPanel
          - DigitalShelfTalker
          - CommerceVideoSpotlight
          - BrandingVideoStandout
          - CommerceDisplaySpotlight
          - BrandingDisplaySpotlightSolo
          - CommerceDisplayGridShelf
          - CommerceDisplayGridDuet
          - BrandingDisplayGridSolo
          - CommerceVideoGridDuet
          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
          - 'null'
        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
          - 'null'
          description: Updated at time
          format: date-time
      additionalProperties: false
      description: A creative entity
    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
    ResourceOfCreative2:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/Creative2'
        id:
          type:
          - string
          - 'null'
          description: Unique identifier of this resource.
        type:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: A class that represents a domain entity exposed by an API.
    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.
    LineItemBidMultipliersV2:
      type:
      - object
      - 'null'
      properties:
        category:
          type:
          - number
          - 'null'
          description: Categories Page Type Bid Multiplier
          format: double
        categoryMenu:
          type:
          - number
          - 'null'
          description: CategoryMenu Page Type Bid Multiplier
          format: double
        checkout:
          type:
          - number
          - 'null'
          description: Checkout Page Type Bid Multiplier
          format: double
        confirmation:
          type:
          - number
          - 'null'
          description: Confirmation Page Type Bid Multiplier
          format: double
        deals:
          type:
          - number
          - 'null'
          description: Deals Page Type Bid Multiplier
          format: double
        favorites:
          type:
          - number
          - 'null'
          description: Favorites Page Type Bid Multiplier
          format: double
        home:
          type:
          - number
          - 'null'
          description: Home Page Type Bid Multiplier
          format: double
        id:
          type:
          - string
          - 'null'
        merchandising:
          type:
          - number
          - 'null'
          description: Merchandising Page Type Bid Multiplier
          format: double
        productDetail:
          type:
          - number
          - 'null'
          description: ProductDetail Page Type Bid Multiplier
          format: double
        search:
          type:
          - number
          - 'null'
          description: Search Page Type Bid Multiplier
          format: double
        searchBar:
          type:
          - number
          - 'null'
          description: SearchBar Page Type Bid Multiplier
          format: double
      description: The Bid Multiplier Entity of a LineItem
    ValueTypeResourceOfStoreIdsUpdateModel202110:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/StoreIdsUpdateModel202110'
        type:
          type: string
      description: Data model for a value type resource
    VideoVariableValue:
      required:
      - duration
      - height
      - url
      - width
      type:
      - object
      - 'null'
      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
    ValueResourceOfRetailerSearchRequestV2:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/RetailerSearchRequestV2'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    EntityResourceCollectionOutcomeCategory202204:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityResourceCategory202204'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities.
    CampaignBudgetOverrides:
      required:
      - dailyBudgetOverrides
      - monthlyBudgetOverrides
      type:
      - object
      - 'null'
      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.
    BrandCatalogRequestV2:
      type: object
      properties:
        brandIdFilter:
          type:
          - array
          - 'null'
          items:
            type: string
            description: The brand ids to filter the catalog by.
            format: long-id
          description: The brand ids to filter the catalog by.
        includeFields:
          type:
          - array
          - 'null'
          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.
        modifiedAfter:
          type:
          - string
          - 'null'
          description: Only products modified after this time will be returned.
          format: date-time
        retailerIdFilter:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
          description: The retailer ids to filter the catalog by.
      additionalProperties: false
      description: A request for a catalog under the specified format.
    ReviewStateModel:
      enum:
      - InReview
      - Recommended
      - Approved
      - AutoApproved
      - Rejected
      - AutoRejected
      type: string
      description: The state of a keyword in the context of a line item.
    RetailMediaKeywordsReviewResult:
      required:
      - keywords
      type:
      - object
      - 'null'
      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
    AudienceIdsUpdateModel202110Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueTypeResourceOfAudienceIdsUpdateModel202110'
      description: Data model for a value type input resource
    AudienceTarget202110Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueTypeResourceOfAudienceTarget202110'
      description: Data model for a value type input resource
    CpcMinBidsResponse:
      required:
      - overallMinBid
      - skuMinBids
      type:
      - object
      - 'null'
      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.
    InputResourceOfPreferredLineItemCreateModelV2:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/PreferredLineItemCreateModelV2'
        type:
          type: string
      description: Data model for a Resource
    LineItemBudgetOverrides:
      required:
      - dailyLineItemBudgetOverrides
      - monthlyLineItemBudgetOverrides
      type:
      - object
      - 'null'
      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.
    ValueResourceRetailMediaKeywordsReview:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/RetailMediaKeywordsReview'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    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
    JsonApiSingleResponseOfCatalogStatus:
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonError'
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonWarning'
      additionalProperties: false
      description: A JSON:API wrapper class to add one JSON:API <typeparamref name="T" /> within a data property
    LineItemBidMultipliersV2Response:
      type:
      - object
      - 'null'
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfLineItemBidMultipliersV2'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single entity
    RmcaCommonProblem:
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
          description: A machine-readable  error code, expressed as a string value.
        detail:
          type:
          - string
          - 'null'
          description: A human-readable explanation specific to this occurrence of the problem
        instance:
          type:
          - string
          - 'null'
          description: A URI that identifies the specific occurrence of the problem.
        source:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
          description: A machine-readable structure to reference to the exact location(s) causing the error(s)
        stackTrace:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          description: The problem's HTTP Status code.
          format: int32
        title:
          type:
          - string
          - 'null'
          description: A short human-readable description of the problem type
        traceId:
          type:
          - string
          - 'null'
          description: The request correlation ID this problem comes from.
        type:
          enum:
          - unknown
          - access-control
          - authentication
          - authorization
          - availability
          - deprecation
          - quota
          - validation
          type:
          - string
          - 'null'
          description: The problem's category.
      additionalProperties: {}
      description: Common problem object.
    EntityResourceCollectionOutcomeOfRetailerResultV2AndMetadata:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityResourceOfRetailerResultV2'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          readOnly: true
        metadata:
          $ref: '#/components/schemas/Metadata'
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for several entities and metadata.
    Template:
      required:
      - allCollectionsMandatory
      - createdAt
      - creativeFormat
      - name
      - sections
      - skuCollectionMin
      - skuPerCollectionMin
      - updatedAt
      type:
      - object
      - 'null'
      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
          - CommerceVideoSpotlight
          - BrandingVideoStandout
          - CommerceDisplaySpotlight
          - BrandingDisplaySpotlightSolo
          - CommerceDisplayGridShelf
          - CommerceDisplayGridDuet
          - BrandingDisplayGridSolo
          - CommerceVideoGridDuet
          type: string
          description: The kind of creative this template can be used to build.
        displayableSkusMax:
          type:
          - integer
          - 'null'
          description: Maximum number of displayable skus
          format: int32
        id:
          type:
          - string
          - 'null'
        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
          - 'null'
          description: Maximum number of skus in the collection
          format: int32
        skuCollectionMin:
          type: integer
          description: Minimum number of skus in the collection
          format: int32
        skuPerCollectionMax:
          type:
          - integer
          - 'null'
          description: Maximum number of skus per collection
          format: int32
        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.
    ValueResourceRecommendedCategoriesRequestV1:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/RecommendedCategoriesRequestV1'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      description: A value resource exposed by the API.
    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

        Attributes properties'
    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

        Attributes properties'
    EntityResourceCategory202204:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Category202204'
        id:
          type:
          - string
          - 'null'
          description: Unique id of the entity.
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      description: A domain entity exposed by the API, identified by a unique id.
    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.
    Creative2ListResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ResourceOfCreative2'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for several entities.
    CampaignAttributesV202301:
      required:
      - name
      - isAutoDailyPacing
      type: object
      properties:
        budget:
          type:
          - number
          - 'null'
          format: double
        clickAttributionScope:
          enum:
          - unknown
          - sameSku
          - sameSkuCategory
          - sameSkuCategoryBrand
          type:
          - string
          - 'null'
        clickAttributionWindow:
          enum:
          - 7D
          - 14D
          - 30D
          - unknown
          type: string
          default: 30D
        companyName:
          type:
          - string
          - 'null'
        dailyPacing:
          type:
          - number
          - 'null'
          format: double
        drawableBalanceIds:
          type: array
          items:
            type: string
            format: long-id
        endDate:
          type:
          - string
          - 'null'
          format: date-time
        isAutoDailyPacing:
          type: boolean
        monthlyPacing:
          type:
          - number
          - 'null'
          format: double
        name:
          maxLength: 255
          minLength: 0
          type: string
        onBehalfCompanyName:
          type:
          - string
          - 'null'
        retailerId:
          type: integer
          format: int32
        startDate:
          type:
          - string
          - 'null'
          format: date-time
        type:
          enum:
          - unknown
          - auction
          - preferred
          type: string
          default: auction
        viewAttributionScope:
          enum:
          - unknown
          - sameSku
          - sameSkuCategory
          - sameSkuCategoryBrand
          type:
          - string
          - 'null'
        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
    ValueResourceOutcomeRecommendedKeywordsResponseV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceRecommendedKeywordsResponseV1'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single value object.
    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
    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
    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
    CategoriesSearchRequestV1:
      type: object
      properties:
        categoryIds:
          minItems: 1
          type:
          - array
          - 'null'
          items:
            type: string
          description: Categories search category ids criteria.
        textSubstring:
          type:
          - string
          - 'null'
          description: Categories search text substring criteria.
      description: An object that represents the request of CategoriesSearch endpoint.
    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
    PromotedProduct:
      type:
      - object
      - 'null'
      properties:
        bidOverride:
          type:
          - number
          - 'null'
          description: The bid override for the promoted product for this line item. Ignored unless adding a product.
          format: decimal
        id:
          type:
          - string
          - 'null'
          description: A retailer defined SKU ID for the promoted product.
        status:
          $ref: '#/components/schemas/LineItemProductStatus'
      additionalProperties: false
      description: A promoted product.
    ExternalCatalogStatus:
      required:
      - createdAt
      - currency
      - fileSizeBytes
      - md5Checksum
      - message
      - rowCount
      - status
      type:
      - object
      - 'null'
      properties:
        createdAt:
          type: string
          description: The time this catalog was created. Represented as a UTC ISO8601 string.
          format: date-time
        currency:
          type:
          - string
          - 'null'
          description: An ISO4217 representation of the currency products are listed under in this catalog.
        fileSizeBytes:
          type:
          - integer
          - 'null'
          description: The size of this catalog in bytes. Available when this catalog reaches a success status.
          format: int32
        md5Checksum:
          type:
          - string
          - 'null'
          description: 'An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval.

            Available when this catalog reaches a success status.'
        message:
          type:
          - string
          - 'null'
          description: An optional information message intended for developer consumption.
        rowCount:
          type:
          - integer
          - 'null'
          description: 'An indication of the number of products contained in this catalog. Available when

            this catalog reaches a success status.'
          format: int32
        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
    ValueResourceOfRecommendedKeywordsResult:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/RecommendedKeywordsResult'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    CreativeUpdateModel202207:
      required:
      - name
      - retailerId
      - templateId
      - templateVariableValues
      type: object
      properties:
        brandId:
          type: integer
          description: The brand associated to the creative
          format: int64
        id:
          type:
          - string
          - 'null'
        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
    TemplateResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfTemplate'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single entity.
    ValueTypeResourceOfAddToBasketIdsUpdateModel202110:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AddToBasketIdsUpdateModel202110'
        type:
          type: string
      description: Data model for a value type resource
    CampaignV202301:
      required:
      - accountId
      - createdAt
      - updatedAt
      - name
      - isAutoDailyPacing
      type: object
      properties:
        accountId:
          type: string
          format: long-id
        budget:
          type:
          - number
          - 'null'
          format: double
        budgetRemaining:
          type:
          - number
          - 'null'
          format: double
        budgetSpent:
          type:
          - number
          - 'null'
          format: double
        clickAttributionScope:
          enum:
          - unknown
          - sameSku
          - sameSkuCategory
          - sameSkuCategoryBrand
          type:
          - string
          - 'null'
        clickAttributionWindow:
          enum:
          - 7D
          - 14D
          - 30D
          - unknown
          type: string
          default: 30D
        companyName:
          type:
          - string
          - 'null'
        createdAt:
          type: string
          format: date-time
        dailyPacing:
          type:
          - number
          - 'null'
          format: double
        drawableBalanceIds:
          type: array
          items:
            type: string
            format: long-id
        endDate:
          type:
          - string
          - 'null'
          format: date-time
        isAutoDailyPacing:
          type: boolean
        monthlyPacing:
          type:
          - number
          - 'null'
          format: double
        name:
          maxLength: 255
          minLength: 0
          type: string
        onBehalfCompanyName:
          type:
          - string
          - 'null'
        promotedBrandIds:
          type: array
          items:
            type: string
            format: long-id
        retailerId:
          type:
          - integer
          - 'null'
          format: int32
        startDate:
          type:
          - string
          - 'null'
          format: date-time
        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
          - 'null'
        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
    ValueResourceOfBrandCatalogRequestV2:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/BrandCatalogRequestV2'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    PreferredLineItemUpdateModelV2Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfPreferredLineItemUpdateModelV2'
      description: A top-level object that encapsulates a Criteo API request for a single entity
    Category202204ListResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ResourceOfCategory202204'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for several entities.
    EditableCampaignAttributesV202301:
      required:
      - name
      - isAutoDailyPacing
      - clickAttributionWindow
      - viewAttributionWindow
      type: object
      properties:
        budget:
          type:
          - number
          - 'null'
          format: double
        clickAttributionScope:
          enum:
          - unknown
          - sameSku
          - sameSkuCategory
          - sameSkuCategoryBrand
          type:
          - string
          - 'null'
        clickAttributionWindow:
          enum:
          - 7D
          - 14D
          - 30D
          - unknown
          type: string
        companyName:
          type:
          - string
          - 'null'
        dailyPacing:
          type:
          - number
          - 'null'
          format: double
        endDate:
          type:
          - string
          - 'null'
          format: date-time
        isAutoDailyPacing:
          type: boolean
        monthlyPacing:
          type:
          - number
          - 'null'
          format: double
        name:
          maxLength: 255
          minLength: 0
          type: string
        onBehalfCompanyName:
          type:
          - string
          - 'null'
        startDate:
          type:
          - string
          - 'null'
          format: date-time
        viewAttributionScope:
          enum:
          - unknown
          - sameSku
          - sameSkuCategory
          - sameSkuCategoryBrand
          type:
          - string
          - 'null'
        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
    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
    ResourceOfLineItemBidMultipliersV2:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/LineItemBidMultipliersV2'
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
        type:
          type:
          - string
          - 'null'
          description: Canonical type name of the entity
      description: A class that represents a domain entity exposed by an API
    ChoiceVariableValue:
      required:
      - chosenOptions
      type:
      - object
      - 'null'
      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)
    BalanceCampaignsV1:
      required:
      - ids
      type:
      - object
      - 'null'
      properties:
        ids:
          type: array
          items:
            type: string
          description: The ids of the campaigns that are mapped to the balance.
      additionalProperties: false
      description: Balance campaigns mapping object.
    JsonApiPageResponseOfBrand:
      required:
      - data
      - metadata
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/JsonApiBodyWithIdOfInt64AndBrandAndBrand'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonError'
        metadata:
          $ref: '#/components/schemas/PageMetadata'
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonWarning'
      additionalProperties: false
      description: A wrapper class to return a single page of <typeparamref name="T" /> with metadata
    ValueResourceDeleteCampaignsRequestV1:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/DeleteCampaignsRequestV1'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    EntityResourceOfSponsoredProductsLineItem:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/SponsoredProductsLineItem'
        id:
          type:
          - string
          - 'null'
          description: Unique id of the entity.
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A domain entity exposed by the API, identified by a unique id.
    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
    CreativeCreateModel202207:
      required:
      - name
      - retailerId
      - templateId
      - templateVariableValues
      type: object
      properties:
        brandId:
          type:
          - integer
          - 'null'
          description: The brand associated to the creative
          format: int64
        id:
          type:
          - string
          - 'null'
        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
    ValueTypeResourceOfAudienceIdsUpdateModel202110:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceIdsUpdateModel202110'
        type:
          type: string
      description: Data model for a value type resource
    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
    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.
    CampaignAvailabilityV2:
      type: object
      properties:
        budgetModelAvailabilities:
          type:
          - array
          - 'null'
          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.
        buyType:
          enum:
          - unknown
          - auction
          - preferredDeals
          - sponsorship
          - offsite
          type:
          - string
          - 'null'
          description: The buy type this object represents availability for
        campaignType:
          enum:
          - unknown
          - sponsoredProducts
          - onsiteDisplay
          - offsite
          type:
          - string
          - 'null'
          description: The type of campaign this object represents availability for
        validCombinations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PageTypeCombinationV2'
          description: PageType-PageEnvironmentType pairs which are supported for this campaign-buy type combination
      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
    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.
    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
    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

        Attributes properties'
    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.
    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.
    EntityResourceCollectionOutcomeCategory202204Metadata:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityResourceCategory202204'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          readOnly: true
        metadata:
          $ref: '#/components/schemas/Metadata'
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities and metadata.
    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
    ResourceOfCreative202210:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/Creative202210'
        id:
          type:
          - string
          - 'null'
          description: Unique identifier of this resource.
        type:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: A class that represents a domain entity exposed by an 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

        Attributes properties'
    RetailerSearchRequestV2:
      type: object
      properties:
        retailerIdFilter:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Optional list of retailer IDs to filter the results
      additionalProperties: false
      description: Request model for searching retailers
    ExternalBrand:
      required:
      - name
      type:
      - object
      - 'null'
      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
    EntityResourceOutcomeOfSponsoredProductsLineItem:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EntityResourceOfSponsoredProductsLineItem'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single entity.
    SellerCatalogRequestV2:
      type: object
      properties:
        includeFields:
          type:
          - array
          - 'null'
          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.
        modifiedAfter:
          type:
          - string
          - 'null'
          description: Only products modified after this time will be returned.
          format: date-time
        sellers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SellerIdentifierV2'
          description: A list of sellers to restrict the catalog to.
      additionalProperties: false
      description: Used to request a catalog of seller SKUs
    ValueResourceCpcMinBidsResponse:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/CpcMinBidsResponse'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    ValueTypeResourceOfStoreTarget202110:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/StoreTarget202110'
        type:
          type: string
      description: Data model for a value type resource
    ValueResourceInputDeleteCampaignsRequestV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceDeleteCampaignsRequestV1'
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API request for a single value object.
    ProductResourceOutcome:
      type: object
      properties:
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RmcaCommonProblem'
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RmcaCommonProblem'
      additionalProperties: false
      description: Outcome object containing errors and warnings.
    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

        Attributes properties'
    ChoiceVariableSpecification:
      required:
      - options
      type:
      - object
      - 'null'
      properties:
        maxSelected:
          type:
          - integer
          - 'null'
          description: The maximum number of selectable options
          format: int32
        minSelected:
          type:
          - integer
          - 'null'
          description: The minimum number of selectable options
          format: int32
        options:
          type: array
          items:
            $ref: '#/components/schemas/ChoiceOption'
          description: The available options
      additionalProperties: false
      description: Specification of choice variable
    CommonLineItem:
      required:
      - name
      - type
      - startDate
      - targetRetailerId
      - campaignId
      type: object
      properties:
        budget:
          type:
          - number
          - 'null'
          format: double
        budgetRemaining:
          type:
          - number
          - 'null'
          format: double
        budgetSpent:
          type: number
          format: double
        campaignId:
          type: string
          format: long-id
        createdAt:
          type: string
          format: date-time
        endDate:
          type:
          - string
          - 'null'
          description: Represents the Date as a year, month, and day in the format YYYY-MM-DD
          format: date
        id:
          type:
          - string
          - 'null'
        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
    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.
    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.
    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
    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
    SponsoredProductsLineItemCreateRequestModel:
      required:
      - name
      - startDate
      - targetRetailerId
      type: object
      properties:
        bidStrategy:
          enum:
          - manual
          - automated
          type: string
          description: 'The bidding strategy for this line item.

            Default value is manual.'
          default: manual
        budget:
          type:
          - number
          - 'null'
          description: The total budget allocated for this line item.
          format: double
        dailyPacing:
          type:
          - number
          - 'null'
          description: The daily pacing limit for budget spending.
          format: double
        endDate:
          type:
          - string
          - 'null'
          description: The date and time when the line item stops running.
          format: date-time
        flightSchedule:
          $ref: '#/components/schemas/FlightSchedule'
        isAutoDailyPacing:
          type: boolean
          description: 'Indicates whether automatic daily pacing is enabled.

            Default value is false.'
          default: false
        keywordStrategy:
          enum:
          - conquesting
          - genericAndBranded
          - genericBrandedAndConquesting
          type:
          - string
          - 'null'
          description: The keyword targeting strategy for this line item.
        maxBid:
          type:
          - number
          - 'null'
          description: The maximum bid amount allowed for this line item.
          format: double
        monthlyPacing:
          type:
          - number
          - 'null'
          description: The monthly pacing limit for budget spending.
          format: double
        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.

            Default 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
          - 'null'
          description: The target bid amount for the line item.
          format: double
        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
    AddRemoveKeywordsModel:
      type: object
      properties:
        keywords:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AddRemoveKeywordModel'
      additionalProperties: false
      description: Data model containing keywords to be added or removed from a line item
    SdkApiRestCommonProblem:
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
          description: A machine-readable error code, expressed as a string value.
        detail:
          type:
          - string
          - 'null'
          description: A human-readable explanation specific to this occurrence of the problem.
        instance:
          type:
          - string
          - 'null'
          description: A URI that identifies the specific occurrence of the problem.
        source:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
          description: A machine-readable structure to reference to the exact location(s) causing the error(s).
        stackTrace:
          type:
          - string
          - 'null'
          description: ''
        title:
          type:
          - string
          - 'null'
          description: A short human-readable description of the problem type.
        traceId:
          type:
          - string
          - 'null'
          description: The request correlation ID this problem comes from.
        type:
          enum:
          - unknown
          - access-control
          - authentication
          - authorization
          - availability
          - deprecation
          - quota
          - validation
          type:
          - string
          - 'null'
          description: The problem's category.
      additionalProperties: false
      description: Common problem object.
    ResourceOutcome:
      type: object
      properties:
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RmcaCommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RmcaCommonProblem'
          readOnly: true
      additionalProperties: false
      description: Outcome object containing errors and warnings.
    DeleteCampaignsRequestV1:
      required:
      - ids
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
          description: The ids of the campaigns that are going to be deleted from balance campaigns mapping.
      additionalProperties: false
      description: Request object for deleting campaigns from balance campaigns mapping.
    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
    KeywordsModel:
      type:
      - object
      - 'null'
      properties:
        keywords:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/KeywordDataModel'
          description: A dictionary of normalized keywords mapped to their properties.
        rank:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The top suggested keywords for products in this line item ranked by popularity score.
      additionalProperties: false
      description: The keywords associated with a line item.
    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
    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.
    ValueTypeResourceOfAudienceTarget202110:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceTarget202110'
        type:
          type: string
      description: Data model for a value type resource
    KeywordsModelResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/KeywordsModelResource'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RmcaCommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RmcaCommonProblem'
          readOnly: true
      additionalProperties: false
      description: Response object containing keywords associated with a line item.
    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
    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
    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
          - 'null'
          items:
            type: string
          description: The collection of supplied negative broad phrases.
        negativeExact:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The collection of supplied negative exact phrases.
        positiveExact:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The collection of supplied positive exact phrases.
      additionalProperties: false
      description: The keywords to be added or removed from a line item.
    EntityResourceOfRetailerResultV2:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/RetailerResultV2'
        id:
          type:
          - string
          - 'null'
          description: Unique id of the entity.
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A domain entity exposed by the API, identified by a unique id.
    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
    LineItemPageCategoryV2:
      required:
      - categoryId
      type: object
      properties:
        categoryId:
          type: string
        includeChildren:
          type: boolean
          default: true
      description: Category information for a preferred line item page
    ResourceOfCreative202110:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Creative202110'
        id:
          type:
          - string
          - 'null'
          description: Unique identifier of this resource.
        type:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: A class that represents a domain entity exposed by an API.
    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.
    CatalogStatusV2:
      required:
      - createdAt
      - status
      type:
      - object
      - 'null'
      properties:
        createdAt:
          type: string
          description: The time this catalog was created. Represented as a UTC ISO8601 string.
          format: date-time
        fileSizeBytes:
          type:
          - integer
          - 'null'
          description: The size of this catalog in bytes. Available when this catalog reaches a success status.
          format: int32
        md5Checksum:
          type:
          - string
          - 'null'
          description: 'An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval.

            Available when this catalog reaches a success status.'
        message:
          type:
          - string
          - 'null'
          description: An optional information message intended for developer consumption.
        rowCount:
          type:
          - integer
          - 'null'
          description: 'An indication of the number of products contained in this catalog. Available when

            this catalog reaches a success status.'
          format: int32
        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
    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
          - 'null'
          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
        status:
          enum:
          - Expired
          - Active
          - Upcoming
          type:
          - string
          - 'null'
          description: Daily budget override computed status.
      additionalProperties: false
      description: Campaign daily budget override.
    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.
    LineItemCappingV2:
      required:
      - type
      - count
      type:
      - object
      - 'null'
      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
    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
    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
          - 'null'
          description: The total budget allocated for this line item.
          format: double
        dailyPacing:
          type:
          - number
          - 'null'
          description: The daily pacing amount for the line item.
          format: double
        endDate:
          type:
          - string
          - 'null'
          description: The date and time when the line item stops running.
          format: date-time
        flightSchedule:
          $ref: '#/components/schemas/FlightSchedule'
        isAutoDailyPacing:
          type: boolean
          description: True if daily pacing is automatic, false if manual.
        maxBid:
          type:
          - number
          - 'null'
          description: The maximum bid amount for the line item.
          format: double
        monthlyPacing:
          type:
          - number
          - 'null'
          description: The monthly pacing amount for the line item.
          format: double
        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
          - 'null'
          description: The target bid amount for the line item.
          format: double
      additionalProperties: false
      description: A request to update a Sponsored Products Line Item.
    RetailerResultV2:
      type:
      - object
      - 'null'
      properties:
        campaignAvailabilities:
          type:
          - array
          - 'null'
          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
        name:
          type:
          - string
          - 'null'
          description: Name of the retailer
      additionalProperties: false
      description: The result of a query for the configuration of a retailer
    Creative2:
      required:
      - creativeFormatV2Type
      - environments
      - formatId
      - name
      - retailerId
      - status
      - templateId
      - templateName
      - templateVariableValues
      type:
      - object
      - 'null'
      properties:
        associatedLineItemIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Associated Line Item Ids
        brandId:
          type:
          - integer
          - 'null'
          description: Brand Id
          format: int64
        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
          - 'null'
        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
          - 'null'
          description: Updated at time
          format: date-time
      additionalProperties: false
      description: A creative entity
    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
          - 'null'
          description: Daily budget override maximum daily spend amount.
          format: double
        startDate:
          type:
          - string
          - 'null'
          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
        status:
          enum:
          - Expired
          - Active
          - Upcoming
          type:
          - string
          - 'null'
          description: Daily budget override computed status.
      additionalProperties: false
      description: The details for a daily budget override
    ValueResourceOutcomeOfRecommendedKeywordsResult:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfRecommendedKeywordsResult'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single value object.
    ResourceOfPreferredLineItemV2:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/PreferredLineItemV2'
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
        type:
          type:
          - string
          - 'null'
          description: Canonical type name of the entity
      description: A class that represents a domain entity exposed by an API
    TextVariableValue:
      required:
      - text
      type:
      - object
      - 'null'
      properties:
        text:
          type:
          - string
          - 'null'
          description: The displayed text
      additionalProperties: false
      description: A value of a template text variable
    HyperlinkVariableValue:
      required:
      - url
      type:
      - object
      - 'null'
      properties:
        url:
          type:
          - string
          - 'null'
          description: The url to redirect to
      additionalProperties: false
      description: A value of a template hyperlink variable
    ValueResourceRetailMediaKeywordsReviewResult:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/RetailMediaKeywordsReviewResult'
        type:
          type:
          - string
          - 'null'
      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
    AssetResource:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/Asset'
        id:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
      description: A class that represents a domain entity exposed by an API
    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.
    ResourceOfCommonLineItem:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CommonLineItem'
        id:
          type:
          - string
          - 'null'
          description: Id of the entity
        type:
          type:
          - string
          - 'null'
          description: Canonical type name of the entity
      description: A class that represents a domain entity exposed by an API
    LineItemPageV2:
      required:
      - pageType
      type:
      - object
      - 'null'
      properties:
        categories:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/LineItemPageCategoryV2'
        pageType:
          enum:
          - unknown
          - search
          - home
          - browse
          - checkout
          - category
          - productDetail
          - confirmation
          - merchandising
          - deals
          - favorites
          - searchBar
          - categoryMenu
          type: string
          description: Page Type Enum
        searchKeywords:
          type:
          - array
          - 'null'
          items:
            type: string
      description: Page information for a preferred line item
    ValueResourceOfLineItemBudgetOverrides:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/LineItemBudgetOverrides'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    SponsoredProductsLineItem:
      required:
      - budgetRemaining
      - campaignId
      - createdAt
      - name
      - startDate
      - targetRetailerId
      - updatedAt
      type:
      - object
      - 'null'
      properties:
        bidStrategy:
          enum:
          - manual
          - automated
          - unknown
          type:
          - string
          - 'null'
          description: Bid strategy for the line item.
        budget:
          type:
          - number
          - 'null'
          description: The total budget allocated for this line item.
          format: double
        budgetRemaining:
          type:
          - number
          - 'null'
          description: The amount of the budget that remains available.
          format: double
        budgetSpent:
          type:
          - number
          - 'null'
          description: The amount of the budget that has been spent so far.
          format: double
        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
          - 'null'
          description: The daily pacing limit for budget spending.
          format: double
        endDate:
          type:
          - string
          - 'null'
          description: The date and time when the line item stops running.
          format: date-time
        flightSchedule:
          $ref: '#/components/schemas/FlightSchedule'
        isAutoDailyPacing:
          type:
          - boolean
          - 'null'
          description: Indicates whether automatic daily pacing is enabled.
        keywordStrategy:
          enum:
          - unknown
          - conquesting
          - genericAndBranded
          - genericBrandedAndConquesting
          type:
          - string
          - 'null'
          description: The keyword targeting strategy for this line item.
        maxBid:
          type:
          - number
          - 'null'
          description: The maximum bid amount allowed for this line item.
          format: double
        monthlyPacing:
          type:
          - number
          - 'null'
          description: The monthly pacing limit for budget spending.
          format: double
        name:
          maxLength: 255
          minLength: 0
          type: string
          description: The name of the line item.
        optimizationStrategy:
          enum:
          - conversion
          - clicks
          - revenue
          - unknown
          type:
          - string
          - 'null'
          description: The optimization strategy for this line item.
        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
          - 'null'
          description: The current status of the line item.
        targetBid:
          type:
          - number
          - 'null'
          description: The target bid amount for the line item.
          format: double
        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.
    CommonError:
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
          description: (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case.
        detail:
          type:
          - string
          - 'null'
          description: (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem.
        instance:
          type:
          - string
          - 'null'
          description: (REQUIRED) A URI reference that identifies the specific occurrence of the problem.
        source:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
          description: (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s)
        stackTrace:
          type:
          - string
          - 'null'
          description: (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology
        title:
          type:
          - string
          - 'null'
          description: (RECOMMENDED) A short, human-readable summary of the problem type.
        traceId:
          type:
          - string
          - 'null'
          description: (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.
        type:
          enum:
          - unknown
          - access-control
          - authentication
          - authorization
          - availability
          - deprecation
          - quota
          - validation
          type:
          - string
          - 'null'
          description: (REQUIRED) The classification of the error.
      additionalProperties: false
      description: A JSON:API Common error structure
    PromotedProductResourceCollectionOutcome:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PromotedProductResource'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RmcaCommonProblem'
          readOnly: true
        meta:
          $ref: '#/components/schemas/ProductMetadata'
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RmcaCommonProblem'
          readOnly: true
      additionalProperties: false
      description: Outcome object containing promoted products.
    LineItemBidMultipliersV2Request:
      type:
      - object
      - 'null'
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfLineItemBidMultipliersV2'
      description: A top-level object that encapsulates a Criteo API request for a single entity
    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
    RecommendedKeywordsResult:
      type:
      - object
      - 'null'
      properties:
        keywords:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/Keywords'
          description: Dictionary of keywords to their keyword models
        recommendedKeywords:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of recommended keywords
      additionalProperties: false
      description: Response model for recommended keywords
    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.
    ValueResourceRecommendedKeywordsResponseV1:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/RecommendedKeywordsResponseV1'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    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
    ValueTypeResourceOfAddToBasketTarget202110:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AddToBasketTarget202110'
        type:
          type: string
      description: Data model for a value type resource
    Keywords:
      type: object
      properties:
        bid:
          type:
          - number
          - 'null'
          description: The bid to use when a positive keyword matches the shopper search phrase
          format: double
        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
    ProductMetadata:
      type:
      - object
      - 'null'
      properties:
        count:
          type:
          - integer
          - 'null'
          description: Total number of items available.
          format: int32
        limit:
          type:
          - integer
          - 'null'
          description: Maximum number of items in the response.
          format: int32
        offset:
          type:
          - integer
          - 'null'
          description: Zero based offset of the first item in the response.
          format: int32
        responseCount:
          type:
          - integer
          - 'null'
          description: Number of items in the response.
          format: int32
      additionalProperties: false
      description: Metadata about the response. Used for pagination.
    EntityResourceCollectionOutcomeOfSponsoredProductsLineItemAndMetadata:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityResourceOfSponsoredProductsLineItem'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          readOnly: true
        metadata:
          $ref: '#/components/schemas/Metadata'
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for several entities and metadata.
    ValueResourceAppendCampaignsRequestV1:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AppendCampaignsRequestV1'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    InputKeywords:
      type: object
      properties:
        negativeBroad:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The collection of supplied negative broad phrased
        negativeExact:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The collection of supplied negative exact phrase
        positiveExact:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The collection of supplied positive exact phrases
      additionalProperties: false
      description: Keywords submitted by the user binned by type after some cleanup has been performed
    ValueResourceOutcomeBalanceCampaignsV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceBalanceCampaignsV1'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single value object.
    ValueResourceOutcomeOfLineItemBudgetOverrides:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfLineItemBudgetOverrides'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single value object.
    AddRemoveKeywordModel:
      type: object
      properties:
        isDeleted:
          type: boolean
        matchType:
          $ref: '#/components/schemas/MatchTypeModel'
        phrase:
          maxLength: 255
          minLength: 0
          type:
          - string
          - 'null'
      additionalProperties: false
      description: A single keyword to be added or removed
    FlightSchedule:
      type:
      - object
      - 'null'
      properties:
        legs:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FlightLeg'
          description: A list of flight legs on which the line item will run.
      additionalProperties: false
      description: A flight schedule for a line item.
    AssetResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AssetResource'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single entity
    PageTypeCombinationV2:
      type: object
      properties:
        pageEnvironmentType:
          enum:
          - unknown
          - web
          - mobile
          - app
          - lockout
          - mixed
          - ios
          - android
          type:
          - string
          - 'null'
          description: The page environment type supported for this campaign-buy type combination
        pageType:
          enum:
          - unknown
          - search
          - home
          - checkout
          - category
          - productDetail
          - confirmation
          - merchandising
          - deals
          - favorites
          - searchbar
          - categoryMenu
          - aiAssistant
          type:
          - string
          - 'null'
          description: The page type supported for this campaign-buy type combination
      additionalProperties: false
      description: Represents a combination of page type and page environment type for a specific campaign-buy type.
    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

        Attributes properties'
    ValueResourceOfSponsoredProductsLineItemUpdateRequestModel:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/SponsoredProductsLineItemUpdateRequestModel'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    AddToBasketIdsUpdateModel202110Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueTypeResourceOfAddToBasketIdsUpdateModel202110'
      description: Data model for a value type input resource
    ValueResourceOutcomeCpcMinBidsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceCpcMinBidsResponse'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single value object.
    Asset:
      required:
      - fileExtension
      type:
      - object
      - 'null'
      properties:
        fileExtension:
          type: string
          description: 'The file extension that is asset is representing. Example: jpg, png, gif or pdf.'
        fileLocation:
          type:
          - string
          - 'null'
          description: A url pointing towards the static file the asset represents.
      description: Handles pointing towards binary content that advertisers can use later on, for example in their creatives.
      x-criteo-canonical:
        infoType: entity
        name: RetailMediaAsset
        version: '202110'
    StoreTarget202110Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueTypeResourceOfStoreTarget202110'
      description: Data model for a value type input resource
    ValueResourceCategoriesSearchRequestV1:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CategoriesSearchRequestV1'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      description: A value resource exposed by the API.
    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
    ResourceOfTemplate:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/Template'
        id:
          type:
          - string
          - 'null'
          description: Unique identifier of this resource.
        type:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: A class that represents a domain entity exposed by an API.
    RecommendedKeywordsResponseV1:
      required:
      - recommendedKeywords
      type:
      - object
      - 'null'
      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
    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
    ValueResourceRecommendedKeywordsRequestV1:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/RecommendedKeywordsRequestV1'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    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.
    EntityResourceOutcomeOfCatalogStatusV2:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/EntityResourceOfCatalogStatusV2'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single entity.
    ExternalCatalogRequest:
      type: object
      properties:
        brandIdFilter:
          type:
          - array
          - 'null'
          items:
            type: string
            format: long-id
        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.
    AppendCampaignsRequestV1:
      required:
      - ids
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
          description: The ids of the campaigns that are going to be appended to balance campaigns mapping.
      additionalProperties: false
      description: Request object for appending campaigns to balance campaigns mapping.
    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
    ValueResourceInputAppendCampaignsRequestV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceAppendCampaignsRequestV1'
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API request for a single value object.
    AddRemoveKeywordsModelRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AddRemoveKeywordsModelResource'
      additionalProperties: false
      description: Request object to add or remove keywords from a line item
    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
    AddToBasketTarget202110Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueTypeResourceOfAddToBasketTarget202110'
      description: Data model for a value type input resource
    JsonApiSingleResponseOfLineItemBidMultipliersV2:
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JsonApiBodyWithLineItemBidMultipliersV2'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonError'
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonWarning'
      description: A JSON:API wrapper class to add one JSON:API <typeparamref name="T" /> within a data property
    PageMetadata:
      required:
      - currentPageIndex
      - currentPageSize
      type: object
      properties:
        currentPageIndex:
          type: integer
          format: int32
        currentPageSize:
          type: integer
          format: int32
        nextPage:
          type:
          - string
          - 'null'
        previousPage:
          type:
          - string
          - 'null'
        totalItemsAcrossAllPages:
          type:
          - integer
          - 'null'
          format: int64
        totalPages:
          type:
          - integer
          - 'null'
          format: int64
      additionalProperties: false
      description: Metadata related to the current request
    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.
    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
    Creative202110ListResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ResourceOfCreative202110'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for several entities.
    Creative202210Response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfCreative202210'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single entity.
    EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityResourceLineItemKeywordReviewReport'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          readOnly: true
        meta:
          $ref: '#/components/schemas/Metadata'
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for several entities and metadata.
    PreferredLineItemV2:
      required:
      - name
      - startDate
      - status
      - targetRetailerId
      - budget
      - campaignId
      type: object
      properties:
        budget:
          type: number
          format: double
        budgetRemaining:
          type:
          - number
          - 'null'
          format: double
        budgetSpent:
          type:
          - number
          - 'null'
          format: double
        campaignId:
          type: string
          format: long-id
        capping:
          $ref: '#/components/schemas/LineItemCappingV2'
        createdAt:
          type: string
          format: date-time
        creativeId:
          type:
          - string
          - 'null'
          description: creative Id
          format: long-id
        endDate:
          type:
          - string
          - 'null'
          description: Represents the Date as a year, month, and day in the format YYYY-MM-DD
          format: date
        id:
          type:
          - string
          - 'null'
        name:
          maxLength: 255
          minLength: 0
          type: string
        pacing:
          enum:
          - unknown
          - standard
          - accelerated
          type:
          - string
          - 'null'
        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
    PageTypeEnvironment202210:
      type: object
      properties:
        environments:
          type:
          - array
          - 'null'
          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
        pageType:
          enum:
          - Search
          - Home
          - Browse
          - Checkout
          - Category
          - ProductDetail
          - Confirmation
          - Merchandising
          - Deals
          type:
          - string
          - 'null'
          description: Creative PageType
      additionalProperties: false
      description: The PageType-Environment Tuples for creatives
    StoreIdsUpdateModel202110Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueTypeResourceOfStoreIdsUpdateModel202110'
      description: Data model for a value type input resource
    ValueResourceOfSponsoredProductsLineItemCreateRequestModel:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/SponsoredProductsLineItemCreateRequestModel'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    AddRemoveKeywordsModelResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AddRemoveKeywordsModel'
        id:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: Resource object containing keywords to be added or removed from a line item
    ValueResourceBalanceCampaignsV1:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/BalanceCampaignsV1'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    LineItemKeywordReviewReport:
      required:
      - accountId
      - accountName
      - campaignId
      - campaignName
      - countKeywords
      - lineItemId
      - lineItemName
      - retailerId
      - retailerName
      type:
      - object
      - 'null'
      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
    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
          - 'null'
          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
        status:
          enum:
          - Expired
          - Active
          - Upcoming
          type:
          - string
          - 'null'
          description: Monthly budget override computed status.
      additionalProperties: false
      description: The details for a monthly budget override
    SetBidModel:
      type: object
      properties:
        bid:
          type:
          - number
          - 'null'
          format: double
        phrase:
          maxLength: 255
          minLength: 0
          type:
          - string
          - 'null'
      additionalProperties: false
      description: A single keyword and associated bid override
    EntityResourceLineItemKeywordReviewReport:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/LineItemKeywordReviewReport'
        id:
          type:
          - string
          - 'null'
          description: Unique id of the entity.
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A domain entity exposed by the API, identified by a unique id.
    ValueResourceOfCampaignBudgetOverrides:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/CampaignBudgetOverrides'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    EntityResourceOfCatalogStatusV2:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/CatalogStatusV2'
        id:
          type:
          - string
          - 'null'
          description: Unique id of the entity.
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A domain entity exposed by the API, identified by a unique id.
    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
          - 'null'
          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
        status:
          enum:
          - Expired
          - Active
          - Upcoming
          type:
          - string
          - 'null'
          description: Monthly budget override computed status.
      additionalProperties: false
      description: Campaign monthly budget override.
    MatchTypeModel:
      enum:
      - PositiveExactMatch
      - NegativeExactMatch
      - NegativeBroadMatch
      type: string
      description: The match type of a keyword.
    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

        Attributes properties'
    ValueResourceOfSellerCatalogRequestV2:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/SellerCatalogRequestV2'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    TextVariableSpecification:
      type:
      - object
      - 'null'
      properties:
        maxChars:
          type:
          - integer
          - 'null'
          description: The maximum amount of characters accepted for the text
          format: int32
      additionalProperties: false
      description: Specification of a text variable
    KeywordsModelResource:
      type:
      - object
      - 'null'
      properties:
        attributes:
          $ref: '#/components/schemas/KeywordsModel'
        id:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: Resource object containing keywords associated with a line item.
    FilesVariableValue:
      required:
      - assetIds
      type:
      - object
      - 'null'
      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
    Metadata:
      required:
      - limit
      - offset
      type:
      - object
      - 'null'
      properties:
        count:
          type:
          - integer
          - 'null'
          format: int64
        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.
    ValueResourceOutcomeOfCampaignBudgetOverrides:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfCampaignBudgetOverrides'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single value object.
    PreferredLineItemCreateModelV2Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/InputResourceOfPreferredLineItemCreateModelV2'
      description: Data model for a create input resource
    PageTypeEnvironment2:
      type: object
      properties:
        environments:
          type:
          - array
          - 'null'
          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
        pageType:
          enum:
          - Unknown
          - Search
          - Home
          - Browse
          - Checkout
          - Category
          - ProductDetail
          - Confirmation
          - Merchandising
          - Deals
          - Favorites
          - SearchBar
          - CategoryMenu
          type:
          - string
          - 'null'
          description: Creative PageType
      additionalProperties: false
      description: The PageType-Environment Tuples for creatives
    Creative2Response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfCreative2'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single entity.
    ValueResourceCpcMinBidsRequest:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CpcMinBidsRequest'
        type:
          type:
          - string
          - 'null'
          description: Type of the resource.
      additionalProperties: false
      description: A value resource exposed by the API.
    FilesVariablesSpecification:
      required:
      - extensions
      type:
      - object
      - 'null'
      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
          - 'null'
          description: The maximum amount of bytes per file
          format: int32
        maxFile:
          type:
          - integer
          - 'null'
          description: The maximum amount of files required
          format: int32
        minFiles:
          type:
          - integer
          - 'null'
          description: The minimum amount of files requires
          format: int32
      additionalProperties: false
      description: Specification of a file variable
    ColorVariableValue:
      required:
      - color
      type:
      - object
      - 'null'
      properties:
        color:
          pattern: ^#(([0-9a-fA-F]{2}){3}|([0-9a-fA-F]){3})$
          type:
          - string
          - 'null'
          description: The displayed color (HEX format)
      additionalProperties: false
      description: A value of a template color variable
    LineItemProductStatus:
      enum:
      - unknown
      - active
      - paused
      type:
      - string
      - 'null'
      description: The status of a promoted product in the context of the line item.
    Section:
      required:
      - templateVariables
      type: object
      properties:
        description:
          type:
          - string
          - 'null'
        templateVariables:
          type: array
          items:
            $ref: '#/components/schemas/TemplateVariable'
        title:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: Section object that hold template variables
    KeywordDataModel:
      type: object
      properties:
        bid:
          type:
          - number
          - 'null'
          description: The bid to use when a positive keyword matches the shopper search phrase.
          format: double
        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.
    ValueResourceOutcomeRetailMediaKeywordsReviewResult:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceRetailMediaKeywordsReviewResult'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Errors that occured during this call.
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SdkApiRestCommonProblem'
          description: Warnings that occured during this call.
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for a single value object.
    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
    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

        Attributes properties'
    Category202204:
      required:
      - name
      - parentId
      - text
      type:
      - object
      - 'null'
      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
    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
    SetBidsModel:
      type: object
      properties:
        keywords:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SetBidModel'
      additionalProperties: false
      description: Data model containing keywords and their associated bid overrides
    SkuMinBid:
      required:
      - minBid
      - skuId
      type: object
      properties:
        minBid:
          type: number
          description: Minimum bid amount value.
          format: double
        skuId:
          type: string
          description: Sku id.
      additionalProperties: false
      description: An object represents the minimum bid amount value of a sku.
    Creative202110:
      required:
      - name
      - retailerId
      - status
      type:
      - object
      - 'null'
      properties:
        associatedLineItemIds:
          type:
          - array
          - 'null'
          items:
            type: string
        brandId:
          type:
          - integer
          - 'null'
          format: int64
        id:
          type:
          - string
          - 'null'
        name:
          type: string
        retailerId:
          type: integer
          format: int32
        status:
          enum:
          - Ready
          - In_Use
          - Archived
          - Deleted
          type: string
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
      description: Metadata and usage info of a preferred deals creative
    TemplateListResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ResourceOfTemplate'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CommonProblem'
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for several entities.
    PromotedProductResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/PromotedProduct'
        id:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: Resource object containing a promoted product.
  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-refined-from:
- criteo-marketing-solutions-api-openapi.yml
- criteo-retail-media-api-openapi.yml
x-samples-languages:
- java
- python
- php
- csharp
- javascript
- curl
- ruby