Skip to content

Commit 98f5be8

Browse files
committed
Regenerate all clients as per latest.
1 parent 8f66cce commit 98f5be8

File tree

36,221 files changed

+2843791
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

36,221 files changed

+2843791
-0
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
3+
# AdAccountCreateSubscriptionRequestPartnerMetadata
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**subscriberKey** | **String** | Text field value that uniquely identifies a subscriber. | [optional]
10+
11+
12+
13+
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
3+
# AdAccountsAudiencesSharedAccountsList200Response
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**items** | [**List<SharedAudienceAccount>**](SharedAudienceAccount.md) | |
10+
**bookmark** | **String** | | [optional]
11+
12+
13+
14+
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
3+
# AdsAnalyticsAdTargetingType
4+
5+
## Enum
6+
7+
8+
9+
10+
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
3+
# AdsAnalyticsCampaignTargetingType
4+
5+
## Enum
6+
7+
8+
9+
10+
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
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+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
3+
# AdvancedAuctionBidOptions
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**bidInMicroCurrency** | **Long** | Bid price in micro currency. A value of 0 will stop distribution for this item in `MAX_BID` ad groups in `CATALOG_SALES` campaigns. A value of `null` will fallback to the ad group's `bid_in_micro_currency`. | [optional]
10+
**appTypeMultipliers** | [**AppTypeMultipliers**](AppTypeMultipliers.md) | | [optional]
11+
**placementMultipliers** | [**PlacementMultipliers**](PlacementMultipliers.md) | | [optional]
12+
13+
14+
15+
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
3+
# AdvancedAuctionItem
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**itemId** | **String** | The catalog retail item id in the merchant namespace |
10+
**country** | [**Country**](Country.md) | |
11+
**language** | [**Language**](Language.md) | |
12+
**bidOptions** | [**AdvancedAuctionBidOptions**](AdvancedAuctionBidOptions.md) | |
13+
14+
15+
16+
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
3+
# AdvancedAuctionItems
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**catalogId** | **String** | Response object of item bid options | [optional]
10+
**items** | [**List<AdvancedAuctionItem>**](AdvancedAuctionItem.md) | Array with item bid options | [optional]
11+
12+
13+
14+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
3+
# AdvancedAuctionItemsGetRecord
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**itemId** | **String** | The catalog retail item id in the merchant namespace |
10+
**country** | [**Country**](Country.md) | |
11+
**language** | [**Language**](Language.md) | |
12+
13+
14+
15+
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
3+
# AdvancedAuctionItemsGetRequest
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**catalogId** | **String** | Catalog id pertaining to the retail item |
10+
**items** | [**List<AdvancedAuctionItemsGetRecord>**](AdvancedAuctionItemsGetRecord.md) | A list of retail catalog items to fetch bid options for |
11+
12+
13+
14+

0 commit comments

Comments
 (0)