Class: AmazonAds::SupplierAdProducts

Inherits:

API

• Object
• API
• AmazonAds::SupplierAdProducts

Defined in:

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

• #query_supplier_ad_product(ad_product_filter:, country_filter: nil, deal_type_filter: nil, inventory_type_filter: nil, max_date_time_filter: nil, max_results: nil, min_date_time_filter: nil, name_filter: nil, next_token: nil, sort: nil, supplier_ad_product_id_filter: nil, supplier_proposal_destination_id_filter: nil, supplier_publisher_id_filter: nil) ⇒ Object

  Query supplier ad products.

Methods inherited from API

#endpoint, #http, #initialize

Constructor Details

This class inherits a constructor from AmazonAds::API

Instance Method Details

#query_supplier_ad_product(ad_product_filter:, country_filter: nil, deal_type_filter: nil, inventory_type_filter: nil, max_date_time_filter: nil, max_results: nil, min_date_time_filter: nil, name_filter: nil, next_token: nil, sort: nil, supplier_ad_product_id_filter: nil, supplier_proposal_destination_id_filter: nil, supplier_publisher_id_filter: nil) ⇒ Object

Query supplier ad products

Signature:

• (ad_product_filter: untyped, ?country_filter: untyped?, ?deal_type_filter: untyped?, ?inventory_type_filter: untyped?, ?max_date_time_filter: untyped?, ?max_results: Integer?, ?min_date_time_filter: untyped?, ?name_filter: untyped?, ?next_token: String?, ?sort: Array[untyped]?, ?supplier_ad_product_id_filter: untyped?, ?supplier_proposal_destination_id_filter: untyped?, ?supplier_publisher_id_filter: untyped?) -> HTTP::Response

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

def query_supplier_ad_product(ad_product_filter:, country_filter: nil, deal_type_filter: nil, inventory_type_filter: nil, max_date_time_filter: nil, max_results: nil, min_date_time_filter: nil, name_filter: nil, next_token: nil, sort: nil, supplier_ad_product_id_filter: nil, supplier_proposal_destination_id_filter: nil, supplier_publisher_id_filter: nil)
  request(:post, "/adsApi/v1/query/supplierAdProducts", json: { "adProductFilter" => ad_product_filter, "countryFilter" => country_filter, "dealTypeFilter" => deal_type_filter, "inventoryTypeFilter" => inventory_type_filter, "maxDateTimeFilter" => max_date_time_filter, "maxResults" => max_results, "minDateTimeFilter" => min_date_time_filter, "nameFilter" => name_filter, "nextToken" => next_token, "sort" => sort, "supplierAdProductIdFilter" => supplier_ad_product_id_filter, "supplierProposalDestinationIdFilter" => supplier_proposal_destination_id_filter, "supplierPublisherIdFilter" => supplier_publisher_id_filter }.compact)
end