Class: AmazonAds::AdvertiserAccounts

Inherits:

API

• Object
• API
• AmazonAds::AdvertiserAccounts

Defined in:

lib/amazon_ads/apis/advertiser_accounts.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

• #create_advertiser_account(advertiser_accounts:) ⇒ Object

  Create advertiser accounts.

• #query_advertiser_account(advertiser_account_id_filter: nil, is_global_account_filter: nil, max_results: nil, next_token: nil) ⇒ Object

  List advertiser accounts.

• #update_advertiser_account(advertiser_accounts:) ⇒ Object

  Update advertiser accounts.

Methods inherited from API

#endpoint, #http, #initialize

Constructor Details

This class inherits a constructor from AmazonAds::API

Instance Method Details

#create_advertiser_account(advertiser_accounts:) ⇒ Object

Create advertiser accounts

Signature:

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

# File 'lib/amazon_ads/apis/advertiser_accounts.rb', line 7

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

#query_advertiser_account(advertiser_account_id_filter: nil, is_global_account_filter: nil, max_results: nil, next_token: nil) ⇒ Object

List advertiser accounts

Signature:

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

# File 'lib/amazon_ads/apis/advertiser_accounts.rb', line 13

def query_advertiser_account(advertiser_account_id_filter: nil, is_global_account_filter: nil, max_results: nil, next_token: nil)
  request(:post, "/adsApi/v1/query/advertiserAccounts", json: { "advertiserAccountIdFilter" => advertiser_account_id_filter, "isGlobalAccountFilter" => is_global_account_filter, "maxResults" => max_results, "nextToken" => next_token }.compact)
end

#update_advertiser_account(advertiser_accounts:) ⇒ Object

Update advertiser accounts

Signature:

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

# File 'lib/amazon_ads/apis/advertiser_accounts.rb', line 19

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