openapi: 3.0.1
info:
  title: Criteo API
  description: Criteo API - MarketingSolutions
  version: 2026-07
servers:
- url: https://api.criteo.com
paths:
  /2026-07/advertisers/me:
    get:
      tags:
      - Advertiser
      summary: /2026-07/advertisers/me
      description: Fetch the portfolio of Advertisers for this account
      operationId: ListAdvertisers
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPortfolioResponse'
              example:
                data:
                - type: advertiser
                  id: '13'
                  attributes:
                    advertiserName: ClientName1
                - type: advertiser
                  id: '1352'
                  attributes:
                    advertiserName: ClientName2
                - type: advertiser
                  id: '73550'
                  attributes:
                    advertiserName: ClientName3
                errors: []
                warnings: []
      security:
      - oauth: []
  /2026-07/log-level/advertisers/{advertiser-id}/report:
    post:
      tags:
      - Analytics
      summary: /2026-07/log-level/advertisers/{advertiser-id}/report
      description: This Statistics endpoint provides publisher data.
      operationId: GetTransparencyReport
      parameters:
      - name: advertiser-id
        in: path
        description: The advertiser ID to fetch the transparency data for. The advertiser must already exist. Must be greater than 0.
        required: true
        schema:
          type: string
          format: int32
      requestBody:
        description: The query message.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransparencyQueryMessage'
            example:
              shouldDisplayProductIds: false
              startDate: '2024-01-01T00:00:00.0000000+00:00'
              endDate: '2024-01-04T00:00:00.0000000+00:00'
          application/xml:
            schema:
              $ref: '#/components/schemas/TransparencyQueryMessage'
            example: "<TransparencyQueryMessage xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Messages\">\r\n  <EndDate>2024-01-04T00:00:00</EndDate>\r\n  <StartDate>2024-01-01T00:00:00</StartDate>\r\n  <ShouldDisplayProductIds>false</ShouldDisplayProductIds>\r\n</TransparencyQueryMessage>"
          text/xml:
            schema:
              $ref: '#/components/schemas/TransparencyQueryMessage'
            example: "<TransparencyQueryMessage xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Messages\">\r\n  <EndDate>2024-01-04T00:00:00</EndDate>\r\n  <StartDate>2024-01-01T00:00:00</StartDate>\r\n  <ShouldDisplayProductIds>false</ShouldDisplayProductIds>\r\n</TransparencyQueryMessage>"
          application/*+xml:
            schema:
              $ref: '#/components/schemas/TransparencyQueryMessage'
            example: "<TransparencyQueryMessage xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Messages\">\r\n  <EndDate>2024-01-04T00:00:00</EndDate>\r\n  <StartDate>2024-01-01T00:00:00</StartDate>\r\n  <ShouldDisplayProductIds>false</ShouldDisplayProductIds>\r\n</TransparencyQueryMessage>"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransparencyReportListResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TransparencyReportListResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/TransparencyReportListResponse'
      security:
      - oauth:
        - MarketingSolutions_Analytics_Read
  /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
  /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
  /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
  /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\r\nPatch 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
  /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\r\nPatch 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
  /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.\r\nThis returns the full configuration of ad sets matching those criteria.\r\nField projection can be used if only a subset of fields is required, instead of the full configuration.\r\n            \r\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
  /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
  /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
  /2026-07/marketing-solutions/ads/{ad-id}/product-boost:
    get:
      tags:
      - Reco
      summary: /2026-07/marketing-solutions/ads/{ad-id}/product-boost
      description: Fetch all boosting associations and configurations
      operationId: FetchBoostedAdAssociations
      parameters:
      - name: ad-id
        in: path
        description: ID of the ad
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceCollectionOutcomeOfBoostedAdProductSet'
      security:
      - oauth:
        - MarketingSolutions_Reco_Read
  /2026-07/marketing-solutions/ads/{ad-id}/product-boost/{product-set-id}:
    delete:
      tags:
      - Reco
      summary: /2026-07/marketing-solutions/ads/{ad-id}/product-boost/{product-set-id}
      description: Delete association and configuration.
      operationId: DeleteBoostedAdAssociation
      parameters:
      - name: ad-id
        in: path
        description: ID of the ad
        required: true
        schema:
          type: string
      - name: product-set-id
        in: path
        description: ID of the product set
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeOfBoostedAdProductSet'
      security:
      - oauth:
        - MarketingSolutions_Reco_Manage
    get:
      tags:
      - Reco
      summary: /2026-07/marketing-solutions/ads/{ad-id}/product-boost/{product-set-id}
      description: Fetch boosting association and configuration
      operationId: FetchBoostedAdAssociation
      parameters:
      - name: ad-id
        in: path
        description: ID of the ad
        required: true
        schema:
          type: string
      - name: product-set-id
        in: path
        description: ID of the product set
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeOfBoostedAdProductSet'
      security:
      - oauth:
        - MarketingSolutions_Reco_Read
    post:
      tags:
      - Reco
      summary: /2026-07/marketing-solutions/ads/{ad-id}/product-boost/{product-set-id}
      description: Create or update product boosting configuration
      operationId: CreateBoostedAdAssociation
      parameters:
      - name: ad-id
        in: path
        description: ID of the ad
        required: true
        schema:
          type: string
      - name: product-set-id
        in: path
        description: ID of the product set
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputOfBoostingConfigurationRequest'
        x-bodyName: boostedAdProductSetAssociationRequest
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeOfBoostedAdProductSet'
        '201':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeOfBoostedAdProductSet'
      security:
      - oauth:
        - MarketingSolutions_Reco_Manage
  /2026-07/marketing-solutions/ads/{ad-id}/product-filter:
    delete:
      tags:
      - Reco
      summary: /2026-07/marketing-solutions/ads/{ad-id}/product-filter
      description: Disable product filtering for a given ad
      operationId: DisableProductFiltering
      parameters:
      - name: ad-id
        in: path
        description: ID of the ad
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeOfProductFilterConfig'
      security:
      - oauth:
        - MarketingSolutions_Reco_Manage
    get:
      tags:
      - Reco
      summary: /2026-07/marketing-solutions/ads/{ad-id}/product-filter
      description: Fetch product filtering configuration for a given ad
      operationId: FetchProductFilteringConfig
      parameters:
      - name: ad-id
        in: path
        description: ID of the ad
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation. Returns the product filtering configuration if it exists, or empty data if it doesn't.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeOfProductFilterConfig'
      security:
      - oauth:
        - MarketingSolutions_Reco_Read
    post:
      tags:
      - Reco
      summary: /2026-07/marketing-solutions/ads/{ad-id}/product-filter
      description: Enable product filtering for a given ad
      operationId: EnableProductFiltering
      parameters:
      - name: ad-id
        in: path
        description: ID of the ad
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputOfCreateProductFilterRequest'
        x-bodyName: createProductFilterRequest
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceOutcomeOfProductFilterConfig'
      security:
      - oauth:
        - MarketingSolutions_Reco_Manage
  /2026-07/marketing-solutions/ads/{id}:
    delete:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/ads/{id}
      description: Delete an Ad
      operationId: DeleteAd
      parameters:
      - name: id
        in: path
        description: The ad identifier to delete.
        required: true
        schema:
          type: string
          format: int32
      responses:
        '204':
          description: The ad was deleted.
      security:
      - oauth:
        - MarketingSolutions_Creative_Manage
    get:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/ads/{id}
      description: Get an Ad with its id
      operationId: GetAd
      parameters:
      - name: id
        in: path
        description: The ad identifier to retrieve.
        required: true
        schema:
          type: string
          format: int32
      responses:
        '200':
          description: The found ad is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOutcomeOfAd'
      security:
      - oauth:
        - MarketingSolutions_Creative_Read
  /2026-07/marketing-solutions/advertisers/{advertiser-id}/ads:
    get:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/advertisers/{advertiser-id}/ads
      description: Get the list of self-services Ads for a given advertiser
      operationId: GetAdvertiserAds
      parameters:
      - name: advertiser-id
        in: path
        description: The advertiser identifier.
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: The number of ads to be returned. The default is 50.
        schema:
          type: integer
          format: int32
          nullable: true
      - name: offset
        in: query
        description: The (zero-based) offset into the collection of ads. The default is 0.
        schema:
          type: integer
          format: int32
          nullable: true
      responses:
        '200':
          description: The list of self-services Ads is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCollectionOutcomeOfAd'
      security:
      - oauth:
        - MarketingSolutions_Creative_Read
    post:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/advertisers/{advertiser-id}/ads
      description: Create an Ad
      operationId: CreateAdvertiserAd
      parameters:
      - name: advertiser-id
        in: path
        description: The advertiser identifier.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceInputOfAdWrite'
        required: true
        x-bodyName: request
      responses:
        '201':
          description: The created Ad is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOutcomeOfAd'
      security:
      - oauth:
        - MarketingSolutions_Creative_Manage
  /2026-07/marketing-solutions/advertisers/{advertiser-id}/coupons:
    get:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/advertisers/{advertiser-id}/coupons
      description: Get the list of self-services Coupons for a given advertiser
      operationId: GetAdvertiserCoupons
      parameters:
      - name: advertiser-id
        in: path
        description: The advertiser identifier.
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: The number of coupons to be returned. The default is 50.
        schema:
          type: integer
          format: int32
          nullable: true
      - name: offset
        in: query
        description: The (zero-based) offset into the collection of coupons. The default is 0.
        schema:
          type: integer
          format: int32
          nullable: true
      responses:
        '200':
          description: The list of self-services Coupons is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCollectionOutcomeOfCoupon'
      security:
      - oauth:
        - MarketingSolutions_Creative_Read
    post:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/advertisers/{advertiser-id}/coupons
      description: Create a Coupon
      operationId: CreateAdvertiserCoupon
      parameters:
      - name: advertiser-id
        in: path
        description: The advertiser identifier.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceInputOfCreateCoupon'
        required: true
        x-bodyName: request
      responses:
        '201':
          description: The created Coupon is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOutcomeOfCoupon'
      security:
      - oauth:
        - MarketingSolutions_Creative_Manage
  /2026-07/marketing-solutions/advertisers/{advertiser-id}/coupons-supported-sizes:
    get:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/advertisers/{advertiser-id}/coupons-supported-sizes
      description: Get the list of Coupon supported sizes
      operationId: GetAdvertiserCouponSupportedSizes
      parameters:
      - name: ad-set-id
        in: query
        description: The ad set id on which you want to check the Coupon supported sizes.
        schema:
          type: string
      - name: advertiser-id
        in: path
        description: The advertiser identifier.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The list of Coupon supported sizes is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOutcomeOfCouponSupportedSizes'
      security:
      - oauth:
        - MarketingSolutions_Creative_Read
  /2026-07/marketing-solutions/advertisers/{advertiser-id}/coupons/{id}:
    delete:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/advertisers/{advertiser-id}/coupons/{id}
      description: Delete a Coupon
      operationId: DeleteAdvertiserCoupon
      parameters:
      - name: advertiser-id
        in: path
        description: The advertiser identifier.
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The Coupon identifier to delete.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The Coupon was deleted.
      security:
      - oauth:
        - MarketingSolutions_Creative_Manage
    get:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/advertisers/{advertiser-id}/coupons/{id}
      description: Get a Coupon with its id
      operationId: GetAdvertiserCoupon
      parameters:
      - name: advertiser-id
        in: path
        description: The advertiser identifier.
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The Coupon identifier to retrieve.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The found Coupon is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOutcomeOfCoupon'
      security:
      - oauth:
        - MarketingSolutions_Creative_Read
    put:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/advertisers/{advertiser-id}/coupons/{id}
      description: Edit a specific Coupon
      operationId: EditAdvertiserCoupon
      parameters:
      - name: advertiser-id
        in: path
        description: The advertiser identifier.
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The Coupon identifier to edit.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceInputOfUpdateCoupon'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: The edited Coupon is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOutcomeOfCoupon'
      security:
      - oauth:
        - MarketingSolutions_Creative_Manage
  /2026-07/marketing-solutions/advertisers/{advertiser-id}/coupons/{id}/preview:
    get:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/advertisers/{advertiser-id}/coupons/{id}/preview
      description: Get the preview of a specific Coupon
      operationId: GetAdvertiserCouponPreview
      parameters:
      - name: advertiser-id
        in: path
        description: The advertiser identifier.
        required: true
        schema:
          type: string
      - name: height
        in: query
        description: The height of the coupon to preview.
        schema:
          type: integer
          format: int32
      - name: id
        in: path
        description: The Coupon identifier to preview.
        required: true
        schema:
          type: string
      - name: width
        in: query
        description: The width of the coupon to preview.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The preview HTML of a specific Coupon is returned.
          content:
            text/html:
              schema:
                type: string
            application/json:
              schema:
                type: string
      security:
      - oauth:
        - MarketingSolutions_Creative_Read
  /2026-07/marketing-solutions/advertisers/{advertiser-id}/creatives:
    get:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/advertisers/{advertiser-id}/creatives
      description: Get the list of self-services Creatives for a given advertiser
      operationId: GetAdvertiserCreatives
      parameters:
      - name: advertiser-id
        in: path
        description: The advertiser identifier.
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: The number of creatives to be returned. The default is 50.
        schema:
          type: integer
          format: int32
          nullable: true
      - name: offset
        in: query
        description: The (zero-based) offset into the collection of creatives. The default is 0.
        schema:
          type: integer
          format: int32
          nullable: true
      responses:
        '200':
          description: The list of self-services Creatives is returned.This list will contain creatives in draft status as well which will have some properties as null
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCollectionOutcomeOfCreativeRead'
      security:
      - oauth:
        - MarketingSolutions_Creative_Read
    post:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/advertisers/{advertiser-id}/creatives
      description: Create a Creative
      operationId: CreateAdvertiserCreative
      parameters:
      - name: advertiser-id
        in: path
        description: The advertiser identifier.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceInputOfCreativeWrite'
        required: true
        x-bodyName: request
      responses:
        '201':
          description: The created creative is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOutcomeOfCreative'
      security:
      - oauth:
        - MarketingSolutions_Creative_Manage
  /2026-07/marketing-solutions/audience-segments:
    patch:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audience-segments
      description: Updates the properties of all segments with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.
      operationId: UpdateAudienceSegments
      requestBody:
        description: Segment Update request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceSegmentBulkUpdateInputV1'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Success or partial success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceSegmentEntityV1ListResponse'
      security:
      - oauth:
        - MarketingSolutions_Audience_Manage
  /2026-07/marketing-solutions/audience-segments/{audience-segment-id}/contact-list:
    delete:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audience-segments/{audience-segment-id}/contact-list
      description: Delete all identifiers from a contact list audience-segment.
      operationId: DeleteContactListByAudienceSegment
      responses:
        '200':
          description: The Contact List was emptied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteAudienceContactListResponse'
              example:
                data:
                  id: '1'
                  type: AudienceContactlist
                errors: []
                warnings:
                - traceId: 56ed4096-f96a-4944-8881-05468efe0ec9
                  type: deprecation
                  code: deprecated-field
                  instance: /audiences/314195
                  title: '''nbValidIds'' is deprecated'
                  detail: The field 'nbValidIds' is deprecated please use 'nbValidIdentifiers
      security:
      - oauth:
        - MarketingSolutions_Audience_Manage
    patch:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audience-segments/{audience-segment-id}/contact-list
      description: Add/remove identifiers to or from a contact list audience-segment.
      operationId: UpdateContactListByAudienceSegment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactlistAmendmentRequest'
        required: true
        x-bodyName: body
      responses:
        '200':
          description: Summary of created request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifyAudienceResponse'
              example:
                data:
                  type: ContactlistAmendment
                  attributes:
                    contactListId: 12
                    operation: add
                    requestDate: '2018-12-10T10:00:50.0000000+00:00'
                    identifierType: madid
                    nbValidIdentifiers: 7343
                    nbInvalidIdentifiers: 13
                    sampleInvalidIdentifiers:
                    - InvalidIdentifier
                errors: []
                warnings:
                - traceId: 56ed4096-f96a-4944-8881-05468efe0ec9
                  type: deprecation
                  code: deprecated-field
                  instance: /audiences/314195
                  title: '''nbValidIds'' is deprecated'
                  detail: The field 'nbValidIds' is deprecated please use 'nbValidIdentifiers
      security:
      - oauth:
        - MarketingSolutions_Audience_Manage
    parameters:
    - name: audience-segment-id
      in: path
      description: The id of the contact list audience-segment to amend
      required: true
      schema:
        type: string
        format: int32
  /2026-07/marketing-solutions/audience-segments/{audience-segment-id}/contact-list/statistics:
    get:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audience-segments/{audience-segment-id}/contact-list/statistics
      description: Returns the statistics of a contact list segment.
      operationId: GetAudienceSegmentContactListStatistics
      parameters:
      - name: audience-segment-id
        in: path
        description: The segment ID.
        required: true
        schema:
          type: string
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactListStatisticsEntityV1Response'
      security:
      - oauth:
        - MarketingSolutions_Audience_Read
  /2026-07/marketing-solutions/audience-segments/compute-sizes:
    post:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audience-segments/compute-sizes
      description: Gets the size of all segments. An error is returned for those whose size calculation is not supported.
      operationId: ComputeAudienceSegmentsSizes
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceSegmentComputeSizesInputV1'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Success or partial success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceSegmentSizeEntityV1ListResponse'
      security:
      - oauth:
        - MarketingSolutions_Audience_Manage
  /2026-07/marketing-solutions/audience-segments/create:
    post:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audience-segments/create
      description: Creates all segments with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.
      operationId: CreateAudienceSegments
      requestBody:
        description: Segment creation parameter
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceSegmentBulkCreateInputV1'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Success or partial success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceSegmentEntityV1ListResponse'
      security:
      - oauth:
        - MarketingSolutions_Audience_Manage
  /2026-07/marketing-solutions/audience-segments/delete:
    post:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audience-segments/delete
      description: Delete the segments associated to the given audience IDs.
      operationId: DeleteAudienceSegments
      requestBody:
        description: Segment delete request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceSegmentBulkDeleteInputV1'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Success or partial success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceSegmentIdEntityV1ListResponse'
      security:
      - oauth:
        - MarketingSolutions_Audience_Manage
  /2026-07/marketing-solutions/audience-segments/estimate-size:
    post:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audience-segments/estimate-size
      description: Gets the size estimation of a non existent segment. An error is returned when size calculation is not supported.
      operationId: EstimateAudienceSegmentsSizes
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceSegmentEstimateSizeInputV1'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceSegmentSizeEstimationV1Response'
      security:
      - oauth:
        - MarketingSolutions_Audience_Manage
  /2026-07/marketing-solutions/audience-segments/in-market-brands:
    get:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audience-segments/in-market-brands
      description: Returns a list with all available in-market brands that can be used to define an in-market segment.
      operationId: GetAudienceSegmentsInMarketBrands
      parameters:
      - name: advertiser-id
        in: query
        description: The advertiser ID.
        required: true
        schema:
          type: string
      - name: country
        in: query
        description: The ISO 3166-1 alpha-2 country code.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InMarketAudienceSegmentBrandEntityV1ListResponse'
      security:
      - oauth:
        - MarketingSolutions_Audience_Read
  /2026-07/marketing-solutions/audience-segments/in-market-interests:
    get:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audience-segments/in-market-interests
      description: Returns a list with all available in-market interests that can be used to define an in-market segment. These in-market interests correspond to the Google product taxonomy.
      operationId: GetAudienceSegmentsInMarketInterests
      parameters:
      - name: advertiser-id
        in: query
        description: The advertiser ID.
        required: true
        schema:
          type: string
      - name: country
        in: query
        description: The ISO 3166-1 alpha-2 country code.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InMarketAudienceSegmentInterestEntityV1ListResponse'
      security:
      - oauth:
        - MarketingSolutions_Audience_Read
  /2026-07/marketing-solutions/audience-segments/search:
    post:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audience-segments/search
      description: Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.
      operationId: SearchAudienceSegments
      parameters:
      - name: limit
        in: query
        description: The number of elements to be returned. The default is 50 and the maximum is 100.
        schema:
          maximum: 100
          minimum: 0
          type: integer
          format: int32
          default: 50
      - name: offset
        in: query
        description: The (zero-based) offset into the collection. The default is 0.
        schema:
          type: integer
          format: int32
          default: 0
      requestBody:
        description: Segment search filters.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceSegmentSearchInputV1'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse'
      security:
      - oauth:
        - MarketingSolutions_Audience_Read
  /2026-07/marketing-solutions/audiences:
    patch:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audiences
      description: Updates the properties of all audiences with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.
      operationId: UpdateAudiences
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceBulkUpdateInputV1'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Success or partial success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceEntityV1ListResponse'
      security:
      - oauth:
        - MarketingSolutions_Audience_Manage
  /2026-07/marketing-solutions/audiences/compute-sizes:
    post:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audiences/compute-sizes
      description: Gets the size of all audiences. An error is returned for those whose size calculation is not supported.
      operationId: ComputeAudiencesSizes
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceComputeSizesInputV1'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Success or partial success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceSizeEntityV1ListResponse'
      security:
      - oauth:
        - MarketingSolutions_Audience_Manage
  /2026-07/marketing-solutions/audiences/create:
    post:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audiences/create
      description: Creates all audiences with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.
      operationId: CreateAudiences
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceBulkCreateInputV1'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Success or partial success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceEntityV1ListResponse'
      security:
      - oauth:
        - MarketingSolutions_Audience_Manage
  /2026-07/marketing-solutions/audiences/delete:
    post:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audiences/delete
      description: Deletes the audiences associated to the given audience IDs.
      operationId: DeleteAudiences
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceBulkDeleteInputV1'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceIdEntityV1ListResponse'
        '204':
          description: Success or partial success
          content:
            application/json: {}
      security:
      - oauth:
        - MarketingSolutions_Audience_Manage
  /2026-07/marketing-solutions/audiences/estimate-size:
    post:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audiences/estimate-size
      description: Gets the size estimation of a non existent audience. An error is returned when size calculation is not supported.
      operationId: EstimateAudiencesSizes
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceEstimateSizeInputV1'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Success or partial success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceSizeEstimationV1Response'
      security:
      - oauth:
        - MarketingSolutions_Audience_Manage
  /2026-07/marketing-solutions/audiences/search:
    post:
      tags:
      - Audience
      summary: /2026-07/marketing-solutions/audiences/search
      description: Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied.
      operationId: SearchAudiences
      parameters:
      - name: limit
        in: query
        description: The number of elements to be returned. The default is 50 and the maximum is 100.
        schema:
          maximum: 100
          minimum: 0
          type: integer
          format: int32
          default: 50
      - name: offset
        in: query
        description: The (zero-based) offset into the collection. The default is 0.
        schema:
          type: integer
          format: int32
          default: 0
      requestBody:
        description: Audience search filters.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceSearchInputV1'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceEntityV1AudienceSearchMetadataV1ListResponse'
      security:
      - oauth:
        - MarketingSolutions_Audience_Read
  /2026-07/marketing-solutions/campaigns:
    patch:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/campaigns
      description: "Patch a list of Campaigns.\r\n            \r\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\r\n            \r\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
  /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.\r\n            \r\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
  /2026-07/marketing-solutions/campaigns/search:
    post:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/campaigns/search
      description: "Search endpoint for campaigns\r\n            \r\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
  /2026-07/marketing-solutions/creatives/{id}:
    delete:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/creatives/{id}
      description: Delete a Creative if there are no ads binded to it
      operationId: DeleteCreative
      parameters:
      - name: id
        in: path
        description: The creative identifier to delete.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The creative was deleted.
      security:
      - oauth:
        - MarketingSolutions_Creative_Manage
    get:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/creatives/{id}
      description: Get a Creative with its id
      operationId: GetCreative
      parameters:
      - name: id
        in: path
        description: The creative identifier to retrieve.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The found creative is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOutcomeOfCreative'
      security:
      - oauth:
        - MarketingSolutions_Creative_Read
    put:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/creatives/{id}
      description: Edit a specific Creative
      operationId: EditCreative
      parameters:
      - name: id
        in: path
        description: The creative identifier to edit.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResourceInputOfCreativeWrite'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: The edited creative is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOutcomeOfCreative'
      security:
      - oauth:
        - MarketingSolutions_Creative_Manage
  /2026-07/marketing-solutions/creatives/{id}/preview:
    post:
      tags:
      - Creative
      summary: /2026-07/marketing-solutions/creatives/{id}/preview
      description: Get the preview of a specific Creative
      operationId: GenerateCreativePreview
      parameters:
      - name: height
        in: query
        description: The height of the Creative to preview.
        schema:
          type: integer
          format: int32
      - name: id
        in: path
        description: The Creative identifier to preview.
        required: true
        schema:
          type: string
      - name: width
        in: query
        description: The width of the Creative to preview.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The preview HTML of a specific Creative is returned.
          content:
            text/html:
              schema:
                type: string
            application/json:
              schema:
                type: string
      security:
      - oauth:
        - MarketingSolutions_Creative_Manage
  /2026-07/marketing-solutions/dataset/{dataset-id}/product-boost:
    get:
      tags:
      - Reco
      summary: /2026-07/marketing-solutions/dataset/{dataset-id}/product-boost
      description: Fetch boosting association and configuration for a given partner
      operationId: FetchBoostedAdAssociationByPartnerId
      parameters:
      - name: client-type
        in: query
        description: Client type filter
        schema:
          enum:
          - Unknown
          - CGrowth
          - CMax
          type: string
          nullable: true
      - name: dataset-id
        in: path
        description: ID of the dataset
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceCollectionOutcomeOfBoostedAdProductSet'
      security:
      - oauth:
        - MarketingSolutions_Reco_Read
  /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
  /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
  /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\r\n• <b>advertiserId</b>: Valid crp advertiserId, seller belongs to provided advertiser<br />\r\n• <b>sellerId</b>: Products from given SellerId will fill the ad preview, must be existing crp sellerId<br />\r\n• <b>height</b>: height may be supplied to request a specific ad preview height. Default height: 250<br />\r\n• <b>width</b>: width may be supplied to request a specific ad preview width. Default width: 300<br />\r\n            \r\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
  /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
  /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.\r\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
  /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
  /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
  /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
  /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
  /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.\r\n            \r\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.\r\n            \r\n<b>Date filter.</b> To find budgets that were active on a specific date, set both `startBeforeDate` and `endAfterDate` to that day.\r\n            \r\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.\r\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.\r\nAll three types of budgets can be modified.\r\n            \r\nThe following constraints apply when modifying an existing budget.\r\n            \r\n• <b>campaignIds</b>: a non-empty subset of the original campaign ids MAY be supplied<br />\r\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 />\r\n• <b>startDate</b>: a future start date MAY be supplied for budgets that have not yet started<br />\r\n• <b>endDate</b>: an end date MAY be supplied and if supplied MUST be a future date greater than the start date<br />\r\n            \r\nOther attributes MUST NOT be supplied.\r\n            \r\nAdding new campaigns to a budget is not allowed. In addition, reducing the amount for\r\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.\r\nAll three types of budgets can be created this way.\r\n            \r\nThe following constraints apply when creating a new budget.\r\n            \r\n• <b>sellerId</b>: the seller MUST be supplied<br />\r\n• <b>campaignIds</b>: a non-empty array of campaign ids MUST be supplied<br />\r\n• <b>budgetType</b>: a budget type MUST be supplied<br />\r\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 />\r\n• <b>startDate</b>: a future start date MUST be supplied<br />\r\n• <b>endDate</b>: an end date MAY be supplied and if supplied MUST be greater than the start date<br />\r\n            \r\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
  /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,\r\n            \r\n    {\r\n        \"id\": \"1759183\",\r\n        \"sellerId\": \"321392\",\r\n        \"campaignIds\": [\r\n            143962\r\n        ],\r\n        \"budgetType\": \"Capped\",\r\n        \"amount\": 1000,\r\n        \"startDate\": \"2021-01-11\",\r\n        \"endDate\": \"2021-01-12\",\r\n        \"spend\": null,\r\n        \"status\": \"Active\"\r\n    }\r\n            \r\nA budget limits the spend of a seller for one or more campaigns.\r\n            \r\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 />\r\n            \r\nIn addition, budgets can limit the spend to a specific range of dates using\r\nthe start and end date attributes. Finally a budget must be active to be used.\r\n            \r\n<b>Spend</b> approximates the current spend against this budget. There may be a lag\r\nbetween when an ad is clicked and the time it accrues to the spend. Daily budgets\r\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.\r\nAll three types of budgets can be modified.\r\n            \r\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
  /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.\r\nIf all parameters are omitted the entire collection to which the user has\r\naccess is returned. Returned sellers must satisfy all supplied filter\r\ncriteria 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.\r\nEach bid must be a non-negative value. Setting the bid to zero will make a seller campaign inactive.\r\n            \r\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
  /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,\r\n            \r\n    {\r\n        \"id\": \"543210.123456\",\r\n        \"sellerId\": \"543210\",\r\n        \"campaignId\": 123456,\r\n        \"bid\": 1.55,\r\n        \"suspendedSince\": \"2018-07-30T15:15:24.813\",\r\n        \"suspensionReasons\": [\r\n            \"NoMoreBudget\"\r\n        ]\r\n    }\r\n            \r\nAn active seller campaign is one for which the value of <b>suspendedSince</b> is null and\r\nthe <b>bid</b> is positive. The currency of the bid is the <b>bidCurrency</b> of the\r\nassociated campaign.\r\n            \r\nAny active seller campaign must also have an active total (capped or uncapped) budget.\r\nIt may optionally have an active daily budget as well to further limit spending.\r\n            \r\nSuspension reasons:\r\n- ManuallyStopped: The Seller-Campaign has been manually paused. This is not related to the other suspension reasons.\r\n- NoBudgetDefined: No valid budget has been linked to the Seller-Campaign.\r\n- NoCpcDefined: No CPC has been set for the Seller-Campaign.\r\n- NoMoreBudget: The current budget of the Seller-Campaign has been exhausted.\r\n- RemovedFromCatalog: All the products of the Seller-Campaign have been deleted from the catalog.\r\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.\r\nSetting the bid to zero will make a seller campaign inactive.\r\n            \r\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
  /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.\r\nIf all parameters are omitted the entire collection to which the user has\r\naccess is returned, except those whose endDate is in the past. Returned budgets must satisfy all supplied filter\r\ncriteria if multiple parameters are used.\r\n            \r\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.\r\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
  /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.\r\nIf all parameters are omitted the entire collection to which the user has\r\naccess is returned. Returned sellers must satisfy all supplied filter\r\ncriteria 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
  /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,\r\n            \r\n    {\r\n        \"id\" : \"123456\"\r\n        \"sellerName\": \"HBogart\",\r\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
  /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.\r\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
  /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.\r\nIf all parameters are omitted the entire collection to which the user has\r\naccess is returned. Returned sellers must satisfy all supplied filter\r\ncriteria 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
  /2026-07/marketing-solutions/marketplace-performance-outcomes/stats/campaigns:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/stats/campaigns
      description: "## Dimensions\r\n            \r\nGet performance statistics aggregated for _campaigns_. The campaign id appears\r\nin the output as the first column.\r\n            \r\nAggregation can be done by `hour`, `day`, `month`, or `year` aligned with the user timezone\r\nif provided. The aggregation interval size is controlled by `intervalSize`. The time\r\ninterval appears in the output as the second column.\r\n            \r\n## Metrics\r\n            \r\nThe metrics reported by this endpoint are\r\n            \r\n.  | Metric Group | Description\r\n---|--------------|------------\r\nA | impressions | Number of times product is shown in a banner\r\nB | clicks | Number of clicks on product\r\nC | cost | Amount spent for clicks on products\r\nD | saleUnits | Number of products sold attributed to clicks\r\nE | revenue | Revenue generated by sales\r\nF | CR = Conversion Rate | salesUnits / clicks\r\nG | CPO = Cost Per Order | cost / salesUnits\r\nH | COS = Cost of Sale | cost / revenue\r\nI | ROAS = Return On Add Spend | revenue / cost\r\n            \r\nThe last six metrics can be computed in two ways depending on the policy to count only\r\nthe sales that result from clicks on the same sellers product in a banner\r\n(same-seller) or not (any-seller).  Reporting can be controlled by `clickAttributionPolicy`.\r\n            \r\nThe 9 (or 15) metric values appear in the output as the final 9 (or 15) columns.\r\n            \r\n## Filtering\r\n            \r\nThe results can be filtered by campaign, date or count.\r\n            \r\nFiltering the results to events associated with a specific campaign is done by setting\r\nthe `campaignId` filter parameter to the desired value.\r\n            \r\nFiltering the results to events\r\nthat happened in a time interval is done by setting the `startDate` and\r\n`endDate` filter parameters using the `yyyy-MM-DD` format. The start date\r\nincludes all events timestamped since the beginning of that day while the end\r\ndate includes events until the end of day. The maximum duration of the date\r\nrange is 1 year. If the aggregation interval is `hour`, then the maximum\r\nduration of the date range is 31 days. Note that month and year aggregate values\r\nmay contain partial data for the interval if filtering by date.\r\n            \r\nFiltering the results to a maximum number of data rows is done by setting the\r\n`count` filter parameter. When combined with startDate this can be used to perform\r\nsimple pagination.\r\n            \r\n## Response Format\r\n            \r\nThe representation format can be specified by MIME values in the Accept header.\r\nFor now the only supported values for the accept header is `application/json` and\r\n`text/csv`.\r\n            \r\n```json\r\n{\r\n   \"columns\": [ \"campaignId\", \"month\", \"impressions\", \"clicks\", \"cost\", \"saleUnits\", \"revenue\", \"cr\", \"cpo\", \"cos\", \"roas\" ],\r\n   \"data\": [\r\n       [168423, \"2019-05-01\", 3969032, 13410, 1111.295, 985, 190758099, 0.073, 1.128, 0.000, 171653.880 ],\r\n       [168423, \"2019-06-01\", 8479603, 25619, 2190.705, 740, 152783656, 0.028, 2.960, 0.000, 69741.775 ]\r\n       ],\r\n   \"rows\": 2\r\n}\r\n```\r\n            \r\nThe JSON result is an object with three fields (`columns`, `data`, and `rows`). The\r\n“columns” array acts as the header for the data rows. The categorical dimension\r\ncolumn comes first and consists of the campaign id.\r\nThe interval column comes next and defines the aggregation period.  The interval size is\r\ndetermined by the `intervalSize` parameter. This is followed by either nine or\r\nfifteen metrics columns. The first three metrics (impressions, clicks, and cost)\r\nalways appear. The remaining depend on the `clickAttributionPolicy` parameter.\r\n            \r\nThe “data” array contains data rows whose values match the entries in the\r\n“columns” array. Id dimensions are numbers while name and date dimensions are strings. The metrics are JSON objects\r\nwhose type is number. Some of these are natural numbers (e.g. clicks and\r\nimpressions)\
        \ whereas others are decimal values. A divide by zero yields null. The\r\ncurrency is assumed to be the local currency established by the advertiser.\r\n            \r\nThe “row” value is a count of the number of rows in the data array, and can be\r\nused to check the integrity of the data.\r\n            \r\nFurther information on the campaign or seller (e.g. the seller name) can be\r\nobtained from the existing V1 or V2 endpoints using the campaign and/or seller\r\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
  /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\r\n            \r\nGet performance statistics aggregated for _seller campaigns_.The campaign id, seller id, and\r\nseller name appear in the first three columns of the output. These are followed by the interval\r\nsize column.\r\n            \r\nAggregation can be done by `hour`, `day`, `month`, or `year` aligned with the user timezone if\r\nprovided. The aggregation interval size is controlled by `intervalSize`. The remaining columns\r\nare metrics.\r\n            \r\n## Metrics\r\n            \r\nThe metrics reported by this endpoint are\r\n            \r\n.  | Metric Group | Description\r\n---|--------------|------------\r\nA | impressions | Number of times product is shown in a banner\r\nB | clicks | Number of clicks on product\r\nC | cost | Amount spent for clicks on products\r\nD | saleUnits | Number of products sold attributed to clicks\r\nE | revenue | Revenue generated by sales\r\nF | CR = Conversion Rate | salesUnits / clicks\r\nG | CPO = Cost Per Order | cost / salesUnits\r\nH | COS = Cost of Sale | cost / revenue\r\nI | ROAS = Return On Add Spend | revenue / cost\r\n            \r\nThe last six metrics can be computed in two ways depending on the policy to count only\r\nthe sales that result from clicks on the same sellers product in a banner\r\n(same-seller) or not (any-seller).  Reporting can be controlled by `clickAttributionPolicy`.\r\n            \r\nThe 9 (or 15) metric values appear in the output as the final 9 (or 15) columns.\r\n            \r\n## Filtering\r\n            \r\nThe results can be filtered by date or count.\r\n            \r\nFiltering the results to events associated with a specific campaign is done by setting\r\nthe `campaignId` filter parameter to the desired value.\r\n            \r\nFiltering the results to events associated with a specific seller is done by setting\r\nthe `sellerId` filter parameter to the desired value.\r\n            \r\nFiltering the results to events\r\nthat happened in a time interval is done by setting the `startDate` and\r\n`endDate` filter parameters using the `yyyy-MM-DD` format. The start date\r\nincludes all events timestamped since the beginning of that day while the end\r\ndate includes events until the end of day. The maximum duration of the date\r\nrange is 1 year. If the aggregation interval is `hour`, then the maximum\r\nduration of the date range is 31 days. Note that month and year aggregate values\r\nmay contain partial data for the interval if filtering by date.\r\n            \r\nFiltering the results to a maximum number of data rows is done by setting the\r\n`count` filter parameter. When combined with startDate this can be used to perform\r\nsimple pagination.\r\n            \r\n## Response Format\r\n            \r\nThe representation format can be specified by MIME values in the Accept header.\r\nFor now the only supported values for the accept header is `application/json` and\r\n`text/csv`.\r\n            \r\n```json\r\n{\r\n    \"columns\": [\r\n        \"campaignId\", \"sellerId\", \"sellerName\", \"month\", \"impressions\", \"clicks\", \"cost\", \"saleUnits\", \"revenue\", \"cr\", \"cpo\", \"cos\", \"roas\"\r\n    ],\r\n    \"data\": [\r\n        [168423, 1110222, \"118883955\", \"2019-05-01\", 14542, 48, 3.36, 0, 0.0, 0.0, null, null, 0.0],\r\n        [168423, 1110222, \"118883955\", \"2019-06-01\", 16619, 53, 3.71, 0, 0.0, 0.0, null, null, 0.0],\r\n        [168423, 1110225, \"117980027\", \"2019-05-01\", 12502, 48, 3.36, 0, 0.0, 0.0, null, null, 0.0],\r\n        [168423, 1110225, \"117980027\", \"2019-06-01\", 20266, 53, 3.71, 0, 0.0, 0.0, null, null, 0.0]\r\n    ],\r\n    \"rows\": 4\r\n}\r\n```\r\n            \r\nThe JSON result is an object with three fields (`columns`, `data`, and `rows`). The\r\n“columns” array acts as the header for the data rows. The categorical dimension\r\ncolumns come first and include the campaign id, seller id, and seller name.\r\nThe interval column comes next and defines the aggregation period. The interval size is\r\ndetermined by the `intervalSize` parameter. This is followed\
        \ by either nine or\r\nfifteen metrics columns. The first three metrics (impressions, clicks, and cost)\r\nalways appear. The remaining depend on the `clickAttributionPolicy` parameter.\r\n            \r\nThe “data” array contains data rows whose values match the entries in the\r\n“columns” array. Id dimensions are numbers while name and date dimensions are strings. The metrics are JSON objects\r\nwhose type is number. Some of these are natural numbers (e.g. clicks and\r\nimpressions) whereas others are decimal values. A divide by zero yields null. The\r\ncurrency is assumed to be the local currency established by the advertiser.\r\n            \r\nThe “row” value is a count of the number of rows in the data array, and can be\r\nused to check the integrity of the data.\r\n            \r\nFurther information on the campaign or seller (e.g. the seller name) can be\r\nobtained from the existing V1 or V2 endpoints using the campaign and/or seller\r\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
  /2026-07/marketing-solutions/marketplace-performance-outcomes/stats/sellers:
    get:
      tags:
      - Campaign
      summary: /2026-07/marketing-solutions/marketplace-performance-outcomes/stats/sellers
      description: "## Dimensions\r\n            \r\nGet performance statistics aggregated for _sellers_. The seller id appears\r\nin the output in the first column and the seller name appears in the second.\r\n            \r\nAggregation can be done by `hour`, `day`, `month`, or `year` aligned with the user timezone\r\nif provided. The aggregation interval size is controlled by `intervalSize`. The time interval\r\nappears in the output as the second column.\r\n            \r\n## Metrics\r\n            \r\nThe metrics reported by this endpoint are\r\n            \r\n.  | Metric Group | Description\r\n---|--------------|------------\r\nA | impressions | Number of times product is shown in a banner\r\nB | clicks | Number of clicks on product\r\nC | cost | Amount spent for clicks on products\r\nD | saleUnits | Number of products sold attributed to clicks\r\nE | revenue | Revenue generated by sales\r\nF | CR = Conversion Rate | salesUnits / clicks\r\nG | CPO = Cost Per Order | cost / salesUnits\r\nH | COS = Cost of Sale | cost / revenue\r\nI | ROAS = Return On Add Spend | revenue / cost\r\n            \r\nThe last six metrics can be computed in two ways depending on the policy to count only\r\nthe sales that result from clicks on the same sellers product in a banner\r\n(same-seller) or not (any-seller).  Reporting can be controlled by `clickAttributionPolicy`.\r\n            \r\nThe 9 (or 15) metric values appear in the output as the final 9 (or 15) columns.\r\n            \r\n## Filtering\r\n            \r\nThe results can be filtered by seller id, date or count.\r\n            \r\nFiltering the results to events associated with a specific seller is done by setting\r\nthe `sellerId` filter parameter to the desired value.\r\n            \r\nFiltering the results to events\r\nthat happened in a time interval is done by setting the `startDate` and\r\n`endDate` filter parameters using the `yyyy-MM-DD` format. The start date\r\nincludes all events timestamped since the beginning of that day while the end\r\ndate includes events until the end of day. The maximum duration of the date\r\nrange is 1 year. If the aggregation interval is `hour`, then the maximum\r\nduration of the date range is 31 days. Note that month and year aggregate values\r\nmay contain partial data for the interval if filtering by date.\r\n            \r\nFiltering the results to a maximum number of data rows is done by setting the\r\n`count` filter parameter. When combined with startDate this can be used to perform\r\nsimple pagination.\r\n            \r\n## Response Format\r\n            \r\nThe representation format can be specified by MIME values in the Accept header.\r\nFor now the only supported values for the accept header is `application/json` and\r\n`text/csv`.\r\n            \r\n```json\r\n{\r\n    \"columns\": [\"sellerId\", \"sellerName\", \"month\", \"impressions\", \"clicks\", \"cost\", \"saleUnits\", \"revenue\", \"cr\", \"cpo\", \"cos\", \"roas\"],\r\n    \"data\": [\r\n       [1200972, \"sellerA\", \"2019-05-01\", 14542, 48, 3.36, 0, 0.0, 0.0, null, null, 0.0],\r\n       [1200972, \"sellerA\", \"2019-06-01\", 16619, 53, 3.71, 0, 0.0, 0.0, null, null, 0.0],\r\n       [1200974, \"sellerB\", \"2019-05-01\", 10102, 47, 3.29, 3, 396000.0, 0.063, 1.096, 8.308E-6, 120364.741],\r\n       [1200974, \"sellerB\", \"2019-06-01\", 11576, 54, 3.78, 1, 132000.0, 0.018, 3.78, 2.863E-5, 34920.634]\r\n    ],\r\n    \"rows\": 4\r\n}\r\n```\r\n            \r\nThe JSON result is an object with three fields (`columns`, `data`, and `rows`). The\r\n“columns” array acts as the header for the data rows. The categorical dimension\r\ncolumns come first and include the seller id and seller name.\r\nThe interval column comes next and defines the aggregation period. The interval size is\r\ndetermined by the `intervalSize` parameter. This is followed by either nine or\r\nfifteen metrics columns. The first three metrics (impressions, clicks, and cost)\r\nalways appear. The remaining metrics depend on the `clickAttributionPolicy` parameter.\r\n            \r\nThe “data” array contains\
        \ data rows whose values match the entries in the\r\n“columns” array. Id dimensions are numbers while name and date dimensions are strings. The metrics are JSON objects\r\nwhose type is number. Some of these are natural numbers (e.g. clicks and\r\nimpressions) whereas others are decimal values. A divide by zero yields null. The\r\ncurrency is assumed to be the local currency established by the advertiser.\r\n            \r\nThe “row” value is a count of the number of rows in the data array, and can be\r\nused to check the integrity of the data.\r\n            \r\nFurther information on the campaign or seller (e.g. the seller name) can be\r\nobtained from the existing V1 or V2 endpoints using the campaign and/or seller\r\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
  /2026-07/marketing-solutions/me:
    get:
      tags:
      - Gateway
      summary: /2026-07/marketing-solutions/me
      description: Get information about the currently logged application
      operationId: GetCurrentApplication
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationSummaryModelResponse'
      security:
      - oauth: []
  /2026-07/marketing-solutions/product-sets:
    post:
      tags:
      - Reco
      summary: /2026-07/marketing-solutions/product-sets
      description: Create a new product set
      operationId: CreateProductSet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputOfCreateProductSetRequest'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Product set created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOutcomeOfProductSet'
      security:
      - oauth:
        - MarketingSolutions_Reco_Manage
  /2026-07/marketing-solutions/product-sets/{product-set-id}:
    delete:
      tags:
      - Reco
      summary: /2026-07/marketing-solutions/product-sets/{product-set-id}
      description: Remove a product set
      operationId: RemoveProductSet
      parameters:
      - name: product-set-id
        in: path
        description: ID of the product set to remove
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ProductSet removed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Outcome'
      security:
      - oauth:
        - MarketingSolutions_Reco_Manage
    get:
      tags:
      - Reco
      summary: /2026-07/marketing-solutions/product-sets/{product-set-id}
      description: Fetch an existing product set
      operationId: FetchProductSet
      parameters:
      - name: product-set-id
        in: path
        description: ID of the product set
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Product set fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOutcomeOfProductSet'
      security:
      - oauth:
        - MarketingSolutions_Reco_Read
    patch:
      tags:
      - Reco
      summary: /2026-07/marketing-solutions/product-sets/{product-set-id}
      description: Patch an existing product set
      operationId: PatchProductSet
      parameters:
      - name: product-set-id
        in: path
        description: ID of the product set
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValueResourceInputOfPatchProductSetRequest'
        required: true
        x-bodyName: request
      responses:
        '200':
          description: Product set modified successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceOutcomeOfProductSet'
      security:
      - oauth:
        - MarketingSolutions_Reco_Manage
  /2026-07/marketing-solutions/product-sets/{product-set-id}/product-filters:
    get:
      tags:
      - Reco
      summary: /2026-07/marketing-solutions/product-sets/{product-set-id}/product-filters
      description: Fetch product filtering usages for a given product set
      operationId: FetchProductFilteringUsages
      parameters:
      - name: product-set-id
        in: path
        description: ID of the product set
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValueResourceCollectionOutcomeOfProductFilterConfig'
      security:
      - oauth:
        - MarketingSolutions_Reco_Read
  /2026-07/marketing-solutions/product-sets/dataset/{dataset-id}:
    get:
      tags:
      - Reco
      summary: /2026-07/marketing-solutions/product-sets/dataset/{dataset-id}
      description: Fetch product sets of a given dataset
      operationId: FetchProductSets
      parameters:
      - name: dataset-id
        in: path
        description: The ID of the dataset that should be used for product set retrieval
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Products sets fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCollectionOutcomeOfProductSet'
      security:
      - oauth:
        - MarketingSolutions_Reco_Read
  /2026-07/placements/report:
    post:
      tags:
      - Analytics
      summary: /2026-07/placements/report
      description: "Your ads are placed in different domains (publishers) and environments (websites and apps). Thanks to the placements endpoint, you can analyse the performances for each publisher, comparing displays, clicks and sales generated.\r\n<br/><br/>\r\nThis endpoint supports data retrieval for up to three months in the past."
      operationId: GetPlacementsReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlacementsReportQueryMessageListRequest'
            example:
              data:
              - type: report
                attributes:
                  advertiserIds: 123,456,789
                  campaignIds: 111,222,333,444
                  adsetIds: 135,246,357,468
                  environment: Web
                  placement: MyPlacement
                  dimensions:
                  - AdsetId
                  - AdvertiserId
                  - Placement
                  metrics:
                  - Clicks
                  - Displays
                  - Cost
                  currency: EUR
                  disclosed: false
                  format: csv
                  timezone: Europe/Paris
                  startDate: '2024-01-01T00:00:00.0000000+00:00'
                  endDate: '2024-01-04T00:00:00.0000000+00:00'
          application/xml:
            schema:
              $ref: '#/components/schemas/PlacementsReportQueryMessageListRequest'
            example: "<ValueResourceCollectionInputOfPlacementsReportQueryMessagetukRIHCU xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Resources\">\r\n  <Data>\r\n    <ValueResourceOfPlacementsReportQueryMessagetukRIHCU>\r\n      <Attributes xmlns:d4p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Messages\">\r\n        <d4p1:EndDate>2024-01-04T00:00:00</d4p1:EndDate>\r\n        <d4p1:StartDate>2024-01-01T00:00:00</d4p1:StartDate>\r\n        <d4p1:Format>csv</d4p1:Format>\r\n        <d4p1:Timezone>Europe/Paris</d4p1:Timezone>\r\n        <d4p1:AdsetIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>135</d6p1:int>\r\n            <d6p1:int>246</d6p1:int>\r\n            <d6p1:int>357</d6p1:int>\r\n            <d6p1:int>468</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:AdsetIds>\r\n        <d4p1:AdvertiserIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>123</d6p1:int>\r\n            <d6p1:int>456</d6p1:int>\r\n            <d6p1:int>789</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:AdvertiserIds>\r\n        <d4p1:CampaignIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>111</d6p1:int>\r\n            <d6p1:int>222</d6p1:int>\r\n            <d6p1:int>333</d6p1:int>\r\n            <d6p1:int>444</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:CampaignIds>\r\n        <d4p1:Currency>EUR</d4p1:Currency>\r\n        <d4p1:Dimensions xmlns:d5p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n          <d5p1:PlacementsReportDimensions>AdsetId</d5p1:PlacementsReportDimensions>\r\n          <d5p1:PlacementsReportDimensions>AdvertiserId</d5p1:PlacementsReportDimensions>\r\n          <d5p1:PlacementsReportDimensions>Placement</d5p1:PlacementsReportDimensions>\r\n        </d4p1:Dimensions>\r\n        <d4p1:Disclosed>false</d4p1:Disclosed>\r\n        <d4p1:Environment>Web</d4p1:Environment>\r\n        <d4p1:IsInternal>false</d4p1:IsInternal>\r\n        <d4p1:Metrics xmlns:d5p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n          <d5p1:PlacementsReportMetrics>Clicks</d5p1:PlacementsReportMetrics>\r\n          <d5p1:PlacementsReportMetrics>Displays</d5p1:PlacementsReportMetrics>\r\n          <d5p1:PlacementsReportMetrics>Cost</d5p1:PlacementsReportMetrics>\r\n        </d4p1:Metrics>\r\n        <d4p1:Placement>MyPlacement</d4p1:Placement>\r\n      </Attributes>\r\n      <Type>report</Type>\r\n    </ValueResourceOfPlacementsReportQueryMessagetukRIHCU>\r\n  </Data>\r\n</ValueResourceCollectionInputOfPlacementsReportQueryMessagetukRIHCU>"
          text/xml:
            schema:
              $ref: '#/components/schemas/PlacementsReportQueryMessageListRequest'
            example: "<ValueResourceCollectionInputOfPlacementsReportQueryMessagetukRIHCU xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Resources\">\r\n  <Data>\r\n    <ValueResourceOfPlacementsReportQueryMessagetukRIHCU>\r\n      <Attributes xmlns:d4p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Messages\">\r\n        <d4p1:EndDate>2024-01-04T00:00:00</d4p1:EndDate>\r\n        <d4p1:StartDate>2024-01-01T00:00:00</d4p1:StartDate>\r\n        <d4p1:Format>csv</d4p1:Format>\r\n        <d4p1:Timezone>Europe/Paris</d4p1:Timezone>\r\n        <d4p1:AdsetIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>135</d6p1:int>\r\n            <d6p1:int>246</d6p1:int>\r\n            <d6p1:int>357</d6p1:int>\r\n            <d6p1:int>468</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:AdsetIds>\r\n        <d4p1:AdvertiserIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>123</d6p1:int>\r\n            <d6p1:int>456</d6p1:int>\r\n            <d6p1:int>789</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:AdvertiserIds>\r\n        <d4p1:CampaignIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>111</d6p1:int>\r\n            <d6p1:int>222</d6p1:int>\r\n            <d6p1:int>333</d6p1:int>\r\n            <d6p1:int>444</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:CampaignIds>\r\n        <d4p1:Currency>EUR</d4p1:Currency>\r\n        <d4p1:Dimensions xmlns:d5p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n          <d5p1:PlacementsReportDimensions>AdsetId</d5p1:PlacementsReportDimensions>\r\n          <d5p1:PlacementsReportDimensions>AdvertiserId</d5p1:PlacementsReportDimensions>\r\n          <d5p1:PlacementsReportDimensions>Placement</d5p1:PlacementsReportDimensions>\r\n        </d4p1:Dimensions>\r\n        <d4p1:Disclosed>false</d4p1:Disclosed>\r\n        <d4p1:Environment>Web</d4p1:Environment>\r\n        <d4p1:IsInternal>false</d4p1:IsInternal>\r\n        <d4p1:Metrics xmlns:d5p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n          <d5p1:PlacementsReportMetrics>Clicks</d5p1:PlacementsReportMetrics>\r\n          <d5p1:PlacementsReportMetrics>Displays</d5p1:PlacementsReportMetrics>\r\n          <d5p1:PlacementsReportMetrics>Cost</d5p1:PlacementsReportMetrics>\r\n        </d4p1:Metrics>\r\n        <d4p1:Placement>MyPlacement</d4p1:Placement>\r\n      </Attributes>\r\n      <Type>report</Type>\r\n    </ValueResourceOfPlacementsReportQueryMessagetukRIHCU>\r\n  </Data>\r\n</ValueResourceCollectionInputOfPlacementsReportQueryMessagetukRIHCU>"
          application/*+xml:
            schema:
              $ref: '#/components/schemas/PlacementsReportQueryMessageListRequest'
            example: "<ValueResourceCollectionInputOfPlacementsReportQueryMessagetukRIHCU xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Resources\">\r\n  <Data>\r\n    <ValueResourceOfPlacementsReportQueryMessagetukRIHCU>\r\n      <Attributes xmlns:d4p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Messages\">\r\n        <d4p1:EndDate>2024-01-04T00:00:00</d4p1:EndDate>\r\n        <d4p1:StartDate>2024-01-01T00:00:00</d4p1:StartDate>\r\n        <d4p1:Format>csv</d4p1:Format>\r\n        <d4p1:Timezone>Europe/Paris</d4p1:Timezone>\r\n        <d4p1:AdsetIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>135</d6p1:int>\r\n            <d6p1:int>246</d6p1:int>\r\n            <d6p1:int>357</d6p1:int>\r\n            <d6p1:int>468</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:AdsetIds>\r\n        <d4p1:AdvertiserIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>123</d6p1:int>\r\n            <d6p1:int>456</d6p1:int>\r\n            <d6p1:int>789</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:AdvertiserIds>\r\n        <d4p1:CampaignIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>111</d6p1:int>\r\n            <d6p1:int>222</d6p1:int>\r\n            <d6p1:int>333</d6p1:int>\r\n            <d6p1:int>444</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:CampaignIds>\r\n        <d4p1:Currency>EUR</d4p1:Currency>\r\n        <d4p1:Dimensions xmlns:d5p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n          <d5p1:PlacementsReportDimensions>AdsetId</d5p1:PlacementsReportDimensions>\r\n          <d5p1:PlacementsReportDimensions>AdvertiserId</d5p1:PlacementsReportDimensions>\r\n          <d5p1:PlacementsReportDimensions>Placement</d5p1:PlacementsReportDimensions>\r\n        </d4p1:Dimensions>\r\n        <d4p1:Disclosed>false</d4p1:Disclosed>\r\n        <d4p1:Environment>Web</d4p1:Environment>\r\n        <d4p1:IsInternal>false</d4p1:IsInternal>\r\n        <d4p1:Metrics xmlns:d5p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n          <d5p1:PlacementsReportMetrics>Clicks</d5p1:PlacementsReportMetrics>\r\n          <d5p1:PlacementsReportMetrics>Displays</d5p1:PlacementsReportMetrics>\r\n          <d5p1:PlacementsReportMetrics>Cost</d5p1:PlacementsReportMetrics>\r\n        </d4p1:Metrics>\r\n        <d4p1:Placement>MyPlacement</d4p1:Placement>\r\n      </Attributes>\r\n      <Type>report</Type>\r\n    </ValueResourceOfPlacementsReportQueryMessagetukRIHCU>\r\n  </Data>\r\n</ValueResourceCollectionInputOfPlacementsReportQueryMessagetukRIHCU>"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
                format: binary
            text/csv:
              schema:
                type: string
                format: binary
            text/xml:
              schema:
                type: string
                format: binary
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                type: string
                format: binary
      security:
      - oauth:
        - MarketingSolutions_Analytics_Read
  /2026-07/statistics/report:
    post:
      tags:
      - Analytics
      summary: /2026-07/statistics/report
      description: "This Statistics endpoint provides ad set related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities.\r\n<br/><br/>\r\nThis endpoint supports data retrieval for up to two years in the past."
      operationId: GetAdsetReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StatisticsReportQueryMessage'
            example:
              advertiserIds: 123,456,789
              adSetIds:
              - '12345'
              - '54321'
              adSetNames:
              - myAdSet1
              - myAdSet2
              adSetStatus:
              - Active
              dimensions:
              - CampaignId
              - Campaign
              - AdsetId
              - Adset
              - AdvertiserId
              - Advertiser
              - AdId
              - Ad
              - CouponId
              - Coupon
              - CategoryId
              - Category
              - Hour
              - Day
              - Week
              - Month
              - Year
              - Os
              - Device
              metrics:
              - Clicks
              - Displays
              - Cpc
              - Visits
              currency: EUR
              format: csv
              timezone: Europe/Paris
              startDate: '2024-01-01T00:00:00.0000000+00:00'
              endDate: '2024-01-04T00:00:00.0000000+00:00'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
                format: binary
            text/csv:
              schema:
                type: string
                format: binary
            text/xml:
              schema:
                type: string
                format: binary
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                type: string
                format: binary
      security:
      - oauth:
        - MarketingSolutions_Analytics_Read
  /2026-07/transactions/report:
    post:
      tags:
      - Analytics
      summary: /2026-07/transactions/report
      description: "This Transactions endpoint provides transactions id related data.\r\n<br/><br/>\r\nThis endpoint supports data retrieval for up to two years in the past."
      operationId: GetTransactionsReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionsReportQueryMessageListRequest'
            example:
              data:
              - type: report
                attributes:
                  advertiserIds: 123,456,789
                  eventType: Display
                  currency: EUR
                  format: csv
                  timezone: Europe/Paris
                  startDate: '2024-01-01T00:00:00.0000000+00:00'
                  endDate: '2024-01-04T00:00:00.0000000+00:00'
          application/xml:
            schema:
              $ref: '#/components/schemas/TransactionsReportQueryMessageListRequest'
            example: "<ValueResourceCollectionInputOfTransactionsReportQueryMessagetukRIHCU xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Resources\">\r\n  <Data>\r\n    <ValueResourceOfTransactionsReportQueryMessagetukRIHCU>\r\n      <Attributes xmlns:d4p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Messages\">\r\n        <d4p1:EndDate>2024-01-04T00:00:00</d4p1:EndDate>\r\n        <d4p1:StartDate>2024-01-01T00:00:00</d4p1:StartDate>\r\n        <d4p1:Format>csv</d4p1:Format>\r\n        <d4p1:Timezone>Europe/Paris</d4p1:Timezone>\r\n        <d4p1:AdvertiserIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>123</d6p1:int>\r\n            <d6p1:int>456</d6p1:int>\r\n            <d6p1:int>789</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:AdvertiserIds>\r\n        <d4p1:Currency>EUR</d4p1:Currency>\r\n        <d4p1:EventType>Display</d4p1:EventType>\r\n        <d4p1:IsInternal>false</d4p1:IsInternal>\r\n      </Attributes>\r\n      <Type>report</Type>\r\n    </ValueResourceOfTransactionsReportQueryMessagetukRIHCU>\r\n  </Data>\r\n</ValueResourceCollectionInputOfTransactionsReportQueryMessagetukRIHCU>"
          text/xml:
            schema:
              $ref: '#/components/schemas/TransactionsReportQueryMessageListRequest'
            example: "<ValueResourceCollectionInputOfTransactionsReportQueryMessagetukRIHCU xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Resources\">\r\n  <Data>\r\n    <ValueResourceOfTransactionsReportQueryMessagetukRIHCU>\r\n      <Attributes xmlns:d4p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Messages\">\r\n        <d4p1:EndDate>2024-01-04T00:00:00</d4p1:EndDate>\r\n        <d4p1:StartDate>2024-01-01T00:00:00</d4p1:StartDate>\r\n        <d4p1:Format>csv</d4p1:Format>\r\n        <d4p1:Timezone>Europe/Paris</d4p1:Timezone>\r\n        <d4p1:AdvertiserIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>123</d6p1:int>\r\n            <d6p1:int>456</d6p1:int>\r\n            <d6p1:int>789</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:AdvertiserIds>\r\n        <d4p1:Currency>EUR</d4p1:Currency>\r\n        <d4p1:EventType>Display</d4p1:EventType>\r\n        <d4p1:IsInternal>false</d4p1:IsInternal>\r\n      </Attributes>\r\n      <Type>report</Type>\r\n    </ValueResourceOfTransactionsReportQueryMessagetukRIHCU>\r\n  </Data>\r\n</ValueResourceCollectionInputOfTransactionsReportQueryMessagetukRIHCU>"
          application/*+xml:
            schema:
              $ref: '#/components/schemas/TransactionsReportQueryMessageListRequest'
            example: "<ValueResourceCollectionInputOfTransactionsReportQueryMessagetukRIHCU xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Resources\">\r\n  <Data>\r\n    <ValueResourceOfTransactionsReportQueryMessagetukRIHCU>\r\n      <Attributes xmlns:d4p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Messages\">\r\n        <d4p1:EndDate>2024-01-04T00:00:00</d4p1:EndDate>\r\n        <d4p1:StartDate>2024-01-01T00:00:00</d4p1:StartDate>\r\n        <d4p1:Format>csv</d4p1:Format>\r\n        <d4p1:Timezone>Europe/Paris</d4p1:Timezone>\r\n        <d4p1:AdvertiserIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>123</d6p1:int>\r\n            <d6p1:int>456</d6p1:int>\r\n            <d6p1:int>789</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:AdvertiserIds>\r\n        <d4p1:Currency>EUR</d4p1:Currency>\r\n        <d4p1:EventType>Display</d4p1:EventType>\r\n        <d4p1:IsInternal>false</d4p1:IsInternal>\r\n      </Attributes>\r\n      <Type>report</Type>\r\n    </ValueResourceOfTransactionsReportQueryMessagetukRIHCU>\r\n  </Data>\r\n</ValueResourceCollectionInputOfTransactionsReportQueryMessagetukRIHCU>"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
                format: binary
            text/csv:
              schema:
                type: string
                format: binary
            text/xml:
              schema:
                type: string
                format: binary
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                type: string
                format: binary
      security:
      - oauth:
        - MarketingSolutions_Analytics_Read
components:
  schemas:
    Ad:
      type: object
      properties:
        adSetId:
          type: string
          description: The id of the Ad Set binded to this Ad
          nullable: true
        creativeId:
          type: string
          description: The id of the Creative binded to this Ad
          nullable: true
        description:
          type: string
          description: The description of the ad
          nullable: true
        endDate:
          type: string
          description: "The date when when we will stop to show this ad. If the end date is not specified (i.e. null) then the ad will go on forever\r\nString must be in ISO8601 format"
          nullable: true
        id:
          type: string
          description: Unique identifier (duplicate of the parent id).
          nullable: true
        inventoryType:
          enum:
          - Native
          - Display
          - Video
          type: string
          description: The inventory the Ad belongs to. Possible values are "Display" and "Native". This is optional since this doesn't make sense for every creative type but will throw an error if not set for a dynamic creative.
          nullable: true
        name:
          type: string
          description: The name of the ad
          nullable: true
        startDate:
          type: string
          description: "The date when the ad will be launched\r\nString must be in ISO8601 format"
          nullable: true
      description: An ad is the binding that connects a creative with an ad set
      nullable: true
    AdaptiveAttributes:
      required:
      - callsToAction
      - colors
      - descriptionFont
      - descriptionText
      - headlineFont
      - headlineText
      - landingPageUrl
      - layouts
      - logos
      type: object
      properties:
        callsToAction:
          type: array
          items:
            type: string
          description: "A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate\r\nresponse, such as “Buy now” or “Go!”."
        colors:
          $ref: '#/components/schemas/AdaptiveColors'
        descriptionFont:
          type: string
          description: "Font of the description\r\nValid supported font like \"Arial\""
        descriptionText:
          type: string
          description: The description text of the banner
        headlineFont:
          type: string
          description: "Font of the headline\r\nValid supported font like \"Arial\""
        headlineText:
          type: string
          description: The headline text of the banner
        imageDisplay:
          enum:
          - ShowFullImage
          - ZoomOnImage
          type: string
          description: "Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your image set should fit inside the allocated\r\nspace (\"ShowFullImage\") or whether it should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some\r\nimage cropping."
          nullable: true
        imageSets:
          type: array
          items:
            $ref: '#/components/schemas/ImageSet'
          description: Multiple image sets, each image set consists of multiple images and a headline text.
          nullable: true
        landingPageUrl:
          type: string
          description: Web redirection of the landing page url
          format: uri
        layouts:
          type: array
          items:
            enum:
            - Editorial
            - Montage
            - InBannerVideo
            type: string
          description: "The Adaptive layouts that are enabled.\r\nIt can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\"."
        logos:
          type: array
          items:
            $ref: '#/components/schemas/ImageShape'
          description: Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net
        videos:
          type: array
          items:
            $ref: '#/components/schemas/VideoDetail'
          description: Multiple videos potentially in different shapes.
          nullable: true
      description: The attributes specific to Adaptive creatives
      nullable: true
    AdaptiveColors:
      required:
      - backgroundColor
      - ctaBackgroundColor
      - ctaTextColor
      - logoAreaAndTitleColor
      - text1Color
      - text2Color
      type: object
      properties:
        backgroundColor:
          type: string
          description: "Color of the creative's background.\r\nA valid RGB24 color in hexadecimal (e.g. \"AB00FF\")"
        ctaBackgroundColor:
          type: string
          description: "Color of the background of the CTA.\r\nA valid RGB24 color in hexadecimal (e.g. \"AB00FF\")."
        ctaTextColor:
          type: string
          description: "Color of the text of the CTA.\r\nA valid RGB24 color in hexadecimal (e.g. \"AB00FF\")."
        logoAreaAndTitleColor:
          type: string
          description: "Color of the creative's logo area.\r\nA valid RGB24 color in hexadecimal (e.g. \"AB00FF\")."
        text1Color:
          type: string
          description: "Color of the headline and the description texts.\r\nA valid RGB24 color in hexadecimal (e.g. \"AB00FF\")"
        text2Color:
          type: string
          description: "Color of the image set's headline text.\r\nA valid RGB24 color in hexadecimal (e.g. \"AB00FF\")"
      description: Entity consists of the color aliases of the creative's elements
      nullable: true
    AdaptiveReadAttributes:
      type: object
      properties:
        callsToAction:
          type: array
          items:
            type: string
          description: "A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate\r\nresponse, such as “Buy now” or “Go!”."
          nullable: true
        colors:
          $ref: '#/components/schemas/AdaptiveColors'
        descriptionFont:
          type: string
          description: "Font of the description\r\nValid supported font like \"Arial\""
          nullable: true
        descriptionText:
          type: string
          description: The description text of the banner
          nullable: true
        headlineFont:
          type: string
          description: "Font of the headline\r\nValid supported font like \"Arial\""
          nullable: true
        headlineText:
          type: string
          description: The headline text of the banner
          nullable: true
        imageDisplay:
          enum:
          - ShowFullImage
          - ZoomOnImage
          type: string
          description: "Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your image set should fit inside the allocated\r\nspace (\"ShowFullImage\") or whether it should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some\r\nimage cropping."
          nullable: true
        imageSets:
          type: array
          items:
            $ref: '#/components/schemas/ImageSet'
          description: Multiple image sets, each image set consists of multiple images and a headline text.
          nullable: true
        landingPageUrl:
          type: string
          description: Web redirection of the landing page url
          format: uri
          nullable: true
        layouts:
          type: array
          items:
            enum:
            - Editorial
            - Montage
            - InBannerVideo
            type: string
          description: "The Adaptive layouts that are enabled.\r\nIt can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\"."
          nullable: true
        logos:
          type: array
          items:
            $ref: '#/components/schemas/ImageShape'
          description: Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net
          nullable: true
        videos:
          type: array
          items:
            $ref: '#/components/schemas/VideoDetail'
          description: Multiple videos potentially in different shapes.
          nullable: true
      description: The attributes specific to Adaptive creatives read
      nullable: true
    AdaptiveWriteAttributes:
      required:
      - callsToAction
      - colors
      - descriptionFont
      - descriptionText
      - headlineFont
      - headlineText
      - landingPageUrl
      - layouts
      - logoBase64String
      type: object
      properties:
        callsToAction:
          minItems: 1
          type: array
          items:
            type: string
          description: "A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate\r\nresponse, such as “Buy now” or “Go!”."
        colors:
          $ref: '#/components/schemas/AdaptiveColors'
        descriptionFont:
          type: string
          description: "Font of the description\r\nValid supported font like \"Arial\""
        descriptionText:
          type: string
          description: The description text of the banner
        headlineFont:
          type: string
          description: "Font of the headline\r\nValid supported font like \"Arial\""
        headlineText:
          type: string
          description: The headline text of the banner
        imageDisplay:
          enum:
          - ShowFullImage
          - ZoomOnImage
          type: string
          description: "Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your image set should fit inside the allocated\r\nspace (\"ShowFullImage\") or whether it should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some\r\nimage cropping."
          nullable: true
        imageSetsBase64:
          type: array
          items:
            $ref: '#/components/schemas/ImageSetBase64'
          description: Multiple image sets, each image set consists of multiple images as a base-64 encoded string and a headline text.
          nullable: true
        landingPageUrl:
          type: string
          description: Web redirection of the landing page url.
          format: uri
        layouts:
          minItems: 1
          type: array
          items:
            enum:
            - Editorial
            - Montage
            - InBannerVideo
            type: string
          description: "The Adaptive layouts that are enabled.\r\nIt can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\"."
        logoBase64String:
          type: string
          description: Logo image as a base-64 encoded string
        videoBase64Strings:
          type: array
          items:
            type: string
          description: Multiple videos potentially in different shapes, each video is a base-64 encoded string.
          nullable: true
      description: The attributes specific to create or update an Adaptive creative
    AdSetAudienceLinkEntityV1:
      type: object
      properties:
        audienceId:
          type: string
          nullable: true
      description: Link Audience with an ad set
      nullable: true
      x-criteo-canonical:
        infoType: entity
        name: AdSetAudience
        version: v1
    AdSetAudienceLinkEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AdSetAudienceLinkEntityV1'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API
      nullable: true
    AdSetAudienceLinkEntityV1Response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AdSetAudienceLinkEntityV1Resource'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single entity
    AdSetAudienceLinkInputEntityV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AdSetAudienceLinkEntityV1Resource'
      description: Input to set audience ad set link.
    AdSetCategoryBid:
      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
          nullable: true
        categoryName:
          type: string
          description: The name of the Category to which the Category Bid has been applied.
          nullable: true
      description: Category Bid information about a Category for a given Ad Set.
      nullable: true
    AdSetCategoryBidListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AdSetCategoryBidResource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: Data model for a list of response resources
    AdSetCategoryBidResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AdSetCategoryBid'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          description: Canonical type name of the entity
          nullable: true
          example: AdSetCategoryBid
      description: Data model for a Resource
    AdSetDeliveryLimitationsV26Q1:
      type: object
      properties:
        devices:
          type: array
          items:
            enum:
            - other
            - desktop
            - mobile
            - tablet
            type: string
            description: "Targeted device type.\r\n            \r\nPossible values:\r\n- other\r\n- desktop\r\n- mobile\r\n- tablet"
          description: "List of devices which the ad set should target.\r\n            \r\nNo limitation if the list is empty."
          nullable: true
        environments:
          type: array
          items:
            enum:
            - web
            - inApp
            type: string
            description: "Targeted environment type.\r\n            \r\nNote: this is very different from AdSetDestinationEnvironment: this parameter defines a delivery limitation,\r\nnot an impression's destination.\r\n            \r\nPossible values:\r\n- web\r\n- inApp"
          description: "List of environments which the ad set should target.\r\n            \r\nNo limitation if the list is empty."
          nullable: true
        operatingSystems:
          type: array
          items:
            enum:
            - android
            - ios
            - unknown
            type: string
            description: "Targeted operating system.\r\n            \r\nPossible values:\r\n- android\r\n- ios\r\n- unknown"
          description: "List of operating systems which the ad set should target.\r\n            \r\nNo limitation if the list is empty."
          nullable: true
      description: Delivery limitations for an ad set.
      nullable: true
    AdSetDeliveryStatus:
      enum:
      - Running
      - Archived
      - NotRunning
      type: string
      description: Status of an ad set's delivery
    AdSetDisplayMultiplier:
      type: object
      properties:
        categoryName:
          type: string
          description: The name of the Category to which the given for which the Display Multiplier has been applied.
          nullable: true
        displayMultiplier:
          type: number
          description: The Display Multiplier applied to the given Category associated to an Ad Set.
          format: double
          nullable: true
      description: Display Multiplier information about a Category for a given Ad Set.
      nullable: true
    AdSetDisplayMultiplierListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AdSetDisplayMultiplierResource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: Data model for a list of response resources
    AdSetDisplayMultiplierResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AdSetDisplayMultiplier'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          description: Canonical type name of the entity
          nullable: true
          example: AdSetDisplayMultiplier
      description: Data model for a Resource
    AdSetFrequencyCappingV26Q1:
      type: object
      properties:
        frequency:
          enum:
          - hourly
          - daily
          - lifetime
          - advanced
          type: string
          description: "Period on which impression limitation is calculated.\r\n            \r\nPossible values:\r\n- hourly\r\n- daily\r\n- lifetime\r\n- advanced"
          nullable: true
        maximumImpressions:
          type: integer
          description: Maximum impressions for the specified period.
          format: int32
          nullable: true
      description: "Ad set frequency capping.\r\n            \r\nSettings that can limit the number of impression by viewer and by period."
      nullable: true
    AdSetGeoLocationV26Q1:
      type: object
      properties:
        countries:
          $ref: '#/components/schemas/NillableAdSetTargetingRuleV26Q1'
        subdivisions:
          $ref: '#/components/schemas/NillableAdSetTargetingRuleV26Q1'
        zipCodes:
          $ref: '#/components/schemas/NillableAdSetTargetingRuleV26Q1'
      description: Ad set geolocation options.
      nullable: true
    AdSetIdV26Q1:
      type: object
      description: ad set id model
      nullable: true
    AdSetSearchFilterV26Q1:
      type: object
      properties:
        adSetIds:
          type: array
          items:
            type: string
          description: Ad set ids to filter on. Ids are string-encoded integers.
          nullable: true
        advertiserIds:
          type: array
          items:
            type: string
          description: "Advertiser ids which ad sets belongs to (indirectly via their marketing campaign).\r\nIds are string-encoded integers."
          nullable: true
        campaignIds:
          type: array
          items:
            type: string
          description: Campaign ids to filter on. Ids are string-encoded integers.
          nullable: true
      description: "Filter on ad set ids.\r\n            \r\nMultiple filters are combined with an implicit AND operation.\r\nIdentifiers are string-encoded integers; invalid values are ignored.\r\nIf no filter is provided (both arrays are null or empty), the search returns all accessible campaigns."
    AdSetSearchRequestMetadataV26Q1:
      type: object
      properties:
        fields:
          type: array
          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.\r\n            \r\nPossible values:\r\n- Name\r\n- AdvertiserId\r\n- DatasetId\r\n- CampaignId\r\n- DestinationEnvironment\r\n- Objective\r\n- Schedule\r\n- Bidding\r\n- Targeting\r\n- Budget\r\n- MediaType\r\n- VideoChannel\r\n- AttributionConfiguration"
          description: "List of fields to include in the response. If null or omitted, all fields are returned.\r\nWhen 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."
          nullable: true
      description: Optional metadata for searching ad sets
    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'
    AdSetTargetingRuleV26Q1:
      type: object
      properties:
        operand:
          enum:
          - undefined
          - in
          - notIn
          type: string
        values:
          type: array
          items:
            type: string
          nullable: true
      description: ad set targeting rule model
    AdSetTargetingV26Q1:
      type: object
      properties:
        deliveryLimitations:
          $ref: '#/components/schemas/AdSetDeliveryLimitationsV26Q1'
        frequencyCapping:
          type: object
          properties:
            value:
              $ref: '#/components/schemas/AdSetFrequencyCappingV26Q1'
          nullable: true
        geoLocation:
          $ref: '#/components/schemas/AdSetGeoLocationV26Q1'
      description: ad set targeting model
      nullable: true
    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
    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
          description: 'Numeric delivery status: 0 = Running, 1 = Archived, 2 = NotRunning'
          nullable: true
      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
    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
          description: IANA timezone identifier for the advertiser (e.g. UTC, Asia/Tokyo)
          nullable: true
      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
    AdvertiserQuotaMessage:
      type: object
      properties:
        advertiserId:
          type: integer
          format: int32
          nullable: true
        quotaEndDate:
          type: string
          format: date-time
          nullable: true
        quotaLimit:
          type: integer
          format: int32
          nullable: true
        quotaStartDate:
          type: string
          format: date-time
          nullable: true
        quotaUsed:
          type: integer
          format: int32
          nullable: true
      description: Data representing an advertiser's quota
    AdWrite:
      required:
      - adSetId
      - creativeId
      - name
      - startDate
      type: object
      properties:
        adSetId:
          type: string
          description: The id of the Ad Set bound to this Ad
        creativeId:
          type: string
          description: The id of the Creative bound to this Ad
        description:
          type: string
          description: The description of the ad
          nullable: true
        endDate:
          type: string
          description: "The date when when we will stop to show this ad. If the end date is not specified (i.e. null) then the ad will go on forever\r\nString must be in ISO8601 format"
          nullable: true
        inventoryType:
          enum:
          - Display
          - Native
          type: string
          description: The inventory the Ad to be created or updated belongs to. Possible values are "Display" and "Native". This is optional since this doesn't make sense for every creative type but will throw an error if not set for a dynamic creative.
          nullable: true
        name:
          type: string
          description: The name of the ad
        startDate:
          type: string
          description: "The date when the ad will be launched\r\nString must be in ISO8601 format"
      description: Entity to create or update an ad
    AlgebraNodeV1:
      type: object
      properties:
        and:
          type: array
          items:
            $ref: '#/components/schemas/AlgebraNodeV1'
          nullable: true
        audienceSegmentId:
          type: string
          nullable: true
        not:
          $ref: '#/components/schemas/AlgebraNodeV1'
        or:
          type: array
          items:
            $ref: '#/components/schemas/AlgebraNodeV1'
          nullable: true
      description: Node in the audience algebra definition.
      nullable: true
    ApplicationSummaryModel:
      type: object
      properties:
        applicationId:
          type: integer
          format: int32
          nullable: true
        criteoService:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        organizationId:
          type: integer
          format: int32
          nullable: true
      description: Used for the /me endpoint. Contains information about the currently authenticated application that we accept to give to our clients
      nullable: true
    ApplicationSummaryModelResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/ApplicationSummaryModel'
        type:
          type: string
          nullable: true
      description: A top-level object that encapsulates a Criteo API response for a single value
      nullable: true
    ApplicationSummaryModelResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ApplicationSummaryModelResource'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single value
    AudienceBulkCreateInputV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceCreateEntityV1Resource'
      description: Input to create one or more audiences.
    AudienceBulkDeleteInputV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceDeleteEntityV1Resource'
      description: Input to delete one or more audiences.
    AudienceBulkUpdateInputV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceUpdateEntityV1Resource'
      description: Input to update one or more audiences.
    AudienceComputeSizeEntityV1:
      type: object
      description: Audience of people of interest for a marketer.
      x-criteo-canonical:
        infoType: entity
        name: Audience
        version: v1
    AudienceComputeSizeEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceComputeSizeEntityV1'
        id:
          type: string
          description: Id of the entity
        type:
          type: string
      description: A class that represents a domain entity exposed by an API
    AudienceComputeSizesInputV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceComputeSizeEntityV1Resource'
      description: Input to retrieve the size of one or more audiences.
    AudienceCreateEntityV1:
      required:
      - advertiserId
      - algebra
      - name
      type: object
      properties:
        advertiserId:
          type: string
          description: Advertiser associated to the audience
        algebra:
          $ref: '#/components/schemas/AlgebraNodeV1'
        description:
          type: string
          description: Description of the audience
        name:
          type: string
          description: Name of the audience
      description: Audience of people of interest for a marketer.
    AudienceCreateEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceCreateEntityV1'
        type:
          type: string
      description: A top-level object that encapsulates a Criteo API response for a single value
    AudienceDeleteEntityV1:
      type: object
      description: Audience to delete
      x-criteo-canonical:
        infoType: entity
        name: Audience
        version: v1
    AudienceDeleteEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceDeleteEntityV1'
        id:
          type: string
          description: Id of the entity
        type:
          type: string
      description: A class that represents a domain entity exposed by an API
    AudienceEntityV1:
      type: object
      properties:
        adSetIds:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Ad sets associated to the audience
          nullable: true
        advertiserId:
          type: string
          description: Advertiser associated to the audience
          nullable: true
        algebra:
          $ref: '#/components/schemas/AlgebraNodeV1'
        createdAt:
          type: string
          description: ISO-8601 timestamp in UTC of audience creation (read-only)
          format: date-time
          nullable: true
        description:
          type: string
          description: Description of the audience
          nullable: true
        name:
          type: string
          description: Name of the audience
          nullable: true
        updatedAt:
          type: string
          description: ISO-8601 timestamp in UTC of audience update (read-only)
          format: date-time
          nullable: true
      description: Audience of people of interest for a marketer.
      nullable: true
      x-criteo-canonical:
        infoType: entity
        name: Audience
        version: v1
    AudienceEntityV1AudienceSearchMetadataV1ListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceEntityV1Resource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        meta:
          $ref: '#/components/schemas/AudienceSearchMetadataV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities and metadata
    AudienceEntityV1ListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceEntityV1Resource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities
    AudienceEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceEntityV1'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API
    AudienceError:
      required:
      - code
      - instance
      - type
      type: object
      properties:
        code:
          type: string
          description: (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case.
        detail:
          type: string
          description: (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem
          nullable: true
        instance:
          type: string
          description: (REQUIRED) A URI reference that identifies the specific occurrence of the problem
        source:
          type: object
          description: (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s)
          nullable: true
        stackTrace:
          type: array
          items:
            type: string
          description: (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology
          nullable: true
        title:
          type: string
          description: (RECOMMENDED) A short, human-readable summary of the problem type
          nullable: true
        traceId:
          type: string
          description: (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.
          nullable: true
        type:
          enum:
          - access-control
          - authentication
          - authorization
          - availability
          - deprecation
          - quota
          - validation
          type: string
          description: (REQUIRED) The classification of the error
      description: Definition of an audience error
    AudienceEstimateSizeEntityV1:
      required:
      - advertiserId
      - algebra
      type: object
      properties:
        advertiserId:
          type: string
          description: Advertiser associated to the audience
        algebra:
          $ref: '#/components/schemas/AlgebraNodeV1'
      description: Audience of people of interest for a marketer.
    AudienceEstimateSizeEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceEstimateSizeEntityV1'
        type:
          type: string
      description: A top-level object that encapsulates a Criteo API response for a single value
    AudienceEstimateSizeInputV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AudienceEstimateSizeEntityV1Resource'
      description: Input to estimate the size of an audience.
    AudienceIdEntityV1:
      type: object
      description: Audience entity with only its ID
      nullable: true
      x-criteo-canonical:
        infoType: entity
        name: Audience
        version: v1
    AudienceIdEntityV1ListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceIdEntityV1Resource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities
    AudienceIdEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceIdEntityV1'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API
    AudienceNameDescription:
      type: object
      properties:
        description:
          type: string
          description: The description of the audience
          nullable: true
        name:
          type: string
          description: The name to designate the audience by
          nullable: true
      description: Description of an audience with name and detailed description
      nullable: true
    AudienceSearchEntityV1:
      type: object
      properties:
        adSetIds:
          type: array
          items:
            type: string
          description: List of AdSet ids
        advertiserIds:
          type: array
          items:
            type: string
          description: List of advertiser ids
        audienceIds:
          type: array
          items:
            type: string
          description: List of audience ids
        audienceSegmentIds:
          type: array
          items:
            type: string
          description: List of segment ids (linked to the result audiences)
      description: Available filters to perform a search on segments. If present, the filters are AND'ed together when applied.
    AudienceSearchEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceSearchEntityV1'
        type:
          type: string
      description: A top-level object that encapsulates a Criteo API response for a single value
    AudienceSearchInputV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AudienceSearchEntityV1Resource'
      description: Audience search parameter
    AudienceSearchMetadataV1:
      type: object
      properties:
        limit:
          type: integer
          description: Max item of the current page
          format: int32
          nullable: true
        offset:
          type: integer
          description: Number of item to skip
          format: int32
          nullable: true
        totalItems:
          type: integer
          description: Total number of items
          format: int32
          nullable: true
      description: Metadata for the audience search response.
      nullable: true
    AudienceSegmentBulkCreateInputV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceSegmentCreateEntityV1Resource'
      description: Input to create one or more audience segments.
    AudienceSegmentBulkDeleteInputV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceSegmentDeleteEntityV1Resource'
      description: Input to delete one or more segments.
    AudienceSegmentBulkUpdateInputV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceSegmentUpdateEntityV1Resource'
      description: Input to update one or more segments.
    AudienceSegmentComputeSizeEntityV1:
      type: object
      description: Set of rules that defines specific people to target.
      x-criteo-canonical:
        infoType: entity
        name: AudienceSegment
        version: v1
    AudienceSegmentComputeSizeEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceSegmentComputeSizeEntityV1'
        id:
          type: string
          description: Id of the entity
        type:
          type: string
      description: A class that represents a domain entity exposed by an API
    AudienceSegmentComputeSizesInputV1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceSegmentComputeSizeEntityV1Resource'
      description: Input to retrieve the size of one or more segments.
    AudienceSegmentCreateEntityV1:
      required:
      - advertiserId
      - name
      type: object
      properties:
        advertiserId:
          type: string
          description: Advertiser associated to the segment
        contactList:
          $ref: '#/components/schemas/ContactListCreateV1'
        description:
          type: string
          description: Description of the segment
        inMarket:
          $ref: '#/components/schemas/InMarketCreateV1'
        location:
          $ref: '#/components/schemas/LocationCreateV1'
        lookalike:
          $ref: '#/components/schemas/LookalikeCreateV1'
        name:
          type: string
          description: Name of the segment
        prospecting:
          $ref: '#/components/schemas/ProspectingCreateV1'
        retargeting:
          $ref: '#/components/schemas/RetargetingCreateV1'
      description: Set of rules that defines specific people to target.
    AudienceSegmentCreateEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceSegmentCreateEntityV1'
        type:
          type: string
      description: A top-level object that encapsulates a Criteo API response for a single value
    AudienceSegmentDeleteEntityV1:
      type: object
      description: Segment to delete
      x-criteo-canonical:
        infoType: entity
        name: AudienceSegment
        version: v1
    AudienceSegmentDeleteEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceSegmentDeleteEntityV1'
        id:
          type: string
          description: Id of the entity
        type:
          type: string
      description: A class that represents a domain entity exposed by an API
    AudienceSegmentEntityV1:
      type: object
      properties:
        advertiserId:
          type: string
          description: Advertiser associated to the segment
          nullable: true
        behavioral:
          $ref: '#/components/schemas/BehavioralV1'
        contactList:
          $ref: '#/components/schemas/ContactListV1'
        createdAt:
          type: string
          description: ISO-8601 timestamp in UTC of segment creation (read-only)
          format: date-time
          nullable: true
        description:
          type: string
          description: Description of the segment
          nullable: true
        inMarket:
          $ref: '#/components/schemas/InMarketV1'
        location:
          $ref: '#/components/schemas/LocationV1'
        lookalike:
          $ref: '#/components/schemas/LookalikeV1'
        name:
          type: string
          description: Name of the segment
          nullable: true
        prospecting:
          $ref: '#/components/schemas/ProspectingV1'
        retargeting:
          $ref: '#/components/schemas/RetargetingV1'
        type:
          enum:
          - Unknown
          - InMarket
          - Prospecting
          - ContactList
          - Location
          - Behavioral
          - Retargeting
          - Lookalike
          type: string
          description: Type of segment (read-only)
          nullable: true
        updatedAt:
          type: string
          description: ISO-8601 timestamp in UTC of segment update (read-only)
          format: date-time
          nullable: true
      description: Set of rules that defines specific people to target.
      nullable: true
      x-criteo-canonical:
        infoType: entity
        name: AudienceSegment
        version: v1
    AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceSegmentEntityV1Resource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        meta:
          $ref: '#/components/schemas/AudienceSegmentSearchMetadataV1'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities and metadata
    AudienceSegmentEntityV1ListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceSegmentEntityV1Resource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities
    AudienceSegmentEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceSegmentEntityV1'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API
    AudienceSegmentEstimateSizeInputV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AudienceSegmentSizeEstimationEntityV1Resource'
      description: Input to estimate the size of an audience segment..
    AudienceSegmentIdEntityV1:
      type: object
      description: Audience Segment entity only with its ID
      nullable: true
      x-criteo-canonical:
        infoType: entity
        name: AudienceSegment
        version: v1
    AudienceSegmentIdEntityV1ListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceSegmentIdEntityV1Resource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities
    AudienceSegmentIdEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceSegmentIdEntityV1'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API
    AudienceSegmentSearchEntityV1:
      type: object
      properties:
        advertiserIds:
          type: array
          items:
            type: string
          description: List of advertiser ids
        audienceSegmentIds:
          type: array
          items:
            type: string
          description: List of segment ids
        audienceSegmentTypes:
          type: array
          items:
            enum:
            - Unknown
            - InMarket
            - Prospecting
            - ContactList
            - Location
            - Behavioral
            - Retargeting
            - Lookalike
            type: string
          description: List of segment types
      description: Available filters to perform a search on audience segments. If present, the filters are AND'ed together when applied.
    AudienceSegmentSearchEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceSegmentSearchEntityV1'
        type:
          type: string
      description: A top-level object that encapsulates a Criteo API response for a single value
    AudienceSegmentSearchInputV1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AudienceSegmentSearchEntityV1Resource'
      description: Audience segment search parameter
    AudienceSegmentSearchMetadataV1:
      type: object
      properties:
        limit:
          type: integer
          description: Max item of the current page
          format: int32
          nullable: true
        offset:
          type: integer
          description: Number of item to skip
          format: int32
          nullable: true
        totalItems:
          type: integer
          description: Total number of items
          format: int32
          nullable: true
      description: Metadata for the audience segment search response.
      nullable: true
    AudienceSegmentSizeEntityV1:
      type: object
      properties:
        size:
          type: integer
          format: int64
          nullable: true
      description: Set of rules that defines specific people to target.
      nullable: true
      x-criteo-canonical:
        infoType: entity
        name: AudienceSegmentSize
        version: v1
    AudienceSegmentSizeEntityV1ListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceSegmentSizeEntityV1Resource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities
    AudienceSegmentSizeEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceSegmentSizeEntityV1'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API
    AudienceSegmentSizeEstimationEntityV1:
      required:
      - advertiserId
      type: object
      properties:
        advertiserId:
          type: string
          description: Advertiser associated to the segment
        inMarket:
          $ref: '#/components/schemas/InMarketSizeEstimationV1'
        location:
          $ref: '#/components/schemas/LocationSizeEstimationV1'
      description: Set of rules that defines specific people to target.
    AudienceSegmentSizeEstimationEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceSegmentSizeEstimationEntityV1'
        type:
          type: string
      description: A top-level object that encapsulates a Criteo API response for a single value
    AudienceSegmentSizeEstimationV1:
      type: object
      properties:
        size:
          type: integer
          format: int64
          nullable: true
      description: Segment size estimation
      nullable: true
    AudienceSegmentSizeEstimationV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceSegmentSizeEstimationV1'
        type:
          type: string
          nullable: true
      description: A top-level object that encapsulates a Criteo API response for a single value
      nullable: true
    AudienceSegmentSizeEstimationV1Response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AudienceSegmentSizeEstimationV1Resource'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single value
    AudienceSegmentUpdateEntityV1:
      type: object
      properties:
        description:
          $ref: '#/components/schemas/NillableString'
        inMarket:
          $ref: '#/components/schemas/InMarketUpdateV1'
        location:
          $ref: '#/components/schemas/LocationUpdateV1'
        lookalike:
          $ref: '#/components/schemas/LookalikeUpdateV1'
        name:
          type: string
          description: Name of the segment
        prospecting:
          $ref: '#/components/schemas/ProspectingUpdateV1'
        retargeting:
          $ref: '#/components/schemas/RetargetingUpdateV1'
      description: Set of rules that defines specific people to target.
      x-criteo-canonical:
        infoType: entity
        name: AudienceSegment
        version: v1
    AudienceSegmentUpdateEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceSegmentUpdateEntityV1'
        id:
          type: string
          description: Id of the entity
        type:
          type: string
      description: A class that represents a domain entity exposed by an API
    AudienceSizeEntityV1:
      type: object
      properties:
        size:
          type: integer
          format: int64
          nullable: true
      description: Audience entity only with its size
      nullable: true
      x-criteo-canonical:
        infoType: entity
        name: AudienceSize
        version: v1
    AudienceSizeEntityV1ListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AudienceSizeEntityV1Resource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities
    AudienceSizeEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceSizeEntityV1'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API
    AudienceSizeEstimationV1:
      type: object
      properties:
        size:
          type: integer
          format: int64
          nullable: true
      description: Audience size estimation
      nullable: true
    AudienceSizeEstimationV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceSizeEstimationV1'
        type:
          type: string
          nullable: true
      description: A top-level object that encapsulates a Criteo API response for a single value
      nullable: true
    AudienceSizeEstimationV1Response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AudienceSizeEstimationV1Resource'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single value
    AudienceUpdateEntityV1:
      type: object
      properties:
        algebra:
          $ref: '#/components/schemas/AlgebraNodeV1'
        description:
          $ref: '#/components/schemas/NillableString'
        name:
          type: string
          description: Name of the audience
      description: Audience of people of interest for a marketer.
      x-criteo-canonical:
        infoType: entity
        name: Audience
        version: v1
    AudienceUpdateEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceUpdateEntityV1'
        id:
          type: string
          description: Id of the entity
        type:
          type: string
      description: A class that represents a domain entity exposed by an API
    AudienceWarning:
      required:
      - code
      - detail
      - instance
      - type
      type: object
      properties:
        code:
          type: string
          description: (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case.
        detail:
          type: string
          description: (REQUIRED) A human-readable explanation specific to this occurrence of the problem
        instance:
          type: string
          description: (REQUIRED) A URI reference that identifies the specific occurrence of the problem
        source:
          type: object
          description: (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s)
          nullable: true
        stackTrace:
          type: array
          items:
            type: string
          description: (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology
          nullable: true
        title:
          type: string
          description: (RECOMMENDED) A short, human-readable summary of the problem type
          nullable: true
        traceId:
          type: string
          description: (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.
          nullable: true
        type:
          enum:
          - access-control
          - authentication
          - authorization
          - availability
          - deprecation
          - quota
          - validation
          type: string
          description: (REQUIRED) The classification of the error
      description: Definition of the warning
    AutomatedBudgetConfigurationV23Q1:
      type: object
      properties:
        adSetOptimizationObjective:
          enum:
          - conversions
          - revenue
          - visits
          - videoViews
          type: string
          description: "Optimization objective used to automate budget allocation across ad sets.\r\nExpected when budgetAutomation.enabled is true.\r\nPossible values are \"conversions\", \"revenue\", \"visits\", and \"videoViews\"."
          nullable: true
      description: Detailed configuration used when campaign budget automation is enabled.
      nullable: true
    BasicAudienceDefinition:
      required:
      - id
      - type
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AudienceNameDescription'
        id:
          type: string
          description: the id of the entity type
        type:
          type: string
          description: the name of the entity type
      description: Common definition of an audience
    BehavioralV1:
      required:
      - category
      type: object
      properties:
        category:
          enum:
          - Unknown
          - Lifestyles
          - LifeEvents
          - Seasonal
          - BuyingPatterns
          type: string
          description: The type of behavioral
        country:
          type: string
          description: The users' country
          nullable: true
        endDate:
          type: string
          description: Desired date when the behavioral will end
          format: date-time
          nullable: true
        startDate:
          type: string
          description: Desired date when the behavioral will start
          format: date-time
          nullable: true
      description: Settings of a behavioral set of users provided by Criteo.
      nullable: true
    BoostedAdProductSet:
      required:
      - adId
      - boostingFactor
      - modificationDate
      - productSetId
      type: object
      properties:
        adId:
          type: string
        boostingFactor:
          type: number
          format: double
        modificationDate:
          type: string
        productSetId:
          type: string
      description: Encapsulate a boosted ad product set association and its configuration
      nullable: true
    BoostingConfigurationRequest:
      required:
      - boostingFactor
      type: object
      properties:
        boostingFactor:
          type: number
          format: double
      description: Encapsulate the parameters needed to create or update a boosting configuration
    BudgetAutomation:
      type: object
      properties:
        budgetConfiguration:
          $ref: '#/components/schemas/BudgetAutomationConfiguration'
        enabled:
          type: boolean
          description: "Whether budget automation is active for this marketing campaign.\r\n- true: budget automation is enabled and \"budgetConfiguration\" must be provided with a valid objective.\r\n- 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.\r\nIf \"enabled\" is omitted and only \"budgetConfiguration\" is provided, \"enabled\" defaults to false — budget automation will not be activated.\r\nTo activate budget automation at creation, \"enabled\" must be explicitly set to true along with a valid \"budgetConfiguration\".\r\nIf the entire \"budgetAutomation\" object is omitted from the create request, the campaign is created with budget automation disabled."
    BudgetAutomationConfiguration:
      type: object
      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.\r\n- \"conversions\": optimize for conversion events.\r\n- \"revenue\": optimize for revenue.\r\n- \"visits\": optimize for site visits.\r\n- \"videoViews\": optimize for completed video views."
      description: "Configuration for budget automation. Only meaningful when \"enabled\" is true.\r\nWhen \"enabled\" is false or omitted, this field is ignored."
      nullable: true
    CampaignBudgetAutomationV23Q1:
      type: object
      properties:
        automatedBudgetConfiguration:
          $ref: '#/components/schemas/AutomatedBudgetConfigurationV23Q1'
        enabled:
          type: boolean
          description: Whether budget automation is enabled for this campaign. This field is always present in the response.
          nullable: true
      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.\r\nWhen enabled is false, automatedBudgetConfiguration is null.\r\nWhen enabled is true, automatedBudgetConfiguration.adSetOptimizationObjective is expected."
      nullable: true
    CampaignScheduledSpendLimitV23Q1:
      type: object
      properties:
        id:
          type: string
          description: Identifier of the scheduled spend limit, for example "12345".
          nullable: true
        spendLimitAmount:
          $ref: '#/components/schemas/NillableDecimal'
        spendLimitRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          type: string
          description: "The period over which the campaign spend limit is applied.\r\n- \"daily\", \"monthly\", and \"lifetime\" are valid when spendLimitType is \"capped\".\r\n- \"undefined\" is returned when spendLimitType is \"uncapped\"."
          nullable: true
        spendLimitType:
          enum:
          - capped
          - uncapped
          type: string
          description: "Controls whether the campaign has a spend limit.\r\n- \"capped\": a spend limit applies, spendLimitAmount.value is non-null, and spendLimitRenewal is \"daily\", \"monthly\", or \"lifetime\".\r\n- \"uncapped\": no spend limit applies, spendLimitAmount.value is null, and spendLimitRenewal is \"undefined\"."
          nullable: true
        startDate:
          type: string
          description: Advertiser-local calendar date when the scheduled spend limit becomes active, for example "2026-08-01".
          format: date
          nullable: true
      description: A campaign spend limit scheduled to become active on the specified "startDate".
    CampaignSearchFiltersV23Q1:
      type: object
      properties:
        advertiserIds:
          type: array
          items:
            type: string
          description: Advertiser IDs to filter on (string-encoded integers).
          nullable: true
        campaignIds:
          type: array
          items:
            type: string
          description: Campaign IDs to filter on (string-encoded integers).
          nullable: true
      description: "Filters for searching campaigns.\r\n            \r\nMultiple filters are combined with an implicit AND operation.\r\nIdentifiers are string-encoded integers; invalid values are ignored.\r\nIf no filter is provided (both arrays are null or empty), the search returns all accessible campaigns."
    CampaignSearchRequestV23Q1:
      type: object
      properties:
        filters:
          $ref: '#/components/schemas/CampaignSearchFiltersV23Q1'
      description: Request payload for the campaign search endpoint.
    CampaignSpendLimitV23Q1:
      type: object
      properties:
        spendLimitAmount:
          $ref: '#/components/schemas/NillableDecimal'
        spendLimitRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          type: string
          description: "The period over which the campaign spend limit is applied.\r\nWhen spendLimitType is \"capped\", this is \"daily\", \"monthly\", or \"lifetime\".\r\nWhen spendLimitType is \"uncapped\", this is \"undefined\"."
          nullable: true
        spendLimitType:
          enum:
          - capped
          - uncapped
          type: string
          description: "Controls whether the campaign has a spend limit.\r\n\"capped\" returns a non-null spendLimitAmount.value and a spendLimitRenewal of \"daily\", \"monthly\", or \"lifetime\".\r\n\"uncapped\" returns spendLimitAmount.value as null and spendLimitRenewal as \"undefined\"."
          nullable: true
      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.
      nullable: true
    CampaignV23Q1:
      type: object
      properties:
        advertiserId:
          type: string
          description: Advertiser id of the campaign (string-encoded integer)
          nullable: true
        budgetAutomation:
          $ref: '#/components/schemas/CampaignBudgetAutomationV23Q1'
        goal:
          enum:
          - unspecified
          - acquisition
          - retention
          type: string
          description: "Goal of the campaign\r\n            \r\nSerialized values are {unspecified}, {acquisition} and {retention}.\r\n            \r\nAcquisition and retention are defined as follows:\r\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.\r\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."
          nullable: true
        id:
          type: string
          description: Id of the entity (duplicate of the parent id).
          nullable: true
        name:
          type: string
          description: Name of the campaign
          nullable: true
        scheduledSpendLimits:
          type: array
          items:
            $ref: '#/components/schemas/CampaignScheduledSpendLimitV23Q1'
          description: Spend limits scheduled to become active in the future. Empty when the campaign has no scheduled spend limits.
          nullable: true
        spendLimit:
          $ref: '#/components/schemas/CampaignSpendLimitV23Q1'
      description: "Campaign read model\r\n            \r\nThe {id} field is the campaign identifier (string-encoded integer)."
      nullable: true
    CampaignV23Q1ListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CampaignV23Q1Resource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: Data model for a list of response resources
    CampaignV23Q1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CampaignV23Q1'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          description: Canonical type name of the entity
          nullable: true
          example: Campaign
      description: Data model for a Resource
      nullable: true
    CampaignV23Q1Response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CampaignV23Q1Resource'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: Data model for response resource
    CommonProblem:
      type: object
      properties:
        code:
          type: string
          description: A machine-readable error code, expressed as a string value.
          nullable: true
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem
          nullable: true
        instance:
          type: string
          description: A URI that identifies the specific occurrence of the problem.
          nullable: true
        source:
          type: object
          additionalProperties:
            type: string
          description: A machine-readable structure to reference to the exact location(s) causing the error(s)
          nullable: true
        stackTrace:
          type: string
          nullable: true
        title:
          type: string
          description: A short human-readable description of the problem type
          nullable: true
        traceId:
          type: string
          description: The request correlation ID this problem comes from.
          nullable: true
        traceIdentifier:
          type: string
          description: The request correlation ID this problem comes from. (deprecated, use traceId instead)
          nullable: true
        type:
          enum:
          - unknown
          - access-control
          - authentication
          - authorization
          - availability
          - deprecation
          - quota
          - validation
          type: string
          description: The problem's category.
          nullable: true
      description: Common problem object.
    ContactlistAmendment:
      required:
      - attributes
      - type
      type: object
      properties:
        attributes:
          required:
          - identifiers
          - operation
          type: object
          properties:
            gumCallerId:
              type: integer
              description: The Gum caller id of the advertiser patching identifiers of type Gum
            identifiers:
              type: array
              items:
                type: string
              description: The users to add or remove, each in the schema specified
            identifierType:
              enum:
              - email
              - madid
              - identityLink
              - gum
              - phoneNumber
              type: string
              description: What type of identifiers are used
            operation:
              enum:
              - add
              - remove
              type: string
              description: Operation to add or remove users
          description: the name of the entity type
        type:
          type: string
          description: User List
          example: ContactlistAmendment
      description: Parameters for the amendment of a contactlist
    ContactlistAmendmentRequest:
      required:
      - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ContactlistAmendment'
      description: Request for a contactlist amendment
    ContactListCreateV1:
      type: object
      description: Settings to target users with your contact lists.
    ContactlistOperation:
      required:
      - attributes
      - type
      type: object
      properties:
        attributes:
          required:
          - operation
          type: object
          properties:
            contactListId:
              type: integer
              description: the affected user list id
              nullable: true
            identifierType:
              type: string
              description: The schema specified for of the identifiers
              nullable: true
            nbInvalidIdentifiers:
              type: integer
              description: How many identifiers were invalid for the specified schema
              nullable: true
            nbValidIdentifiers:
              type: integer
              description: How many identifiers were valid for the specified schema
              nullable: true
            operation:
              type: string
              description: The action recorded
            requestDate:
              type: string
              description: When the action was recorded
              format: date-time
              nullable: true
            sampleInvalidIdentifiers:
              type: array
              items:
                type: string
              description: A sample of invalid identifiers if there is some
              nullable: true
          description: the contactlist operation attributes
        type:
          type: string
          description: the name of the entity type
      description: Response definition of a contactlist operation
    ContactListStatisticsEntityV1:
      type: object
      properties:
        matchRate:
          type: number
          description: "Percentage of matched identifiers in the contact list.\r\nCan differ from matches/identifiers depending on the contact list type."
          format: double
          nullable: true
        numberOfIdentifiers:
          type: integer
          description: Number of identifiers in the contact list.
          format: int32
          nullable: true
        numberOfMatches:
          type: integer
          description: Number of matched identifiers in the contact list.
          format: int32
          nullable: true
      description: Contact list statistics.
      nullable: true
      x-criteo-canonical:
        infoType: entity
        name: ContactListStatistics
        version: v1
    ContactListStatisticsEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/ContactListStatisticsEntityV1'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API
      nullable: true
    ContactListStatisticsEntityV1Response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ContactListStatisticsEntityV1Resource'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single entity
    ContactListV1:
      type: object
      properties:
        isReadOnly:
          type: boolean
          description: Is the segment read-only
          nullable: true
      description: Settings to target users with your contact lists.
      nullable: true
    Coupon:
      type: object
      properties:
        adSetId:
          type: string
          description: The id of the Ad Set on which the Coupon is applied to
          nullable: true
        advertiserId:
          type: string
          description: Advertiser linked to the Coupon
          nullable: true
        author:
          type: string
          description: The login of the person who created this Coupon
          nullable: true
        description:
          type: string
          description: The description of the Coupon
          nullable: true
        endDate:
          type: string
          description: "The date when when we will stop to show this Coupon. If the end date is not specified (i.e. null) then the Coupon will go on forever\r\nString must be in ISO8601 format"
          nullable: true
        format:
          type: string
          description: 'Format of the Coupon, it can have two values: "FullFrame" or "LogoZone"'
          nullable: true
        id:
          type: string
          description: Unique identifier (duplicate of the parent id).
          nullable: true
        images:
          type: array
          items:
            $ref: '#/components/schemas/ImageSlide'
          description: List of slides containing the image URLs
          nullable: true
        landingPageUrl:
          type: string
          description: Web redirection of the landing page url
          nullable: true
        name:
          type: string
          description: The name of the Coupon
          nullable: true
        rotationsNumber:
          type: integer
          description: Number of rotations for the Coupons (from 1 to 10 times)
          format: int32
          nullable: true
        showDuration:
          type: integer
          description: Show Coupon for a duration of N seconds (between 1 and 5)
          format: int32
          nullable: true
        showEvery:
          type: integer
          description: Show the Coupon every N seconds (between 1 and 10)
          format: int32
          nullable: true
        startDate:
          type: string
          description: "The date when the Coupon will be launched\r\nString must be in ISO8601 format"
          nullable: true
        status:
          type: string
          description: The status of the Coupon
          nullable: true
      description: Coupons are static images applied on ad set which can be displayed within an ad and link to a landing page.
      nullable: true
    CouponSupportedSizes:
      type: object
      properties:
        fullFrame:
          type: array
          items:
            type: string
          description: Array of FullFrame sizes as string in width x height format
          nullable: true
        logoZone:
          type: array
          items:
            type: string
          description: Array of LogoZone sizes as string in width x height format
          nullable: true
      description: Entity containing the list of Coupon supported sizes
      nullable: true
    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
          description: The lookback window. Optional, should be specified only for attribution methods PostClick and LastClick.
          nullable: true
      description: Create model for an ad set's attribution configuration.
    CreateAdSetBiddingV26Q1:
      required:
      - costController
      type: object
      properties:
        bidAmount:
          type: number
          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
          nullable: true
        costController:
          enum:
          - COS
          - maxCPC
          - CPI
          - CPM
          - CPO
          - CPSV
          - CPV
          - dailyBudget
          - targetCPM
          type: string
          description: How spend is controlled
      description: ad set bidding create model
    CreateAdSetBudgetV26Q1:
      required:
      - budgetStrategy
      type: object
      properties:
        budgetAmount:
          type: number
          description: Maximum budget amount in the advertiser's currency per renewal period. Required non-null when capped. Must be null when uncapped.
          format: double
          nullable: true
        budgetDeliverySmoothing:
          enum:
          - accelerated
          - standard
          type: string
          description: "Pacing strategy for spending the budget within a renewal period. Only applicable when budgetStrategy is \"capped\".\r\n- \"accelerated\": spend pacing is based on delivery efficiency rather than the full budget period.\r\n- \"standard\": spread spending evenly over the renewal period.\r\nWhen 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\".\r\n- \"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.\r\n- \"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.\r\n- \"daily\", \"monthly\", \"weekly\": budget resets at the start of each period.\r\n- \"lifetime\": budget covers the entire ad set duration without resetting.\r\n- \"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.\r\n- \"capped\": spending is limited to budgetAmount. Requires budgetAmount (non-null), budgetRenewal (not \"undefined\"), and budgetDeliverySmoothing (not null).\r\n- \"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.\r\n- \"targetFullBudget\": spend toward the full budget amount within the renewal period.\r\n- \"targetAverageDailyBudget\": spend toward an average daily amount. Only supported for capped, standard, monthly budgets.\r\n- \"undefined\": no explicit pacing behavior. Required for uncapped budgets and accelerated budgets."
      description: "Budget create model for an ad set.\r\nFor \"capped\": budgetAmount (required, non-null), budgetRenewal (required, not \"undefined\"), and budgetDeliverySmoothing (required) must all be provided.\r\npacingBehavior is optional; \"targetAverageDailyBudget\" is only supported for capped, standard, monthly budgets.\r\nFor \"uncapped\": budgetAmount must be null, budgetRenewal must be \"undefined\", budgetDeliverySmoothing, budgetDeliveryWeek, and pacingBehavior must be omitted or \"undefined\".\r\nFor marketing campaigns with budget automation enabled, omit this object.\r\nIn that case, the ad set budget is initialized from the marketing campaign spend limit amount and renewal period."
    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
    CreateAdSetScheduleV26Q1:
      required:
      - startDate
      type: object
      properties:
        endDate:
          type: string
          format: date-time
          nullable: true
        startDate:
          type: string
          format: date-time
      description: ad set schedule create model
    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
    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
          description: Campaign id this ad set belongs to
          nullable: true
        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
          description: Name of the ad set
          nullable: true
        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
          description: The click tracking code associated to this Ad Set.
          nullable: true
      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
    CreateAdSetV26Q1Request:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreateAdSetV26Q1Resource'
      description: Data model for an input resources
    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
    CreateCampaign:
      required:
      - advertiserId
      - goal
      - name
      - spendLimit
      type: object
      properties:
        advertiserId:
          type: string
          description: Advertiser ID this campaign belongs to (string-encoded integer).
          nullable: true
        budgetAutomation:
          $ref: '#/components/schemas/BudgetAutomation'
        goal:
          enum:
          - Unspecified
          - Acquisition
          - Retention
          type: string
          description: "Goal of the campaign\r\n            \r\nSerialized values are {Unspecified}, {Acquisition} and {Retention}.\r\n            \r\nAcquisition and retention are defined as follows:\r\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.\r\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
          description: Name of the campaign
          nullable: true
        spendLimit:
          $ref: '#/components/schemas/CreateCampaignSpendLimit'
      description: Campaign create model.
    CreateCampaignRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreateCampaignResource'
      description: Data model for an input resources
    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
    CreateCampaignSpendLimit:
      required:
      - spendLimitType
      type: object
      properties:
        spendLimitAmount:
          type: number
          description: Maximum spend amount in the advertiser's currency per renewal period. Non-null when capped. null when uncapped.
          format: double
          nullable: true
        spendLimitRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          type: string
          description: "The period over which the spend limit is consumed.\r\n- \"daily\", \"monthly\": spend limit resets at the start of each period.\r\n- \"lifetime\": spend limit covers the entire campaign duration without resetting.\r\n- \"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.\r\n- \"capped\": spending is limited to spendLimitAmount. Requires spendLimitAmount (non-null) and spendLimitRenewal (not \"undefined\").\r\n- \"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.\r\nWhen spendLimitType is \"capped\": spendLimitAmount and spendLimitRenewal are required.\r\nWhen spendLimitType is \"uncapped\": spendLimitAmount is null and spendLimitRenewal is \"undefined\"."
    CreateCoupon:
      required:
      - adSetId
      - format
      - images
      - landingPageUrl
      - name
      - rotationsNumber
      - showDuration
      - showEvery
      - startDate
      type: object
      properties:
        adSetId:
          type: string
          description: The id of the Ad Set on which the Coupon is applied to
        description:
          type: string
          description: The description of the Coupon
          nullable: true
        endDate:
          type: string
          description: "The date when when we will stop to show this Coupon. If the end date is not specified (i.e. null) then the Coupon will go on forever\r\nString must be in ISO8601 format"
          nullable: true
        format:
          enum:
          - FullFrame
          - LogoZone
          type: string
          description: 'Format of the Coupon, it can have two values: "FullFrame" or "LogoZone"'
        images:
          type: array
          items:
            $ref: '#/components/schemas/CreateImageSlide'
          description: List of slides containing the images as a base-64 encoded string
        landingPageUrl:
          type: string
          description: Web redirection of the landing page url
        name:
          type: string
          description: The name of the Coupon
        rotationsNumber:
          maximum: 10
          minimum: 1
          type: integer
          description: Number of rotations for the Coupons (from 1 to 10 times)
          format: int32
        showDuration:
          maximum: 5
          minimum: 1
          type: integer
          description: Show Coupon for a duration of N seconds (between 1 and 5)
          format: int32
        showEvery:
          maximum: 10
          minimum: 1
          type: integer
          description: Show the Coupon every N seconds (between 1 and 10)
          format: int32
        startDate:
          type: string
          description: "The date when the coupon will be launched\r\nString must be in ISO8601 format"
      description: Entity to create a Coupon
    CreateImageSlide:
      type: object
      properties:
        height:
          type: integer
          description: Height of the Coupon slide
          format: int32
        slideBase64Strings:
          type: array
          items:
            type: string
          description: Array of images of the same size as a base-64 encoded string
          nullable: true
        width:
          type: integer
          description: Width of the Coupon slide
          format: int32
      description: Slide containing the images of the same size as a base-64 encoded string
    CreateProductFilterRequest:
      type: object
      properties:
        productSetId:
          type: string
          nullable: true
      description: Encapsulate the parameters needed to enable product filtering
    CreateProductSetRequest:
      type: object
      properties:
        datasetId:
          type: string
        isDraft:
          type: boolean
        name:
          type: string
        rules:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/ProductSetRule'
      description: Entity to create a product set
    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
    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
    Creative:
      required:
      - advertiserId
      - author
      - name
      - status
      type: object
      properties:
        adaptiveAttributes:
          $ref: '#/components/schemas/AdaptiveAttributes'
        advertiserId:
          type: string
          description: Advertiser linked to the Creative
        author:
          type: string
          description: The login of the person who created this creative (
        datasetId:
          type: string
          description: Data set id linked to the Creative
          nullable: true
        description:
          type: string
          description: The description of the creative
          nullable: true
        dynamicAttributes:
          $ref: '#/components/schemas/DynamicAttributes'
        format:
          type: string
          description: The format of the creative
          nullable: true
        htmlTagAttributes:
          $ref: '#/components/schemas/HtmlTagAttributes'
        id:
          type: string
          description: Unique identifier (duplicate of the parent id).
          nullable: true
        imageAttributes:
          $ref: '#/components/schemas/ImageAttributes'
        name:
          type: string
          description: The name of the creative
        status:
          type: string
          description: The status of the creative
      description: A creative is a project with the necessary information to display a creative
      nullable: true
    CreativeRead:
      required:
      - advertiserId
      - author
      - name
      - status
      type: object
      properties:
        adaptiveAttributes:
          $ref: '#/components/schemas/AdaptiveReadAttributes'
        advertiserId:
          type: string
          description: Advertiser linked to the Creative
        author:
          type: string
          description: The login of the person who created this creative (
        datasetId:
          type: string
          description: Data set id linked to the Creative
          nullable: true
        description:
          type: string
          description: The description of the creative
          nullable: true
        dynamicAttributes:
          $ref: '#/components/schemas/DynamicAttributes'
        format:
          type: string
          description: The format of the creative
          nullable: true
        htmlTagAttributes:
          $ref: '#/components/schemas/HtmlTagAttributes'
        imageAttributes:
          $ref: '#/components/schemas/ImageAttributes'
        name:
          type: string
          description: The name of the creative
        status:
          type: string
          description: The status of the creative
      description: A CreativeRead is a project with the necessary information to display a creative
      nullable: true
    CreativeWrite:
      required:
      - datasetId
      - format
      - name
      type: object
      properties:
        adaptiveWriteAttributes:
          $ref: '#/components/schemas/AdaptiveWriteAttributes'
        datasetId:
          type: string
          description: Dataset linked to the Creative
        description:
          type: string
          description: The description of the creative
          nullable: true
        dynamicWriteAttributes:
          $ref: '#/components/schemas/DynamicWriteAttributes'
        format:
          enum:
          - Image
          - HtmlTag
          - Dynamic
          - Adaptive
          type: string
          description: "The format of the creative\r\nYou can use \"Image\", \" HtmlTag\", \"Dynamic\" or \"Adaptive\""
        htmlTagWriteAttributes:
          $ref: '#/components/schemas/HtmlTagWriteAttributes'
        imageWriteAttributes:
          $ref: '#/components/schemas/ImageWriteAttributes'
        name:
          type: string
          description: The name of the creative
      description: Entity to create or update a creative
    CriteoApiError:
      type: object
      properties:
        code:
          enum:
          - internal-error
          - deprecated-field
          - endpoint-deprecated
          - required-field
          - invalid-date-format
          - invalid
          - invalid-ranged
          - invalid-timespan
          type: string
          description: A machine-readable error code string in kabab-case. Unique across Criteo
          nullable: true
          example: internal-error
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
          nullable: true
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem
          nullable: true
        source:
          type: object
          additionalProperties:
            type: string
          description: A machine-readable structure to reference to the exact location(s) causing the error(s).
          nullable: true
        title:
          type: string
          description: A short, human-readable remarks of the problem type.
          nullable: true
        traceId:
          type: string
          description: The correlation ID provided by the gateway
          nullable: true
        type:
          enum:
          - access_control
          - authentication
          - authorization
          - availability
          - deprecation
          - quota
          - validation
          type: string
          description: A machine-readable code specifying error category
          nullable: true
          example: access_control
      description: Criteo API response error
    CriteoApiWarning:
      type: object
      properties:
        code:
          enum:
          - internal-error
          - deprecated-field
          - endpoint-deprecated
          - required-field
          - invalid-date-format
          - invalid
          - invalid-ranged
          - invalid-timespan
          type: string
          description: A machine-readable error code string in kabab-case. Unique across Criteo
          nullable: true
          example: internal-error
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
          nullable: true
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem
          nullable: true
        title:
          type: string
          description: A short, human-readable remarks of the problem type.
          nullable: true
        traceId:
          type: string
          description: The correlation ID provided by the gateway
          nullable: true
        type:
          enum:
          - access_control
          - authentication
          - authorization
          - availability
          - deprecation
          - quota
          - validation
          type: string
          description: A machine-readable code specifying error category
          nullable: true
          example: access_control
      description: Criteo API response warning
    DeleteAudienceContactListResponse:
      required:
      - data
      - errors
      - warnings
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BasicAudienceDefinition'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/AudienceError'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/AudienceWarning'
      description: Response of a contactlist deletion
    DynamicAttributes:
      type: object
      properties:
        bodyTextColor:
          type: string
          description: "Color of the creative's body text\r\nValid hexadecimal color (e.g. \"AB00FF\")"
          nullable: true
        callsToAction:
          type: array
          items:
            type: string
          description: "A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate\r\nresponse, such as “Buy now” or “Go!”."
          nullable: true
        creativeBackgroundColor:
          type: string
          description: "Color of the creative's background\r\nValid hexadecimal color (e.g. \"AB00FF\")"
          nullable: true
        logos:
          type: array
          items:
            $ref: '#/components/schemas/ImageShape'
          description: Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net
          nullable: true
        pricesColor:
          type: string
          description: "Color of the creative's prices\r\nValid hexadecimal color (e.g. \"AB00FF\")"
          nullable: true
        primaryFont:
          type: string
          description: "Font of the primary font\r\nValid supported font like \"Arial\""
          nullable: true
        productImageDisplay:
          enum:
          - ShowFullImage
          - ZoomOnImage
          type: string
          description: "Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your product catalog images should fit inside the allocated\r\nspace (\"ShowFullImage\") or whether they should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some\r\nimage cropping."
          nullable: true
      description: The attributes specific to Dynamic creatives
      nullable: true
    DynamicWriteAttributes:
      required:
      - bodyTextColor
      - callsToAction
      - logoBase64String
      - pricesColor
      - productImageDisplay
      type: object
      properties:
        bodyTextColor:
          type: string
          description: "Color of the creative's body text\r\nValid hexadecimal color (e.g. \"AB00FF\")"
        callsToAction:
          minItems: 1
          type: array
          items:
            type: string
          description: "A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate\r\nresponse, such as “Buy now” or “Go!”."
        creativeBackgroundColor:
          type: string
          description: "Color of the creative's background\r\nValid hexadecimal color (e.g. \"AB00FF\")"
          nullable: true
        logoBase64String:
          type: string
          description: Logo image as a base-64 encoded string
        pricesColor:
          type: string
          description: "Color of the creative's prices\r\nValid hexadecimal color (e.g. \"AB00FF\")"
        primaryFont:
          type: string
          description: "Font of the primary font\r\nValid supported font like \"Arial\""
          nullable: true
        productImageDisplay:
          enum:
          - ShowFullImage
          - ZoomOnImage
          type: string
          description: "Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your product catalog images should fit inside the allocated\r\nspace (\"ShowFullImage\") or whether they should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some\r\nimage cropping."
      description: The attributes specific to create or update a Dynamic creative
    EntityOfPortfolioMessage:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/PortfolioMessage'
        id:
          type: string
          description: A opaque string containing the unique Id of the entity
          nullable: true
        meta:
          type: object
          description: A meta object that contains application-specific metadata
          nullable: true
        type:
          enum:
          - campaign
          - adset
          - ad
          - advertiser
          - agency
          - publisher
          - address
          - client
          - contact
          - industry
          type: string
          description: A string containing the entity type
          nullable: true
          example: campaign
      description: Generic Criteo API successful data model
    GetPortfolioResponse:
      type: object
      properties:
        data:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/EntityOfPortfolioMessage'
          description: The response�s primary data
          nullable: true
        errors:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/CriteoApiError'
          description: "Error list returned by the Criteo API\r\nFor successful requests it is empty"
          nullable: true
        warnings:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/CriteoApiWarning'
          description: "Warnings list returned by the Criteo API\r\nIn some situations the operations are successful but it may be useful to issue warnings to the API consumer.\r\nFor example the endpoint, entity or field is deprecated. Warnings are like compiler warnings, they indicate that problems may occur in the future."
          nullable: true
      description: Portfolio fetch Response
    HtmlTagAttributes:
      type: object
      properties:
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: An array containing the html tags
          nullable: true
      description: The attributes specific to HtmlTag creatives
      nullable: true
    HtmlTagWriteAttributes:
      required:
      - tags
      type: object
      properties:
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: An array containing the html tags
      description: The attributes specific to create or update a HtmlTag creative
    ImageAttributes:
      type: object
      properties:
        landingPageUrl:
          type: string
          description: Web redirection of the landing page url
          nullable: true
        urls:
          type: array
          items:
            type: string
          description: Array of images uploaded on demostatic.criteo.com when deploying and then static.criteo.net
          nullable: true
      description: The attributes specific to Image creatives
      nullable: true
    ImageSet:
      required:
      - images
      type: object
      properties:
        headlineText:
          type: string
          description: The headline of the image set
          nullable: true
        images:
          type: array
          items:
            $ref: '#/components/schemas/ImageShape'
          description: The images' urls with their shapes.
      description: Entity consists of multiple images in different ratios and a headline text.
    ImageSetBase64:
      required:
      - imageBase64Strings
      type: object
      properties:
        headlineText:
          type: string
          description: The headline of the image set
          nullable: true
        imageBase64Strings:
          minItems: 1
          type: array
          items:
            type: string
          description: Multiple images potentially in different shapes, each image is a base-64 encoded string.
      description: Entity consists of multiple images in different ratios as a base-64 encoded and a headline text.
    ImageShape:
      required:
      - shape
      - url
      type: object
      properties:
        shape:
          enum:
          - Horizontal
          - Vertical
          - Square
          type: string
          description: Ratio of the image
        url:
          type: string
          description: URL of the image uploaded on demostatic.criteo.com when deploying and then static.criteo.net
          format: uri
      description: Entity containing the shape and url of the image
    ImageSlide:
      type: object
      properties:
        height:
          type: integer
          description: Height of the Coupon slide
          format: int32
          nullable: true
        slideUrls:
          type: array
          items:
            type: string
          description: Array of images of the same size uploaded on demostatic.criteo.com when deploying and then static.criteo.net
          nullable: true
        width:
          type: integer
          description: Width of the Coupon slide
          format: int32
          nullable: true
      description: Slide containing the image URLs
    ImageWriteAttributes:
      required:
      - base64Strings
      - landingPageUrl
      type: object
      properties:
        base64Strings:
          minItems: 1
          type: array
          items:
            type: string
          description: Array of images as a base-64 encoded string
        landingPageUrl:
          type: string
          description: Web redirection of the landing page url
          format: uri
      description: The attributes specific to create or update an Image creative
    InMarketAudienceSegmentBrandEntityV1:
      type: object
      properties:
        name:
          type: string
          description: Name of the in-market segment brand
          nullable: true
        size:
          type: integer
          description: Size of the in-market segment brand
          format: int32
          nullable: true
      description: In-market segment brand entity
      nullable: true
      x-criteo-canonical:
        infoType: entity
        name: InMarketAudienceSegmentBrand
        version: v1
    InMarketAudienceSegmentBrandEntityV1ListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/InMarketAudienceSegmentBrandEntityV1Resource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities
    InMarketAudienceSegmentBrandEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/InMarketAudienceSegmentBrandEntityV1'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API
    InMarketAudienceSegmentInterestEntityV1:
      type: object
      properties:
        parentId:
          type: string
          description: Id of the parent in-market segment interest
          nullable: true
      description: In-market segment interest entity
      nullable: true
      x-criteo-canonical:
        infoType: entity
        name: InMarketAudienceSegmentInterest
        version: v1
    InMarketAudienceSegmentInterestEntityV1ListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/InMarketAudienceSegmentInterestEntityV1Resource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities
    InMarketAudienceSegmentInterestEntityV1Resource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/InMarketAudienceSegmentInterestEntityV1'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API
    InMarketCreateV1:
      required:
      - country
      type: object
      properties:
        brandIds:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Choose the brands your segment might be interested in
        buyingPower:
          uniqueItems: true
          type: array
          items:
            enum:
            - Low
            - Medium
            - High
            - VeryHigh
            type: string
          description: Reach people who frequently purchase high price range items to lower price range items
        country:
          type: string
          description: Reach people of a specific country
        gender:
          enum:
          - Male
          - Female
          type: string
          description: Reach people who’ve shown interest in products made for a specific gender
        interestIds:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Reach new people based on their interests
        priceRange:
          uniqueItems: true
          type: array
          items:
            enum:
            - Low
            - Medium
            - High
            type: string
          description: Reach people who’ve shown interest in products within a specific price range
      description: Settings to target users based on high shopping intents and demographics.
    InMarketSizeEstimationV1:
      required:
      - country
      type: object
      properties:
        brandIds:
          uniqueItems: true
          type: array
          items:
            type: string
        buyingPower:
          uniqueItems: true
          type: array
          items:
            enum:
            - Low
            - Medium
            - High
            - VeryHigh
            type: string
        country:
          type: string
        gender:
          enum:
          - Male
          - Female
          type: string
        interestIds:
          uniqueItems: true
          type: array
          items:
            type: string
        priceRange:
          uniqueItems: true
          type: array
          items:
            enum:
            - Low
            - Medium
            - High
            type: string
      description: Settings to target users based on high shopping intents and demographics.
    InMarketUpdateV1:
      type: object
      properties:
        brandIds:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Choose the brands your segment might be interested in
        buyingPower:
          uniqueItems: true
          type: array
          items:
            enum:
            - Low
            - Medium
            - High
            - VeryHigh
            type: string
          description: Reach people who frequently purchase high price range items to lower price range items
        country:
          type: string
          description: Reach people of a specific country
        gender:
          $ref: '#/components/schemas/NillableGenderV1'
        interestIds:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Reach new people based on their interests
        priceRange:
          uniqueItems: true
          type: array
          items:
            enum:
            - Low
            - Medium
            - High
            type: string
          description: Reach people who’ve shown interest in products within a specific price range
      description: Settings to target users based on high shopping intents and demographics.
    InMarketV1:
      type: object
      properties:
        brandIds:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Choose the brands your segment might be interested in
          nullable: true
        buyingPower:
          uniqueItems: true
          type: array
          items:
            enum:
            - Unknown
            - Low
            - Medium
            - High
            - VeryHigh
            type: string
          description: Reach people who frequently purchase high price range items to lower price range items
          nullable: true
        country:
          type: string
          description: Reach people of a specific country
          nullable: true
        gender:
          enum:
          - Unknown
          - Male
          - Female
          type: string
          description: Reach people who’ve shown interest in products made for a specific gender
          nullable: true
        interestIds:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Reach new people based on their interests
          nullable: true
        priceRange:
          uniqueItems: true
          type: array
          items:
            enum:
            - Unknown
            - Low
            - Medium
            - High
            type: string
          description: Reach people who’ve shown interest in products within a specific price range
          nullable: true
      description: Settings to target users based on high shopping intents and demographics.
      nullable: true
    LocationCreateV1:
      required:
      - pointsOfInterest
      - radiusInKm
      type: object
      properties:
        pointsOfInterest:
          type: array
          items:
            $ref: '#/components/schemas/PointOfInterestV1'
          description: Reach users which have been historically located in the given coordinates
        radiusInKm:
          type: integer
          description: The expected maximum distance in kilometers between a user and a point of interest
          format: int32
      description: Settings to target users based on their location.
    LocationSizeEstimationV1:
      required:
      - pointsOfInterest
      - radiusInKm
      type: object
      properties:
        pointsOfInterest:
          type: array
          items:
            $ref: '#/components/schemas/PointOfInterestV1'
        radiusInKm:
          type: integer
          format: int32
      description: Settings to define your audience based on their location.
    LocationUpdateV1:
      type: object
      properties:
        pointsOfInterest:
          type: array
          items:
            $ref: '#/components/schemas/PointOfInterestV1'
          description: Reach users which have been historically located in the given coordinates
        radiusInKm:
          type: integer
          description: Radius in kilometers
          format: int32
        registryType:
          enum:
          - PointOfInterest
          type: string
          description: The kind of Location audience
      description: Settings to target users based on their location.
    LocationV1:
      type: object
      properties:
        pointsOfInterest:
          type: array
          items:
            $ref: '#/components/schemas/PointOfInterestV1'
          description: Reach users which have been historically located in the given coordinates
          nullable: true
        radiusInKm:
          type: integer
          description: The expected maximum distance in kilometers between a user and a point of interest
          format: int32
          nullable: true
        registryType:
          enum:
          - Unknown
          - PointOfInterest
          type: string
          description: The kind of Location audience
          nullable: true
      description: Settings to target users based on their location.
      nullable: true
    LookalikeCreateV1:
      required:
      - seedSegmentId
      type: object
      properties:
        seedSegmentId:
          type: string
          description: Segment from which the Lookalike segment will be generated
        targetSize:
          type: integer
          description: Desired size of the generated Lookalike segment
          format: int64
      description: Settings to target users close to a given seed segment.
    LookalikeUpdateV1:
      type: object
      properties:
        targetSize:
          type: integer
          description: Desired size of the generated Lookalike segment
          format: int64
      description: Settings to target users that behave like a given seed segment
    LookalikeV1:
      type: object
      properties:
        seedSegmentId:
          type: string
          description: Segment from which the Lookalike segment will be generated
          nullable: true
        targetSize:
          type: integer
          description: Desired size of the generated Lookalike segment
          format: int64
          nullable: true
      description: Settings to target users that behave like a given seed segment
      nullable: true
    ModifyAudienceResponse:
      required:
      - data
      - errors
      - warnings
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ContactlistOperation'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/AudienceError'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/AudienceWarning'
      description: Parameters to modify an audience
    NillableAdSetTargetingRuleV26Q1:
      type: object
      properties:
        value:
          type: object
          allOf:
          - $ref: '#/components/schemas/AdSetTargetingRuleV26Q1'
          nullable: true
      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.
      nullable: true
    NillableDateTime:
      type: object
      properties:
        value:
          type: string
          format: date-time
          nullable: true
      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.
      nullable: true
    NillableDecimal:
      type: object
      properties:
        value:
          type: number
          format: double
          nullable: true
      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.
      nullable: true
    NillableGenderV1:
      type: object
      properties:
        value:
          enum:
          - Male
          - Female
          type: string
          description: The value. If missing or null the value is set to "null"
          nullable: true
      description: Placeholder object for value for which "null" is a valid business value
      nullable: true
    NillableInt32:
      type: object
      properties:
        value:
          type: integer
          description: The value. If missing or null the value is set to "null"
          format: int32
          nullable: true
      description: Placeholder object for value for which "null" is a valid business value
      nullable: true
    NillableString:
      type: object
      properties:
        value:
          type: string
          description: The string's value. If missing or null the string's value is set to "null"
          nullable: true
      description: Placeholder object for string value  for which "null" is a valid business value
      nullable: true
    Outcome:
      type: object
      properties:
        errors:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A class implementing the body of a response without data of the Criteo API as described in API Guild Guidelines
    PatchAdSetAttributionConfigurationV26Q1:
      type: object
      properties:
        attributionMethod:
          enum:
          - unknown
          - criteoAttribution
          - lastClick
          - postClick
          - sftp
          - googleAnalytics
          type: string
          description: The attribution method.
          nullable: true
        lookbackWindow:
          enum:
          - unknown
          - 30M
          - 24H
          - 7D
          - 30D
          type: string
          description: The lookback window. Optional, should be specified only for attribution methods PostClick and LastClick.
          nullable: true
      description: Patch model for an ad set's attribution configuration.
    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
          description: "Pacing strategy for spending the budget within a renewal period. Only applicable when budgetStrategy is \"capped\".\r\n- \"accelerated\": spend pacing is based on delivery efficiency rather than the full budget period.\r\n- \"standard\": spread spending evenly over the renewal period.\r\nWhen budgetStrategy is \"uncapped\", this field is not set (null in read responses, omit in create/patch requests)."
          nullable: true
        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\".\r\n- \"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.\r\n- \"undefined\": used when budgetStrategy is \"uncapped\", when budgetRenewal is not \"weekly\", or when budgetDeliverySmoothing is \"accelerated\"."
          nullable: true
        budgetRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          - weekly
          type: string
          description: "The period over which the budget is spent.\r\n- \"daily\", \"monthly\", \"weekly\": budget resets at the start of each period.\r\n- \"lifetime\": budget covers the entire ad set duration without resetting.\r\n- \"undefined\": only used when budgetStrategy is \"uncapped\" (no renewal applies). Required for capped budgets (must not be \"undefined\")."
          nullable: true
        budgetStrategy:
          enum:
          - capped
          - uncapped
          type: string
          description: "Controls whether the ad set has a spending limit.\r\n- \"capped\": spending is limited to budgetAmount. Requires budgetAmount (non-null), budgetRenewal (not \"undefined\"), and budgetDeliverySmoothing (not null).\r\n- \"uncapped\": no spending limit. budgetAmount is null, budgetRenewal is \"undefined\", and budgetDeliverySmoothing is null."
          nullable: true
        pacingBehavior:
          enum:
          - undefined
          - targetFullBudget
          - targetAverageDailyBudget
          type: string
          description: "Controls how a standard capped budget is paced.\r\n- \"targetFullBudget\": spend toward the full budget amount within the renewal period.\r\n- \"targetAverageDailyBudget\": spend toward an average daily amount. Only supported for capped, standard, monthly budgets.\r\n- \"undefined\": no explicit pacing behavior. Required for uncapped budgets and accelerated budgets."
          nullable: true
      description: "Budget patch model for an ad set. Only provided fields are updated; omitted fields are left unchanged.\r\nSwitching to \"uncapped\": set budgetStrategy to \"uncapped\" and budgetAmount.value to null. Other budget fields (budgetRenewal, budgetDeliverySmoothing, budgetDeliveryWeek, and pacingBehavior) are automatically cleared.\r\nSwitching to \"capped\": set budgetStrategy to \"capped\", budgetAmount.value to a positive number, budgetRenewal to a period, and budgetDeliverySmoothing to a pacing strategy.\r\npacingBehavior can only be set for capped budgets using standard delivery smoothing; \"targetAverageDailyBudget\" also requires monthly renewal.\r\nManual budget updates are not supported when the linked marketing campaign has budget automation enabled."
    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.
    PatchAdSetCategoryBidListRequest:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatchAdSetCategoryBidResource'
          nullable: true
      description: Data model for a list of input resources
    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
    PatchAdSetCategoryBidResultListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatchAdSetCategoryBidResultResource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: Data model for a list of response resources
    PatchAdSetCategoryBidResultResource:
      type: object
      properties:
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          description: Canonical type name of the entity
          nullable: true
          example: AdSetCategoryBid
      description: Data model for a Resource
    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.
    PatchAdSetDisplayMultiplierListRequest:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatchAdSetDisplayMultiplierResource'
          nullable: true
      description: Data model for a list of input 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
    PatchAdSetDisplayMultiplierResultListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatchAdSetDisplayMultiplierResultResource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: Data model for a list of response resources
    PatchAdSetDisplayMultiplierResultResource:
      type: object
      properties:
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          description: Canonical type name of the entity
          nullable: true
          example: AdSetDisplayMultiplier
      description: Data model for a Resource
    PatchAdSetScheduledBudgetCreationV26Q1:
      required:
      - startDate
      type: object
      properties:
        budgetAmount:
          type: number
          description: "Maximum budget amount in the advertiser's currency per renewal period.\r\nRequired when budgetStrategy is \"capped\"; must be omitted when budgetStrategy is \"uncapped\"."
          format: double
          nullable: true
        budgetDeliverySmoothing:
          enum:
          - accelerated
          - standard
          type: string
          description: "Pacing strategy for spending the budget within a renewal period. Only applicable when budgetStrategy is \"capped\".\r\n- \"accelerated\": spend pacing is based on delivery efficiency rather than the full budget period.\r\n- \"standard\": spread spending evenly over the renewal period.\r\nWhen budgetStrategy is \"uncapped\", this field is not set (null in read responses, omit in create/patch requests)."
          nullable: true
        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\".\r\n- \"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.\r\n- \"undefined\": used when budgetStrategy is \"uncapped\", when budgetRenewal is not \"weekly\", or when budgetDeliverySmoothing is \"accelerated\"."
          nullable: true
        budgetRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          - weekly
          type: string
          description: "The period over which the budget is spent.\r\n- \"daily\", \"monthly\", \"weekly\": budget resets at the start of each period.\r\n- \"lifetime\": budget covers the entire ad set duration without resetting.\r\n- \"undefined\": only used when budgetStrategy is \"uncapped\" (no renewal applies). Required for capped budgets (must not be \"undefined\")."
          nullable: true
        budgetStrategy:
          enum:
          - capped
          - uncapped
          type: string
          description: "Controls whether the ad set has a spending limit.\r\n- \"capped\": spending is limited to budgetAmount. Requires budgetAmount (non-null), budgetRenewal (not \"undefined\"), and budgetDeliverySmoothing (not null).\r\n- \"uncapped\": no spending limit. budgetAmount is null, budgetRenewal is \"undefined\", and budgetDeliverySmoothing is null."
          nullable: true
        pacingBehavior:
          enum:
          - undefined
          - targetFullBudget
          - targetAverageDailyBudget
          type: string
          description: "Controls how a standard capped budget is paced.\r\n- \"targetFullBudget\": spend toward the full budget amount within the renewal period.\r\n- \"targetAverageDailyBudget\": spend toward an average daily amount. Only supported for capped, standard, monthly budgets.\r\n- \"undefined\": no explicit pacing behavior. Required for uncapped budgets and accelerated budgets."
          nullable: true
        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\".\r\nIt contains the same fields as an active-budget patch, plus the required start date.\r\nThe start date must be strictly in the future and unique among the ad set's scheduled budgets.\r\nCreating an \"uncapped\" scheduled budget: set budgetStrategy to \"uncapped\" and omit budgetAmount.\r\nCreating 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.\r\nManual scheduled budget changes are not supported when the linked marketing campaign has budget automation enabled."
    PatchAdSetScheduledBudgetDeletionV26Q1:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: Identifier of the scheduled budget to delete.
          nullable: true
      description: Deletion of an existing scheduled budget of the ad set, identified by its "id".
    PatchAdSetScheduledBudgetUpdateV26Q1:
      required:
      - id
      type: object
      properties:
        budgetAmount:
          $ref: '#/components/schemas/NillableDecimal'
        budgetDeliverySmoothing:
          enum:
          - accelerated
          - standard
          type: string
          description: "Pacing strategy for spending the budget within a renewal period. Only applicable when budgetStrategy is \"capped\".\r\n- \"accelerated\": spend pacing is based on delivery efficiency rather than the full budget period.\r\n- \"standard\": spread spending evenly over the renewal period.\r\nWhen budgetStrategy is \"uncapped\", this field is not set (null in read responses, omit in create/patch requests)."
          nullable: true
        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\".\r\n- \"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.\r\n- \"undefined\": used when budgetStrategy is \"uncapped\", when budgetRenewal is not \"weekly\", or when budgetDeliverySmoothing is \"accelerated\"."
          nullable: true
        budgetRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          - weekly
          type: string
          description: "The period over which the budget is spent.\r\n- \"daily\", \"monthly\", \"weekly\": budget resets at the start of each period.\r\n- \"lifetime\": budget covers the entire ad set duration without resetting.\r\n- \"undefined\": only used when budgetStrategy is \"uncapped\" (no renewal applies). Required for capped budgets (must not be \"undefined\")."
          nullable: true
        budgetStrategy:
          enum:
          - capped
          - uncapped
          type: string
          description: "Controls whether the ad set has a spending limit.\r\n- \"capped\": spending is limited to budgetAmount. Requires budgetAmount (non-null), budgetRenewal (not \"undefined\"), and budgetDeliverySmoothing (not null).\r\n- \"uncapped\": no spending limit. budgetAmount is null, budgetRenewal is \"undefined\", and budgetDeliverySmoothing is null."
          nullable: true
        id:
          type: string
          description: Identifier of the scheduled budget to update.
          nullable: true
        pacingBehavior:
          enum:
          - undefined
          - targetFullBudget
          - targetAverageDailyBudget
          type: string
          description: "Controls how a standard capped budget is paced.\r\n- \"targetFullBudget\": spend toward the full budget amount within the renewal period.\r\n- \"targetAverageDailyBudget\": spend toward an average daily amount. Only supported for capped, standard, monthly budgets.\r\n- \"undefined\": no explicit pacing behavior. Required for uncapped budgets and accelerated budgets."
          nullable: true
        startDate:
          type: string
          description: "New advertiser-local calendar date when the scheduled budget becomes active. Must be strictly in the future\r\nand unique among the ad set's scheduled budgets."
          format: date
          nullable: true
      description: "A patch of an existing scheduled budget of the ad set, identified by its \"id\".\r\nOnly provided fields are updated; omitted fields are left unchanged.\r\nSwitching 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.\r\nSwitching 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.\r\nManual scheduled budget changes are not supported when the linked marketing campaign has budget automation enabled."
    PatchAdSetScheduledBudgetV26Q1:
      type: object
      properties:
        scheduledBudgetCreations:
          type: array
          items:
            $ref: '#/components/schemas/PatchAdSetScheduledBudgetCreationV26Q1'
          nullable: true
        scheduledBudgetDeletions:
          type: array
          items:
            $ref: '#/components/schemas/PatchAdSetScheduledBudgetDeletionV26Q1'
          nullable: true
        scheduledBudgetUpdates:
          type: array
          items:
            $ref: '#/components/schemas/PatchAdSetScheduledBudgetUpdateV26Q1'
          nullable: true
      description: Scheduled budget patch model for an ad set. Groups the operations (Create, Update, Delete) on the ad set's scheduled budget.
    PatchAdSetSchedulingV26Q1:
      type: object
      properties:
        endDate:
          $ref: '#/components/schemas/NillableDateTime'
        startDate:
          $ref: '#/components/schemas/NillableDateTime'
      description: Model for patching ad set scheduling.
    PatchAdSetV26Q1:
      type: object
      properties:
        attributionConfiguration:
          $ref: '#/components/schemas/PatchAdSetAttributionConfigurationV26Q1'
        bidding:
          $ref: '#/components/schemas/PatchAdSetBiddingV26Q1'
        budget:
          $ref: '#/components/schemas/PatchAdSetBudgetV26Q1'
        name:
          type: string
          description: Name of the ad set.
          nullable: true
        scheduledBudget:
          $ref: '#/components/schemas/PatchAdSetScheduledBudgetV26Q1'
        scheduling:
          $ref: '#/components/schemas/PatchAdSetSchedulingV26Q1'
        targeting:
          $ref: '#/components/schemas/AdSetTargetingV26Q1'
      description: Model for patching an ad set.
    PatchCampaign:
      type: object
      properties:
        budgetAutomation:
          $ref: '#/components/schemas/PatchMarketingCampaignBudgetAutomation'
        scheduledSpendLimit:
          $ref: '#/components/schemas/PatchCampaignScheduledSpendLimit'
        spendLimit:
          $ref: '#/components/schemas/PatchCampaignSpendLimit'
      description: "Campaign patch model.\r\nThe campaign identifier is provided in the resource {id} field (string-encoded integer) and is required."
    PatchCampaignListRequest:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatchCampaignWriteResource'
          nullable: true
      description: List of input resources
    PatchCampaignScheduledSpendLimit:
      type: object
      properties:
        scheduledSpendLimitCreations:
          type: array
          items:
            $ref: '#/components/schemas/PatchCampaignScheduledSpendLimitCreation'
          description: Scheduled spend limits to create.
          nullable: true
        scheduledSpendLimitDeletions:
          type: array
          items:
            $ref: '#/components/schemas/PatchCampaignScheduledSpendLimitDeletion'
          description: Scheduled spend limits to delete.
          nullable: true
        scheduledSpendLimitUpdates:
          type: array
          items:
            $ref: '#/components/schemas/PatchCampaignScheduledSpendLimitUpdate'
          description: Scheduled spend limits to update.
          nullable: true
      description: "Scheduled spend-limit operations for a marketing campaign (patch).\r\nCreate, update, and delete operations are applied together by the backend."
    PatchCampaignScheduledSpendLimitCreation:
      required:
      - spendLimitType
      - startDate
      type: object
      properties:
        spendLimitAmount:
          $ref: '#/components/schemas/NillableDecimal'
        spendLimitRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          type: string
          description: "The period over which the campaign spend limit is applied.\r\nWhen spendLimitType is \"capped\", this is \"daily\", \"monthly\", or \"lifetime\".\r\nWhen spendLimitType is \"uncapped\", this is \"undefined\"."
          nullable: true
        spendLimitType:
          enum:
          - capped
          - uncapped
          type: string
          description: "Controls whether the campaign has a spend limit.\r\n\"capped\" returns a non-null spendLimitAmount.value and a spendLimitRenewal of \"daily\", \"monthly\", or \"lifetime\".\r\n\"uncapped\" returns spendLimitAmount.value as null and spendLimitRenewal as \"undefined\"."
          nullable: true
        startDate:
          type: string
          description: Advertiser-local calendar date when the scheduled spend limit becomes active, for example "2026-09-01".
          format: date
          nullable: true
      description: "Scheduled spend-limit creation.\r\nThe startDate is an advertiser-local calendar date, for example 2026-09-01.\r\nWhen spendLimitType is \"capped\": spendLimitAmount and spendLimitRenewal are required.\r\nWhen spendLimitType is \"uncapped\": spendLimitAmount.value is null and spendLimitRenewal is \"undefined\".\r\nAll scheduled spend limits for the campaign must use the same spendLimitRenewal as the active spend limit.\r\nWhen spendLimitRenewal is \"monthly\", startDate must be the first day of the month."
    PatchCampaignScheduledSpendLimitDeletion:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: Identifier of the scheduled spend limit to delete.
          nullable: true
      description: Scheduled spend-limit deletion.
    PatchCampaignScheduledSpendLimitUpdate:
      required:
      - id
      - spendLimitType
      - startDate
      type: object
      properties:
        id:
          type: string
          description: Identifier of the scheduled spend limit to update.
          nullable: true
        spendLimitAmount:
          $ref: '#/components/schemas/NillableDecimal'
        spendLimitRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          type: string
          description: "The period over which the campaign spend limit is applied.\r\nWhen spendLimitType is \"capped\", this is \"daily\", \"monthly\", or \"lifetime\".\r\nWhen spendLimitType is \"uncapped\", this is \"undefined\"."
          nullable: true
        spendLimitType:
          enum:
          - capped
          - uncapped
          type: string
          description: "Controls whether the campaign has a spend limit.\r\n\"capped\" returns a non-null spendLimitAmount.value and a spendLimitRenewal of \"daily\", \"monthly\", or \"lifetime\".\r\n\"uncapped\" returns spendLimitAmount.value as null and spendLimitRenewal as \"undefined\"."
          nullable: true
        startDate:
          type: string
          description: Advertiser-local calendar date when the scheduled spend limit becomes active, for example "2026-09-01".
          format: date
          nullable: true
      description: "Scheduled spend-limit update.\r\nUpdates are full replacements: id, startDate, spendLimitType, and the capped or uncapped spend-limit values must describe the complete desired state.\r\nThe startDate is an advertiser-local calendar date, for example 2026-09-01.\r\nAll scheduled spend limits for the campaign must use the same spendLimitRenewal as the active spend limit.\r\nWhen spendLimitRenewal is \"monthly\", startDate must be the first day of the month."
    PatchCampaignSpendLimit:
      type: object
      properties:
        spendLimitAmount:
          $ref: '#/components/schemas/NillableDecimal'
        spendLimitRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          type: string
          description: "The period over which the campaign spend limit is applied.\r\nWhen spendLimitType is \"capped\", this is \"daily\", \"monthly\", or \"lifetime\".\r\nWhen spendLimitType is \"uncapped\", this is \"undefined\"."
          nullable: true
        spendLimitType:
          enum:
          - capped
          - uncapped
          type: string
          description: "Controls whether the campaign has a spend limit.\r\n\"capped\" returns a non-null spendLimitAmount.value and a spendLimitRenewal of \"daily\", \"monthly\", or \"lifetime\".\r\n\"uncapped\" returns spendLimitAmount.value as null and spendLimitRenewal as \"undefined\"."
          nullable: true
      description: "Spend limit configuration for a marketing campaign (patch).\r\nOnly provided fields are updated; omitted fields are left unchanged.\r\nWhen spendLimitType is \"capped\": spendLimitAmount and spendLimitRenewal are required.\r\nWhen spendLimitType is \"uncapped\": spendLimitAmount is null and spendLimitRenewal is \"undefined\"."
    PatchCampaignWriteResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/PatchCampaign'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          description: Canonical type name of the entity
          nullable: true
          example: Campaign
      description: write model data for resources
    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.\r\nOnly provided fields are updated; omitted fields are left unchanged.\r\nIf \"enabled\" is omitted and only \"budgetConfiguration\" is provided, \"enabled\" defaults to false — budget automation will not be activated.\r\nTo activate budget automation, \"enabled\" must be explicitly set to true along with a valid \"budgetConfiguration\".\r\nTo deactivate, set \"enabled\" to false; \"budgetConfiguration\" can be omitted."
    PatchProductSetRequest:
      type: object
      properties:
        isDraft:
          type: boolean
          description: '[optional] New value of product set segment status (draft or active)'
          nullable: true
        minimumNumberOfProducts:
          type: integer
          description: '[optional] New minimum number of products of the product set to be patched. This is used to determine if the rules are valid!'
          format: int32
          nullable: true
        name:
          type: string
          description: '[optional]  New name that will be associated to the product set'
        rules:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/ProductSetRule'
          description: '[optional] New rules that will be associated to the product set'
      description: Entity to update a product set
    PatchResultCampaignListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PatchResultCampaignReadResource'
          nullable: true
          readOnly: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: List of output resources
    PatchResultCampaignReadResource:
      type: object
      properties:
        id:
          type: string
          description: Id of the entity
          nullable: true
          readOnly: true
        type:
          type: string
          nullable: true
          readOnly: true
          example: Campaign
      description: read model data for resources
    PlacementsReportQueryMessage:
      required:
      - advertiserIds
      - currency
      - dimensions
      - endDate
      - metrics
      - startDate
      type: object
      properties:
        adsetIds:
          type: string
          description: Optional list of ad set IDs to filter on. The ad sets must already exist. If empty, all ad sets will be included.
          nullable: true
        advertiserIds:
          type: string
          description: List of advertiser IDs to report on, provided as a single comma-separated string (e.g., "123,456,789"). The advertisers must already exist. If empty, all advertisers will be used.
        campaignIds:
          type: string
          description: Optional list of campaign IDs to filter on. The campaigns must already exist. If empty, all campaigns will be included.
          nullable: true
        currency:
          type: string
          description: The currency used for the report. ISO 4217 code (three-letter capitals).
        dimensions:
          minItems: 1
          type: array
          items:
            enum:
            - AdsetId
            - AdvertiserId
            - Placement
            - Environment
            - AdsetName
            - AdvertiserName
            - CampaignId
            - CampaignName
            - AdChannel
            - SocialPlatform
            - CategoryId
            - CategoryName
            type: string
          description: List of dimensions for the report. At least one dimension should be provided.
        disclosed:
          type: boolean
          description: Optionally returns disclosed or undisclosed placements.
          default: true
        endDate:
          type: string
          description: End date of the report. Date component of ISO 8601 format, any time or timezone component is ignored.
          format: date-time
        environment:
          enum:
          - Web
          - Android
          - Ios
          type: string
          description: Optional type of environment to filter on. If empty, all environments will be included.
          nullable: true
        format:
          enum:
          - csv
          - excel
          - xml
          - json
          type: string
          description: Optional file format of the generated report.
          default: json
        metrics:
          minItems: 1
          type: array
          items:
            enum:
            - Clicks
            - Displays
            - Cost
            - SalesPc30d
            - RevenuePc30d
            - CosPc30d
            - RoasPc30d
            - CpoPc30d
            - CvrPc30d
            - SalesPv1d
            - RevenuePv1d
            - CosPv1d
            - RoasPv1d
            - CpoPv1d
            - CvrPv1d
            type: string
          description: List of metrics for the report. At least one dimension should be provided.
        placement:
          type: string
          description: Optional filter on a specific placement domain name. If empty, all placements will be included.
          nullable: true
        startDate:
          type: string
          description: Start date of the report. Date component of ISO 8601 format, any time or timezone component is ignored. Must be ≤ endDate.
          format: date-time
        timezone:
          type: string
          description: Optional timezone used for the report. Timezone Database format (Tz).
          default: UTC
          nullable: true
      additionalProperties: false
      description: This is the message defining the query for Placements report
    PlacementsReportQueryMessageListRequest:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PlacementsReportQueryMessageResource'
          nullable: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API request for several value objects.
    PlacementsReportQueryMessageResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/PlacementsReportQueryMessage'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
    PointOfInterestV1:
      type: object
      properties:
        latitude:
          type: number
          description: ISO-6709 latitude (rounded at 5 decimals)
          format: double
          nullable: true
        longitude:
          type: number
          description: ISO-6709 longitude (rounded at 5 decimals)
          format: double
          nullable: true
        name:
          type: string
          description: Name of the point of interest
          nullable: true
      description: "Named coordinate defined by its latitude and longitude.\r\nLatitude and Longitude are rounded at 5 decimals."
    PortfolioMessage:
      type: object
      properties:
        advertiserName:
          type: string
          nullable: true
      description: Class with elementary info about advertiser
      nullable: true
    ProductFilterConfig:
      required:
      - adId
      - productSetId
      type: object
      properties:
        adId:
          type: string
        productSetId:
          type: string
      description: Entity to create a product filter configuration
      nullable: true
    ProductSet:
      required:
      - clientType
      - creationDate
      - datasetId
      - keepVariantProducts
      - minimumNumberOfProducts
      - name
      - numberOfProducts
      - rules
      - status
      type: object
      properties:
        clientType:
          enum:
          - Unknown
          - CGrowth
          - CMax
          type: string
          description: The client type of the product set
        creationDate:
          type: string
          description: "The creation date of the product set (UTC time in ISO8601 format). Example: \"02/25/2022 14:51:26\".\r\nCan be null if the value isn't available."
        datasetId:
          type: string
          description: The dataset to which the product set belong
        id:
          type: string
          nullable: true
        isFallbackAllowed:
          type: boolean
        keepVariantProducts:
          type: boolean
        minimumNumberOfProducts:
          type: integer
          description: "Minimum amount of products that should match the product set to consider it valid.\r\nGreater or equal than one."
          format: int32
        name:
          type: string
          description: The name of the product set
        numberOfProducts:
          type: integer
          description: "The number of products matching the product set.\r\nCan be null for newly created product set."
          format: int32
          nullable: true
        rules:
          type: array
          items:
            $ref: '#/components/schemas/ProductSetRule'
          description: The rules identifying the product belonging to the set
        status:
          enum:
          - Unknown
          - Draft
          - Pending
          - Valid
          - Invalid
          - Deleted
          type: string
          description: The status of the product set
      description: Encapsulate a group of product
      nullable: true
    ProductSetRule:
      type: object
      properties:
        field:
          enum:
          - OBSOLETE_Extradata
          - Category1
          - Category2
          - Category3
          - ExternalItemId
          - SalePrice
          - Brand
          - CustomLabel0
          - CustomLabel1
          - CustomLabel2
          - CustomLabel3
          - CustomLabel4
          type: string
          description: The field on which we want to apply the rule
          nullable: true
        operator:
          enum:
          - IsIn
          - IsNotIn
          - Between
          - NotBetween
          - LessThan
          - GreaterThan
          type: string
          description: The operator used with the field
          nullable: true
        values:
          uniqueItems: false
          type: array
          items:
            type: string
          description: The values on which we want to apply the rule
          nullable: true
      description: Encapsulate a product rule
    ProspectingCreateV1:
      required:
      - usersType
      type: object
      properties:
        daysSinceLastVisitMax:
          type: integer
          description: When non buyers are included, include users who visited your website after this number of days
          format: int32
        daysSinceLastVisitMin:
          type: integer
          description: When non buyers are included, include users who visited your website before this number of days
          format: int32
        usersType:
          enum:
          - Prospects
          - ProspectsOrNonBuyers
          type: string
          description: Type of users to target
      description: Settings to target prospecting users to website visitors.
    ProspectingUpdateV1:
      type: object
      properties:
        daysSinceLastVisitMax:
          $ref: '#/components/schemas/NillableInt32'
        daysSinceLastVisitMin:
          $ref: '#/components/schemas/NillableInt32'
        usersType:
          enum:
          - Prospects
          - ProspectsOrNonBuyers
          type: string
          description: Type of users to target
      description: Settings to target prospecting users to website visitors.
    ProspectingV1:
      type: object
      properties:
        daysSinceLastVisitMax:
          type: integer
          description: When non buyers are included, include users who visited your website after this number of days
          format: int32
          nullable: true
        daysSinceLastVisitMin:
          type: integer
          description: When non buyers are included, include users who visited your website before this number of days
          format: int32
          nullable: true
        usersType:
          enum:
          - Unknown
          - Prospects
          - ProspectsOrNonBuyers
          type: string
          description: Type of users to target
          nullable: true
      description: Settings to target prospecting users to website visitors.
      nullable: true
    ReadAdSetAttributionConfigurationV26Q1:
      type: object
      properties:
        attributionMethod:
          enum:
          - unknown
          - criteoAttribution
          - lastClick
          - postClick
          - sftp
          - googleAnalytics
          type: string
          description: "Ad set attribution method.\r\nThis defines how certain events (visits, clicks, sales...) are attributed to the ad set.\r\n            \r\nPossible values:\r\n- unknown\r\n- criteoAttribution (default attribution method)\r\n- lastClick\r\n- postClick\r\n- sftp\r\n- googleAnalytics (requires Google Analytics integration)"
          nullable: true
        lookbackWindow:
          enum:
          - unknown
          - 30M
          - 24H
          - 7D
          - 30D
          type: string
          description: The lookback window. Optional, should be specified only for attribution methods PostClick and LastClick.
          nullable: true
      description: "Read model for an ad set's attribution configuration.\r\n            \r\nThe lookback window is only set for ad sets with an attribution method that is postClick or lastClick.\r\nIt will be null with any other attribution method."
      nullable: true
    ReadAdSetBiddingV26Q1:
      type: object
      properties:
        bidAmount:
          type: number
          description: "Decimal value target relating to the `adSetObjective` specified.\r\nMay be `null` for objectives that do not require a target value.\r\nAt most 4 decimals are supported. Additional decimals are rounded."
          format: double
          nullable: true
        costController:
          enum:
          - COS
          - maxCPC
          - CPI
          - CPM
          - CPO
          - CPSV
          - CPV
          - dailyBudget
          - targetCPM
          type: string
          description: "Cost controller for the ad set.\r\n            \r\nPossible values:\r\n- COS\r\n- maxCPC\r\n- CPI\r\n- CPM\r\n- CPO\r\n- CPSV\r\n- CPV\r\n- dailyBudget\r\n- targetCPM"
          nullable: true
      description: Ad set bidding read configuration.
      nullable: true
    ReadAdSetBudgetV26Q1:
      type: object
      properties:
        budgetAmount:
          type: number
          description: Maximum budget amount in the advertiser's currency per renewal period. Required non-null when capped. Must be null when uncapped.
          format: double
          nullable: true
        budgetDeliverySmoothing:
          enum:
          - accelerated
          - standard
          type: string
          description: "Pacing strategy for spending the budget within a renewal period. Only applicable when budgetStrategy is \"capped\".\r\n- \"accelerated\": spend pacing is based on delivery efficiency rather than the full budget period.\r\n- \"standard\": spread spending evenly over the renewal period.\r\nWhen budgetStrategy is \"uncapped\", this field is not set (null in read responses, omit in create/patch requests)."
          nullable: true
        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\".\r\n- \"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.\r\n- \"undefined\": used when budgetStrategy is \"uncapped\", when budgetRenewal is not \"weekly\", or when budgetDeliverySmoothing is \"accelerated\"."
          nullable: true
        budgetRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          - weekly
          type: string
          description: "The period over which the budget is spent.\r\n- \"daily\", \"monthly\", \"weekly\": budget resets at the start of each period.\r\n- \"lifetime\": budget covers the entire ad set duration without resetting.\r\n- \"undefined\": only used when budgetStrategy is \"uncapped\" (no renewal applies). Required for capped budgets (must not be \"undefined\")."
          nullable: true
        budgetStrategy:
          enum:
          - capped
          - uncapped
          type: string
          description: "Controls whether the ad set has a spending limit.\r\n- \"capped\": spending is limited to budgetAmount. Requires budgetAmount (non-null), budgetRenewal (not \"undefined\"), and budgetDeliverySmoothing (not null).\r\n- \"uncapped\": no spending limit. budgetAmount is null, budgetRenewal is \"undefined\", and budgetDeliverySmoothing is null."
          nullable: true
        pacingBehavior:
          enum:
          - undefined
          - targetFullBudget
          - targetAverageDailyBudget
          type: string
          description: "Controls how a standard capped budget is paced.\r\n- \"targetFullBudget\": spend toward the full budget amount within the renewal period.\r\n- \"targetAverageDailyBudget\": spend toward an average daily amount. Only supported for capped, standard, monthly budgets.\r\n- \"undefined\": no explicit pacing behavior. Required for uncapped budgets and accelerated budgets."
          nullable: true
      description: "Budget configuration for an ad set. Controls how much can be spent and how spending is paced.\r\nWhen budgetStrategy is \"capped\": budgetAmount, budgetRenewal, and budgetDeliverySmoothing are all set.\r\nWhen budgetStrategy is \"uncapped\": budgetAmount is null, budgetRenewal is \"undefined\", budgetDeliverySmoothing is null, budgetDeliveryWeek is \"undefined\", and pacingBehavior is \"undefined\"."
      nullable: true
    ReadAdSetScheduledBudgetV26Q1:
      type: object
      properties:
        budgetAmount:
          type: number
          description: Maximum budget amount in the advertiser's currency per renewal period. Non-null when capped. null when uncapped.
          format: double
          nullable: true
        budgetDeliverySmoothing:
          enum:
          - accelerated
          - standard
          type: string
          description: "Pacing strategy for spending the budget within a renewal period. Only applicable when budgetStrategy is \"capped\".\r\n- \"accelerated\": spend pacing is based on delivery efficiency rather than the full budget period.\r\n- \"standard\": spread spending evenly over the renewal period.\r\nWhen budgetStrategy is \"uncapped\", this field is not set (null in read responses, omit in create/patch requests)."
          nullable: true
        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\".\r\n- \"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.\r\n- \"undefined\": used when budgetStrategy is \"uncapped\", when budgetRenewal is not \"weekly\", or when budgetDeliverySmoothing is \"accelerated\"."
          nullable: true
        budgetRenewal:
          enum:
          - undefined
          - daily
          - monthly
          - lifetime
          - weekly
          type: string
          description: "The period over which the budget is spent.\r\n- \"daily\", \"monthly\", \"weekly\": budget resets at the start of each period.\r\n- \"lifetime\": budget covers the entire ad set duration without resetting.\r\n- \"undefined\": only used when budgetStrategy is \"uncapped\" (no renewal applies). Required for capped budgets (must not be \"undefined\")."
          nullable: true
        budgetStrategy:
          enum:
          - capped
          - uncapped
          type: string
          description: "Controls whether the ad set has a spending limit.\r\n- \"capped\": spending is limited to budgetAmount. Requires budgetAmount (non-null), budgetRenewal (not \"undefined\"), and budgetDeliverySmoothing (not null).\r\n- \"uncapped\": no spending limit. budgetAmount is null, budgetRenewal is \"undefined\", and budgetDeliverySmoothing is null."
          nullable: true
        id:
          type: string
          description: Identifier of the scheduled budget.
          nullable: true
        pacingBehavior:
          enum:
          - undefined
          - targetFullBudget
          - targetAverageDailyBudget
          type: string
          description: "Controls how a standard capped budget is paced.\r\n- \"targetFullBudget\": spend toward the full budget amount within the renewal period.\r\n- \"targetAverageDailyBudget\": spend toward an average daily amount. Only supported for capped, standard, monthly budgets.\r\n- \"undefined\": no explicit pacing behavior. Use for uncapped or accelerated budgets, or omit pacingBehavior."
          nullable: true
        startDate:
          type: string
          description: Advertiser-local calendar date when the scheduled budget becomes active.
          format: date
          nullable: true
      description: "A budget configuration scheduled to replace the ad set's active budget on the specified \"startDate\".\r\nIt contains the same fields as the active budget, plus the scheduled budget identifier and start date."
    ReadAdSetScheduleV26Q1:
      type: object
      properties:
        activationStatus:
          enum:
          - 'on'
          - 'off'
          type: string
          description: Activation status of the ad set, i.e. whether the consumer wants it to deliver
          nullable: true
        deliveryStatus:
          enum:
          - draft
          - inactive
          - live
          - notLive
          - pausing
          - paused
          - scheduled
          - ended
          - notDelivering
          - archived
          type: string
          description: "Delivery status of the ad set, i.e. whether the ad set is delivering.\r\n            \r\nPossible values:\r\n- draft\r\n- inactive\r\n- live\r\n- notLive\r\n- pausing\r\n- paused\r\n- scheduled\r\n- ended\r\n- notDelivering\r\n- archived"
          nullable: true
        endDate:
          $ref: '#/components/schemas/NillableDateTime'
        startDate:
          $ref: '#/components/schemas/NillableDateTime'
      description: Ad set schedule read model
      nullable: true
    ReadAdSetV26Q1:
      type: object
      properties:
        advertiserId:
          type: string
          description: "Advertiser id of the campaign this ad set belongs to\r\nThis value is a string-encoded integer."
          nullable: true
        attributionConfiguration:
          $ref: '#/components/schemas/ReadAdSetAttributionConfigurationV26Q1'
        bidding:
          $ref: '#/components/schemas/ReadAdSetBiddingV26Q1'
        budget:
          $ref: '#/components/schemas/ReadAdSetBudgetV26Q1'
        campaignId:
          type: string
          description: "Campaign id this ad set belongs to.\r\n            \r\nThis is a key to a MarketingCampaign entity, which can be retrieved using the MarketingCampaigns endpoints.\r\nThis value is a string-encoded integer."
          nullable: true
        datasetId:
          type: string
          description: "Dataset id of this ad set\r\nThis value is a string-encoded integer."
          nullable: true
        destinationEnvironment:
          enum:
          - undefined
          - web
          - app
          type: string
          description: "The environment that an ad click will lead a user to.\r\n            \r\nPossible values:\r\n- undefined: the ad set does not specify its destination environment\r\n- web: the ad set lead users to a web page\r\n- app: the ad set lead users to an app"
          nullable: true
        mediaType:
          enum:
          - display
          - video
          type: string
          nullable: true
        name:
          type: string
          description: Name of the ad set
          nullable: true
        objective:
          enum:
          - customAction
          - clicks
          - conversions
          - displays
          - appPromotion
          - revenue
          - storeConversions
          - value
          - reach
          - visits
          - videoViews
          type: string
          description: "Ad set objective.\r\n            \r\nPossible values:\r\n- customAction (previously \"Actions\")\r\n- clicks\r\n- conversions\r\n- displays\r\n- appPromotion (previously \"Installs\")\r\n- revenue\r\n- storeConversions\r\n- value\r\n- reach (previously \"ViewedImpressions\")\r\n- visits\r\n- videoViews (previously \"CompletedVideoViews\")"
          nullable: true
        schedule:
          $ref: '#/components/schemas/ReadAdSetScheduleV26Q1'
        scheduledBudgets:
          type: array
          items:
            $ref: '#/components/schemas/ReadAdSetScheduledBudgetV26Q1'
          nullable: true
        targeting:
          $ref: '#/components/schemas/AdSetTargetingV26Q1'
        videoChannel:
          enum:
          - olv
          - ctv
          type: string
          nullable: true
      description: "Ad set read model.\r\n            \r\nThe ad set is the configuration unit that defines ads delivery. Its binds together the objective, budget,\r\nscheduling, targeting options and ads."
      nullable: true
    ReadModelAdSetId:
      type: object
      properties:
        id:
          type: string
          description: Id of the entity
          nullable: true
          readOnly: true
        type:
          type: string
          nullable: true
          readOnly: true
          example: AdSetId
      description: read model data for resources
    ReadModelAdSetIdV26Q1:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AdSetIdV26Q1'
        id:
          type: string
          description: Id of the entity
          nullable: true
          readOnly: true
        type:
          type: string
          nullable: true
          readOnly: true
          example: AdSetIdV26Q1
      description: read model data for resources
    ReadModelReadAdSetV26Q1:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/ReadAdSetV26Q1'
        id:
          type: string
          description: Id of the entity
          nullable: true
          readOnly: true
        type:
          type: string
          nullable: true
          readOnly: true
          example: ReadAdSetV26Q1
      description: read model data for resources
      nullable: true
    RequestsAdSetId:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WriteModelAdSetId'
          nullable: true
      description: List of input resources
    RequestsPatchAdSetV26Q1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WriteModelPatchAdSetV26Q1'
          nullable: true
      description: List of input resources
    ResourceCollectionOutcomeOfAd:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceOfAd'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities.
    ResourceCollectionOutcomeOfCoupon:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceOfCoupon'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities.
    ResourceCollectionOutcomeOfCreativeRead:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceOfCreativeRead'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several entities.
    ResourceCollectionOutcomeOfProductSet:
      type: object
      properties:
        data:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/ResourceOfProductSet'
          nullable: true
        errors:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A class implementing the response  of the Criteo API as described in API Guild Guidelines with collection of entities as body
    ResourceInputOfAdWrite:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfAdWrite'
      description: A top-level object that encapsulates a Criteo API request for a single entity.
    ResourceInputOfCreateCoupon:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfCreateCoupon'
      description: A top-level object that encapsulates a Criteo API request for a single entity.
    ResourceInputOfCreativeWrite:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfCreativeWrite'
      description: A top-level object that encapsulates a Criteo API request for a single entity.
    ResourceInputOfUpdateCoupon:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfUpdateCoupon'
      description: A top-level object that encapsulates a Criteo API request for a single entity.
    ResourceOfAd:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Ad'
        id:
          type: string
          description: Unique identifier of this resource.
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API.
      nullable: true
    ResourceOfAdWrite:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/AdWrite'
        id:
          type: string
          description: Unique identifier of this resource.
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API.
    ResourceOfCoupon:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Coupon'
        id:
          type: string
          description: Unique identifier of this resource.
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API.
      nullable: true
    ResourceOfCouponSupportedSizes:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CouponSupportedSizes'
        id:
          type: string
          description: Unique identifier of this resource.
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API.
      nullable: true
    ResourceOfCreateCoupon:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CreateCoupon'
        id:
          type: string
          description: Unique identifier of this resource.
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API.
    ResourceOfCreative:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/Creative'
        id:
          type: string
          description: Unique identifier of this resource.
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API.
      nullable: true
    ResourceOfCreativeRead:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CreativeRead'
        id:
          type: string
          description: Unique identifier of this resource.
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API.
    ResourceOfCreativeWrite:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CreativeWrite'
        id:
          type: string
          description: Unique identifier of this resource.
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API.
    ResourceOfProductSet:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/ProductSet'
        id:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents an entity in a guild compliant way
      nullable: true
    ResourceOfUpdateCoupon:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/UpdateCoupon'
        id:
          type: string
          description: Unique identifier of this resource.
          nullable: true
        type:
          type: string
          nullable: true
      description: A class that represents a domain entity exposed by an API.
    ResourceOutcomeOfAd:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfAd'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single entity.
    ResourceOutcomeOfCoupon:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfCoupon'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single entity.
    ResourceOutcomeOfCouponSupportedSizes:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfCouponSupportedSizes'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single entity.
    ResourceOutcomeOfCreative:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfCreative'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single entity.
    ResourceOutcomeOfProductSet:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceOfProductSet'
        errors:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          uniqueItems: false
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A class implementing the response of the Criteo API as described in API Guild Guidelines with a single entity as body
    ResponseReadAdSetV26Q1:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ReadModelReadAdSetV26Q1'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: output resource
    ResponsesAdSetId:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ReadModelAdSetId'
          nullable: true
          readOnly: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: List of output resources
    ResponsesAdSetIdV26Q1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ReadModelAdSetIdV26Q1'
          nullable: true
          readOnly: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: List of output resources
    ResponsesReadAdSetV26Q1:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ReadModelReadAdSetV26Q1'
          nullable: true
          readOnly: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: List of output resources
    RetargetingCreateV1:
      required:
      - daysSinceLastVisitMax
      - daysSinceLastVisitMin
      - visitorsType
      type: object
      properties:
        daysSinceLastVisitMax:
          type: integer
          description: Maximum number of days since last visit to partner.
          format: int32
        daysSinceLastVisitMin:
          type: integer
          description: Minimum number of days since last visit to partner.
          format: int32
        visitorsType:
          enum:
          - All
          - Buyers
          - NonBuyers
          type: string
          description: Types of visitors.
      description: Settings to target users based on its type and days since last visit.
    RetargetingUpdateV1:
      type: object
      properties:
        daysSinceLastVisitMax:
          type: integer
          description: Maximum number of days since last visit to partner.
          format: int32
        daysSinceLastVisitMin:
          type: integer
          description: Minimum number of days since last visit to partner.
          format: int32
        visitorsType:
          enum:
          - All
          - Buyers
          - NonBuyers
          type: string
          description: Types of visitors.
      description: Settings to target users based on its type and days since last visit.
    RetargetingV1:
      type: object
      properties:
        daysSinceLastVisitMax:
          type: integer
          description: Maximum number of days since last visit to partner.
          format: int32
          nullable: true
        daysSinceLastVisitMin:
          type: integer
          description: Minimum number of days since last visit to partner.
          format: int32
          nullable: true
        visitorsType:
          enum:
          - Unknown
          - All
          - Buyers
          - NonBuyers
          type: string
          description: Types of visitors.
          nullable: true
      description: Settings to target users based on its type and days since last visit.
      nullable: true
    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
    SellerBudgetMessage:
      type: object
      properties:
        amount:
          type: number
          description: Budget amount in the advertiser's currency
          format: double
          nullable: true
        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
          description: Amount spent against this budget so far, or null if not available
          format: double
          nullable: true
        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
    SellerBudgetStatusV2:
      enum:
      - Archived
      - Current
      - Scheduled
      type: string
      description: Status of a seller budget
    SellerCampaignMessage:
      type: object
      properties:
        bid:
          type: number
          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
          nullable: true
        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
          description: Timestamp when the seller-campaign was suspended. Null means the seller-campaign is active.
          format: date-time
          nullable: true
        suspensionReasons:
          type: array
          items:
            $ref: '#/components/schemas/SellerCampaignSuspensionReason'
          description: List of reasons why the seller-campaign is suspended. Null means the seller-campaign is active.
          nullable: true
      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
    SellerCampaignProductSet:
      type: object
      properties:
        productSetNumberOfProducts:
          type: integer
          description: Number of products matching the product set rules
          format: int32
          nullable: true
        productSetStatus:
          type: string
          description: Status of the product set (e.g. Active, Pending)
          nullable: true
        rules:
          type: array
          items:
            type: object
          description: Array of product set filtering rules
          nullable: true
      description: Product set targeting configuration for a seller-campaign
      nullable: true
    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).'
    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.
    Size:
      type: object
      properties:
        height:
          type: integer
          format: int32
          nullable: true
        width:
          type: integer
          format: int32
          nullable: true
      description: Size entity containing width and height of the creative
      nullable: true
    StatisticsReportQueryMessage:
      required:
      - advertiserIds
      - currency
      - dimensions
      - endDate
      - metrics
      - startDate
      type: object
      properties:
        adSetIds:
          type: array
          items:
            type: string
          description: Optional list of ad set IDs to filter on. The ad sets must already exist. If empty, all ad sets will be fetched.
          nullable: true
        adSetNames:
          type: array
          items:
            type: string
          description: Optional list of ad set names to filter on. If empty, all ad sets will be fetched.
          nullable: true
        adSetStatus:
          type: array
          items:
            enum:
            - Active
            - NotRunning
            - Dead
            type: string
          description: Optional list of ad set statuses to filter on. If empty, all ad sets will be fetched.
          nullable: true
        advertiserIds:
          type: string
          description: List of advertiser IDs to report on, provided as a single comma-separated string (e.g., "123,456,789"). The advertisers must already exist. If empty, all advertisers will be used.
        currency:
          type: string
          description: The currency used for the report. ISO 4217 code (three-letter capitals).
        dimensions:
          minItems: 1
          type: array
          items:
            enum:
            - AdsetId
            - Adset
            - AdvertiserId
            - Advertiser
            - CategoryId
            - Category
            - Hour
            - Day
            - Week
            - Month
            - Year
            - Os
            - Device
            - CampaignId
            - Campaign
            - AdId
            - Ad
            - CouponId
            - Coupon
            - MarketingObjectiveId
            - MarketingObjective
            - ChannelId
            - Channel
            - Goal
            - AdChannel
            - SocialPlatform
            type: string
          description: 'List of dimensions for the report. At least one dimension should be provided. <br/><br/> When an ID dimension is requested (e.g., AdsetId), the corresponding name dimension (e.g., Adset) is automatically included, and vice versa. This applies to the following pairs: AdsetId/Adset, AdId/Ad, AdvertiserId/Advertiser, CampaignId/Campaign, CategoryId/Category, CouponId/Coupon, MarketingObjectiveId/MarketingObjective, ChannelId/Channel.'
        endDate:
          type: string
          description: End date of the report. Date component of ISO 8601 format, any time or timezone component is ignored.
          format: date-time
        format:
          enum:
          - csv
          - excel
          - xml
          - json
          type: string
          description: Optional file format of the generated report.
          default: json
        metrics:
          type: array
          items:
            enum:
            - Clicks
            - Displays
            - AdvertiserCost
            - SalesPc30dClientAttribution
            - SalesClientAttribution
            - SalesPc30d
            - SalesAllPc30dClientAttribution
            - SalesAllClientAttribution
            - SalesAllPc30d
            - SalesPv24h
            - SalesAllPv24h
            - SalesPc30Pv24
            - SalesAllPc30Pv24
            - SalesPc30dPv24h
            - SalesAllPc30dPv24h
            - SalesPc7dPv24
            - SalesAllPc7dPv24
            - SalesLc
            - SalesAllLc
            - SalesPc7d
            - SalesAllPc7d
            - SalesPc1d
            - SalesAllPc1d
            - SalesPiPc
            - SalesPiPv
            - SalesPiPcPv
            - PostInstallSales
            - SalesOfflinePc
            - SalesOfflinePv
            - SalesOfflinePc30d
            - SalesOfflinePv24h
            - RevenueGeneratedPc30dClientAttribution
            - RevenueGeneratedClientAttribution
            - RevenueGeneratedPc30d
            - RevenueGeneratedAllPc30dClientAttribution
            - RevenueGeneratedAllClientAttribution
            - RevenueGeneratedAllPc30d
            - RevenueGeneratedPv24h
            - RevenueGeneratedAllPv24h
            - RevenueGeneratedPc30Pv24
            - RevenueGeneratedAllPc30Pv24
            - RevenueGeneratedPc30dPv24h
            - RevenueGeneratedAllPc30dPv24h
            - RevenueGeneratedPc7dPv24
            - RevenueGeneratedAllPc7dPv24
            - RevenueGeneratedLc
            - RevenueGeneratedAllLc
            - RevenueGeneratedPc7d
            - RevenueGeneratedAllPc7d
            - RevenueGeneratedPc1d
            - RevenueGeneratedAllPc1d
            - RevenueGeneratedOfflinePc
            - RevenueGeneratedOfflinePv
            - RevenueGeneratedOfflinePc30d
            - RevenueGeneratedOfflinePv24h
            - ConversionRatePc30dClientAttribution
            - ConversionRateClientAttribution
            - ConversionRatePc30d
            - ConversionRateAllPc30dClientAttribution
            - ConversionRateAllClientAttribution
            - ConversionRateAllPc30d
            - ConversionRatePv24h
            - ConversionRateAllPv24h
            - ConversionRatePc30Pv24
            - ConversionRateAllPc30Pv24
            - ConversionRatePc30dPv24h
            - ConversionRateAllPc30dPv24h
            - ConversionRatePc7dPv24
            - ConversionRateAllPc7dPv24
            - ConversionRatePc7d
            - ConversionRateAllPc7d
            - ConversionRatePc1d
            - ConversionRateAllPc1d
            - ConversionRatePiPcPv
            - PostInstallConversionRate
            - ECosPc30dClientAttribution
            - ECosClientAttribution
            - ECosPc30d
            - ECosAllPc30dClientAttribution
            - ECosAllClientAttribution
            - ECosAllPc30d
            - ECosPv24h
            - ECosAllPv24h
            - ECosPc30Pv24
            - ECosAllPc30Pv24
            - ECosPc30dPv24h
            - ECosAllPc30dPv24h
            - ECosPc7dPv24
            - ECosAllPc7dPv24
            - ECosPc7d
            - ECosAllPc7d
            - ECosPc1d
            - ECosAllPc1d
            - CostPerOrderPc30dClientAttribution
            - CostPerOrderClientAttribution
            - CostPerOrderPc30d
            - CostPerOrderAllPc30dClientAttribution
            - CostPerOrderAllClientAttribution
            - CostPerOrderAllPc30d
            - CostPerOrderPv24h
            - CostPerOrderAllPv24h
            - CostPerOrderPc30Pv24
            - CostPerOrderAllPc30Pv24
            - CostPerOrderPc30dPv24h
            - CostPerOrderAllPc30dPv24h
            - CostPerOrderPc7dPv24
            - CostPerOrderAllPc7dPv24
            - CostPerOrderPc7d
            - CostPerOrderAllPc7d
            - CostPerOrderPc1d
            - CostPerOrderAllPc1d
            - ExposedUsers
            - Audience
            - Reach
            - AverageCartPc30dClientAttribution
            - AverageCartAllPc30dClientAttribution
            - AverageCartClientAttribution
            - AverageCartAllClientAttribution
            - AverageCartPc30d
            - AverageCartAllPc30d
            - AverageCartPv24h
            - AverageCartAllPv24h
            - AverageCartPc1d
            - AverageCartAllPc1d
            - AverageCartPc7d
            - AverageCartAllPc7d
            - AverageCartPc30Pv24
            - AverageCartAllPc30Pv24
            - AverageCartPc30dPv24h
            - AverageCartAllPc30dPv24h
            - AverageCartPc7dPv24
            - AverageCartAllPc7dPv24
            - ClickThroughRate
            - ECpc
            - Cpc
            - ECpm
            - ReturnOnAdvertisingSpendingClientAttribution
            - ReturnOnAdvertisingSpendingAllClientAttribution
            - AdvertiserValue
            - AdvertiserAllValue
            - CostOfAdvertiserValue
            - CostOfAdvertiserValueAll
            - AppInstallsPcPv
            - AppInstalls
            - QualifiedVisits
            - Visits
            - VisitsPV1D
            - VisitsAllPv1d
            - OrderValuePi
            - PostInstallOrderValue
            - BounceRate
            - CostPerInstallPcPv
            - CostPerInstall
            - CostPerVisit
            - CostPerVisitPV1D
            - CostPerQualifiedVisit
            - InstallRatePcPv
            - InstallRate
            - OmnichannelRoasPc30d
            - OmnichannelRoasAllPc30d
            - OmnichannelRevenuePc30d
            - OmnichannelRevenueAllPc30d
            - OmnichannelSalesPc30d
            - OmnichannelSalesAllPc30d
            - OmnichannelRoasAllPv24h
            - OmnichannelRoasPv24h
            - OmnichannelRevenueAllPv24h
            - OmnichannelRevenuePv24h
            - OmnichannelSalesAllPv24h
            - OmnichannelSalesPv24h
            - OmnichannelRoasClientAttribution
            - OmnichannelRevenueClientAttribution
            - OmnichannelSalesClientAttribution
            - RoasAllPc30dClientAttribution
            - RoasPc30dClientAttribution
            - RoasAllClientAttribution
            - RoasClientAttribution
            - RoasAllPc30d
            - RoasPc30d
            - RoasAllPc7d
            - RoasPc7d
            - RoasAllPc1d
            - RoasPc1d
            - RoasAllPv24h
            - RoasPv24h
            - RoasPc30Pv24
            - RoasAllPc30Pv24
            - RoasPc30dPv24h
            - RoasAllPc30dPv24h
            - RoasPc7dPv24
            - RoasAllPc7dPv24
            - CostOfSalePi
            - CostPerOrderPi
            - PostInstallCostOfSale
            - PostInstallCostPerOrder
            - ReturnOnAdvertiserSpendingPi
            - PostInstallRoas
            - ReturnOnAdvertiserSpendingOfflinePc
            - ReturnOnAdvertiserSpendingOfflinePv
            - RoasOfflinePc30d
            - RoasOfflinePv24h
            - PotentialDisplays
            - OverallCompetitionWin
            - ViewableDisplays
            - NonViewableDisplays
            - UntrackableDisplays
            - Frequency
            - InvalidDisplays
            - InvalidClicks
            - ResultType
            - VideoStarted
            - VideoFirstQuartile
            - VideoMidpoint
            - VideoThirdQuartile
            - VideoCompleted
            - VideoAvoc
            - VideoStartRate
            - VideoCompletionRate
            - VideoAverageViewRate
            - VideoCpv
            - VideoCpcv
            - PotentialUsers
            - RetailerMarginEuro
            - PlatformFeeEuro
            - AllInMediaCost
            - NetMediaCost
            - Cos
            type: string
          description: List of metrics for the report. Provide at least one metric to return performance data; otherwise, the response will include only dimension-related information.
        startDate:
          type: string
          description: Start date of the report. Date component of ISO 8601 format, any time or timezone component is ignored. Must be ≤ endDate.
          format: date-time
        timezone:
          type: string
          description: Optional timezone used for the report. Timezone Database format (Tz).
          default: UTC
          nullable: true
      additionalProperties: false
      description: This is the message defining the query for Adset report
    StatsReportMessage:
      type: object
      properties:
        columns:
          type: array
          items:
            type: string
          description: List of column names for the report (e.g. campaignId, sellerId, day, impressions, clicks, cost, etc.)
          nullable: true
        data:
          type: array
          items:
            type: array
            items: {}
          description: Array of data rows, each row is an array of values matching the columns order
          nullable: true
        links:
          type: object
          description: Pagination links (empty object if no pagination)
          nullable: true
        rows:
          type: integer
          description: Total number of data rows in the report
          format: int32
          nullable: true
      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: {}
    Tag:
      type: object
      properties:
        htmlTag:
          type: string
          description: Html tag
          nullable: true
        size:
          $ref: '#/components/schemas/Size'
      description: Entity specifying the html of the tag and its size
    TransactionsReportQueryMessage:
      required:
      - advertiserIds
      - currency
      - endDate
      - startDate
      type: object
      properties:
        advertiserIds:
          type: string
          description: List of advertiser IDs to report on, provided as a single comma-separated string (e.g., "123,456,789"). The advertisers must already exist. If empty, all advertisers will be used.
        currency:
          type: string
          description: The currency used for the report. ISO 4217 code (three-letter capitals).
        endDate:
          type: string
          description: End date of the report. Date component of ISO 8601 format, any time or timezone component is ignored.
          format: date-time
        eventType:
          enum:
          - Click
          - Display
          type: string
          description: Optional event type to filter on. If empty, all event types will be included.
          nullable: true
        format:
          enum:
          - csv
          - excel
          - xml
          - json
          type: string
          description: Optional file format of the generated report.
          default: json
        startDate:
          type: string
          description: Start date of the report. Date component of ISO 8601 format, any time or timezone component is ignored. Must be ≤ endDate.
          format: date-time
        timezone:
          type: string
          description: Optional timezone used for the report. Timezone Database format (Tz).
          default: UTC
          nullable: true
      additionalProperties: false
      description: This is the message defining the query for Transaction report
    TransactionsReportQueryMessageListRequest:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TransactionsReportQueryMessageResource'
          nullable: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API request for several value objects.
    TransactionsReportQueryMessageResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/TransactionsReportQueryMessage'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
    TransparencyQueryMessage:
      required:
      - endDate
      - startDate
      type: object
      properties:
        endDate:
          type: string
          description: End date of the report. Date component of ISO 8601 format, any time or timezone component is ignored.
          format: date-time
        shouldDisplayProductIds:
          type: boolean
          description: Specify if the product ids are displayed in the report.
          default: false
        startDate:
          type: string
          description: Start date of the report. Date component of ISO 8601 format, any time or timezone component is ignored. Must be ≤ endDate.
          format: date-time
      additionalProperties: false
      description: This is the message defining the query for Transparency report
    TransparencyReport:
      required:
      - advertiserId
      - files
      - tokenValidUntil
      type: object
      properties:
        advertiserId:
          type: string
        files:
          type: array
          items:
            $ref: '#/components/schemas/TransparencyReportFile'
        tokenValidUntil:
          type: string
          format: date-time
      additionalProperties: false
      description: This is the message defining the attribute response for Transparency report
      nullable: true
    TransparencyReportFile:
      required:
      - fileName
      - url
      type: object
      properties:
        fileName:
          type: string
        url:
          type: string
      additionalProperties: false
      description: This is the message defining the file response for Transparency report
    TransparencyReportListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TransparencyReportResource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          description: Errors that occured during this call.
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          description: Warnings that occured during this call.
          nullable: true
          readOnly: true
      additionalProperties: false
      description: A top-level object that encapsulates a Criteo API response for several value objects.
    TransparencyReportResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/TransparencyReport'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
    UpdateCoupon:
      required:
      - startDate
      type: object
      properties:
        endDate:
          type: string
          description: "The date when when we will stop to show this Coupon. If the end date is not specified (i.e. null) then the Coupon will go on forever\r\nString must be in ISO8601 format"
          nullable: true
        startDate:
          type: string
          description: "The date when the Coupon will be launched\r\nString must be in ISO8601 format"
      description: Entity to edit a Coupon
    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
    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
    ValueResourceCollectionOutcomeOfBoostedAdProductSet:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ValueResourceOfBoostedAdProductSet'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several values.
    ValueResourceCollectionOutcomeOfProductFilterConfig:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ValueResourceOfProductFilterConfig'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for several values.
    ValueResourceInputOfBoostingConfigurationRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfBoostingConfigurationRequest'
      description: A top-level object that encapsulates a Criteo API request for a single value.
    ValueResourceInputOfCreateProductFilterRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfCreateProductFilterRequest'
      description: A top-level object that encapsulates a Criteo API request for a single value.
    ValueResourceInputOfCreateProductSetRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfCreateProductSetRequest'
      description: "Represents an API request message containing the usual valueResource data field,\r\ni.e. data is not an entity (no id). This can be used for association objects."
      example:
        data:
          type: CreateProductSetRequest
          attributes:
            datasetId: '0'
            name: My Product Set
            isDraft: true
            rules:
            - operator: IsIn
              field: Brand
              values:
              - MyBrand
    ValueResourceInputOfPatchProductSetRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfPatchProductSetRequest'
      description: A top-level object that encapsulates a Criteo API request for a single value
    ValueResourceOfBoostedAdProductSet:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/BoostedAdProductSet'
        type:
          type: string
          nullable: true
      description: A top-level object that encapsulates a Criteo API response for a single value.
      nullable: true
    ValueResourceOfBoostingConfigurationRequest:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/BoostingConfigurationRequest'
        type:
          type: string
          nullable: true
      description: A top-level object that encapsulates a Criteo API response for a single value.
    ValueResourceOfCreateProductFilterRequest:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CreateProductFilterRequest'
        type:
          type: string
          nullable: true
      description: A top-level object that encapsulates a Criteo API response for a single value.
    ValueResourceOfCreateProductSetRequest:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CreateProductSetRequest'
        type:
          type: string
      description: A class that represents a ValueType in a guild compliant way
    ValueResourceOfPatchProductSetRequest:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/PatchProductSetRequest'
        type:
          type: string
      description: A top-level object that encapsulates a Criteo API response for a single value
    ValueResourceOfProductFilterConfig:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/ProductFilterConfig'
        type:
          type: string
          nullable: true
      description: A top-level object that encapsulates a Criteo API response for a single value.
      nullable: true
    ValueResourceOutcomeOfBoostedAdProductSet:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfBoostedAdProductSet'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single value.
    ValueResourceOutcomeOfProductFilterConfig:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ValueResourceOfProductFilterConfig'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          nullable: true
          readOnly: true
      description: A top-level object that encapsulates a Criteo API response for a single value.
    VideoDetail:
      required:
      - duration
      - shape
      - url
      type: object
      properties:
        duration:
          type: number
          description: The duration of the video in milliseconds, the video could be trimmed if it is longer than 30000 ms.
          format: double
        shape:
          enum:
          - Horizontal
          - Vertical
          - Square
          type: string
          description: Shape of the video
        url:
          type: string
          description: URL of the video uploaded on demostatic.criteo.com when deploying and then static.criteo.net
          format: uri
      description: Entity consists of the url of the video, its duration and its shape.
    WriteModelAdSetId:
      type: object
      properties:
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          description: Canonical type name of the entity
          nullable: true
          example: AdSetId
      description: write model data for resources
    WriteModelPatchAdSetV26Q1:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/PatchAdSetV26Q1'
        id:
          type: string
          description: Id of the entity
          nullable: true
        type:
          type: string
          description: Canonical type name of the entity
          nullable: true
          example: PatchAdSetV26Q1
      description: write model data for resources
  securitySchemes:
    oauth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.criteo.com/oauth2/token
          scopes: {}
        authorizationCode:
          authorizationUrl: https://api.criteo.com/oauth2
          tokenUrl: https://api.criteo.com/oauth2/token
          scopes: {}
security:
- oauth: []
tags:
- name: Advertiser
- name: Analytics
- name: Audience
- name: Campaign
- name: Creative
- name: Gateway
- name: Reco
x-samples-languages:
- java
- python
- php
- csharp
- javascript
- curl
- ruby