Class: PinterestSdkClient::ConversionTagsApi
- Inherits:
-
Object
- Object
- PinterestSdkClient::ConversionTagsApi
- Defined in:
- lib/pinterest_sdk/api/conversion_tags_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#conversion_tags_create(ad_account_id, conversion_tag_create, opts = {}) ⇒ ConversionTag
Create conversion tag Create a conversion tag, also known as [Pinterest tag](help.pinterest.com/en/business/article/set-up-the-pinterest-tag), with the option to enable enhanced match.
-
#conversion_tags_create_with_http_info(ad_account_id, conversion_tag_create, opts = {}) ⇒ Array<(ConversionTag, Integer, Hash)>
Create conversion tag Create a conversion tag, also known as [Pinterest tag](help.pinterest.com/en/business/article/set-up-the-pinterest-tag), with the option to enable enhanced match.
-
#conversion_tags_get(ad_account_id, conversion_tag_id, opts = {}) ⇒ ConversionTag
Get conversion tag Get information about an existing conversion tag.
-
#conversion_tags_get_with_http_info(ad_account_id, conversion_tag_id, opts = {}) ⇒ Array<(ConversionTag, Integer, Hash)>
Get conversion tag Get information about an existing conversion tag.
-
#conversion_tags_list(ad_account_id, opts = {}) ⇒ ConversionTagsList200Response
List conversion tags List conversion tags associated with an ad account.
-
#conversion_tags_list_with_http_info(ad_account_id, opts = {}) ⇒ Array<(ConversionTagsList200Response, Integer, Hash)>
List conversion tags List conversion tags associated with an ad account.
-
#initialize(api_client = ApiClient.default) ⇒ ConversionTagsApi
constructor
A new instance of ConversionTagsApi.
-
#ocpm_eligible_conversion_tags_get(ad_account_id, opts = {}) ⇒ Hash<String, Array<ConversionEventResponse>>
Get Ocpm eligible conversion tags Get Ocpm eligible conversion tag events for an ad account.
-
#ocpm_eligible_conversion_tags_get_with_http_info(ad_account_id, opts = {}) ⇒ Array<(Hash<String, Array<ConversionEventResponse>>, Integer, Hash)>
Get Ocpm eligible conversion tags Get Ocpm eligible conversion tag events for an ad account.
-
#page_visit_conversion_tags_get(ad_account_id, opts = {}) ⇒ PageVisitConversionTagsGet200Response
Get page visit conversion tags Get all page visit conversion tag events for an ad account.
-
#page_visit_conversion_tags_get_with_http_info(ad_account_id, opts = {}) ⇒ Array<(PageVisitConversionTagsGet200Response, Integer, Hash)>
Get page visit conversion tags Get all page visit conversion tag events for an ad account.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ConversionTagsApi
Returns a new instance of ConversionTagsApi.
19 20 21 |
# File 'lib/pinterest_sdk/api/conversion_tags_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/conversion_tags_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#conversion_tags_create(ad_account_id, conversion_tag_create, opts = {}) ⇒ ConversionTag
Create conversion tag Create a conversion tag, also known as [Pinterest tag](help.pinterest.com/en/business/article/set-up-the-pinterest-tag), with the option to enable enhanced match. The Pinterest Tag tracks actions people take on the ad account’s website after they view the ad account’s ad on Pinterest. The advertiser needs to customize this tag to track conversions. For more information, see: [Set up the Pinterest tag](help.pinterest.com/en/business/article/set-up-the-pinterest-tag) [Pinterest Tag](/docs/track-conversions/pinterest-tag/) [Enhanced match](/docs/track-conversions/pinterest-tag/#enhanced-match)
28 29 30 31 |
# File 'lib/pinterest_sdk/api/conversion_tags_api.rb', line 28 def (ad_account_id, conversion_tag_create, opts = {}) data, _status_code, _headers = (ad_account_id, conversion_tag_create, opts) data end |
#conversion_tags_create_with_http_info(ad_account_id, conversion_tag_create, opts = {}) ⇒ Array<(ConversionTag, Integer, Hash)>
Create conversion tag Create a conversion tag, also known as [Pinterest tag](help.pinterest.com/en/business/article/set-up-the-pinterest-tag), with the option to enable enhanced match. The Pinterest Tag tracks actions people take on the ad account's website after they view the ad account's ad on Pinterest. The advertiser needs to customize this tag to track conversions. For more information, see: [Set up the Pinterest tag](help.pinterest.com/en/business/article/set-up-the-pinterest-tag) [Pinterest Tag](/docs/track-conversions/pinterest-tag/) [Enhanced match](/docs/track-conversions/pinterest-tag/#enhanced-match)
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/conversion_tags_api.rb', line 39 def (ad_account_id, conversion_tag_create, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConversionTagsApi.conversion_tags_create ...' end # verify the required parameter 'ad_account_id' is set if @api_client.config.client_side_validation && ad_account_id.nil? fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling ConversionTagsApi.conversion_tags_create" end if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18 fail ArgumentError, 'invalid value for "ad_account_id" when calling ConversionTagsApi.conversion_tags_create, the character length must be smaller than or equal to 18.' end pattern = Regexp.new(/^\d+$/) if @api_client.config.client_side_validation && ad_account_id !~ pattern fail ArgumentError, "invalid value for 'ad_account_id' when calling ConversionTagsApi.conversion_tags_create, must conform to the pattern #{pattern}." end # verify the required parameter 'conversion_tag_create' is set if @api_client.config.client_side_validation && conversion_tag_create.nil? fail ArgumentError, "Missing the required parameter 'conversion_tag_create' when calling ConversionTagsApi.conversion_tags_create" end # resource path local_var_path = '/ad_accounts/{ad_account_id}/conversion_tags'.sub('{' + 'ad_account_id' + '}', CGI.escape(ad_account_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(conversion_tag_create) # return_type return_type = opts[:debug_return_type] || 'ConversionTag' # auth_names auth_names = opts[:debug_auth_names] || ['pinterest_oauth2'] = opts.merge( :operation => :"ConversionTagsApi.conversion_tags_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ConversionTagsApi#conversion_tags_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#conversion_tags_get(ad_account_id, conversion_tag_id, opts = {}) ⇒ ConversionTag
Get conversion tag Get information about an existing conversion tag.
111 112 113 114 |
# File 'lib/pinterest_sdk/api/conversion_tags_api.rb', line 111 def (ad_account_id, conversion_tag_id, opts = {}) data, _status_code, _headers = (ad_account_id, conversion_tag_id, opts) data end |
#conversion_tags_get_with_http_info(ad_account_id, conversion_tag_id, opts = {}) ⇒ Array<(ConversionTag, Integer, Hash)>
Get conversion tag Get information about an existing conversion tag.
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/conversion_tags_api.rb', line 122 def (ad_account_id, conversion_tag_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConversionTagsApi.conversion_tags_get ...' end # verify the required parameter 'ad_account_id' is set if @api_client.config.client_side_validation && ad_account_id.nil? fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling ConversionTagsApi.conversion_tags_get" end if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18 fail ArgumentError, 'invalid value for "ad_account_id" when calling ConversionTagsApi.conversion_tags_get, the character length must be smaller than or equal to 18.' end pattern = Regexp.new(/^\d+$/) if @api_client.config.client_side_validation && ad_account_id !~ pattern fail ArgumentError, "invalid value for 'ad_account_id' when calling ConversionTagsApi.conversion_tags_get, must conform to the pattern #{pattern}." end # verify the required parameter 'conversion_tag_id' is set if @api_client.config.client_side_validation && conversion_tag_id.nil? fail ArgumentError, "Missing the required parameter 'conversion_tag_id' when calling ConversionTagsApi.conversion_tags_get" end if @api_client.config.client_side_validation && conversion_tag_id.to_s.length > 18 fail ArgumentError, 'invalid value for "conversion_tag_id" when calling ConversionTagsApi.conversion_tags_get, the character length must be smaller than or equal to 18.' end pattern = Regexp.new(/^\d+$/) if @api_client.config.client_side_validation && conversion_tag_id !~ pattern fail ArgumentError, "invalid value for 'conversion_tag_id' when calling ConversionTagsApi.conversion_tags_get, must conform to the pattern #{pattern}." end # resource path local_var_path = '/ad_accounts/{ad_account_id}/conversion_tags/{conversion_tag_id}'.sub('{' + 'ad_account_id' + '}', CGI.escape(ad_account_id.to_s)).sub('{' + 'conversion_tag_id' + '}', CGI.escape(conversion_tag_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] || 'ConversionTag' # auth_names auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials'] = opts.merge( :operation => :"ConversionTagsApi.conversion_tags_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ConversionTagsApi#conversion_tags_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#conversion_tags_list(ad_account_id, opts = {}) ⇒ ConversionTagsList200Response
List conversion tags List conversion tags associated with an ad account.
198 199 200 201 |
# File 'lib/pinterest_sdk/api/conversion_tags_api.rb', line 198 def (ad_account_id, opts = {}) data, _status_code, _headers = (ad_account_id, opts) data end |
#conversion_tags_list_with_http_info(ad_account_id, opts = {}) ⇒ Array<(ConversionTagsList200Response, Integer, Hash)>
List conversion tags List conversion tags associated with an ad account.
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 255 256 257 258 259 260 261 262 263 264 265 |
# File 'lib/pinterest_sdk/api/conversion_tags_api.rb', line 209 def (ad_account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConversionTagsApi.conversion_tags_list ...' end # verify the required parameter 'ad_account_id' is set if @api_client.config.client_side_validation && ad_account_id.nil? fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling ConversionTagsApi.conversion_tags_list" end if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18 fail ArgumentError, 'invalid value for "ad_account_id" when calling ConversionTagsApi.conversion_tags_list, the character length must be smaller than or equal to 18.' end pattern = Regexp.new(/^\d+$/) if @api_client.config.client_side_validation && ad_account_id !~ pattern fail ArgumentError, "invalid value for 'ad_account_id' when calling ConversionTagsApi.conversion_tags_list, must conform to the pattern #{pattern}." end # resource path local_var_path = '/ad_accounts/{ad_account_id}/conversion_tags'.sub('{' + 'ad_account_id' + '}', CGI.escape(ad_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'filter_deleted'] = opts[:'filter_deleted'] if !opts[:'filter_deleted'].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] || 'ConversionTagsList200Response' # auth_names auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials'] = opts.merge( :operation => :"ConversionTagsApi.conversion_tags_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ConversionTagsApi#conversion_tags_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#ocpm_eligible_conversion_tags_get(ad_account_id, opts = {}) ⇒ Hash<String, Array<ConversionEventResponse>>
Get Ocpm eligible conversion tags Get Ocpm eligible conversion tag events for an ad account.
272 273 274 275 |
# File 'lib/pinterest_sdk/api/conversion_tags_api.rb', line 272 def (ad_account_id, opts = {}) data, _status_code, _headers = (ad_account_id, opts) data end |
#ocpm_eligible_conversion_tags_get_with_http_info(ad_account_id, opts = {}) ⇒ Array<(Hash<String, Array<ConversionEventResponse>>, Integer, Hash)>
Get Ocpm eligible conversion tags Get Ocpm eligible conversion tag events for an ad account.
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/conversion_tags_api.rb', line 282 def (ad_account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConversionTagsApi.ocpm_eligible_conversion_tags_get ...' end # verify the required parameter 'ad_account_id' is set if @api_client.config.client_side_validation && ad_account_id.nil? fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling ConversionTagsApi.ocpm_eligible_conversion_tags_get" end if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18 fail ArgumentError, 'invalid value for "ad_account_id" when calling ConversionTagsApi.ocpm_eligible_conversion_tags_get, the character length must be smaller than or equal to 18.' end pattern = Regexp.new(/^\d+$/) if @api_client.config.client_side_validation && ad_account_id !~ pattern fail ArgumentError, "invalid value for 'ad_account_id' when calling ConversionTagsApi.ocpm_eligible_conversion_tags_get, must conform to the pattern #{pattern}." end # resource path local_var_path = '/ad_accounts/{ad_account_id}/conversion_tags/ocpm_eligible'.sub('{' + 'ad_account_id' + '}', CGI.escape(ad_account_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] || 'Hash<String, Array<ConversionEventResponse>>' # auth_names auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials'] = opts.merge( :operation => :"ConversionTagsApi.ocpm_eligible_conversion_tags_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ConversionTagsApi#ocpm_eligible_conversion_tags_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#page_visit_conversion_tags_get(ad_account_id, opts = {}) ⇒ PageVisitConversionTagsGet200Response
Get page visit conversion tags Get all page visit conversion tag events for an ad account.
347 348 349 350 |
# File 'lib/pinterest_sdk/api/conversion_tags_api.rb', line 347 def (ad_account_id, opts = {}) data, _status_code, _headers = (ad_account_id, opts) data end |
#page_visit_conversion_tags_get_with_http_info(ad_account_id, opts = {}) ⇒ Array<(PageVisitConversionTagsGet200Response, Integer, Hash)>
Get page visit conversion tags Get all page visit conversion tag events for an ad account.
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 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 |
# File 'lib/pinterest_sdk/api/conversion_tags_api.rb', line 360 def (ad_account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ConversionTagsApi.page_visit_conversion_tags_get ...' end # verify the required parameter 'ad_account_id' is set if @api_client.config.client_side_validation && ad_account_id.nil? fail ArgumentError, "Missing the required parameter 'ad_account_id' when calling ConversionTagsApi.page_visit_conversion_tags_get" end if @api_client.config.client_side_validation && ad_account_id.to_s.length > 18 fail ArgumentError, 'invalid value for "ad_account_id" when calling ConversionTagsApi.page_visit_conversion_tags_get, the character length must be smaller than or equal to 18.' end pattern = Regexp.new(/^\d+$/) if @api_client.config.client_side_validation && ad_account_id !~ pattern fail ArgumentError, "invalid value for 'ad_account_id' when calling ConversionTagsApi.page_visit_conversion_tags_get, must conform to the pattern #{pattern}." 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 ConversionTagsApi.page_visit_conversion_tags_get, 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 ConversionTagsApi.page_visit_conversion_tags_get, must be greater than or equal to 1.' 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 # resource path local_var_path = '/ad_accounts/{ad_account_id}/conversion_tags/page_visit'.sub('{' + 'ad_account_id' + '}', CGI.escape(ad_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil? query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].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] || 'PageVisitConversionTagsGet200Response' # auth_names auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials'] = opts.merge( :operation => :"ConversionTagsApi.page_visit_conversion_tags_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ConversionTagsApi#page_visit_conversion_tags_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |