Class: AmazonAds::Ads

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

Constant Summary

Constants inherited from API

AmazonAds::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_ad(ads:) ⇒ Object

Create ads

Signature:

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



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

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

#delete_ad(ad_ids:) ⇒ Object

Delete ads

Signature:

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



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

def delete_ad(ad_ids:)
  request(:post, "/adsApi/v1/delete/ads", json: { "adIds" => ad_ids }.compact)
end

#query_ad(ad_product_filter:, ad_group_id_filter: nil, ad_id_filter: nil, campaign_id_filter: nil, marketplace_scope_filter: nil, max_results: nil, name_filter: nil, next_token: nil, state_filter: nil) ⇒ Object

List ads

Signature:

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



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

def query_ad(ad_product_filter:, ad_group_id_filter: nil, ad_id_filter: nil, campaign_id_filter: nil, marketplace_scope_filter: nil, max_results: nil, name_filter: nil, next_token: nil, state_filter: nil)
  request(:post, "/adsApi/v1/query/ads", json: { "adGroupIdFilter" => ad_group_id_filter, "adIdFilter" => ad_id_filter, "adProductFilter" => ad_product_filter, "campaignIdFilter" => campaign_id_filter, "marketplaceScopeFilter" => marketplace_scope_filter, "maxResults" => max_results, "nameFilter" => name_filter, "nextToken" => next_token, "stateFilter" => state_filter }.compact)
end

#update_ad(ads:) ⇒ Object

Update ads

Signature:

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



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

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