google-api-client 0.32.1 → 0.40.0

data/docs/oauth.md

@@ -0,0 +1,268 @@
+# OAuth 2.0
+
+This document describes OAuth 2.0, when to use it, how to acquire client IDs and client secrets, and generally how to use OAuth 2.0 with the Google API Client Library for Ruby.
+
+## About OAuth 2.0
+
+OAuth 2.0 is the authorization protocol used by Google APIs. It is summarized on the Authentication page of this library's documentation, and there are other good references as well:
+
+- [The OAuth 2.0 Authorization Protocol](https://tools.ietf.org/html/rfc6749)
+- [Using OAuth 2.0 to Access Google APIs](https://developers.google.com/identity/protocols/OAuth2)
+
+## Acquiring client IDs and secrets
+
+To find your project's client ID and client secret, do the following:
+
+Select an existing OAuth 2.0 credential or open the Credentials page.
+If you haven't done so already, create your project's OAuth 2.0 credentials by clicking Create credentials > OAuth client ID, and providing the information needed to create the credentials.
+Look for the Client ID in the OAuth 2.0 client IDs section. For details, click the client ID.
+There are different types of client IDs, so be sure to get the correct type for your application:
+
+*   Web application client IDs
+*   Installed application client IDs
+*   [Service Account](https://developers.google.com/accounts/docs/OAuth2ServiceAccount) client IDs
+
+**Warning**: Keep your client secret private. If someone obtains your client secret, they could use it to consume your quota, incur charges against your Google APIs Console project, and request access to user data.
+
+## The Signet library
+
+The [Signet](https://github.com/googleapis/signet) library is included with the Google API Client Library for Ruby. It handles all steps of the OAuth 2.0 protocol required for making API calls. It is available as a separate gem if you only need an OAuth 2.0 library.
+
+## Flows
+
+There are three main OAuth 2.0 flows in the Google API Client Library for Ruby: web server, installed application and service account.
+
+## Web server
+
+We start by retrieving the client ID and client secret from a preconfigured client_secrets.json file:
+
+```rb
+client_secrets = Google::APIClient::ClientSecrets.load
+```
+For web-based applications, we then redirect the user to an authorization page:
+
+```rb
+# Request authorization
+redirect user_credentials.authorization_uri.to_s, 303
+```
+
+The user completes the steps on her browser, and control gets returned to the application via the callback URL:
+
+```rb
+get '/oauth2callback' do
+  # Exchange token
+  user_credentials.code = params[:code] if params[:code]
+  user_credentials.fetch_access_token!
+  redirect to('/')
+end
+```
+
+user_credentials now has everything needed to make authenticated requests:
+
+```rb
+events = calendar.list_events('primary', options: { authorization: user_credentials })
+```
+
+Below is the full sample we've been looking at.
+
+```rb
+require 'google/apis/calendar_v3'
+require 'google/api_client/client_secrets'
+require 'sinatra'
+require 'logger'
+
+enable :sessions
+
+def logger; settings.logger end
+
+def calendar; settings.calendar; end
+
+def user_credentials
+  # Build a per-request oauth credential based on token stored in session
+  # which allows us to use a shared API client.
+  @authorization ||= (
+    auth = settings.authorization.dup
+    auth.redirect_uri = to('/oauth2callback')
+    auth.update_token!(session)
+    auth
+  )
+end
+
+configure do
+  log_file = File.open('calendar.log', 'a+')
+  log_file.sync = true
+  logger = Logger.new(log_file)
+  logger.level = Logger::DEBUG
+
+  Google::Apis::ClientOptions.default.application_name = 'Ruby Calendar sample'
+  Google::Apis::ClientOptions.default.application_version = '1.0.0'
+  calendar_api = Google::Apis::CalendarV3::CalendarService.new
+
+  client_secrets = Google::APIClient::ClientSecrets.load
+  authorization = client_secrets.to_authorization
+  authorization.scope = 'https://www.googleapis.com/auth/calendar'
+
+  set :authorization, authorization
+  set :logger, logger
+  set :calendar, calendar_api
+end
+
+before do
+  # Ensure user has authorized the app
+  unless user_credentials.access_token || request.path_info =~ /^\/oauth2/
+    redirect to('/oauth2authorize')
+  end
+end
+
+after do
+  # Serialize the access/refresh token to the session and credential store.
+  session[:access_token] = user_credentials.access_token
+  session[:refresh_token] = user_credentials.refresh_token
+  session[:expires_in] = user_credentials.expires_in
+  session[:issued_at] = user_credentials.issued_at
+end
+
+get '/oauth2authorize' do
+  # Request authorization
+  redirect user_credentials.authorization_uri.to_s, 303
+end
+
+get '/oauth2callback' do
+  # Exchange token
+  user_credentials.code = params[:code] if params[:code]
+  user_credentials.fetch_access_token!
+  redirect to('/')
+end
+
+get '/' do
+  # Fetch list of events on the user's default calandar
+  events = calendar.list_events('primary', options: { authorization: user_credentials })
+  [200, {'Content-Type' => 'application/json'}, events.to_h.to_json]
+end
+```
+
+### Installed application
+
+We start by retrieving the client ID and client secret from a preconfigured client_secrets.json file:
+
+```rb
+client_secrets = Google::APIClient::ClientSecrets.load
+```
+
+For installed applications, we can use the Google::APIClient::InstalledAppFlow helper class to handle most of the setup:
+
+```rb
+flow = Google::APIClient::InstalledAppFlow.new(
+    :client_id => client_secrets.client_id,
+    :client_secret => client_secrets.client_secret,
+    :scope => ['https://www.googleapis.com/auth/adsense.readonly']
+)
+```
+
+The user completes the steps on her browser, which is opened automatically, and the authorization code is fed into the application automatically, so all it takes is:
+
+```rb
+adsense.authorization = flow.authorize(storage)
+```
+
+The client now has everything needed to make an authenticated request:
+
+```rb
+  report = adsense.generate_report(start_date: '2011-01-01', end_date: '2011-08-31',
+                                   metric: %w(PAGE_VIEWS AD_REQUESTS AD_REQUESTS_COVERAGE
+                                              CLICKS AD_REQUESTS_CTR COST_PER_CLICK
+                                              AD_REQUESTS_RPM EARNINGS),
+                                   dimension: %w(DATE),
+                                   sort: %w(+DATE))
+```
+
+Below is the full sample we've been looking at.
+
+```rb
+# AdSense Management API command-line sample.
+require 'google/apis/adsense_v1_4'
+require 'google/api_client/client_secrets'
+require 'google/api_client/auth/installed_app'
+require 'google/api_client/auth/storage'
+require 'google/api_client/auth/storages/file_store'
+require 'logger'
+require 'json'
+
+CREDENTIAL_STORE_FILE = "#{$0}-oauth2.json"
+
+# Handles authentication and loading of the API.
+def setup
+  log_file = File.open('adsense.log', 'a+')
+  log_file.sync = true
+  logger = Logger.new(log_file)
+  logger.level = Logger::DEBUG
+
+  adsense = Google::Apis::AdsenseV1_4::AdSenseService.new
+
+  # Stores auth credentials in a file, so they survive multiple runs
+  # of the application. This avoids prompting the user for authorization every
+  # time the access token expires, by remembering the refresh token.
+  # Note: FileStorage is not suitable for multi-user applications.
+  storage = Google::APIClient::Storage.new(
+    Google::APIClient::FileStore.new(CREDENTIAL_STORE_FILE))
+  adsense.authorization = storage.authorize
+  if storage.authorization.nil?
+    client_secrets = Google::APIClient::ClientSecrets.load
+    # The InstalledAppFlow is a helper class to handle the OAuth 2.0 installed
+    # application flow, which ties in with Stroage to store credentials
+    # between runs.
+    flow = Google::APIClient::InstalledAppFlow.new(
+      :client_id => client_secrets.client_id,
+      :client_secret => client_secrets.client_secret,
+      :scope => ['https://www.googleapis.com/auth/adsense.readonly']
+    )
+    adsense.authorization = flow.authorize(storage)
+  end
+  return adsense
+end
+
+# Generates a report for the default account.
+def generate_report(adsense)
+  report = adsense.generate_report(start_date: '2011-01-01', end_date: '2011-08-31',
+                                   metric: %w(PAGE_VIEWS AD_REQUESTS AD_REQUESTS_COVERAGE
+                                              CLICKS AD_REQUESTS_CTR COST_PER_CLICK
+                                              AD_REQUESTS_RPM EARNINGS),
+                                   dimension: %w(DATE),
+                                   sort: %w(+DATE))
+
+  # Display headers.
+  report.headers.each do |header|
+    print '%25s' % header.name
+  end
+  puts
+
+  # Display results.
+  report.rows.each do |row|
+    row.each do |column|
+      print '%25s' % column
+    end
+    puts
+  end
+end
+
+
+if __FILE__ == $0
+  adsense = setup()
+  generate_report(adsense)
+end
+```
+
+## Service accounts
+
+For server-to-server interactions, like those between a web application and Google Cloud Storage, Prediction, or BigQuery APIs, you can use service accounts.
+
+```rb
+require 'googleauth'
+require 'google/apis/compute_v1'
+
+compute = Google::Apis::ComputeV1::ComputeService.new
+
+# Get the environment configured authorization
+scopes =  ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/compute']
+compute.authorization = Google::Auth.get_application_default(scopes)
+```

data/docs/pagination.md

@@ -0,0 +1,29 @@
+# Pagination
+
+Some API methods may return very large lists of data. To reduce the response size, many of these API methods support pagination. With paginated results, your application can iteratively request and process large lists one page at a time. When using API methods that support pagination, responses will come back with a next_page property, which builds a request for the next page for you.
+
+To process the first page of results, construct a request as you normally would. There's usually an API-level parameter you can provide to specify the maximum size of each page, so be sure to check the API's documentation.
+
+`stamps = service.list_stamps(cents: 5, max_results: 20)`
+
+For further pages, repeat the request including the next page token from the previous result.
+
+`stamps = service.list_stamps(cents:5, max_results: 20, page_token: stamps.next_page_token)`
+
+Here is a full example which loops through the paginated results of a user's public Google Plus activities feed:
+
+```rb
+require 'google/apis/plus_v1'
+
+plus = Google::Apis::PlusV1::PlusService.new
+plus.key = '...' # API Key from the Google Developers Console
+next_page = nil
+begin
+  puts "Fetching page of activities"
+  activities = plus.list_activities('103354693083460731603', 'public', page_token: next_page)
+  activities.items.each do |activity|
+    puts "#{activity.published} #{activity.title}"
+  end
+  next_page = activities.next_page_token
+end while next_page
+```

data/docs/performance.md

@@ -0,0 +1,25 @@
+# Performance Tips
+
+This document covers techniques you can use to improve the performance of your application. The documentation for the specific API you are using should have a similar page with more detail on some of these topics. For example, see the Performance Tips page for the Google Drive API.
+
+## Partial response (fields parameter)
+
+By default, the server sends back the full representation of a resource after processing requests. For better performance, you can ask the server to send only the fields you really need and get a partial response instead.
+
+To request a partial response, add the standard fields parameter to any API method. The value of this parameter specifies the fields you want returned. You can use this parameter with any request that returns response data.
+
+In the following code snippet, the list_stamps method of a fictitious Stamps API is called. The cents parameter is defined by the API to only return stamps with the given value. The value of the fields parameter is set to 'count,items/name'code>. The response will only contain stamps whose value is 5 cents, and the data returned will only include the number of stamps found along with the stamp names:
+
+`response = service.list_stamps(cents: 5, fields: 'count,items/name')`
+
+Note how commas are used to delimit the desired fields, and slashes are used to indicate fields that are contained in parent fields. There are other formatting options for the fields parameter, and you should see the "Performance Tips" page in the documentation for the API you are using.
+
+## Partial update (patch)
+
+If the API you are calling supports patch, you can avoid sending unnecessary data when modifying resources. For these APIs, you can call the patch() method and supply the arguments you wish to modify for the resource. If supported, the API's reference will have documentation for the patch() method.
+
+For more information about patch semantics, see the "Performance Tips" page in the documentation for the API you are using.
+
+## Batch
+
+If you are sending many small requests you may benefit from batching, which allows those requests to be bundled into a single HTTP request.

data/generated/google/apis/abusiveexperiencereport_v1.rb

@@ -26,10 +26,7 @@ module Google
     # @see https://developers.google.com/abusive-experience-report/
     module AbusiveexperiencereportV1
       VERSION = 'V1'
-      REVISION = '20190902'
-
-      # Test scope for access to the Zoo service
-      AUTH_XAPI_ZOO = 'https://www.googleapis.com/auth/xapi.zoo'
+      REVISION = '20200210'
     end
   end
 end

data/generated/google/apis/acceleratedmobilepageurl_v1.rb

@@ -26,7 +26,7 @@ module Google
     # @see https://developers.google.com/amp/cache/
     module AcceleratedmobilepageurlV1
       VERSION = 'V1'
-      REVISION = '20180612'
+      REVISION = '20200215'
     end
   end
 end