Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mcloonan committed Sep 22, 2016
1 parent 55531f1 commit f795c04
Showing 1 changed file with 37 additions and 25 deletions.
62 changes: 37 additions & 25 deletions README.md
@@ -1,52 +1,60 @@
# 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.
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.
The Ruby client libraries make it easier to write Ruby clients to
programmatically access your accounts.

New to the library? Check out the [Getting Started video screencast on YouTube](http://www.youtube.com/watch?v=PJx6oRyZx2Y) and take a look at the [wiki for this project](https://github.com/googleads/google-api-ads-ruby/wiki).
**New to the library?** Take a look at the [wiki for this project]
(https://github.com/googleads/google-api-ads-ruby/wiki).

**Want to stay up-to-date with our latest releases?** Subscribe to the [master RSS feed on GitHub](https://github.com/googleads/google-api-ads-ruby/commits/master.atom).
**Want to stay up-to-date with our latest releases?** Subscribe to the
[master RSS feed on GitHub]
(https://github.com/googleads/google-api-ads-ruby/commits/master.atom).

## Products currently supported

- Google AdWords API
- Google's DoubleClick For Publishers API

## Client Library Feature
## Client library features

- Support for logging incoming and outgoing SOAP messages
- Support for logging request information
- Based on Savon backend
- Based on Savon library
- Ruby 2.1 and 2.2 compatible
- OAuth2 and OAuth2 JWT built-in authentication
- Support for API calls to different environments (Production, Sandbox)
- 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) Support for tracking API unit usage
- (AdWords) Full support for AdHoc reporting
- 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.
1. Install your library of choice using RubyGems.

```
$ gem install google-adwords-api
$ gem install google-dfp-api
```
$ gem install google-adwords-api

1. Copy the sample config file (**adwords_api.yml** or **dfp_api.yml**) for your product to your home directory
and fill out the required properties.
or

$ gem install google-dfp-api


1. Copy the sample config file (**adwords_api.yml** or **dfp_api.yml**) for your
product to your home directory and fill out the required properties.

* [adwords_api.yml](https://github.com/googleads/google-api-ads-ruby/blob/master/adwords_api/adwords_api.yml)
* [dfp_api.yml](https://github.com/googleads/google-api-ads-ruby/blob/master/dfp_api/dfp_api.yml)

1. Setup your OAuth2 credentials.

The AdWords and DoubleClick for Publishers APIs use
[OAuth2](http://oauth.net/2/) as the authentication mechanism. Follow the appropriate guide below based on your use case.
[OAuth2](http://oauth.net/2/) as the authentication mechanism. Follow the
appropriate guide below based on your use case.

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

Expand All @@ -57,26 +65,30 @@ and fill out the required properties.

* [Developing a web application (AdWords or DFP)](https://github.com/googleads/google-api-ads-ruby/wiki/API-access-on-behalf-of-your-clients-(web-flow))

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

* [AdWords](https://github.com/googleads/google-api-ads-ruby/blob/master/adwords_api/README.md)
* [DFP](https://github.com/googleads/google-api-ads-ruby/blob/master/dfp_api/README.md)

## Submitting bug reports and/or feature requests

If you have issues directly related to the client library, use the [issue tracker](https://github.com/googleads/google-api-ads-ruby/issues).
If you have issues directly related to the client library, use the [issue
tracker](https://github.com/googleads/google-api-ads-ruby/issues).

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

* [AdWords](https://groups.google.com/forum/#!forum/adwords-api)
* [DoubleClick for Publishers](https://groups.google.com/forum/#!forum/google-doubleclick-for-publishers-api)

Make sure to subscribe to our [Google Plus page](https://plus.google.com/+GoogleAdsDevelopers)
for API change announcements and other news.
Make sure to subscribe to our [Google Plus page]
(https://plus.google.com/+GoogleAdsDevelopers) for API change announcements and
other news.

## Logging

To enable logging, see the library-specific README files for [AdWords](https://github.com/googleads/google-api-ads-ruby/blob/master/adwords_api/README.md#23---logging) and [DFP](https://github.com/googleads/google-api-ads-ruby/blob/master/dfp_api/README.md#how-do-i-enable-logging).
To enable logging, see the library-specific README files for [AdWords](https://github.com/googleads/google-api-ads-ruby/blob/master/adwords_api/README.md#23---logging)
or [DFP](https://github.com/googleads/google-api-ads-ruby/blob/master/dfp_api/README.md#how-do-i-enable-logging).

## Updates

Expand Down

0 comments on commit f795c04

Please sign in to comment.