amazon-ads 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4e68acc1d736bb5c7f6a59b10163bce7a2622065a291fcebfe3aafd7e028fa2
+  data.tar.gz: 3f33dd9eeae73cfb943bf548efbb842393aea4b42d6b8f87fb79e8faad4f9d49
+SHA512:
+  metadata.gz: ef4d4bf550a0c1cbee2ca11b469906d576e35a1db35978e52896572ad202a0905d32087810e1ee750b358ee9409bb073b1f863485847588bfd1f2cfce7f901bf
+  data.tar.gz: 6755c1f89af12711d7dd3970e1ac37e9e3ac1872c944f497030bfa74a84e5cbbd825af087719cf68104e6be019302f7639138c0dcbe6006b2294dcf490448080

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Hakan Ensari
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Sponsor
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sponsor`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sponsor.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/amazon_ads/api.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+require "http"
+
+module AmazonAds
+  # Base class for Amazon Ads API clients.
+  # Handles authentication, response parsing, error mapping, and retry logic.
+  class API
+    ENDPOINTS = { #: Hash[Symbol, String]
+      na: "https://advertising-api.amazon.com",
+      eu: "https://advertising-api-eu.amazon.com",
+      fe: "https://advertising-api-fe.amazon.com",
+    }.freeze
+
+    MAX_RETRIES = 3 #: Integer
+    BASE_RETRY_DELAY = 1 #: Integer
+
+    attr_reader :region #: Symbol
+    attr_reader :profile_id #: String?
+
+    #: (region: Symbol, ?access_token: String?, ?lwa: LWA?, ?profile_id: String?) -> void
+    def initialize(region:, access_token: nil, lwa: nil, profile_id: nil)
+      @region = region
+      @access_token = access_token
+      @lwa = lwa
+      @profile_id = profile_id
+
+      unless @access_token || @lwa
+        raise ArgumentError, "Either access_token or lwa must be provided"
+      end
+    end
+
+    private
+
+    # Returns the current access token, refreshing via LWA if needed.
+    #: () -> String
+    def access_token
+      @lwa ? @lwa.access_token : @access_token or raise AmazonAds::AuthenticationError, "No access token"
+    end
+
+    #: () -> HTTP::Client
+    def http
+      HTTP
+        .headers(default_headers)
+        .use(:auto_inflate)
+    end
+
+    #: () -> Hash[String, String]
+    def default_headers
+      headers = {
+        "Authorization" => "Bearer #{access_token}",
+        "Amazon-Advertising-API-ClientId" => client_id,
+        "Content-Type" => "application/json",
+        "Accept" => "application/json",
+      }
+      headers["Amazon-Advertising-API-Scope"] = profile_id if profile_id
+
+      headers
+    end
+
+    #: () -> String
+    def client_id
+      ENV.fetch("AMAZON_ADS_CLIENT_ID")
+    end
+
+    #: () -> String
+    def endpoint
+      ENDPOINTS.fetch(region) do
+        raise ArgumentError, "Unknown region: #{region}"
+      end
+    end
+
+    # Handles HTTP response, raising appropriate errors or parsing success responses.
+    #: (HTTP::Response) -> untyped
+    def handle_response(response)
+      case response.status.code
+      when 200..299
+        return if response.body.to_s.empty?
+
+        response.parse
+      when 400
+        raise AmazonAds::BadRequestError.new("Bad request", response: response)
+      when 401
+        raise AmazonAds::AuthenticationError.new("Unauthorized", response: response)
+      when 404
+        raise AmazonAds::NotFoundError.new("Not found", response: response)
+      when 429
+        retry_after = response.headers["Retry-After"]&.to_i
+        raise AmazonAds::RateLimitError.new("Rate limited", response: response, retry_after: retry_after)
+      when 500..599
+        raise AmazonAds::ServerError.new("Server error", response: response)
+      else
+        raise AmazonAds::Error.new("Request failed with status #{response.status.code}", response: response)
+      end
+    end
+
+    # Executes request with retry logic for rate limiting.
+    #: () { () -> HTTP::Response } -> untyped
+    def with_retry(&block)
+      retries = 0
+
+      loop do
+        response = yield
+        return handle_response(response)
+      rescue AmazonAds::RateLimitError => e
+        retries += 1
+        raise if retries > MAX_RETRIES
+
+        delay = e.retry_after || (BASE_RETRY_DELAY * (2**(retries - 1)))
+        sleep(delay)
+      end
+    end
+
+    #: (String, ?params: Hash[String, untyped]) -> untyped
+    def get(path, params: {})
+      with_retry { http.get("#{endpoint}#{path}", params: params) }
+    end
+
+    #: (String, ?body: Hash[String, untyped]) -> untyped
+    def post(path, body: {})
+      with_retry { http.post("#{endpoint}#{path}", json: body) }
+    end
+
+    #: (String, ?body: Hash[String, untyped]) -> untyped
+    def put(path, body: {})
+      with_retry { http.put("#{endpoint}#{path}", json: body) }
+    end
+
+    #: (String, ?body: Hash[String, untyped]) -> untyped
+    def patch(path, body: {})
+      with_retry { http.patch("#{endpoint}#{path}", json: body) }
+    end
+
+    #: (String) -> untyped
+    def delete(path)
+      with_retry { http.delete("#{endpoint}#{path}") }
+    end
+  end
+end

data/lib/amazon_ads/apis/profiles.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module AmazonAds
+  # Amazon Ads API - Profiles
+  #
+  # @see https://advertising.amazon.com/API/docs/en-us/reference/profiles
+  class Profiles < API
+    # Gets a list of profiles.
+    #: (?api_program: String?, ?access_level: String?, ?profile_type_filter: String?, ?valid_payment_method_filter: String?) -> untyped
+    def list_profiles(api_program: nil, access_level: nil, profile_type_filter: nil, valid_payment_method_filter: nil)
+      get("/v2/profiles", params: { "apiProgram" => api_program, "accessLevel" => access_level, "profileTypeFilter" => profile_type_filter, "validPaymentMethodFilter" => valid_payment_method_filter }.compact)
+    end
+
+    # Update the daily budget for one or more profiles.
+    #: (?body: Hash[String, untyped]) -> untyped
+    def update_profiles(body: {})
+      put("/v2/profiles", body: body)
+    end
+
+    # Gets a profile specified by identifier.
+    #: (Integer) -> untyped
+    def get_profile_by_id(profile_id)
+      get("/v2/profiles/#{profile_id}")
+    end
+  end
+end

data/lib/amazon_ads/apis/sponsored_products.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module AmazonAds
+  # Amazon Ads API - Sponsored Products
+  #
+  # @see https://advertising.amazon.com/API/docs/en-us/sponsored-products
+  class SponsoredProducts < API
+    # Gets a bid recommendation for an ad group. [PLANNED DEPRECATION 3/27/2024]
+    #: (Numeric) -> untyped
+    def get_ad_group_bid_recommendations(ad_group_id)
+      get("/v2/sp/adGroups/#{ad_group_id}/bidRecommendations")
+    end
+
+    # Gets a bid recommendation for a keyword. [PLANNED DEPRECATION 3/27/2024]
+    #: (Numeric) -> untyped
+    def get_keyword_bid_recommendations(keyword_id)
+      get("/v2/sp/keywords/#{keyword_id}/bidRecommendations")
+    end
+
+    # Gets bid recommendations for keywords. [PLANNED DEPRECATION 3/27/2024]
+    #: (?body: Hash[String, untyped]) -> untyped
+    def create_keyword_bid_recommendations(body: {})
+      post("/v2/sp/keywords/bidRecommendations", body: body)
+    end
+
+    # Gets suggested keywords for the specified ad group.
+    #: (Numeric, ?max_num_suggestions: Integer?, ?ad_state_filter: String?) -> untyped
+    def get_ad_group_suggested_keywords(ad_group_id, max_num_suggestions: nil, ad_state_filter: nil)
+      get("/v2/sp/adGroups/#{ad_group_id}/suggested/keywords", params: { "maxNumSuggestions" => max_num_suggestions, "adStateFilter" => ad_state_filter }.compact)
+    end
+
+    # Gets suggested keywords with extended data for the specified ad group.
+    #: (Numeric, ?max_num_suggestions: Integer?, ?suggest_bids: String?, ?ad_state_filter: String?) -> untyped
+    def get_ad_group_suggested_keywords_ex(ad_group_id, max_num_suggestions: nil, suggest_bids: nil, ad_state_filter: nil)
+      get("/v2/sp/adGroups/#{ad_group_id}/suggested/keywords/extended", params: { "maxNumSuggestions" => max_num_suggestions, "suggestBids" => suggest_bids, "adStateFilter" => ad_state_filter }.compact)
+    end
+
+    # Gets suggested keywords for the specified ASIN.
+    #: (String, ?max_num_suggestions: Integer?) -> untyped
+    def get_asin_suggested_keywords(asin_value, max_num_suggestions: nil)
+      get("/v2/sp/asins/#{asin_value}/suggested/keywords", params: { "maxNumSuggestions" => max_num_suggestions }.compact)
+    end
+
+    # Gets suggested keyword for a specified list of ASINs.
+    #: (?body: Hash[String, untyped]) -> untyped
+    def bulk_get_asin_suggested_keywords(body: {})
+      post("/v2/sp/asins/suggested/keywords", body: body)
+    end
+
+    # Gets a list of bid recommendations for keyword, product, or auto targeting expressions.
+    #: (?body: Hash[String, untyped]) -> untyped
+    def get_bid_recommendations(body: {})
+      post("/v2/sp/targets/bidRecommendations", body: body)
+    end
+
+    # Request a snapshot
+    #: (String, ?body: Hash[String, untyped]) -> untyped
+    def request_snapshot(record_type, body: {})
+      post("/v2/sp/#{record_type}/snapshot", body: body)
+    end
+
+    # Get the status of a requested snapshot
+    #: (Numeric) -> untyped
+    def get_snapshot_status(snapshot_id)
+      get("/v2/sp/snapshots/#{snapshot_id}")
+    end
+
+    # Download requested snapshot
+    #: (Numeric) -> untyped
+    def download_snapshot(snapshot_id)
+      get("/v2/sp/snapshots/#{snapshot_id}/download")
+    end
+  end
+end

data/lib/amazon_ads/client.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module AmazonAds
+  # High-level client for Amazon Ads API.
+  # Provides convenient access to all API endpoints with automatic authentication.
+  class Client
+    attr_reader :lwa #: LWA
+    attr_reader :region #: Symbol
+    attr_reader :profile_id #: String?
+
+    #: (?region: Symbol, ?profile_id: String?, ?lwa: LWA?) -> void
+    def initialize(region: AmazonAds.configuration.region, profile_id: AmazonAds.configuration.profile_id, lwa: nil)
+      @lwa = lwa || AmazonAds.configuration.lwa
+      @region = region
+      @profile_id = profile_id
+    end
+
+    # Access Profiles API
+    #: () -> Profiles
+    def profiles
+      @profiles ||= Profiles.new(region: region, lwa: lwa, profile_id: profile_id)
+    end
+
+    # Access Sponsored Products API
+    #: () -> SponsoredProducts
+    def sponsored_products
+      @sponsored_products ||= SponsoredProducts.new(region: region, lwa: lwa, profile_id: profile_id)
+    end
+
+    # Creates a new client with a different profile ID
+    #: (String) -> Client
+    def with_profile(profile_id)
+      Client.new(region: region, profile_id: profile_id, lwa: lwa)
+    end
+  end
+end

data/lib/amazon_ads/configuration.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module AmazonAds
+  # Configuration for the AmazonAds library.
+  # Centralizes settings for authentication and API access.
+  class Configuration
+    attr_accessor :client_id #: String?
+    attr_accessor :client_secret #: String?
+    attr_accessor :refresh_token #: String?
+    attr_accessor :region #: Symbol
+    attr_accessor :profile_id #: String?
+
+    #: () -> void
+    def initialize
+      @client_id = ENV["AMAZON_ADS_CLIENT_ID"]
+      @client_secret = ENV["AMAZON_ADS_CLIENT_SECRET"]
+      @refresh_token = ENV["AMAZON_ADS_REFRESH_TOKEN"]
+      @region = :na
+      @profile_id = nil
+    end
+
+    # Builds an LWA instance from the configuration.
+    #: () -> LWA
+    def lwa
+      LWA.new(
+        client_id: client_id || raise(ArgumentError, "client_id is required"),
+        client_secret: client_secret || raise(ArgumentError, "client_secret is required"),
+        refresh_token: refresh_token || raise(ArgumentError, "refresh_token is required"),
+      )
+    end
+  end
+end

data/lib/amazon_ads/errors.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+module AmazonAds
+  # Base error class for AmazonAds API errors
+  class Error < StandardError
+    attr_reader :response #: HTTP::Response?
+
+    #: (?String?, ?response: HTTP::Response?) -> void
+    def initialize(message = nil, response: nil)
+      @response = response
+      super(message)
+    end
+  end
+
+  # Raised when authentication fails (401 Unauthorized)
+  class AuthenticationError < Error
+  end
+
+  # Raised when rate limited (429 Too Many Requests)
+  class RateLimitError < Error
+    attr_reader :retry_after #: Integer?
+
+    #: (?String?, ?response: HTTP::Response?, ?retry_after: Integer?) -> void
+    def initialize(message = nil, response: nil, retry_after: nil)
+      @retry_after = retry_after
+      super(message, response: response)
+    end
+  end
+
+  # Raised when resource not found (404 Not Found)
+  class NotFoundError < Error
+  end
+
+  # Raised when request is invalid (400 Bad Request)
+  class BadRequestError < Error
+  end
+
+  # Raised when server error occurs (5xx)
+  class ServerError < Error
+  end
+end

data/lib/amazon_ads/lwa.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+require "http"
+
+module AmazonAds
+  # Requests Login with Amazon (LWA) access tokens for the Amazon Ads API.
+  # Handles token caching and automatic refresh when tokens expire.
+  #
+  # @see https://advertising.amazon.com/API/docs/en-us/info/api-overview
+  class LWA
+    URL = "https://api.amazon.com/auth/o2/token" #: String
+    TOKEN_EXPIRY_BUFFER = 60 #: Integer
+
+    attr_reader :client_id #: String
+    attr_reader :client_secret #: String
+    attr_reader :refresh_token #: String
+
+    #: (?client_id: String, ?client_secret: String, ?refresh_token: String) -> void
+    def initialize(
+      client_id: ENV.fetch("AMAZON_ADS_CLIENT_ID"),
+      client_secret: ENV.fetch("AMAZON_ADS_CLIENT_SECRET"),
+      refresh_token: ENV.fetch("AMAZON_ADS_REFRESH_TOKEN")
+    )
+      @client_id = client_id
+      @client_secret = client_secret
+      @refresh_token = refresh_token
+      @access_token = nil #: String?
+      @expires_at = nil #: Time?
+      @mutex = Mutex.new
+    end
+
+    # Returns a valid access token, refreshing if necessary.
+    #: () -> String
+    def access_token
+      @mutex.synchronize do
+        refresh! if token_expired?
+        @access_token or raise AmazonAds::AuthenticationError, "Failed to obtain access token"
+      end
+    end
+
+    # Forces a token refresh regardless of expiry.
+    #: () -> String
+    def refresh!
+      response = HTTP.post(URL, form: params)
+
+      unless response.status.success?
+        body = begin
+          response.parse
+        rescue StandardError
+          {}
+        end
+        message = body["error_description"] || body["error"] || "Authentication failed"
+        raise AmazonAds::AuthenticationError.new(message, response: response)
+      end
+
+      data = response.parse
+      @access_token = data.fetch("access_token")
+      expires_in = data.fetch("expires_in", 3600)
+      @expires_at = Time.now + expires_in - TOKEN_EXPIRY_BUFFER
+
+      @access_token
+    end
+
+    # Returns true if the token is expired or not yet fetched.
+    #: () -> bool
+    def token_expired?
+      @access_token.nil? || @expires_at.nil? || Time.now >= @expires_at
+    end
+
+    private
+
+    #: () -> Hash[String, String]
+    def params
+      {
+        "grant_type" => "refresh_token",
+        "client_id" => client_id,
+        "client_secret" => client_secret,
+        "refresh_token" => refresh_token,
+      }
+    end
+  end
+end

data/lib/amazon_ads/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AmazonAds
+  VERSION = "0.1.0"
+end

data/lib/amazon_ads.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# rbs_inline: enabled
+
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect("api" => "API", "lwa" => "LWA")
+loader.collapse("#{__dir__}/amazon_ads/apis")
+loader.ignore("#{__dir__}/generator")
+loader.ignore("#{__dir__}/amazon_ads/errors.rb")
+loader.setup
+
+require_relative "amazon_ads/errors"
+
+# Amazon Ads API client for Ruby
+module AmazonAds
+  class << self
+    # Returns the global configuration object.
+    #: () -> Configuration
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Configures the AmazonAds library.
+    #: () { (Configuration) -> void } -> void
+    def configure
+      yield(configuration)
+    end
+
+    # Resets the configuration to defaults.
+    #: () -> void
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

data/sig/generated/amazon_ads/api.rbs

@@ -0,0 +1,61 @@
+# Generated from lib/amazon_ads/api.rb with RBS::Inline
+
+module AmazonAds
+  # Base class for Amazon Ads API clients.
+  # Handles authentication, response parsing, error mapping, and retry logic.
+  class API
+    ENDPOINTS: untyped
+
+    MAX_RETRIES: Integer
+
+    BASE_RETRY_DELAY: Integer
+
+    attr_reader region: Symbol
+
+    attr_reader profile_id: String?
+
+    # : (region: Symbol, ?access_token: String?, ?lwa: LWA?, ?profile_id: String?) -> void
+    def initialize: (region: Symbol, ?access_token: String?, ?lwa: LWA?, ?profile_id: String?) -> void
+
+    private
+
+    # Returns the current access token, refreshing via LWA if needed.
+    # : () -> String
+    def access_token: () -> String
+
+    # : () -> HTTP::Client
+    def http: () -> HTTP::Client
+
+    # : () -> Hash[String, String]
+    def default_headers: () -> Hash[String, String]
+
+    # : () -> String
+    def client_id: () -> String
+
+    # : () -> String
+    def endpoint: () -> String
+
+    # Handles HTTP response, raising appropriate errors or parsing success responses.
+    # : (HTTP::Response) -> untyped
+    def handle_response: (HTTP::Response) -> untyped
+
+    # Executes request with retry logic for rate limiting.
+    # : () { () -> HTTP::Response } -> untyped
+    def with_retry: () { () -> HTTP::Response } -> untyped
+
+    # : (String, ?params: Hash[String, untyped]) -> untyped
+    def get: (String, ?params: Hash[String, untyped]) -> untyped
+
+    # : (String, ?body: Hash[String, untyped]) -> untyped
+    def post: (String, ?body: Hash[String, untyped]) -> untyped
+
+    # : (String, ?body: Hash[String, untyped]) -> untyped
+    def put: (String, ?body: Hash[String, untyped]) -> untyped
+
+    # : (String, ?body: Hash[String, untyped]) -> untyped
+    def patch: (String, ?body: Hash[String, untyped]) -> untyped
+
+    # : (String) -> untyped
+    def delete: (String) -> untyped
+  end
+end

data/sig/generated/amazon_ads/apis/profiles.rbs

@@ -0,0 +1,20 @@
+# Generated from lib/amazon_ads/apis/profiles.rb with RBS::Inline
+
+module AmazonAds
+  # Amazon Ads API - Profiles
+  #
+  # @see https://advertising.amazon.com/API/docs/en-us/reference/profiles
+  class Profiles < API
+    # Gets a list of profiles.
+    # : (?api_program: String?, ?access_level: String?, ?profile_type_filter: String?, ?valid_payment_method_filter: String?) -> untyped
+    def list_profiles: (?api_program: String?, ?access_level: String?, ?profile_type_filter: String?, ?valid_payment_method_filter: String?) -> untyped
+
+    # Update the daily budget for one or more profiles.
+    # : (?body: Hash[String, untyped]) -> untyped
+    def update_profiles: (?body: Hash[String, untyped]) -> untyped
+
+    # Gets a profile specified by identifier.
+    # : (Integer) -> untyped
+    def get_profile_by_id: (Integer) -> untyped
+  end
+end

data/sig/generated/amazon_ads/apis/sponsored_products.rbs

@@ -0,0 +1,52 @@
+# Generated from lib/amazon_ads/apis/sponsored_products.rb with RBS::Inline
+
+module AmazonAds
+  # Amazon Ads API - Sponsored Products
+  #
+  # @see https://advertising.amazon.com/API/docs/en-us/sponsored-products
+  class SponsoredProducts < API
+    # Gets a bid recommendation for an ad group. [PLANNED DEPRECATION 3/27/2024]
+    # : (Numeric) -> untyped
+    def get_ad_group_bid_recommendations: (Numeric) -> untyped
+
+    # Gets a bid recommendation for a keyword. [PLANNED DEPRECATION 3/27/2024]
+    # : (Numeric) -> untyped
+    def get_keyword_bid_recommendations: (Numeric) -> untyped
+
+    # Gets bid recommendations for keywords. [PLANNED DEPRECATION 3/27/2024]
+    # : (?body: Hash[String, untyped]) -> untyped
+    def create_keyword_bid_recommendations: (?body: Hash[String, untyped]) -> untyped
+
+    # Gets suggested keywords for the specified ad group.
+    # : (Numeric, ?max_num_suggestions: Integer?, ?ad_state_filter: String?) -> untyped
+    def get_ad_group_suggested_keywords: (Numeric, ?max_num_suggestions: Integer?, ?ad_state_filter: String?) -> untyped
+
+    # Gets suggested keywords with extended data for the specified ad group.
+    # : (Numeric, ?max_num_suggestions: Integer?, ?suggest_bids: String?, ?ad_state_filter: String?) -> untyped
+    def get_ad_group_suggested_keywords_ex: (Numeric, ?max_num_suggestions: Integer?, ?suggest_bids: String?, ?ad_state_filter: String?) -> untyped
+
+    # Gets suggested keywords for the specified ASIN.
+    # : (String, ?max_num_suggestions: Integer?) -> untyped
+    def get_asin_suggested_keywords: (String, ?max_num_suggestions: Integer?) -> untyped
+
+    # Gets suggested keyword for a specified list of ASINs.
+    # : (?body: Hash[String, untyped]) -> untyped
+    def bulk_get_asin_suggested_keywords: (?body: Hash[String, untyped]) -> untyped
+
+    # Gets a list of bid recommendations for keyword, product, or auto targeting expressions.
+    # : (?body: Hash[String, untyped]) -> untyped
+    def get_bid_recommendations: (?body: Hash[String, untyped]) -> untyped
+
+    # Request a snapshot
+    # : (String, ?body: Hash[String, untyped]) -> untyped
+    def request_snapshot: (String, ?body: Hash[String, untyped]) -> untyped
+
+    # Get the status of a requested snapshot
+    # : (Numeric) -> untyped
+    def get_snapshot_status: (Numeric) -> untyped
+
+    # Download requested snapshot
+    # : (Numeric) -> untyped
+    def download_snapshot: (Numeric) -> untyped
+  end
+end

data/sig/generated/amazon_ads/client.rbs

@@ -0,0 +1,28 @@
+# Generated from lib/amazon_ads/client.rb with RBS::Inline
+
+module AmazonAds
+  # High-level client for Amazon Ads API.
+  # Provides convenient access to all API endpoints with automatic authentication.
+  class Client
+    attr_reader lwa: LWA
+
+    attr_reader region: Symbol
+
+    attr_reader profile_id: String?
+
+    # : (?region: Symbol, ?profile_id: String?, ?lwa: LWA?) -> void
+    def initialize: (?region: Symbol, ?profile_id: String?, ?lwa: LWA?) -> void
+
+    # Access Profiles API
+    # : () -> Profiles
+    def profiles: () -> Profiles
+
+    # Access Sponsored Products API
+    # : () -> SponsoredProducts
+    def sponsored_products: () -> SponsoredProducts
+
+    # Creates a new client with a different profile ID
+    # : (String) -> Client
+    def with_profile: (String) -> Client
+  end
+end

data/sig/generated/amazon_ads/configuration.rbs

@@ -0,0 +1,24 @@
+# Generated from lib/amazon_ads/configuration.rb with RBS::Inline
+
+module AmazonAds
+  # Configuration for the AmazonAds library.
+  # Centralizes settings for authentication and API access.
+  class Configuration
+    attr_accessor client_id: String?
+
+    attr_accessor client_secret: String?
+
+    attr_accessor refresh_token: String?
+
+    attr_accessor region: Symbol
+
+    attr_accessor profile_id: String?
+
+    # : () -> void
+    def initialize: () -> void
+
+    # Builds an LWA instance from the configuration.
+    # : () -> LWA
+    def lwa: () -> LWA
+  end
+end

data/sig/generated/amazon_ads/errors.rbs

@@ -0,0 +1,35 @@
+# Generated from lib/amazon_ads/errors.rb with RBS::Inline
+
+module AmazonAds
+  # Base error class for AmazonAds API errors
+  class Error < StandardError
+    attr_reader response: HTTP::Response?
+
+    # : (?String?, ?response: HTTP::Response?) -> void
+    def initialize: (?String?, ?response: HTTP::Response?) -> void
+  end
+
+  # Raised when authentication fails (401 Unauthorized)
+  class AuthenticationError < Error
+  end
+
+  # Raised when rate limited (429 Too Many Requests)
+  class RateLimitError < Error
+    attr_reader retry_after: Integer?
+
+    # : (?String?, ?response: HTTP::Response?, ?retry_after: Integer?) -> void
+    def initialize: (?String?, ?response: HTTP::Response?, ?retry_after: Integer?) -> void
+  end
+
+  # Raised when resource not found (404 Not Found)
+  class NotFoundError < Error
+  end
+
+  # Raised when request is invalid (400 Bad Request)
+  class BadRequestError < Error
+  end
+
+  # Raised when server error occurs (5xx)
+  class ServerError < Error
+  end
+end

data/sig/generated/amazon_ads/lwa.rbs

@@ -0,0 +1,39 @@
+# Generated from lib/amazon_ads/lwa.rb with RBS::Inline
+
+module AmazonAds
+  # Requests Login with Amazon (LWA) access tokens for the Amazon Ads API.
+  # Handles token caching and automatic refresh when tokens expire.
+  #
+  # @see https://advertising.amazon.com/API/docs/en-us/info/api-overview
+  class LWA
+    URL: String
+
+    TOKEN_EXPIRY_BUFFER: Integer
+
+    attr_reader client_id: String
+
+    attr_reader client_secret: String
+
+    attr_reader refresh_token: String
+
+    # : (?client_id: String, ?client_secret: String, ?refresh_token: String) -> void
+    def initialize: (?client_id: String, ?client_secret: String, ?refresh_token: String) -> void
+
+    # Returns a valid access token, refreshing if necessary.
+    # : () -> String
+    def access_token: () -> String
+
+    # Forces a token refresh regardless of expiry.
+    # : () -> String
+    def refresh!: () -> String
+
+    # Returns true if the token is expired or not yet fetched.
+    # : () -> bool
+    def token_expired?: () -> bool
+
+    private
+
+    # : () -> Hash[String, String]
+    def params: () -> Hash[String, String]
+  end
+end

data/sig/generated/amazon_ads.rbs

@@ -0,0 +1,16 @@
+# Generated from lib/amazon_ads.rb with RBS::Inline
+
+# Amazon Ads API client for Ruby
+module AmazonAds
+  # Returns the global configuration object.
+  # : () -> Configuration
+  def self.configuration: () -> Configuration
+
+  # Configures the AmazonAds library.
+  # : () { (Configuration) -> void } -> void
+  def self.configure: () { (Configuration) -> void } -> void
+
+  # Resets the configuration to defaults.
+  # : () -> void
+  def self.reset_configuration!: () -> void
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: amazon-ads
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hakan Ensari
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+email:
+- hakanensari@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/amazon_ads.rb
+- lib/amazon_ads/api.rb
+- lib/amazon_ads/apis/profiles.rb
+- lib/amazon_ads/apis/sponsored_products.rb
+- lib/amazon_ads/client.rb
+- lib/amazon_ads/configuration.rb
+- lib/amazon_ads/errors.rb
+- lib/amazon_ads/lwa.rb
+- lib/amazon_ads/version.rb
+- sig/generated/amazon_ads.rbs
+- sig/generated/amazon_ads/api.rbs
+- sig/generated/amazon_ads/apis/profiles.rbs
+- sig/generated/amazon_ads/apis/sponsored_products.rbs
+- sig/generated/amazon_ads/client.rbs
+- sig/generated/amazon_ads/configuration.rbs
+- sig/generated/amazon_ads/errors.rbs
+- sig/generated/amazon_ads/lwa.rbs
+homepage: https://github.com/lineofflight/amazon-ads-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lineofflight/amazon-ads-ruby
+  source_code_uri: https://github.com/lineofflight/amazon-ads-ruby
+  changelog_uri: https://github.com/lineofflight/amazon-ads-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Amazon Ads API client for Ruby
+test_files: []