Operate on item level bid options
Changed onThis 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.
Request
- Base URLhttps://api.pinterest.com/v5
- AuthOAuth 2Authorization codehttps://www.pinterest.com/oauth/Token URLhttps://api.pinterest.com/v5/oauth/tokenScopesads:write, catalogs:read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Unique identifier of an ad account.
Request body
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.
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 propertyallOflist - breaking
the
request property type changed fromstringto no type - breaking
the
/////request property type changed from no type toobject - breaking
the
/////request property type changed from no type toobject - breaking
the
response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - breaking
the
/////response's property type changed from no type toobjectfor status - breaking
the
/////response's property type changed from no type toobjectfor status - breaking
the
/////response's property type changed from no type toobjectfor status - breaking
the
/////response's property type changed from no type toobjectfor 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 #2from the/////request propertyallOflist - warning
removed
subschema #2from the/////request propertyallOflist - 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 propertyallOflist for the response status - info
added to the
response propertyallOflist for the response status - info
removed
subschema #2from the/////response propertyallOflist for the response status - info
removed
subschema #2from the/////response propertyallOflist for the response status - info
removed
subschema #2from the/////response propertyallOflist for the response status - info
removed
subschema #2from the/////response propertyallOflist 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
- breaking
added
subschema #2to the/////request propertyallOflist - breaking
added to the
/response propertyoneOflist for the response status - breaking
added to the
/response propertyoneOflist for the response status - info
added the new optional request property
/////// - info
removed
subschema #2from the/response propertyallOflist for the response status - info
removed
subschema #2from the/response propertyallOflist 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
- breaking