Skip to content
Ads API Client Libraries for Ruby
Ruby Other
  1. Ruby 99.9%
  2. Other 0.1%
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.


Type Name Latest commit message Commit time
Failed to load latest commit information.
ad_manager_api Adding missing AdRule and Report types for v202002. Feb 19, 2020
ads_common Support for Ads Common registry enumerations Jun 26, 2018
ads_savon Relaxing dependencies for better Rail compatibility Jul 18, 2017
adwords_api Removing support for v201806. Mar 26, 2019 Support for Ad Manager API v201808. Aug 21, 2018
LICENSE Syncing top level docs Aug 16, 2016 Update README to reference Ad Manager. Jan 23, 2019

Ads API Client Libraries for Ruby

This project hosts the new Ads common framework for Ruby, as well as the Ruby client libraries for the various SOAP-based Ads APIs at Google.

The Ruby client libraries make it easier to write Ruby clients to programmatically access your accounts.

New to the library? Take a look at the wiki for this project.

Want to stay up-to-date with our latest releases? Subscribe to the master RSS feed on GitHub.

Products currently supported

  • Google AdWords API AdWords Gem Version
  • Google Ad Manager API DFP Gem Version

Client library features

  • Support for logging incoming and outgoing SOAP messages
  • Support for logging request information
  • Based on Savon library
  • Ruby 2.1, 2.2, 2.3, and 2.4 compatible
  • OAuth2 and OAuth2 JWT built-in authentication
  • Local validation for parameter number and type on API calls
  • Thread-safe
  • Ruby-like syntax, by converting all method names and properties to snake_case instead of lowerCamelCase
  • Simplified development model by using arrays and hashes instead of solid objects
  • (AdWords) Full support for reporting and BatchJobService uploads

Getting started

  1. Install your library of choice using RubyGems.

     $ gem install google-adwords-api


     $ gem install google-dfp-api

    Note: If you're using a version of Ruby lower than 2.2.2, you will need to manually install a previous version of Rack, a dependency of our HTTP library. You can do this with:

     $ gem install rack -v 1.6.4
  2. Copy the sample config file (adwords_api.yml or ad_manager_api.yml) for your product to your home directory and fill out the required properties.

  1. Setup your OAuth2 credentials.

The AdWords and Ad Manager APIs use OAuth2 as the authentication mechanism. Follow the appropriate guide below based on your use case.

If you're accessing an API using your own credentials...

If you're accessing an API on behalf of clients...

  1. See each product's individual README for more specific instructions:

Submitting bug reports and/or feature requests

If you have issues directly related to the client library, use the issue tracker.

If you have issues pertaining to a specific product, use the product support forums:

Make sure to subscribe to our blog for API change announcements and other news.


To enable logging, see the library-specific README files for AdWords or Ad Manager.



See for details on how to contribute.

This library has adopted the community-driven style guide hosted by bbatsov. Updates to the existing code base will be made incrementally to conform to the style defined there, and all new code will be subject to that style guide. Keep this in mind while crafting contributions.

Note: if you have an ad blocker active, you might experience issues while submitting an issue or pull request. You can still contribute by disabling the ad blocker for this project URL.

You can’t perform that action at this time.