Class: AmazonAds::AdExtensions

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

Create ad extensions - API is in open beta

Signature:

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



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

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

#query_ad_extension(ad_extension_id_filter: nil, ad_extension_status_filter: nil, ad_extension_type_filter: nil, ad_group_id_filter: nil, ad_id_filter: nil, ad_product_filter: nil, max_results: nil, next_token: nil, state_filter: nil) ⇒ Object

Query ad_extension - API is in open beta

Signature:

  • (?ad_extension_id_filter: untyped?, ?ad_extension_status_filter: untyped?, ?ad_extension_type_filter: untyped?, ?ad_group_id_filter: untyped?, ?ad_id_filter: untyped?, ?ad_product_filter: untyped?, ?max_results: Integer?, ?next_token: String?, ?state_filter: untyped?) -> HTTP::Response



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

def query_ad_extension(ad_extension_id_filter: nil, ad_extension_status_filter: nil, ad_extension_type_filter: nil, ad_group_id_filter: nil, ad_id_filter: nil, ad_product_filter: nil, max_results: nil, next_token: nil, state_filter: nil)
  request(:post, "/adsApi/v1/query/adExtensions", json: { "adExtensionIdFilter" => ad_extension_id_filter, "adExtensionStatusFilter" => ad_extension_status_filter, "adExtensionTypeFilter" => ad_extension_type_filter, "adGroupIdFilter" => ad_group_id_filter, "adIdFilter" => ad_id_filter, "adProductFilter" => ad_product_filter, "maxResults" => max_results, "nextToken" => next_token, "stateFilter" => state_filter }.compact)
end

#update_ad_extension(ad_extensions:) ⇒ Object

Update ad_extension - API is in open beta

Signature:

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



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

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