Class: PinterestSdkClient::AudiencesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AudiencesApi

Returns a new instance of AudiencesApi.



19
20
21
 
# File 'lib/pinterest_sdk/api/audiences_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/audiences_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#audiences_create(ad_account_id, audience_create_request, opts = {}) ⇒ Audience

Create audience Create an audience you can use in targeting for specific ad groups. Targeting combines customer information with the ways users interact with Pinterest to help you reach specific groups of users; you can include or exclude specific audience_ids when you create an ad group. <p/> Learn about <a href="/docs/work-with-targets-and-audiences/create-audiences/" target="_blank">creating different kinds of audiences</a>.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

  • audience_create_request (AudienceCreateRequest) —

    List of ads to create, size limit [1, 30]

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

    the optional parameters

Returns:



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

def audiences_create(, audience_create_request, opts = {})
  data, _status_code, _headers = audiences_create_with_http_info(, audience_create_request, opts)
  data
end

#audiences_create_with_http_info(ad_account_id, audience_create_request, opts = {}) ⇒ Array<(Audience, Integer, Hash)>

Create audience Create an audience you can use in targeting for specific ad groups. Targeting combines customer information with the ways users interact with Pinterest to help you reach specific groups of users; you can include or exclude specific &#x60;audience_ids&#x60; when you create an ad group. &lt;p/&gt; Learn about &lt;a href&#x3D;&quot;/docs/work-with-targets-and-audiences/create-audiences/&quot; target&#x3D;&quot;_blank&quot;&gt;creating different kinds of audiences&lt;/a&gt;.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

  • audience_create_request (AudienceCreateRequest) —

    List of ads to create, size limit [1, 30]

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

    the optional parameters

Returns:

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

    Audience 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
101
102
103
 
# File 'lib/pinterest_sdk/api/audiences_api.rb', line 39

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

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

  # verify the required parameter 'audience_create_request' is set
  if @api_client.config.client_side_validation && audience_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'audience_create_request' when calling AudiencesApi.audiences_create"
  end
  # resource path
  local_var_path = '/ad_accounts/{ad_account_id}/audiences'.sub('{' + 'ad_account_id' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # 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(audience_create_request)

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

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

  new_options = opts.merge(
    :operation => :"AudiencesApi.audiences_create",
    :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: AudiencesApi#audiences_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#audiences_get(ad_account_id, audience_id, opts = {}) ⇒ Audience

Get audience Get a specific audience given the audience ID.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

  • audience_id (String) —

    Unique identifier of an audience

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

    the optional parameters

Returns:



111
112
113
114
 
# File 'lib/pinterest_sdk/api/audiences_api.rb', line 111

def audiences_get(, audience_id, opts = {})
  data, _status_code, _headers = audiences_get_with_http_info(, audience_id, opts)
  data
end

#audiences_get_with_http_info(ad_account_id, audience_id, opts = {}) ⇒ Array<(Audience, Integer, Hash)>

Get audience Get a specific audience given the audience ID.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

  • audience_id (String) —

    Unique identifier of an audience

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

    the optional parameters

Returns:

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

    Audience data, response status code and response headers



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
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/pinterest_sdk/api/audiences_api.rb', line 122

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

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

  # verify the required parameter 'audience_id' is set
  if @api_client.config.client_side_validation && audience_id.nil?
    fail ArgumentError, "Missing the required parameter 'audience_id' when calling AudiencesApi.audiences_get"
  end
  if @api_client.config.client_side_validation && audience_id.to_s.length > 18
    fail ArgumentError, 'invalid value for "audience_id" when calling AudiencesApi.audiences_get, the character length must be smaller than or equal to 18.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && audience_id !~ pattern
    fail ArgumentError, "invalid value for 'audience_id' when calling AudiencesApi.audiences_get, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/ad_accounts/{ad_account_id}/audiences/{audience_id}'.sub('{' + 'ad_account_id' + '}', CGI.escape(.to_s)).sub('{' + 'audience_id' + '}', CGI.escape(audience_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # 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']

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"AudiencesApi.audiences_get",
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AudiencesApi#audiences_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#audiences_list(ad_account_id, opts = {}) ⇒ AudiencesList200Response

List audiences Get list of audiences for the ad account.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

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

    the optional parameters

Options Hash (opts):

  • :bookmark (String) —

    Cursor used to fetch the next page of items

  • :order (String) —

    The order in which to sort the items returned: “ASCENDING” or “DESCENDING” by ID. For received audiences, it is sorted by sharing event time. Note that higher-value IDs are associated with more-recently added items.

  • :page_size (Integer) —

    Maximum number of items to include in a single page of the response. See documentation on &lt;a href&#x3D;&#39;/docs/reference/pagination/&#39;&gt;Pagination&lt;/a&gt; for more information. (default to 25)

  • :ownership_type (String) —

    Filter audiences by ownership type. (default to ‘OWNED’)

Returns:



201
202
203
204
 
# File 'lib/pinterest_sdk/api/audiences_api.rb', line 201

def audiences_list(, opts = {})
  data, _status_code, _headers = audiences_list_with_http_info(, opts)
  data
end

#audiences_list_with_http_info(ad_account_id, opts = {}) ⇒ Array<(AudiencesList200Response, Integer, Hash)>

List audiences Get list of audiences for the ad account.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

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

    the optional parameters

Options Hash (opts):

  • :bookmark (String) —

    Cursor used to fetch the next page of items

  • :order (String) —

    The order in which to sort the items returned: “ASCENDING” or “DESCENDING” by ID. For received audiences, it is sorted by sharing event time. Note that higher-value IDs are associated with more-recently added items.

  • :page_size (Integer) —

    Maximum number of items to include in a single page of the response. See documentation on &lt;a href&#x3D;&#39;/docs/reference/pagination/&#39;&gt;Pagination&lt;/a&gt; for more information. (default to 25)

  • :ownership_type (String) —

    Filter audiences by ownership type. (default to ‘OWNED’)

Returns:

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

    AudiencesList200Response data, response status code and response headers



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/pinterest_sdk/api/audiences_api.rb', line 215

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

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

  allowable_values = ["ASCENDING", "DESCENDING"]
  if @api_client.config.client_side_validation && opts[:'order'] && !allowable_values.include?(opts[:'order'])
    fail ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AudiencesApi.audiences_list, must be smaller than or equal to 250.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AudiencesApi.audiences_list, must be greater than or equal to 1.'
  end

  allowable_values = ["OWNED", "RECEIVED"]
  if @api_client.config.client_side_validation && opts[:'ownership_type'] && !allowable_values.include?(opts[:'ownership_type'])
    fail ArgumentError, "invalid value for \"ownership_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ad_accounts/{ad_account_id}/audiences'.sub('{' + 'ad_account_id' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'ownership_type'] = opts[:'ownership_type'] if !opts[:'ownership_type'].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']

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"AudiencesApi.audiences_list",
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AudiencesApi#audiences_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#audiences_update(ad_account_id, audience_id, audience_update_request, opts = {}) ⇒ Audience

Update audience Update (edit or remove) an existing targeting audience.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

  • audience_id (String) —

    Unique identifier of an audience

  • audience_update_request (AudienceUpdateRequest) —

    The audience to be updated.

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

    the optional parameters

Returns:



299
300
301
302
 
# File 'lib/pinterest_sdk/api/audiences_api.rb', line 299

def audiences_update(, audience_id, audience_update_request, opts = {})
  data, _status_code, _headers = audiences_update_with_http_info(, audience_id, audience_update_request, opts)
  data
end

#audiences_update_with_http_info(ad_account_id, audience_id, audience_update_request, opts = {}) ⇒ Array<(Audience, Integer, Hash)>

Update audience Update (edit or remove) an existing targeting audience.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

  • audience_id (String) —

    Unique identifier of an audience

  • audience_update_request (AudienceUpdateRequest) —

    The audience to be updated.

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

    the optional parameters

Returns:

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

    Audience data, response status code and response headers



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/pinterest_sdk/api/audiences_api.rb', line 311

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

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

  # verify the required parameter 'audience_id' is set
  if @api_client.config.client_side_validation && audience_id.nil?
    fail ArgumentError, "Missing the required parameter 'audience_id' when calling AudiencesApi.audiences_update"
  end
  if @api_client.config.client_side_validation && audience_id.to_s.length > 18
    fail ArgumentError, 'invalid value for "audience_id" when calling AudiencesApi.audiences_update, the character length must be smaller than or equal to 18.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && audience_id !~ pattern
    fail ArgumentError, "invalid value for 'audience_id' when calling AudiencesApi.audiences_update, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'audience_update_request' is set
  if @api_client.config.client_side_validation && audience_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'audience_update_request' when calling AudiencesApi.audiences_update"
  end
  # resource path
  local_var_path = '/ad_accounts/{ad_account_id}/audiences/{audience_id}'.sub('{' + 'ad_account_id' + '}', CGI.escape(.to_s)).sub('{' + 'audience_id' + '}', CGI.escape(audience_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # 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(audience_update_request)

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

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

  new_options = opts.merge(
    :operation => :"AudiencesApi.audiences_update",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AudiencesApi#audiences_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end