Class: AmazonAds::Commitments

Inherits:
API
  • Object
show all
Defined in:
lib/amazon_ads/apis/commitments.rb

Constant Summary

Constants inherited from API

API::ENDPOINTS

Instance Attribute Summary

Attributes inherited from API

#access_token, #account_id, #profile_id, #region, #retries

Instance Method Summary collapse

Methods inherited from API

#endpoint, #http, #initialize

Constructor Details

This class inherits a constructor from AmazonAds::API

Instance Method Details

#create_commitment(commitments:) ⇒ Object

Create commitments

Signature:

  • (commitments: Array[untyped]) -> HTTP::Response



7
8
9
 
# File 'lib/amazon_ads/apis/commitments.rb', line 7

def create_commitment(commitments:)
  request(:post, "/adsApi/v1/create/commitments", json: { "commitments" => commitments }.compact)
end

#dsp_create_commitment(commitments:) ⇒ Object

Create commitments (Deprecated legacy ad-product path alias of CreateCommitment; prefer the ad-product-agnostic path.)

Signature:

  • (commitments: Array[untyped]) -> HTTP::Response



13
14
15
 
# File 'lib/amazon_ads/apis/commitments.rb', line 13

def dsp_create_commitment(commitments:)
  request(:post, "/adsApi/v1/create/commitments/dsp", json: { "commitments" => commitments }.compact)
end

#dsp_list_commitment(next_token: nil, max_results: nil) ⇒ Object

List commitments (Deprecated legacy ad-product path alias of ListCommitment; prefer the ad-product-agnostic path.)

Signature:

  • (?next_token: String?, ?max_results: Integer?) -> HTTP::Response



19
20
21
 
# File 'lib/amazon_ads/apis/commitments.rb', line 19

def dsp_list_commitment(next_token: nil, max_results: nil)
  request(:get, "/adsApi/v1/commitments/dsp", params: { "nextToken" => next_token, "maxResults" => max_results }.compact)
end

#dsp_query_commitment(advertiser_ids_filter: nil, campaign_ids_filter: nil, commitment_id_filter: nil, commitment_name_filter: nil, deal_ids_filter: nil, max_results: nil, next_token: nil, spend_calculation_mode_filter: nil) ⇒ Object

Query commitments with filters (Deprecated legacy ad-product path alias of QueryCommitment; prefer the ad-product-agnostic path.)

Signature:

  • (?advertiser_ids_filter: untyped?, ?campaign_ids_filter: untyped?, ?commitment_id_filter: untyped?, ?commitment_name_filter: untyped?, ?deal_ids_filter: untyped?, ?max_results: Integer?, ?next_token: String?, ?spend_calculation_mode_filter: untyped?) -> HTTP::Response



25
26
27
 
# File 'lib/amazon_ads/apis/commitments.rb', line 25

def dsp_query_commitment(advertiser_ids_filter: nil, campaign_ids_filter: nil, commitment_id_filter: nil, commitment_name_filter: nil, deal_ids_filter: nil, max_results: nil, next_token: nil, spend_calculation_mode_filter: nil)
  request(:post, "/adsApi/v1/query/commitments/dsp", json: { "advertiserIdsFilter" => advertiser_ids_filter, "campaignIdsFilter" => campaign_ids_filter, "commitmentIdFilter" => commitment_id_filter, "commitmentNameFilter" => commitment_name_filter, "dealIdsFilter" => deal_ids_filter, "maxResults" => max_results, "nextToken" => next_token, "spendCalculationModeFilter" => spend_calculation_mode_filter }.compact)
end

#dsp_retrieve_commitment(commitment_ids:) ⇒ Object

Get Commitments (Deprecated legacy ad-product path alias of RetrieveCommitment; prefer the ad-product-agnostic path.)

Signature:

  • (commitment_ids: Array[untyped]) -> HTTP::Response



31
32
33
 
# File 'lib/amazon_ads/apis/commitments.rb', line 31

def dsp_retrieve_commitment(commitment_ids:)
  request(:post, "/adsApi/v1/retrieve/commitments/dsp", json: { "commitmentIds" => commitment_ids }.compact)
end

#dsp_update_commitment(commitments:) ⇒ Object

Update commitments (Deprecated legacy ad-product path alias of UpdateCommitment; prefer the ad-product-agnostic path.)

Signature:

  • (commitments: Array[untyped]) -> HTTP::Response



37
38
39
 
# File 'lib/amazon_ads/apis/commitments.rb', line 37

def dsp_update_commitment(commitments:)
  request(:post, "/adsApi/v1/update/commitments/dsp", json: { "commitments" => commitments }.compact)
end

#list_commitment(next_token: nil, max_results: nil) ⇒ Object

List commitments

Signature:

  • (?next_token: String?, ?max_results: Integer?) -> HTTP::Response



43
44
45
 
# File 'lib/amazon_ads/apis/commitments.rb', line 43

def list_commitment(next_token: nil, max_results: nil)
  request(:get, "/adsApi/v1/commitments", params: { "nextToken" => next_token, "maxResults" => max_results }.compact)
end

#query_commitment(advertiser_ids_filter: nil, campaign_ids_filter: nil, commitment_id_filter: nil, commitment_name_filter: nil, deal_ids_filter: nil, max_results: nil, next_token: nil, spend_calculation_mode_filter: nil) ⇒ Object

Query commitments with filters

Signature:

  • (?advertiser_ids_filter: untyped?, ?campaign_ids_filter: untyped?, ?commitment_id_filter: untyped?, ?commitment_name_filter: untyped?, ?deal_ids_filter: untyped?, ?max_results: Integer?, ?next_token: String?, ?spend_calculation_mode_filter: untyped?) -> HTTP::Response



49
50
51
 
# File 'lib/amazon_ads/apis/commitments.rb', line 49

def query_commitment(advertiser_ids_filter: nil, campaign_ids_filter: nil, commitment_id_filter: nil, commitment_name_filter: nil, deal_ids_filter: nil, max_results: nil, next_token: nil, spend_calculation_mode_filter: nil)
  request(:post, "/adsApi/v1/query/commitments", json: { "advertiserIdsFilter" => advertiser_ids_filter, "campaignIdsFilter" => campaign_ids_filter, "commitmentIdFilter" => commitment_id_filter, "commitmentNameFilter" => commitment_name_filter, "dealIdsFilter" => deal_ids_filter, "maxResults" => max_results, "nextToken" => next_token, "spendCalculationModeFilter" => spend_calculation_mode_filter }.compact)
end

#retrieve_commitment(commitment_ids:) ⇒ Object

Get Commitments

Signature:

  • (commitment_ids: Array[untyped]) -> HTTP::Response



55
56
57
 
# File 'lib/amazon_ads/apis/commitments.rb', line 55

def retrieve_commitment(commitment_ids:)
  request(:post, "/adsApi/v1/retrieve/commitments", json: { "commitmentIds" => commitment_ids }.compact)
end

#update_commitment(commitments:) ⇒ Object

Update commitments

Signature:

  • (commitments: Array[untyped]) -> HTTP::Response



61
62
63
 
# File 'lib/amazon_ads/apis/commitments.rb', line 61

def update_commitment(commitments:)
  request(:post, "/adsApi/v1/update/commitments", json: { "commitments" => commitments }.compact)
end