advanced_auction

Operate on item level bid options

Changed on

This endpoint supports multiple operations on a set of one or more bid options (bid price and bid adjustments for targeting categories) for retail catalog items. These advanced auction settings are applied in campaigns using objective_type CATALOG_SALES and ad groups using bid_strategy_type MAX_BID.

The catalog must be owned by the "operation user_account". See detailed documentation here. By default, the "operation user_account" is the token user_account.

Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account: Owner, Admin.

This endpoint is not available to all users.

post/advanced_auction/items/submit

Request

Query parameters

ad_account_idstring

Unique identifier of an ad account.

Request body

catalog_idstring required

Example request

{
  "items": [
    {
      "item_id": "DS0294-M",
      "country": "US",
      "language": "EN",
      "operation": "UPSERT",
      "bid_options": {
        "bid_in_micro_currency": 5000000,
        "app_type_multipliers": {
          "android_mobile": 1.1,
          "android_tablet": 1.1,
          "ipad": 1.2,
          "iphone": 1.2,
          "web": 0.9,
          "web_mobile": 0.8
        }
      },
      "update_mask": [
        "BID",
        "APP_TYPE_BID_MULTIPLIER_SET"
      ],
      "errors": [
        {
          "code": 6,
          "message": "Bid in micro currency should be non-negative"
        }
      ]
    }
  ]
}

Response

The request has succeeded.

catalog_idstring

Example response

{
  "items": [
    {
      "item_id": "DS0294-M",
      "country": "US",
      "language": "EN",
      "operation": "UPSERT",
      "bid_options": {
        "bid_in_micro_currency": 5000000,
        "app_type_multipliers": {
          "android_mobile": 1.1,
          "android_tablet": 1.1,
          "ipad": 1.2,
          "iphone": 1.2,
          "web": 0.9,
          "web_mobile": 0.8
        }
      },
      "update_mask": [
        "BID",
        "APP_TYPE_BID_MULTIPLIER_SET"
      ],
      "errors": [
        {
          "code": 6,
          "message": "Bid in micro currency should be non-negative"
        }
      ]
    }
  ]
}

Changes

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added the new required request property //////

    • breaking

      added to the request property allOf list

    • breaking

      the request property type changed from string to no type

    • breaking

      the ///// request property type changed from no type to object

    • breaking

      the ///// request property type changed from no type to object

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed subschema #2 from the ///// request property allOf list

    • warning

      removed subschema #2 from the ///// request property allOf list

    • warning

      removed the request property //

    • info

      added the new optional request property //////

    • info

      added the new optional request property //////

    • info

      removed the pattern ^\d+$ from the request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed subschema #2 from the ///// response property allOf list for the response status

    • info

      removed subschema #2 from the ///// response property allOf list for the response status

    • info

      removed subschema #2 from the ///// response property allOf list for the response status

    • info

      removed subschema #2 from the ///// response property allOf list for the response status

    • info

      the response's property pattern ^\d+$ was removed for the status

    • info

      the response's property pattern ^\d+$ was removed for the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • breaking

      added subschema #2 to the ///// request property allOf list

    • breaking

      added to the / response property oneOf list for the response status

    • breaking

      added to the / response property oneOf list for the response status

    • info

      added the new optional request property ///////

    • info

      removed subschema #2 from the / response property allOf list for the response status

    • info

      removed subschema #2 from the / response property allOf list for the response status

    • info

      added discriminator to / response property for the response status

    • info

      added discriminator to / response property for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status