Sign in
advanced_auction

Operate on item level bid options

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". <a href="/docs/api-features/modify-items-in-batch/" target="_blank">See detailed documentation here.</a> By default, the "operation user_account" is the token user_account.

Optional: Business Access: Specify an <code>ad_account_id</code> (obtained via <a href='/docs/api/v5/#operation/ad_accounts/list'>List ad accounts</a>) 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 <a href="https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts">Business Access</a> roles on the ad_account: Owner, Admin.

This endpoint is not available to all users.

post/advanced_auction/items/submit

Query parameters

ad_account_idstring

Unique identifier of an ad account.

Request body

catalog_idstring required

Catalog id pertaining to all items

Example request

{
  "catalog_id": "2680059592705",
  "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"
      ]
    }
  ]
}

Response

Response containing the results of the item bid options operations

catalog_idstring

Catalog id pertaining to all items

Example response

{
  "catalog_id": "2680059592705",
  "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"
      ]
    }
  ]
}

Changes