Class: AmazonAds::Targets

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

Create target

Signature:

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



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

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

#delete_target(target_ids:) ⇒ Object

Delete target

Signature:

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



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

def delete_target(target_ids:)
  request(:post, "/adsApi/v1/delete/targets", json: { "targetIds" => target_ids }.compact)
end

#query_target(ad_product_filter:, ad_group_id_filter: nil, campaign_id_filter: nil, inventory_source_id_filter: nil, inventory_source_type_filter: nil, keyword_filter: nil, marketplace_scope_filter: nil, match_type_filter: nil, max_results: nil, native_language_locale_filter: nil, negative_filter: nil, next_token: nil, product_id_filter: nil, state_filter: nil, target_id_filter: nil, target_type_filter: nil) ⇒ Object

List target

Signature:

  • (ad_product_filter: untyped, ?ad_group_id_filter: untyped?, ?campaign_id_filter: untyped?, ?inventory_source_id_filter: untyped?, ?inventory_source_type_filter: untyped?, ?keyword_filter: untyped?, ?marketplace_scope_filter: untyped?, ?match_type_filter: untyped?, ?max_results: Integer?, ?native_language_locale_filter: untyped?, ?negative_filter: untyped?, ?next_token: String?, ?product_id_filter: untyped?, ?state_filter: untyped?, ?target_id_filter: untyped?, ?target_type_filter: untyped?) -> HTTP::Response



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

def query_target(ad_product_filter:, ad_group_id_filter: nil, campaign_id_filter: nil, inventory_source_id_filter: nil, inventory_source_type_filter: nil, keyword_filter: nil, marketplace_scope_filter: nil, match_type_filter: nil, max_results: nil, native_language_locale_filter: nil, negative_filter: nil, next_token: nil, product_id_filter: nil, state_filter: nil, target_id_filter: nil, target_type_filter: nil)
  request(:post, "/adsApi/v1/query/targets", json: { "adGroupIdFilter" => ad_group_id_filter, "adProductFilter" => ad_product_filter, "campaignIdFilter" => campaign_id_filter, "inventorySourceIdFilter" => inventory_source_id_filter, "inventorySourceTypeFilter" => inventory_source_type_filter, "keywordFilter" => keyword_filter, "marketplaceScopeFilter" => marketplace_scope_filter, "matchTypeFilter" => match_type_filter, "maxResults" => max_results, "nativeLanguageLocaleFilter" => native_language_locale_filter, "negativeFilter" => negative_filter, "nextToken" => next_token, "productIdFilter" => product_id_filter, "stateFilter" => state_filter, "targetIdFilter" => target_id_filter, "targetTypeFilter" => target_type_filter }.compact)
end

#update_target(targets:) ⇒ Object

Update target

Signature:

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



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

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