Module: AmazonAds

Defined in:
lib/amazon_ads.rb,
lib/amazon_ads/api.rb,
lib/amazon_ads/lwa.rb,
lib/amazon_ads/error.rb,
lib/amazon_ads/version.rb,
lib/amazon_ads/apis/ads.rb,
lib/amazon_ads/apis/targets.rb,
lib/amazon_ads/apis/profiles.rb,
lib/amazon_ads/apis/ad_groups.rb,
lib/amazon_ads/apis/campaigns.rb,
lib/amazon_ads/apis/reporting.rb,
lib/amazon_ads/apis/commitments.rb,
lib/amazon_ads/apis/brand_stores.rb,
lib/amazon_ads/apis/ad_extensions.rb,
lib/amazon_ads/apis/geo_locations.rb,
lib/amazon_ads/apis/ad_associations.rb,
lib/amazon_ads/apis/recommendations.rb,
lib/amazon_ads/apis/deal_preferences.rb,
lib/amazon_ads/apis/location_indexes.rb,
lib/amazon_ads/apis/manager_accounts.rb,
lib/amazon_ads/apis/marketing_stream.rb,
lib/amazon_ads/apis/selling_accounts.rb,
lib/amazon_ads/apis/advertising_deals.rb,
lib/amazon_ads/apis/brand_store_pages.rb,
lib/amazon_ads/apis/commitment_spends.rb,
lib/amazon_ads/apis/campaign_forecasts.rb,
lib/amazon_ads/apis/supplier_proposals.rb,
lib/amazon_ads/apis/advertiser_accounts.rb,
lib/amazon_ads/apis/supplier_publishers.rb,
lib/amazon_ads/apis/brand_store_editions.rb,
lib/amazon_ads/apis/recommendation_types.rb,
lib/amazon_ads/apis/supplier_ad_products.rb,
lib/amazon_ads/apis/supplier_target_items.rb,
lib/amazon_ads/apis/supplier_proposed_deals.rb,
lib/amazon_ads/apis/advertising_deal_targets.rb,
lib/amazon_ads/apis/reserved_target_pricings.rb,
lib/amazon_ads/apis/branded_keywords_pricings.rb,
lib/amazon_ads/apis/supplier_ad_product_prices.rb,
lib/amazon_ads/apis/supplier_proposal_destinations.rb,
lib/amazon_ads/apis/keyword_reservation_validations.rb,
lib/amazon_ads/apis/supplier_proposed_deal_forecasts.rb,
lib/amazon_ads/apis/supplier_proposed_deal_revisions.rb,
lib/amazon_ads/apis/brand_store_edition_publish_versions.rb,
lib/amazon_ads/apis/supplier_proposed_deal_historical_versions.rb

Overview

Amazon Ads API client for Ruby

Defined Under Namespace

Classes: API, AdAssociations, AdExtensions, AdGroups, Ads, AdvertiserAccounts, AdvertisingDealTargets, AdvertisingDeals, BrandStoreEditionPublishVersions, BrandStoreEditions, BrandStorePages, BrandStores, BrandedKeywordsPricings, CampaignForecasts, Campaigns, CommitmentSpends, Commitments, DealPreferences, Error, GeoLocations, KeywordReservationValidations, LWA, LocationIndexes, ManagerAccounts, MarketingStream, Profiles, RecommendationTypes, Recommendations, Reporting, ReservedTargetPricings, SellingAccounts, SupplierAdProductPrices, SupplierAdProducts, SupplierProposalDestinations, SupplierProposals, SupplierProposedDealForecasts, SupplierProposedDealHistoricalVersions, SupplierProposedDealRevisions, SupplierProposedDeals, SupplierPublishers, SupplierTargetItems, Targets

Constant Summary collapse

VERSION = 
"0.5.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.client_id ⇒ Object

Returns the client ID Falls back to the AMAZON_ADS_CLIENT_ID env var

Signature:

  • () -> String?



24
25
26
 
# File 'lib/amazon_ads.rb', line 24

def self.client_id
  @client_id || ENV["AMAZON_ADS_CLIENT_ID"]
end

.client_secret ⇒ Object

Returns the client secret Falls back to the AMAZON_ADS_CLIENT_SECRET env var

Signature:

  • () -> String?



37
38
39
 
# File 'lib/amazon_ads.rb', line 37

def self.client_secret
  @client_secret || ENV["AMAZON_ADS_CLIENT_SECRET"]
end

Class Method Details

.client_id! ⇒ Object

Returns the client ID or raises

Signature:

  • () -> String



30
31
32
 
# File 'lib/amazon_ads.rb', line 30

def self.client_id!
  client_id or raise ArgumentError, "client id is required"
end

.client_secret! ⇒ Object

Returns the client secret or raises

Signature:

  • () -> String



43
44
45
 
# File 'lib/amazon_ads.rb', line 43

def self.client_secret!
  client_secret or raise ArgumentError, "client secret is required"
end