Class: PinterestSdkClient::AdvancedAuctionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pinterest_sdk/api/advanced_auction_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AdvancedAuctionApi

Returns a new instance of AdvancedAuctionApi.



19
20
21
 
# File 'lib/pinterest_sdk/api/advanced_auction_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/pinterest_sdk/api/advanced_auction_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#advanced_auction_items_get_post(advanced_auction_items_get_request, opts = {}) ⇒ AdvancedAuctionItems

Get item bid options (POST) 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 ad_account_id (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="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.

Parameters:

  • advanced_auction_items_get_request (AdvancedAuctionItemsGetRequest) —

    Request object used to get bid options values for a batch of retail catalog items

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:



28
29
30
31
 
# File 'lib/pinterest_sdk/api/advanced_auction_api.rb', line 28

def advanced_auction_items_get_post(advanced_auction_items_get_request, opts = {})
  data, _status_code, _headers = advanced_auction_items_get_post_with_http_info(advanced_auction_items_get_request, opts)
  data
end

#advanced_auction_items_get_post_with_http_info(advanced_auction_items_get_request, opts = {}) ⇒ Array<(AdvancedAuctionItems, Integer, Hash)>

Get item bid options (POST) Get the bid options for a batch of retail catalog items. The catalog must be owned by the &quot;operation user_account&quot;. &lt;a href&#x3D;&quot;/docs/api-features/shopping-overview/#Update%20items%20in%20batch&quot; target&#x3D;&quot;_blank&quot;&gt;See detailed documentation here.&lt;/a&gt; By default, the &quot;operation user_account&quot; is the token user_account. Optional: Business Access: Specify an &lt;code&gt;ad_account_id&lt;/code&gt; (obtained via &lt;a href&#x3D;&#39;/docs/api/v5/#operation/ad_accounts/list&#39;&gt;List ad accounts&lt;/a&gt;) to use the owner of that ad_account as the &quot;operation user_account&quot;. In order to do this, the token user_account must have one of the following &lt;a href&#x3D;&quot;help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts&quot;&gt;Business Access&lt;/a&gt; roles on the ad_account: &#x60;Owner&#x60;, &#x60;Admin&#x60;. This endpoint is not available to all users.

Parameters:

  • advanced_auction_items_get_request (AdvancedAuctionItemsGetRequest) —

    Request object used to get bid options values for a batch of retail catalog items

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:

  • (Array<(AdvancedAuctionItems, Integer, Hash)>) —

    AdvancedAuctionItems data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/pinterest_sdk/api/advanced_auction_api.rb', line 39

def advanced_auction_items_get_post_with_http_info(advanced_auction_items_get_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdvancedAuctionApi.advanced_auction_items_get_post ...'
  end
  # verify the required parameter 'advanced_auction_items_get_request' is set
  if @api_client.config.client_side_validation && advanced_auction_items_get_request.nil?
    fail ArgumentError, "Missing the required parameter 'advanced_auction_items_get_request' when calling AdvancedAuctionApi.advanced_auction_items_get_post"
  end
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
    fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling AdvancedAuctionApi.advanced_auction_items_get_post, the character length must be smaller than or equal to 18.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling AdvancedAuctionApi.advanced_auction_items_get_post, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/advanced_auction/items/get'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ad_account_id'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(advanced_auction_items_get_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AdvancedAuctionItems'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']

  new_options = opts.merge(
    :operation => :"AdvancedAuctionApi.advanced_auction_items_get_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdvancedAuctionApi#advanced_auction_items_get_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#advanced_auction_items_submit_post(advanced_auction_items_submit_request, opts = {}) ⇒ AdvancedAuctionProcessedItems

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 ad_account_id (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="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.

Parameters:

  • advanced_auction_items_submit_request (AdvancedAuctionItemsSubmitRequest) —

    Request object used to upsert or delete bid options for a batch of retail catalog items

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:



108
109
110
111
 
# File 'lib/pinterest_sdk/api/advanced_auction_api.rb', line 108

def advanced_auction_items_submit_post(advanced_auction_items_submit_request, opts = {})
  data, _status_code, _headers = advanced_auction_items_submit_post_with_http_info(advanced_auction_items_submit_request, opts)
  data
end

#advanced_auction_items_submit_post_with_http_info(advanced_auction_items_submit_request, opts = {}) ⇒ Array<(AdvancedAuctionProcessedItems, Integer, Hash)>

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 &#x60;CATALOG_SALES&#x60; and ad groups using bid_strategy_type &#x60;MAX_BID&#x60;. The catalog must be owned by the &quot;operation user_account&quot;. &lt;a href&#x3D;&quot;/docs/api-features/modify-items-in-batch/&quot; target&#x3D;&quot;_blank&quot;&gt;See detailed documentation here.&lt;/a&gt; By default, the &quot;operation user_account&quot; is the token user_account. Optional: Business Access: Specify an &lt;code&gt;ad_account_id&lt;/code&gt; (obtained via &lt;a href&#x3D;&#39;/docs/api/v5/#operation/ad_accounts/list&#39;&gt;List ad accounts&lt;/a&gt;) to use the owner of that ad_account as the &quot;operation user_account&quot;. In order to do this, the token user_account must have one of the following &lt;a href&#x3D;&quot;help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts&quot;&gt;Business Access&lt;/a&gt; roles on the ad_account: &#x60;Owner&#x60;, &#x60;Admin&#x60;. This endpoint is not available to all users.

Parameters:

  • advanced_auction_items_submit_request (AdvancedAuctionItemsSubmitRequest) —

    Request object used to upsert or delete bid options for a batch of retail catalog items

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/pinterest_sdk/api/advanced_auction_api.rb', line 119

def advanced_auction_items_submit_post_with_http_info(advanced_auction_items_submit_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdvancedAuctionApi.advanced_auction_items_submit_post ...'
  end
  # verify the required parameter 'advanced_auction_items_submit_request' is set
  if @api_client.config.client_side_validation && advanced_auction_items_submit_request.nil?
    fail ArgumentError, "Missing the required parameter 'advanced_auction_items_submit_request' when calling AdvancedAuctionApi.advanced_auction_items_submit_post"
  end
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
    fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling AdvancedAuctionApi.advanced_auction_items_submit_post, the character length must be smaller than or equal to 18.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling AdvancedAuctionApi.advanced_auction_items_submit_post, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/advanced_auction/items/submit'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ad_account_id'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(advanced_auction_items_submit_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AdvancedAuctionProcessedItems'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['pinterest_oauth2']

  new_options = opts.merge(
    :operation => :"AdvancedAuctionApi.advanced_auction_items_submit_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdvancedAuctionApi#advanced_auction_items_submit_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end