Class: PinterestSdkClient::ConversionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConversionsApi

Returns a new instance of ConversionsApi.



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

def api_client
  @api_client
end

Instance Method Details

#advertiser_defined_events_create(ad_account_id, advertiser_defined_events_create_request, opts = {}) ⇒ AdvertiserDefinedEventsCreate200Response

Create advertiser defined events Map advertiser defined events to standard events for the given ad account.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

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

    the optional parameters

Returns:



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

def advertiser_defined_events_create(, advertiser_defined_events_create_request, opts = {})
  data, _status_code, _headers = advertiser_defined_events_create_with_http_info(, advertiser_defined_events_create_request, opts)
  data
end

#advertiser_defined_events_create_with_http_info(ad_account_id, advertiser_defined_events_create_request, opts = {}) ⇒ Array<(AdvertiserDefinedEventsCreate200Response, Integer, Hash)>

Create advertiser defined events Map advertiser defined events to standard events for the given ad account.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

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

    the optional parameters

Returns:



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/conversions_api.rb', line 39

def advertiser_defined_events_create_with_http_info(, advertiser_defined_events_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversionsApi.advertiser_defined_events_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 ConversionsApi.advertiser_defined_events_create"
  end
  if @api_client.config.client_side_validation && .to_s.length > 18
    fail ArgumentError, 'invalid value for "ad_account_id" when calling ConversionsApi.advertiser_defined_events_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 ConversionsApi.advertiser_defined_events_create, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'advertiser_defined_events_create_request' is set
  if @api_client.config.client_side_validation && advertiser_defined_events_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'advertiser_defined_events_create_request' when calling ConversionsApi.advertiser_defined_events_create"
  end
  # resource path
  local_var_path = '/ad_accounts/{ad_account_id}/advertiser_defined_events'.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(advertiser_defined_events_create_request)

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

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

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

#advertiser_defined_events_delete(ad_account_id, event_names, opts = {}) ⇒ AdvertiserDefinedEventsCreate200Response

Delete advertiser defined events Untrack advertiser defined events for the given ad account.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

  • event_names (Array<String>) —

    List of event names to delete

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

    the optional parameters

Returns:



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

def advertiser_defined_events_delete(, event_names, opts = {})
  data, _status_code, _headers = advertiser_defined_events_delete_with_http_info(, event_names, opts)
  data
end

#advertiser_defined_events_delete_with_http_info(ad_account_id, event_names, opts = {}) ⇒ Array<(AdvertiserDefinedEventsCreate200Response, Integer, Hash)>

Delete advertiser defined events Untrack advertiser defined events for the given ad account.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

  • event_names (Array<String>) —

    List of event names to delete

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

    the optional parameters

Returns:



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
 
# File 'lib/pinterest_sdk/api/conversions_api.rb', line 122

def advertiser_defined_events_delete_with_http_info(, event_names, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversionsApi.advertiser_defined_events_delete ...'
  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 ConversionsApi.advertiser_defined_events_delete"
  end
  if @api_client.config.client_side_validation && .to_s.length > 18
    fail ArgumentError, 'invalid value for "ad_account_id" when calling ConversionsApi.advertiser_defined_events_delete, 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 ConversionsApi.advertiser_defined_events_delete, must conform to the pattern #{pattern}."
  end

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'event_names'] = @api_client.build_collection_param(event_names, :csv)

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

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

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

#advertiser_defined_events_get(ad_account_id, opts = {}) ⇒ AdvertiserDefinedEventsGet200Response

Get advertiser defined events Get advertiser defined events for the given ad account.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

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

    the optional parameters

Returns:



189
190
191
192
 
# File 'lib/pinterest_sdk/api/conversions_api.rb', line 189

def advertiser_defined_events_get(, opts = {})
  data, _status_code, _headers = advertiser_defined_events_get_with_http_info(, opts)
  data
end

#advertiser_defined_events_get_with_http_info(ad_account_id, opts = {}) ⇒ Array<(AdvertiserDefinedEventsGet200Response, Integer, Hash)>

Get advertiser defined events Get advertiser defined events for the given ad account.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

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

    the optional parameters

Returns:



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
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
 
# File 'lib/pinterest_sdk/api/conversions_api.rb', line 199

def advertiser_defined_events_get_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversionsApi.advertiser_defined_events_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 ConversionsApi.advertiser_defined_events_get"
  end
  if @api_client.config.client_side_validation && .to_s.length > 18
    fail ArgumentError, 'invalid value for "ad_account_id" when calling ConversionsApi.advertiser_defined_events_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 ConversionsApi.advertiser_defined_events_get, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/ad_accounts/{ad_account_id}/advertiser_defined_events'.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']

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

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

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

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

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

#advertiser_defined_events_update(ad_account_id, advertiser_defined_events_create_request, opts = {}) ⇒ AdvertiserDefinedEventsCreate200Response

Update advertiser defined events Update advertiser defined event names or mappings for the given ad account.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

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

    the optional parameters

Returns:



262
263
264
265
 
# File 'lib/pinterest_sdk/api/conversions_api.rb', line 262

def advertiser_defined_events_update(, advertiser_defined_events_create_request, opts = {})
  data, _status_code, _headers = advertiser_defined_events_update_with_http_info(, advertiser_defined_events_create_request, opts)
  data
end

#advertiser_defined_events_update_with_http_info(ad_account_id, advertiser_defined_events_create_request, opts = {}) ⇒ Array<(AdvertiserDefinedEventsCreate200Response, Integer, Hash)>

Update advertiser defined events Update advertiser defined event names or mappings for the given ad account.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

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

    the optional parameters

Returns:



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
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
 
# File 'lib/pinterest_sdk/api/conversions_api.rb', line 273

def advertiser_defined_events_update_with_http_info(, advertiser_defined_events_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConversionsApi.advertiser_defined_events_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 ConversionsApi.advertiser_defined_events_update"
  end
  if @api_client.config.client_side_validation && .to_s.length > 18
    fail ArgumentError, 'invalid value for "ad_account_id" when calling ConversionsApi.advertiser_defined_events_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 ConversionsApi.advertiser_defined_events_update, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'advertiser_defined_events_create_request' is set
  if @api_client.config.client_side_validation && advertiser_defined_events_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'advertiser_defined_events_create_request' when calling ConversionsApi.advertiser_defined_events_update"
  end
  # resource path
  local_var_path = '/ad_accounts/{ad_account_id}/advertiser_defined_events'.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(advertiser_defined_events_create_request)

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

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

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