Class: PinterestSdkClient::MsotEventsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MsotEventsApi

Returns a new instance of MsotEventsApi.



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

def api_client
  @api_client
end

Instance Method Details

#msot_events_create(ad_account_id, conversion_msot_events, opts = {}) ⇒ nil

Send Measurement Source Of Truth (MSOT) attributed conversion events <strong>This feature is currently in beta and not available to all apps, if you’re interested in joining the beta, please reach out to your Pinterest account manager.</strong>
<p>Advertisers or their measurement partners can send attributed MSOT conversion events to Pinterest based on their ad_account_id. The request body should be a JSON object.</p> - These events will NOT be used in Reporting.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

  • conversion_msot_events (ConversionMSOTEvents) —

    Attributed MSOT conversion events

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

    the optional parameters

Returns:

  • (nil) 


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

def msot_events_create(, conversion_msot_events, opts = {})
  msot_events_create_with_http_info(, conversion_msot_events, opts)
  nil
end

#msot_events_create_with_http_info(ad_account_id, conversion_msot_events, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Send Measurement Source Of Truth (MSOT) attributed conversion events &lt;strong&gt;This feature is currently in beta and not available to all apps, if you&#39;re interested in joining the beta, please reach out to your Pinterest account manager.&lt;/strong&gt; &lt;br&gt; &lt;p&gt;Advertisers or their measurement partners can send attributed MSOT conversion events to Pinterest based on their &lt;code&gt;ad_account_id&lt;/code&gt;. The request body should be a JSON object.&lt;/p&gt; - These events will NOT be used in Reporting.

Parameters:

  • ad_account_id (String) —

    Unique identifier of an ad account.

  • conversion_msot_events (ConversionMSOTEvents) —

    Attributed MSOT conversion events

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

    the optional parameters

Returns:

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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