4 <dt>Homepage</dt><dd><a href="http://www.github.com/google/google-api-ruby-client">http://www.github.com/google/google-api-ruby-client</a></dd>
5 <dt>Authors</dt><dd>Bob Aman, <a href="mailto:sbazyl@google.com">Steven Bazyl</a></dd>
6 <dt>Copyright</dt><dd>Copyright © 2011 Google, Inc.</dd>
7 <dt>License</dt><dd>Apache 2.0</dd>
10 [![Build Status](https://secure.travis-ci.org/google/google-api-ruby-client.png)](http://travis-ci.org/google/google-api-ruby-client)
11 [![Dependency Status](https://gemnasium.com/google/google-api-ruby-client.png)](https://gemnasium.com/google/google-api-ruby-client)
15 The Google API Ruby Client makes it trivial to discover and access supported
20 This library is in Alpha. Some advanced features may not work. Please file bugs if any problems are found.
24 Be sure `https://rubygems.org/` is in your gem sources.
26 For normal client usage, this is sufficient:
29 $ gem install google-api-client
35 require 'google/api_client'
36 require 'google/api_client/client_secrets'
37 require 'google/api_client/auth/installed_app'
39 # Initialize the client.
40 client = Google::APIClient.new(
41 :application_name => 'Example Ruby application',
42 :application_version => '1.0.0'
45 # Initialize Google+ API. Note this will make a request to the
46 # discovery service every time, so be sure to use serialization
47 # in your production code. Check the samples for more details.
48 plus = client.discovered_api('plus')
50 # Load client secrets from your client_secrets.json.
51 client_secrets = Google::APIClient::ClientSecrets.load
53 # Run installed application flow. Check the samples for a more
54 # complete example that saves the credentials between runs.
55 flow = Google::APIClient::InstalledAppFlow.new(
56 :client_id => client_secrets.client_id,
57 :client_secret => client_secrets.client_secret,
58 :scope => ['https://www.googleapis.com/auth/plus.me']
60 client.authorization = flow.authorize
63 result = client.execute(
64 :api_method => plus.activities.list,
65 :parameters => {'collection' => 'public', 'userId' => 'me'}
75 To take full advantage of the client, load API definitions prior to use. To load an API:
78 urlshortener = client.discovered_api('urlshortener')
81 Specific versions of the API can be loaded as well:
84 drive = client.discovered_api('drive', 'v2')
87 Locally cached discovery documents may be used as well. To load an API from a local file:
90 doc = File.read('my-api.json')
91 my_api = client.register_discovery_document('myapi', 'v1', doc)
96 Most interactions with Google APIs require users to authorize applications via OAuth 2.0. The client library uses [Signet](https://github.com/google/signet) to handle most aspects of authorization. For additional details about Google's OAuth support, see [Google Developers](https://developers.google.com/accounts/docs/OAuth2).
98 Credentials can be managed at the connection level, as shown, or supplied on a per-request basis when calling `execute`.
100 For server-to-server interactions, like those between a web application and Google Cloud Storage, Prediction, or BigQuery APIs, use service accounts.
103 key = Google::APIClient::KeyUtils.load_from_pkcs12('client.p12', 'notasecret')
104 client.authorization = Signet::OAuth2::Client.new(
105 :token_credential_uri => 'https://accounts.google.com/o/oauth2/token',
106 :audience => 'https://accounts.google.com/o/oauth2/token',
107 :scope => 'https://www.googleapis.com/auth/prediction',
108 :issuer => '123456-abcdef@developer.gserviceaccount.com',
110 client.authorization.fetch_access_token!
114 Service accounts are also used for delegation in Google Apps domains. The target user for impersonation is specified by setting the `:person` parameter to the user's email address
115 in the credentials. Detailed instructions on how to enable delegation for your domain can be found at [developers.google.com](https://developers.google.com/drive/delegation).
117 ### Automatic Retries & Backoff
119 The API client can automatically retry requests for recoverable errors. To enable retries, set the `client.retries` property to
120 the number of additional attempts. To avoid flooding servers, retries invovle a 1 second delay that increases on each subsequent retry.
122 The default value for retries is 0, but will be enabled by default in future releases.
124 ### Batching Requests
126 Some Google APIs support batching requests into a single HTTP request. Use `Google::APIClient::BatchRequest`
127 to bundle multiple requests together.
132 client = Google::APIClient.new
133 urlshortener = client.discovered_api('urlshortner')
135 batch = Google::APIClient::BatchRequest.new do |result|
139 batch.add(:api_method => urlshortener.url.insert,
140 :body_object => { 'longUrl' => 'http://example.com/foo' })
141 batch.add(:api_method => urlshortener.url.insert,
142 :body_object => { 'longUrl' => 'http://example.com/bar' })
143 client.execute(batch)
146 Blocks for handling responses can be specified either at the batch level or when adding an individual API call. For example:
149 batch.add(:api_method=>urlshortener.url.insert, :body_object => { 'longUrl' => 'http://example.com/bar' }) do |result|
156 For APIs that support file uploads, use `Google::APIClient::UploadIO` to load the stream. Both multipart and resumable
157 uploads can be used. For example, to upload a file to Google Drive using multipart
160 drive = client.discovered_api('drive', 'v2')
162 media = Google::APIClient::UploadIO.new('mymovie.m4v', 'video/mp4')
164 'title' => 'My movie',
165 'description' => 'The best home movie ever made'
167 client.execute(:api_method => drive.files.insert,
168 :parameters => { 'uploadType' => 'multipart' },
169 :body_object => metadata,
173 To use resumable uploads, change the `uploadType` parameter to `resumable`. To check the status of the upload
174 and continue if necessary, check `result.resumable_upload`.
177 client.execute(:api_method => drive.files.insert,
178 :parameters => { 'uploadType' => 'resumable' },
179 :body_object => metadata,
181 upload = result.resumable_upload
185 client.execute(upload)
191 See the full list of [samples on Github](https://github.com/google/google-api-ruby-client-samples).
196 Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).