PIpinterest
advanced_auction

Get item bid options (POST)

Changed on

Get the bid options for a batch of retail catalog items.

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/get

Request

Query parameters

ad_account_idstring

Unique identifier of an ad account.

Request body

catalog_idstring required

Example request

{
  "items": [
    {
      "item_id": "DS0294-M",
      "language": "EN"
    }
  ]
}

Response

The request has succeeded.

catalog_idstring

Example response

{
  "items": [
    {
      "bid_options": {
        "app_type_multipliers": {
          "android_mobile": 1.1,
          "android_tablet": 1.1,
          "ipad": 1.2,
          "iphone": 1.2,
          "web": 0.9,
          "web_mobile": 0.8
        },
        "placement_multipliers": {
          "browse": 0.9,
          "search": 1.2,
          "related_pins": 1.1
        }
      },
      "item_id": "DS0294-M",
      "language": "EN"
    }
  ]
}

Changes

  • v5b698c180678aRevision changes
    • 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 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

    • warning

      removed from the / request property allOf list

    • 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 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

      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

  • v543134ca41f18Revision changes
    • warning

      added the new RELATED_PINS enum value to the ///// response property for the response status