|
| 1 | +# AdvancedAuctionApi |
| 2 | + |
| 3 | +All URIs are relative to *https://api.pinterest.com/v5* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**advancedAuctionItemsGetPost**](AdvancedAuctionApi.md#advancedAuctionItemsGetPost) | **POST** /advanced_auction/items/get | Get item bid options (POST) |
| 8 | +[**advancedAuctionItemsSubmitPost**](AdvancedAuctionApi.md#advancedAuctionItemsSubmitPost) | **POST** /advanced_auction/items/submit | Operate on item level bid options |
| 9 | + |
| 10 | + |
| 11 | + |
| 12 | +## advancedAuctionItemsGetPost |
| 13 | + |
| 14 | +> AdvancedAuctionItems advancedAuctionItemsGetPost(advancedAuctionItemsGetRequest, adAccountId) |
| 15 | +
|
| 16 | +Get item bid options (POST) |
| 17 | + |
| 18 | +Get the bid options for a batch of retail catalog items. The catalog must be owned by the \"operation user_account\". <a href=\"/docs/api-features/shopping-overview/#Update%20items%20in%20batch\" 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. |
| 19 | + |
| 20 | +### Example |
| 21 | + |
| 22 | +```java |
| 23 | +// Import classes: |
| 24 | +//import org.openapitools.client.api.AdvancedAuctionApi; |
| 25 | + |
| 26 | +AdvancedAuctionApi apiInstance = new AdvancedAuctionApi(); |
| 27 | +AdvancedAuctionItemsGetRequest advancedAuctionItemsGetRequest = new AdvancedAuctionItemsGetRequest(); // AdvancedAuctionItemsGetRequest | Request object used to get bid options values for a batch of retail catalog items |
| 28 | +String adAccountId = null; // String | Unique identifier of an ad account. |
| 29 | +try { |
| 30 | + AdvancedAuctionItems result = apiInstance.advancedAuctionItemsGetPost(advancedAuctionItemsGetRequest, adAccountId); |
| 31 | + System.out.println(result); |
| 32 | +} catch (ApiException e) { |
| 33 | + System.err.println("Exception when calling AdvancedAuctionApi#advancedAuctionItemsGetPost"); |
| 34 | + e.printStackTrace(); |
| 35 | +} |
| 36 | +``` |
| 37 | + |
| 38 | +### Parameters |
| 39 | + |
| 40 | + |
| 41 | +Name | Type | Description | Notes |
| 42 | +------------- | ------------- | ------------- | ------------- |
| 43 | + **advancedAuctionItemsGetRequest** | [**AdvancedAuctionItemsGetRequest**](AdvancedAuctionItemsGetRequest.md)| Request object used to get bid options values for a batch of retail catalog items | |
| 44 | + **adAccountId** | **String**| Unique identifier of an ad account. | [optional] [default to null] |
| 45 | + |
| 46 | +### Return type |
| 47 | + |
| 48 | +[**AdvancedAuctionItems**](AdvancedAuctionItems.md) |
| 49 | + |
| 50 | +### Authorization |
| 51 | + |
| 52 | +[pinterest_oauth2](../README.md#pinterest_oauth2) |
| 53 | + |
| 54 | +### HTTP request headers |
| 55 | + |
| 56 | +- **Content-Type**: application/json |
| 57 | +- **Accept**: application/json |
| 58 | + |
| 59 | + |
| 60 | +## advancedAuctionItemsSubmitPost |
| 61 | + |
| 62 | +> AdvancedAuctionProcessedItems advancedAuctionItemsSubmitPost(advancedAuctionItemsSubmitRequest, adAccountId) |
| 63 | +
|
| 64 | +Operate on item level bid options |
| 65 | + |
| 66 | +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. |
| 67 | + |
| 68 | +### Example |
| 69 | + |
| 70 | +```java |
| 71 | +// Import classes: |
| 72 | +//import org.openapitools.client.api.AdvancedAuctionApi; |
| 73 | + |
| 74 | +AdvancedAuctionApi apiInstance = new AdvancedAuctionApi(); |
| 75 | +AdvancedAuctionItemsSubmitRequest advancedAuctionItemsSubmitRequest = new AdvancedAuctionItemsSubmitRequest(); // AdvancedAuctionItemsSubmitRequest | Request object used to upsert or delete bid options for a batch of retail catalog items |
| 76 | +String adAccountId = null; // String | Unique identifier of an ad account. |
| 77 | +try { |
| 78 | + AdvancedAuctionProcessedItems result = apiInstance.advancedAuctionItemsSubmitPost(advancedAuctionItemsSubmitRequest, adAccountId); |
| 79 | + System.out.println(result); |
| 80 | +} catch (ApiException e) { |
| 81 | + System.err.println("Exception when calling AdvancedAuctionApi#advancedAuctionItemsSubmitPost"); |
| 82 | + e.printStackTrace(); |
| 83 | +} |
| 84 | +``` |
| 85 | + |
| 86 | +### Parameters |
| 87 | + |
| 88 | + |
| 89 | +Name | Type | Description | Notes |
| 90 | +------------- | ------------- | ------------- | ------------- |
| 91 | + **advancedAuctionItemsSubmitRequest** | [**AdvancedAuctionItemsSubmitRequest**](AdvancedAuctionItemsSubmitRequest.md)| Request object used to upsert or delete bid options for a batch of retail catalog items | |
| 92 | + **adAccountId** | **String**| Unique identifier of an ad account. | [optional] [default to null] |
| 93 | + |
| 94 | +### Return type |
| 95 | + |
| 96 | +[**AdvancedAuctionProcessedItems**](AdvancedAuctionProcessedItems.md) |
| 97 | + |
| 98 | +### Authorization |
| 99 | + |
| 100 | +[pinterest_oauth2](../README.md#pinterest_oauth2) |
| 101 | + |
| 102 | +### HTTP request headers |
| 103 | + |
| 104 | +- **Content-Type**: application/json |
| 105 | +- **Accept**: application/json |
| 106 | + |
0 commit comments