Class: AmazonAds::Campaigns

Inherits:
API
  • Object
show all
Defined in:
lib/amazon_ads/apis/campaigns.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_campaign(campaigns:) ⇒ Object

Create campaigns

Signature:

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



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

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

#delete_campaign(campaign_ids:) ⇒ Object

Delete campaigns

Signature:

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



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

def delete_campaign(campaign_ids:)
  request(:post, "/adsApi/v1/delete/campaigns", json: { "campaignIds" => campaign_ids }.compact)
end

#query_campaign(ad_product_filter:, campaign_id_filter: nil, goal_filter: nil, marketplace_scope_filter: nil, max_results: nil, name_filter: nil, next_token: nil, portfolio_id_filter: nil, state_filter: nil) ⇒ Object

Query campaign

Signature:

  • (ad_product_filter: untyped, ?campaign_id_filter: untyped?, ?goal_filter: untyped?, ?marketplace_scope_filter: untyped?, ?max_results: Integer?, ?name_filter: untyped?, ?next_token: String?, ?portfolio_id_filter: untyped?, ?state_filter: untyped?) -> HTTP::Response



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

def query_campaign(ad_product_filter:, campaign_id_filter: nil, goal_filter: nil, marketplace_scope_filter: nil, max_results: nil, name_filter: nil, next_token: nil, portfolio_id_filter: nil, state_filter: nil)
  request(:post, "/adsApi/v1/query/campaigns", json: { "adProductFilter" => ad_product_filter, "campaignIdFilter" => campaign_id_filter, "goalFilter" => goal_filter, "marketplaceScopeFilter" => marketplace_scope_filter, "maxResults" => max_results, "nameFilter" => name_filter, "nextToken" => next_token, "portfolioIdFilter" => portfolio_id_filter, "stateFilter" => state_filter }.compact)
end

#update_campaign(campaigns:) ⇒ Object

Update campaign

Signature:

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



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

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