將 OAuth 2.0 用於網路伺服器應用程式

本文說明網路伺服器應用程式如何使用 Google API 用戶端程式庫或 Google OAuth 2.0 端點，實作 OAuth 2.0 授權以存取 Google API。

OAuth 2.0 可讓使用者與應用程式共用特定資料，同時保有使用者名稱、密碼和其他資訊的隱私。舉例來說，應用程式可透過 OAuth 2.0 取得使用者授權，以便在 Google 雲端硬碟中儲存檔案。

這個 OAuth 2.0 流程專門用於使用者授權。這個 API 適用於可儲存機密資訊並維持狀態的應用程式。當使用者與應用程式互動時，或在使用者離開應用程式後，確實授權的網路伺服器應用程式可以存取 API。

網路伺服器應用程式也會經常使用 服務帳戶授權 API 要求，特別是在呼叫 Cloud API 存取專案型資料 (而非使用者專屬資料) 時。網路伺服器應用程式可將服務帳戶結合使用者授權。

用戶端程式庫

本頁中的特定語言範例會使用 Google API 用戶端程式庫實作 OAuth 2.0 授權。如要執行程式碼範例，您必須先安裝您語言的用戶端程式庫。

當您使用 Google API 用戶端程式庫處理應用程式的 OAuth 2.0 流程時，用戶端程式庫會執行應用程式原本需要處理的許多動作，例如，它可判斷應用程式何時可以使用或更新儲存的存取權杖，以及應用程式何時必須取得同意聲明。用戶端程式庫也會產生正確的重新導向網址，並協助導入重新導向處理常式，以便交換存取權杖的授權碼。

伺服器端應用程式的 Google API 用戶端程式庫支援下列語言：

必要條件

為專案啟用 API

凡是呼叫 Google API 的應用程式，都必須在 API Console中啟用這些 API。

如要為專案啟用 API，請按照下列步驟操作：

  1. Open the API Library (位於 Google API Console中)。
  2. If prompted, select a project, or create a new one.
  3. API Library 會列出所有可用的 API，並按照產品系列和熱門程度分組。如果清單裡找不到您想啟用的 API，請用搜尋功能尋找，或按一下所屬產品系列中的「查看全部」。
  4. 選取要啟用的 API，然後按一下「Enable」按鈕。
  5. If prompted, enable billing.
  6. If prompted, read and accept the API's Terms of Service.

建立授權憑證

凡是使用 OAuth 2.0 存取 Google API 的應用程式，都必須具備可讓 Google 的 OAuth 2.0 伺服器識別應用程式的授權憑證。下列步驟說明如何為專案建立憑證，如此一來，您的應用程式就能使用憑證，存取您為該專案啟用的 API。

  1. Go to the Credentials page.
  2. 按一下 [Create credentials] (建立憑證) > [OAuth client ID] (OAuth 用戶端 ID)。
  3. 選取「Web application」(網頁應用程式) 應用程式類型。
  4. 填寫表單並按一下「建立」。如果應用程式使用 PHP、Java、Python、Ruby 和 .NET 等語言和架構，就必須指定經過授權的重新導向 URI。重新導向 URI 是 OAuth 2.0 伺服器可傳送回應的端點。這些端點必須遵守 Google 的驗證規則。

    如要進行測試，您可以指定參照本機電腦的 URI，例如 http://localhost:8080。請記住，請注意，本說明文件中的所有範例均使用 http://localhost:8080 做為重新導向 URI。

    建議您設計應用程式的驗證端點，讓應用程式不會向網頁上的其他資源公開授權碼。

建立憑證後，請從 API Console下載 client_secret.json 檔案。請將檔案安全地儲存在只有您的應用程式可存取的位置。

識別存取權範圍

範圍可讓應用程式僅要求存取所需資源，同時讓使用者控制對應用程式授予的存取權量。因此，要求的範圍數量和獲得使用者同意聲明的可能性可能會有反思。

開始實作 OAuth 2.0 授權前，建議您先找出應用程式需要存取的範圍。

此外，我們也建議應用程式透過增量授權程序要求存取授權範圍，讓應用程式在相關情境中要求存取使用者資料。這項最佳做法可協助使用者輕鬆瞭解應用程式需要存取權的原因。

OAuth 2.0 API 範圍文件包含可用於存取 Google API 的完整範圍清單。

特定語言的規範

您必須具備 Google 帳戶、網際網路連線和網路瀏覽器，才能執行本文中的任何程式碼範例。如果您使用其中一種 API 用戶端程式庫，請同時參閱下列各種語言的特定規定。

PHP

如要執行本文件中的 PHP 程式碼範例，您需要：

  • 已安裝指令列介面 (CLI) 和 JSON 擴充功能的 PHP 5.6 以上版本。
  • Composer 依附元件管理工具。

  • PHP 適用的 Google API 用戶端程式庫：

    composer require google/apiclient:^2.10

Python

如要執行本文件中的 Python 程式碼範例，您需要：

  • Python 2.6 以上版本
  • pip 套件管理工具。
  • Python 適用的 Google API 用戶端程式庫： 
    pip install --upgrade google-api-python-client
  • google-auth、google-auth-oauthlib 和 google-auth-httplib2 用於使用者授權。 
    pip install --upgrade google-auth google-auth-oauthlib google-auth-httplib2
  • Flask Python 網頁應用程式架構。 
    pip install --upgrade flask
  • requests HTTP 程式庫。 
    pip install --upgrade requests

Ruby

如要執行本文件中的 Ruby 程式碼範例，您需要：

  • Ruby 2.6 以上版本

  • Ruby 適用的 Google 驗證程式庫：

    gem install googleauth

  • Sinatra Ruby 網頁應用程式架構。

    gem install sinatra

Node.js

如要執行本文件中的 Node.js 程式碼範例，您需要：

  • Node.js 的維護 LTS、有效 LTS 或目前版本。

  • Google API Node.js 用戶端：

    npm install googleapis

HTTP/REST

您不需要安裝任何程式庫，就能直接呼叫 OAuth 2.0 端點。

取得 OAuth 2.0 存取權杖

下列步驟顯示您的應用程式如何與 Google 的 OAuth 2.0 伺服器互動，取得使用者的同意，以便代表使用者執行 API 要求。您的應用程式必須取得同意，才能執行需要使用者授權的 Google API 要求。

下方清單概略說明這些步驟：

  1. 應用程式會識別需要的權限。
  2. 應用程式會將使用者連同要求的權限清單一併重新導向至 Google。
  3. 使用者決定是否要授予應用程式權限。
  4. 應用程式會找出使用者的決定。
  5. 如果使用者授予要求的權限，應用程式就會擷取代表使用者提出 API 要求所需的權杖。

步驟 1：設定授權參數

第一步是建立授權要求。該要求會設定識別應用程式的參數，並定義使用者必須授予應用程式的權限。

  • 如果您使用 Google 用戶端程式庫進行 OAuth 2.0 驗證及授權，請建立並設定用於定義這些參數的物件。
  • 如果您直接呼叫 Google OAuth 2.0 端點，系統會產生網址，並在該網址上設定參數。

下列各分頁定義了網路伺服器應用程式支援的授權參數。此外，各語言適用的範例也說明瞭如何使用用戶端程式庫或授權程式庫來設定會設定這些參數的物件。

PHP

下列程式碼片段會建立 Google\Client() 物件，用來定義授權要求中的參數。

這個物件會使用 client_secret.json 檔案中的資訊來識別應用程式。(如要進一步瞭解該檔案，請參閱「建立授權憑證」一文)。物件也會指出應用程式要求存取權限的範圍，以及應用程式驗證端點的網址 (由 Google 的 OAuth 2.0 伺服器處理回應)。最後，程式碼會設定選用的 access_type 和 include_granted_scopes 參數。

例如，以下程式碼會要求取得使用者 Google 雲端硬碟的唯讀及離線存取權限：

$client = new Google\Client();
$client->setAuthConfig('client_secret.json');
$client->addScope(Google\Service\Drive::DRIVE_METADATA_READONLY);
$client->setRedirectUri('http://' . $_SERVER['HTTP_HOST'] . '/oauth2callback.php');
// offline access will give you both an access and refresh token so that
// your app can refresh the access token without user interaction.
$client->setAccessType('offline');
// Using "consent" will prompt the user for consent
$client->setPrompt('consent');
$client->setIncludeGrantedScopes(true);   // incremental auth

這個要求會指定以下資訊：

參數
client_id 必要

應用程式的用戶端 ID。您可以在 API Console Credentials page中找到這個值。

在 PHP 中呼叫 setAuthConfig 函式，從 client_secret.json 檔案載入授權憑證。

$client = new Google\Client();
$client->setAuthConfig('client_secret.json');
redirect_uri 必要

決定使用者完成授權流程後，API 伺服器會將使用者重新導向的位置。這個值必須與您在用戶端的 API Console Credentials page中設定的 OAuth 2.0 用戶端授權重新導向 URI 完全相符。如果這個值與所提供 client_id 的授權重新導向 URI 不符，您會收到 redirect_uri_mismatch 錯誤。

請注意，http 或 https 配置、大小寫和結尾的斜線 (「/」) 必須全部相符。

如要在 PHP 中設定這個值，請呼叫 setRedirectUri 函式。請注意，您必須為提供的 client_id 指定有效的重新導向 URI。

$client->setRedirectUri('https://oauth2.example.com/code');
scope 必要

以空格分隔的範圍清單，用於識別應用程式可代表使用者存取的資源。這些值會指示 Google 向使用者顯示的同意畫面。

範圍可讓應用程式僅要求存取所需資源，同時讓使用者控制對應用程式授予的存取權量。因此，要求的範圍數量與獲得使用者同意聲明的可能性之間存在相反關係。

如要在 PHP 中設定這個值，請呼叫 addScope 函式：

$client->addScope(Google\Service\Drive::DRIVE_METADATA_READONLY);

我們建議您讓應用程式盡可能在相關情境中要求授權範圍。透過增量授權，在使用情境中要求存取使用者資料，可協助您協助使用者輕鬆瞭解應用程式需要存取權的原因。
access_type 建議

指出當使用者未在瀏覽器中時，您的應用程式是否可以重新整理存取權杖。有效的參數值為 online，也就是預設值 offline。

如果使用者未在瀏覽器中出現時，應用程式需要重新整理存取權杖，請將值設為 offline。這是更新存取權杖的方法，詳情請參閱本文件後續章節。這個值會指示 Google 授權伺服器在應用程式第一次交換權杖的授權碼時，傳回更新權杖「及」存取權杖。

如要在 PHP 中設定這個值，請呼叫 setAccessType 函式：

$client->setAccessType('offline');
state 建議

指定應用程式用來維持授權要求和授權伺服器回應之間狀態的任何字串值。在使用者同意或拒絕應用程式的存取要求後，伺服器會在 redirect_uri 的網址查詢元件 (?) 中，傳回您以 name=value 組合傳送的確切值。

您可以將這個參數用於許多用途，例如將使用者導向應用程式中的正確資源、傳送 Nonce，以及減少跨網站要求。由於 redirect_uri 可以猜到，使用 state 值可以提高連入連線保證是驗證要求的結果。如果您產生隨機字串，或將 Cookie 或其他會擷取用戶端狀態的值編碼，則可驗證回應，進一步確保要求和回應來自同一個瀏覽器，以防範跨網站要求偽造等攻擊。如要瞭解如何建立並確認 state 權杖，請參閱 OpenID Connect 說明文件。

如要在 PHP 中設定這個值，請呼叫 setState 函式：

$client->setState($sample_passthrough_value);
include_granted_scopes 選填

可讓應用程式使用漸進式授權，在相關情境中要求存取其他範圍。如果您將此參數值設為 true，且系統已獲授權要求，則新的存取權杖也會涵蓋使用者先前授予應用程式存取權的所有範圍。如需範例，請參閱增量授權一節。

如要在 PHP 中設定這個值，請呼叫 setIncludeGrantedScopes 函式：

$client->setIncludeGrantedScopes(true);
login_hint 選填

如果應用程式知道要驗證的使用者為何，可以使用這項參數向 Google 驗證伺服器提供提示。伺服器會根據提示，在登入表單中預先填入電子郵件欄位，或選取適當的多登入工作階段，藉此簡化登入流程。

將參數值設為電子郵件地址或 sub ID，相當於使用者的 Google ID。

如要在 PHP 中設定這個值，請呼叫 setLoginHint 函式：

$client->setLoginHint('None');
prompt 選填

以空格分隔且區分大小寫的提示清單如未指定這個參數，則只有在專案首次要求存取權時，系統才會提示使用者。詳情請參閱「 提示重新同意聲明」。

如要在 PHP 中設定這個值，請呼叫 setPrompt 函式：

$client->setPrompt('consent');

可能的值為：

none 不要顯示任何驗證或同意畫面。不可與其他值指定。
consent 提示使用者表示同意。
select_account 提示使用者選取帳戶。

Python

下列程式碼片段使用 google-auth-oauthlib.flow 模組建構授權要求。

程式碼會建構 Flow 物件，該物件會使用您在建立授權憑證後下載的 client_secret.json 檔案資訊來識別您的應用程式。這個物件也會指出應用程式要求存取權限的範圍，以及應用程式驗證端點的網址 (由 Google 的 OAuth 2.0 伺服器處理回應)。最後，程式碼會設定選用的 access_type 和 include_granted_scopes 參數。

例如，以下程式碼會要求取得使用者 Google 雲端硬碟的唯讀及離線存取權限：

import google.oauth2.credentials
import google_auth_oauthlib.flow

# Use the client_secret.json file to identify the application requesting
# authorization. The client ID (from that file) and access scopes are required.
flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
    'client_secret.json',
    scopes=['https://www.googleapis.com/auth/drive.metadata.readonly'])

# Indicate where the API server will redirect the user after the user completes
# the authorization flow. The redirect URI is required. The value must exactly
# match one of the authorized redirect URIs for the OAuth 2.0 client, which you
# configured in the API Console. If this value doesn't match an authorized URI,
# you will get a 'redirect_uri_mismatch' error.
flow.redirect_uri = 'https://www.example.com/oauth2callback'

# Generate URL for request to Google's OAuth 2.0 server.
# Use kwargs to set optional request parameters.
authorization_url, state = flow.authorization_url(
    # Enable offline access so that you can refresh an access token without
    # re-prompting the user for permission. Recommended for web server apps.
    access_type='offline',
    # Enable incremental authorization. Recommended as a best practice.
    include_granted_scopes='true')

這個要求會指定以下資訊：

參數
client_id 必要

應用程式的用戶端 ID。您可以在 API Console Credentials page中找到這個值。

在 Python 中呼叫 from_client_secrets_file 方法，從 client_secret.json 檔案擷取用戶端 ID。(您也可以使用 from_client_config 方法傳遞用戶端設定，因為這個方法最初顯示在用戶端密鑰檔案中，但不會存取檔案本身)。

flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
    'client_secret.json',
    scopes=['https://www.googleapis.com/auth/drive.metadata.readonly'])
redirect_uri 必要

決定使用者完成授權流程後，API 伺服器會將使用者重新導向的位置。這個值必須與您在用戶端的 API Console Credentials page中設定的 OAuth 2.0 用戶端授權重新導向 URI 完全相符。如果這個值與所提供 client_id 的授權重新導向 URI 不符，您會收到 redirect_uri_mismatch 錯誤。

請注意，http 或 https 配置、大小寫和結尾的斜線 (「/」) 必須全部相符。

如要在 Python 中設定這個值，請設定 flow 物件的 redirect_uri 屬性：

flow.redirect_uri = 'https://oauth2.example.com/code'
scope 必要

指定應用程式可以代表使用者存取的資源範圍清單。這些值會指示 Google 向使用者顯示的同意畫面。

範圍可讓應用程式僅要求存取所需資源，同時讓使用者控制對應用程式授予的存取權量。因此，要求的範圍數量與獲得使用者同意聲明的可能性之間存在相反關係。

在 Python 中，請使用設定 client_id 的方法來指定範圍清單。 

flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
    'client_secret.json',
    scopes=['https://www.googleapis.com/auth/drive.metadata.readonly'])

我們建議您讓應用程式盡可能在相關情境中要求授權範圍。透過增量授權，在使用情境中要求存取使用者資料，可協助您協助使用者輕鬆瞭解應用程式需要存取權的原因。
access_type 建議

指出當使用者未在瀏覽器中時，您的應用程式是否可以重新整理存取權杖。有效的參數值為 online，也就是預設值 offline。

如果使用者未在瀏覽器中出現時，應用程式需要重新整理存取權杖，請將值設為 offline。這是更新存取權杖的方法，詳情請參閱本文件後續章節。這個值會指示 Google 授權伺服器在應用程式第一次交換權杖的授權碼時，傳回更新權杖「及」存取權杖。

在 Python 中呼叫 flow.authorization_url 方法，將 access_type 指定為關鍵字引數，藉此設定 access_type 參數：

authorization_url, state = flow.authorization_url(
    access_type='offline',
    include_granted_scopes='true')
state 建議

指定應用程式用來維持授權要求和授權伺服器回應之間狀態的任何字串值。在使用者同意或拒絕應用程式的存取要求後，伺服器會在 redirect_uri 的網址查詢元件 (?) 中，傳回您以 name=value 組合傳送的確切值。

您可以將這個參數用於許多用途，例如將使用者導向應用程式中的正確資源、傳送 Nonce，以及減少跨網站要求。由於 redirect_uri 可以猜到，使用 state 值可以提高連入連線保證是驗證要求的結果。如果您產生隨機字串，或將 Cookie 或其他會擷取用戶端狀態的值編碼，則可驗證回應，進一步確保要求和回應來自同一個瀏覽器，以防範跨網站要求偽造等攻擊。如要瞭解如何建立並確認 state 權杖，請參閱 OpenID Connect 說明文件。

在 Python 中呼叫 flow.authorization_url 方法，將 state 指定為關鍵字引數，藉此設定 state 參數：

authorization_url, state = flow.authorization_url(
    access_type='offline',
    state=sample_passthrough_value,
    include_granted_scopes='true')
include_granted_scopes 選填

可讓應用程式使用漸進式授權，在相關情境中要求存取其他範圍。如果您將此參數值設為 true，且系統已獲授權要求，則新的存取權杖也會涵蓋使用者先前授予應用程式存取權的所有範圍。如需範例，請參閱增量授權一節。

在 Python 中呼叫 flow.authorization_url 方法，將 include_granted_scopes 指定為關鍵字引數，藉此設定 include_granted_scopes 參數：

authorization_url, state = flow.authorization_url(
    access_type='offline',
    include_granted_scopes='true')
login_hint 選填

如果應用程式知道要驗證的使用者為何，可以使用這項參數向 Google 驗證伺服器提供提示。伺服器會根據提示，在登入表單中預先填入電子郵件欄位，或選取適當的多登入工作階段，藉此簡化登入流程。

將參數值設為電子郵件地址或 sub ID，相當於使用者的 Google ID。

在 Python 中呼叫 flow.authorization_url 方法，將 login_hint 指定為關鍵字引數，藉此設定 login_hint 參數：

authorization_url, state = flow.authorization_url(
    access_type='offline',
    login_hint='None',
    include_granted_scopes='true')
prompt 選填

以空格分隔且區分大小寫的提示清單如未指定這個參數，則只有在專案首次要求存取權時，系統才會提示使用者。詳情請參閱「 提示重新同意聲明」一節。

在 Python 中呼叫 flow.authorization_url 方法，將 prompt 指定為關鍵字引數，藉此設定 prompt 參數：

authorization_url, state = flow.authorization_url(
      access_type='offline',
      prompt='consent',
      include_granted_scopes='true')

可能的值為：

none 不要顯示任何驗證或同意畫面。不可與其他值指定。
consent 提示使用者表示同意。
select_account 提示使用者選取帳戶。

Ruby

使用您建立的 client_secrets.json 檔案，設定應用程式中的用戶端物件。設定用戶端物件時，您需要指定應用程式需要存取的範圍，以及應用程式驗證端點的網址，該端點會處理 OAuth 2.0 伺服器傳出的回應。

例如，以下程式碼會要求取得使用者 Google 雲端硬碟的唯讀及離線存取權限：

require 'google/apis/drive_v3'
require "googleauth"
require 'googleauth/stores/redis_token_store'

client_id = Google::Auth::ClientId.from_file('/path/to/client_secret.json')
scope = 'https://www.googleapis.com/auth/drive.metadata.readonly'
token_store = Google::Auth::Stores::RedisTokenStore.new(redis: Redis.new)
authorizer = Google::Auth::WebUserAuthorizer.new(client_id, scope, token_store, '/oauth2callback')


Your application uses the client object to perform OAuth 2.0 operations, such as generating
  authorization request URLs and applying access tokens to HTTP requests.

Node.js

The code snippet below creates a google.auth.OAuth2 object, which defines the parameters in the authorization request.

That object uses information from your client_secret.json file to identify your application. To ask for permissions from a user to retrieve an access token, you redirect them to a consent page. To create a consent page URL:

const {google} = require('googleapis');

/**
 * To use OAuth2 authentication, we need access to a CLIENT_ID, CLIENT_SECRET, AND REDIRECT_URI
 * from the client_secret.json file. To get these credentials for your application, visit
 * https://console.cloud.google.com/apis/credentials.
 */
const oauth2Client = new google.auth.OAuth2(
  YOUR_CLIENT_ID,
  YOUR_CLIENT_SECRET,
  YOUR_REDIRECT_URL
);

// Access scopes for read-only Drive activity.
const scopes = [
  'https://www.googleapis.com/auth/drive.metadata.readonly'
];

// Generate a url that asks permissions for the Drive activity scope
const authorizationUrl = oauth2Client.generateAuthUrl({
  // 'online' (default) or 'offline' (gets refresh_token)
  access_type: 'offline',
  /** Pass in the scopes array defined above.
    * Alternatively, if only one scope is needed, you can pass a scope URL as a string */
  scope: scopes,
  // Enable incremental authorization. Recommended as a best practice.
  include_granted_scopes: true
});

重要注意事項：refresh_token 只會在首次授權時傳回。詳情請參閱 這個頁面。

HTTP/REST

Google 的 OAuth 2.0 端點位於 https://accounts.google.com/o/oauth2/v2/auth。這個端點只能透過 HTTPS 存取。系統會拒絕純 HTTP 連線。

Google 授權伺服器支援網路伺服器應用程式的下列查詢字串參數：

參數
client_id 必要

應用程式的用戶端 ID。您可以在 API Console Credentials page中找到這個值。
redirect_uri 必要

決定使用者完成授權流程後，API 伺服器會將使用者重新導向的位置。這個值必須與您在用戶端的 API Console Credentials page中設定的 OAuth 2.0 用戶端授權重新導向 URI 完全相符。如果這個值與所提供 client_id 的授權重新導向 URI 不符，您會收到 redirect_uri_mismatch 錯誤。

請注意，http 或 https 配置、大小寫和結尾的斜線 (「/」) 必須全部相符。
response_type 必要

判斷 Google OAuth 2.0 端點是否傳回授權碼。

將網路伺服器應用程式的參數值設為 code。
scope 必要

以空格分隔的範圍清單，用於識別應用程式可代表使用者存取的資源。這些值會指示 Google 向使用者顯示的同意畫面。

範圍可讓應用程式僅要求存取所需資源，同時讓使用者控制對應用程式授予的存取權量。因此，要求的範圍數量與獲得使用者同意聲明的可能性之間存在相反關係。

我們建議您讓應用程式盡可能在相關情境中要求授權範圍。透過增量授權，在使用情境中要求存取使用者資料，可協助您協助使用者輕鬆瞭解應用程式需要存取權的原因。
access_type 建議

指出當使用者未在瀏覽器中時，您的應用程式是否可以重新整理存取權杖。有效的參數值為 online，也就是預設值 offline。

如果使用者未在瀏覽器中出現時，應用程式需要重新整理存取權杖，請將值設為 offline。這是更新存取權杖的方法，詳情請參閱本文件後續章節。這個值會指示 Google 授權伺服器在應用程式第一次交換權杖的授權碼時，傳回更新權杖「及」存取權杖。
state 建議

指定應用程式用來維持授權要求和授權伺服器回應之間狀態的任何字串值。在使用者同意或拒絕應用程式的存取要求後，伺服器會在 redirect_uri 的網址查詢元件 (?) 中，傳回您以 name=value 組合傳送的確切值。

您可以將這個參數用於許多用途，例如將使用者導向應用程式中的正確資源、傳送 Nonce，以及減少跨網站要求。由於 redirect_uri 可以猜到，使用 state 值可以提高連入連線保證是驗證要求的結果。如果您產生隨機字串，或將 Cookie 或其他會擷取用戶端狀態的值編碼，則可驗證回應，進一步確保要求和回應來自同一個瀏覽器，以防範跨網站要求偽造等攻擊。如要瞭解如何建立並確認 state 權杖，請參閱 OpenID Connect 說明文件。
include_granted_scopes 選填

可讓應用程式使用漸進式授權，在相關情境中要求存取其他範圍。如果您將此參數值設為 true，且系統已獲授權要求，則新的存取權杖也會涵蓋使用者先前授予應用程式存取權的所有範圍。如需範例，請參閱增量授權一節。
login_hint 選填

如果應用程式知道要驗證的使用者為何，可以使用這項參數向 Google 驗證伺服器提供提示。伺服器會根據提示，在登入表單中預先填入電子郵件欄位，或選取適當的多登入工作階段，藉此簡化登入流程。

將參數值設為電子郵件地址或 sub ID，相當於使用者的 Google ID。
prompt 選填

以空格分隔且區分大小寫的提示清單如未指定這個參數，則只有在專案首次要求存取權時，系統才會提示使用者。詳情請參閱「 提示重新同意聲明」一節。

可能的值為：

none 不要顯示任何驗證或同意畫面。不可與其他值指定。
consent 提示使用者表示同意。
select_account 提示使用者選取帳戶。

步驟 2：重新導向至 Google 的 OAuth 2.0 伺服器

將使用者重新導向至 Google 的 OAuth 2.0 伺服器，以便啟動驗證和授權程序。通常發生在應用程式首次需要存取使用者資料時。就增量授權來說，如果應用程式需要存取的額外資源尚未取得存取權限，系統也會執行這個步驟。

PHP

  1. 產生網址，以要求 Google 的 OAuth 2.0 伺服器存取權： 
    $auth_url = $client->createAuthUrl();
  2. 將使用者重新導向至 $auth_url： 
    header('Location: ' . filter_var($auth_url, FILTER_SANITIZE_URL));

Python

以下範例說明如何使用 Flask 網頁應用程式架構，將使用者重新導向至授權網址：

return flask.redirect(authorization_url)

Ruby

  1. 產生網址，以要求 Google 的 OAuth 2.0 伺服器存取權： 
    auth_uri = authorizer.get_authorization_url(login_hint: user_id, request: request)
  2. 將使用者重新導向至 auth_uri。

Node.js

  1. 使用步驟 1 generateAuthUrl 方法產生的網址 authorizationUrl，向 Google 的 OAuth 2.0 伺服器要求存取權。
  2. 將使用者重新導向至 authorizationUrl。 
    res.writeHead(301, { "Location": authorizationUrl });

HTTP/REST

Sample redirect to Google's authorization server

An example URL is shown below, with line breaks and spaces for readability.

https://accounts.google.com/o/oauth2/v2/auth?
 scope=https%3A//www.googleapis.com/auth/drive.metadata.readonly&
 access_type=offline&
 include_granted_scopes=true&
 response_type=code&
 state=state_parameter_passthrough_value&
 redirect_uri=https%3A//oauth2.example.com/code&
 client_id=client_id

建立要求網址後，請將使用者重新導向至該網址。

Google 的 OAuth 2.0 伺服器會驗證使用者，並徵得使用者的同意，允許應用程式存取要求的範圍。回應會使用您指定的重新導向網址傳回應用程式。

步驟 3：Google 提示使用者徵求同意聲明

在這個步驟中，使用者可決定是否授予應用程式所要求的存取權。在這個階段中，Google 會顯示同意視窗，當中會顯示您的應用程式名稱，以及應用程式要求透過使用者的授權憑證存取存取權的 Google API 服務，以及要授予的存取權範圍摘要。接著，使用者便可同意授予應用程式要求的一或多個範圍的存取權，或是拒絕要求。

由於應用程式會等待 Google OAuth 2.0 伺服器的回應來指出是否已授予任何存取權，因此在這個階段，應用程式不需要採取任何行動。系統會在下列步驟中說明該回應。

錯誤

向 Google 的 OAuth 2.0 授權端點發出的要求可能會顯示面向使用者的錯誤訊息，而不是預期的驗證和授權流程。以下列出常見的錯誤代碼和建議解決方法。

admin_policy_enforced

Google 帳戶因 Google Workspace 管理員的政策限制，而無法授權一或多個要求的範圍。請參閱 Google Workspace 管理員說明文章「 控管哪些第三方應用程式和內部應用程式可存取 Google Workspace 資料」，進一步瞭解在未明確授予 OAuth 用戶端 ID 存取權之前，管理員可如何限制所有範圍、敏感和受限制範圍的存取權。

disallowed_useragent

授權端點會顯示在 Google 的 OAuth 2.0 政策不允許的內嵌使用者代理程式中。

Android

Android 開發人員在 android.webkit.WebView 中開啟授權要求時，可能會看見這則錯誤訊息。 開發人員應改用 Android 程式庫，例如 Android 版 Google 登入或 OpenID Foundation 的 Android 版 AppAuth。

當 Android 應用程式在內嵌的使用者代理程式中開啟一般網頁連結，而且使用者從您的網站前往 Google 的 OAuth 2.0 授權端點時，網頁開發人員就可能遇到這個錯誤。開發人員應允許在作業系統的預設連結處理常式 (包括 Android 應用程式連結處理常式或預設的瀏覽器應用程式) 中開啟一般連結。此外，系統也支援 Android Custom Tabs 程式庫。

iOS

iOS 和 macOS 開發人員在 WKWebView 中開啟授權要求時，可能會遇到這個錯誤。開發人員應改用 iOS 程式庫，例如 iOS 適用的 Google 登入或 OpenID Foundation 的 iOS 適用的 AppAuth。

當 iOS 或 macOS 應用程式在內嵌的使用者代理程式中開啟一般網頁連結，而且使用者從您的網站前往 Google 的 OAuth 2.0 授權端點時，就可能會遇到這個錯誤。開發人員應允許在作業系統的預設連結處理常式 (包括通用連結處理常式或預設的瀏覽器應用程式) 中開啟一般連結。此外，系統也支援 SFSafariViewController 程式庫。
org_internal

要求中的 OAuth 用戶端 ID 屬於一項專案，用於限制特定 Google Cloud 機構中的 Google 帳戶存取權。如要進一步瞭解這個設定選項，請參閱「設定 OAuth 同意畫面」說明文章中的「使用者類型」一節。

invalid_client

OAuth 用戶端密鑰不正確。查看 OAuth 用戶端設定，包括這項要求使用的用戶端 ID 和密鑰。

invalid_grant

更新存取權杖或使用增量授權時，權杖可能已過期或已失效。重新驗證使用者，並要求使用者同意取得新權杖。如果您持續看到這個錯誤，請確認您的應用程式設定正確無誤，而且您在要求中使用了正確的權杖和參數。否則，使用者帳戶可能已遭刪除或停用。

redirect_uri_mismatch

授權要求中傳遞的 redirect_uri 與 OAuth 用戶端 ID 的授權重新導向 URI 不符。請查看 Google API Console Credentials page中已授權的重新導向 URI。

redirect_uri 參數可能參照的 OAuth 外部 (OOB) 流程已淘汰，我們不再支援。請參閱遷移指南來更新整合作業。

invalid_request

您提交的要求出現錯誤。可能的原因如下：

  • 要求的格式有誤
  • 要求缺少必要參數
  • 要求使用了 Google 不支援的授權方法。確認 OAuth 整合功能採用建議的整合方法

步驟 4：處理 OAuth 2.0 伺服器回應

OAuth 2.0 伺服器會透過要求中指定的網址，回應應用程式的存取要求。

如果使用者核准了存取要求，回應內便會提供授權碼。如果使用者並未核准要求，回應內便會提供錯誤訊息。傳回到網路伺服器的授權碼或錯誤訊息會顯示在查詢字串中，如下所示：

錯誤回應：

https://oauth2.example.com/auth?error=access_denied

授權碼回應：

https://oauth2.example.com/auth?code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7

OAuth 2.0 伺服器回應範例

您可以點選下列範例網址來測試這個流程，這會要求取得 Google 雲端硬碟中檔案中繼資料的唯讀存取權：

https://accounts.google.com/o/oauth2/v2/auth?
 scope=https%3A//www.googleapis.com/auth/drive.metadata.readonly&
 access_type=offline&
 include_granted_scopes=true&
 response_type=code&
 state=state_parameter_passthrough_value&
 redirect_uri=https%3A//oauth2.example.com/code&
 client_id=client_id

完成 OAuth 2.0 流程後，系統會將您重新導向至 http://localhost/oauth2callback，這可能會發生 404 NOT FOUND 錯誤，除非您的本機電腦提供位於該位址的檔案。下一步會提供更詳細的資訊，說明當使用者被重新導向回應用程式時，URI 傳回的資訊。

步驟 5：交換授權碼，以便更新及存取存取權杖

網路伺服器收到授權碼後，即可用授權碼交換存取權杖。

PHP

如要交換存取權杖的授權碼，請使用 authenticate 方法：

$client->authenticate($_GET['code']);

您可以使用 getAccessToken 方法擷取存取權杖：

$access_token = $client->getAccessToken();

Python

在回呼頁面上，使用 google-auth 程式庫來驗證授權伺服器回應。接著，使用 flow.fetch_token 方法交換存取權杖回應中的授權碼：

state = flask.session['state']
flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
    'client_secret.json',
    scopes=['https://www.googleapis.com/auth/drive.metadata.readonly'],
    state=state)
flow.redirect_uri = flask.url_for('oauth2callback', _external=True)

authorization_response = flask.request.url
flow.fetch_token(authorization_response=authorization_response)

# Store the credentials in the session.
# ACTION ITEM for developers:
#     Store user's access and refresh tokens in your data store if
#     incorporating this code into your real app.
credentials = flow.credentials
flask.session['credentials'] = {
    'token': credentials.token,
    'refresh_token': credentials.refresh_token,
    'token_uri': credentials.token_uri,
    'client_id': credentials.client_id,
    'client_secret': credentials.client_secret,
    'scopes': credentials.scopes}

Ruby

在回呼頁面上，使用 googleauth 程式庫驗證授權伺服器回應。請使用 authorizer.handle_auth_callback_deferred 方法儲存授權碼，並重新導向回最初要求授權的網址。這會暫時在使用者的工作階段中儲存結果，藉此延遲程式碼交換作業。

  target_url = Google::Auth::WebUserAuthorizer.handle_auth_callback_deferred(request)
  redirect target_url

Node.js

如要交換存取權杖的授權碼，請使用 getToken 方法：

const url = require('url');

// Receive the callback from Google's OAuth 2.0 server.
if (req.url.startsWith('/oauth2callback')) {
  // Handle the OAuth 2.0 server response
  let q = url.parse(req.url, true).query;

  // Get access and refresh tokens (if access_type is offline)
  let { tokens } = await oauth2Client.getToken(q.code);
  oauth2Client.setCredentials(tokens);
}

HTTP/REST

如要交換存取權杖的授權碼，請呼叫 https://oauth2.googleapis.com/token 端點並設定下列參數：

欄位
client_id 從 API Console Credentials page取得的用戶端 ID。
client_secret 從 API Console Credentials page取得的用戶端密鑰。
code 初始要求傳回的授權碼。
grant_type 如 OAuth 2.0 規格所定義，這個欄位的值必須設為 authorization_code。
redirect_uri 針對指定的 client_id，在 API Console Credentials page 中為您的專案列出的其中一個重新導向 URI。

以下程式碼片段為要求範例：

POST /token HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&
client_id=your_client_id&
client_secret=your_client_secret&
redirect_uri=https%3A//oauth2.example.com/code&
grant_type=authorization_code

Google 回應這項要求時，會傳回含有短期存取權杖和更新權杖的 JSON 物件。請注意，只有在應用程式對 Google 授權伺服器發出的初始要求中，將 access_type 參數設為 offline 時，系統才會傳回更新權杖。

回應會包含以下欄位：

欄位
access_token 應用程式為了授權 Google API 要求而傳送的憑證。
expires_in 存取權杖的剩餘生命週期 (以秒為單位)。
refresh_token 可用來取得新存取權杖的權杖。更新權杖的效力會持續到使用者撤銷存取權為止。 再次強調，您必須在對 Google 授權伺服器發出的初始要求中，將 access_type 參數設為 offline，才能在回應中看見這個欄位。
scope access_token 授予的存取權範圍，是以空格分隔且區分大小寫的字串清單表示。
token_type 傳回的權杖類型。目前，這個欄位的值一律會設為 Bearer。

以下程式碼片段顯示回應範例：

{
  "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
  "expires_in": 3920,
  "token_type": "Bearer",
  "scope": "https://www.googleapis.com/auth/drive.metadata.readonly",
  "refresh_token": "1//xEoDL4iW3cxlI7yDbSRFYNG01kVKM2C-259HOF2aQbI"
}

錯誤

交換存取權杖的授權碼時，可能會遇到下列錯誤，而非預期的回應。以下列出常見的錯誤代碼和建議解決方法。

invalid_grant

提供的授權碼無效或格式錯誤。請重新啟動 OAuth 程序，要求新的驗證碼，以再次提示使用者表示同意。

呼叫 Google API

PHP

完成下列步驟，即可使用存取權杖呼叫 Google API：

  1. 如果需要將存取權杖套用至新的 Google\Client 物件 (例如，將存取權杖儲存在使用者工作階段)，請使用 setAccessToken 方法： 
    $client->setAccessToken($access_token);
  2. 為您要呼叫的 API 建立服務物件。方法是為要呼叫的 API 的建構函式提供已授權的 Google\Client 物件。舉例來說，如要呼叫 Drive API： 
    $drive = new Google\Service\Drive($client);
  3. 使用服務物件提供的介面向 API 服務發出要求。舉例來說，如要列出已驗證使用者 Google 雲端硬碟中的檔案，請執行下列步驟： 
    $files = $drive->files->listFiles(array())->getItems();

Python

取得存取權杖後，應用程式就可以使用該權杖，代表指定使用者帳戶或服務帳戶授權 API 要求。透過使用者專屬授權憑證，針對要呼叫的 API 建構服務物件，然後使用該物件提出已授權的 API 要求。

  1. 為您要呼叫的 API 建立服務物件。只要使用 API 名稱和版本和使用者憑證呼叫 googleapiclient.discovery 程式庫的 build 方法，即可建立服務物件。舉例來說，如要呼叫 Drive API 第 3 版： 
    from googleapiclient.discovery import build

drive = build('drive', 'v2', credentials=credentials)
  2. 使用服務物件提供的介面向 API 服務發出要求。舉例來說，如要列出已驗證使用者 Google 雲端硬碟中的檔案，請執行下列步驟： 
    files = drive.files().list().execute()

Ruby

取得存取權杖後，應用程式就可以使用該權杖，代表指定使用者帳戶或服務帳戶提出 API 要求。透過使用者專屬授權憑證，針對要呼叫的 API 建構服務物件，然後使用該物件提出已授權的 API 要求。

  1. 為您要呼叫的 API 建立服務物件。 舉例來說，如要呼叫 Drive API 第 3 版： 
    drive = Google::Apis::DriveV3::DriveService.new
  2. 在服務上設定憑證： 
    drive.authorization = credentials
  3. 使用服務物件提供的介面向 API 服務發出要求。舉例來說，如要列出已驗證使用者 Google 雲端硬碟中的檔案，請執行下列操作： 
    files = drive.list_files

您也可以為每個方法提供 options 參數，藉此依個別方法提供授權：

files = drive.list_files(options: { authorization: credentials })

Node.js

取得存取權杖並將其設為 OAuth2 物件後，請使用物件呼叫 Google API。您的應用程式可以使用這個權杖，代表指定使用者帳戶或服務帳戶授權 API 要求。為您要呼叫的 API 建立服務物件。

const { google } = require('googleapis');

// Example of using Google Drive API to list filenames in user's Drive.
const drive = google.drive('v3');
drive.files.list({
  auth: oauth2Client,
  pageSize: 10,
  fields: 'nextPageToken, files(id, name)',
}, (err1, res1) => {
  if (err1) return console.log('The API returned an error: ' + err1);
  const files = res1.data.files;
  if (files.length) {
    console.log('Files:');
    files.map((file) => {
      console.log(`${file.name} (${file.id})`);
    });
  } else {
    console.log('No files found.');
  }
});

HTTP/REST

應用程式取得存取權杖後，如果已授予 API 所需的存取權範圍，您可以使用權杖代表指定使用者帳戶呼叫 Google API。方法是加入 access_token 查詢參數或 Authorization HTTP 標頭 Bearer 值，將存取權杖加入 API 要求中。可以的話，建議您使用 HTTP 標頭，因為查詢字串通常會顯示在伺服器記錄中。在大多數情況下，您可以使用用戶端程式庫設定對 Google API 的呼叫 (例如在呼叫 Drive Files API 時)。

您可以在 OAuth 2.0 Playground 中試用所有 Google API 並查看其範圍。

HTTP GET 範例

使用 Authorization: Bearer HTTP 標頭呼叫 drive.files 端點 (Drive Files API) 時可能如下所示。請注意，您必須指定自己的存取權杖：

GET /drive/v2/files HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer access_token

以下說明如何使用 access_token 查詢字串參數，對已驗證的使用者呼叫同一個 API：

GET https://www.googleapis.com/drive/v2/files?access_token=access_token

curl 範例

您可以使用 curl 指令列應用程式測試這些指令。以下為使用 HTTP 標頭選項的範例 (建議選項)：

curl -H "Authorization: Bearer access_token" https://www.googleapis.com/drive/v2/files

或者，您也可以使用查詢字串參數選項：

curl https://www.googleapis.com/drive/v2/files?access_token=access_token

完整範例

以下範例會在使用者通過驗證後，輸出使用者 Google 雲端硬碟中檔案的 JSON 格式清單。

PHP

如要執行這個範例：

  1. 在 API Console中，將本機電腦的網址新增至重新導向網址清單，例如新增 http://localhost:8080。
  2. 建立新的目錄並變更目錄。例如： 
    mkdir ~/php-oauth2-example
cd ~/php-oauth2-example
  3. 使用 Composer 安裝 PHP 適用的 Google API 用戶端程式庫： 
    composer require google/apiclient:^2.10
  4. 使用下方內容建立 index.php 和 oauth2callback.php 檔案。
  5. 使用設定為提供 PHP 的網路伺服器執行範例。如果您使用 PHP 5.6 以上版本，可以使用 PHP 的內建測試網路伺服器： 
    php -S localhost:8080 ~/php-oauth2-example

index.php

<?php
require_once __DIR__.'/vendor/autoload.php';

session_start();

$client = new Google\Client();
$client->setAuthConfig('client_secrets.json');
$client->addScope(Google\Service\Drive::DRIVE_METADATA_READONLY);

if (isset($_SESSION['access_token']) && $_SESSION['access_token']) {
  $client->setAccessToken($_SESSION['access_token']);
  $drive = new Google\Service\Drive($client);
  $files = $drive->files->listFiles(array())->getItems();
  echo json_encode($files);
} else {
  $redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . '/oauth2callback.php';
  header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL));
}

oauth2callback.php

<?php
require_once __DIR__.'/vendor/autoload.php';

session_start();

$client = new Google\Client();
$client->setAuthConfigFile('client_secrets.json');
$client->setRedirectUri('http://' . $_SERVER['HTTP_HOST'] . '/oauth2callback.php');
$client->addScope(Google\Service\Drive::DRIVE_METADATA_READONLY);

if (! isset($_GET['code'])) {
  $auth_url = $client->createAuthUrl();
  header('Location: ' . filter_var($auth_url, FILTER_SANITIZE_URL));
} else {
  $client->authenticate($_GET['code']);
  $_SESSION['access_token'] = $client->getAccessToken();
  $redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . '/';
  header('Location: ' . filter_var($redirect_uri, FILTER_SANITIZE_URL));
}

Python

本範例使用 Flask 架構。這項工具會在 http://localhost:8080 中執行網頁應用程式，讓您測試 OAuth 2.0 流程。如果你前往該網址，應該會看到四個連結：

  • 測試 API 要求：這個連結會指向嘗試執行範例 API 要求的網頁。必要時，系統會啟動授權流程。如果成功，頁面會顯示 API 回應。
  • 直接測試驗證流程：這個連結會指向嘗試透過授權流程將使用者帶往的網頁。應用程式會要求使用者代表使用者提交已授權的 API 要求。
  • 撤銷目前的憑證：這個連結指向的網頁會 撤銷使用者已授予應用程式的權限。
  • Clear Flask 工作階段憑證：這個連結會清除儲存在 Flask 工作階段的授權憑證。這可讓您瞭解，如果使用者已授予應用程式權限，以便在新的工作階段中執行 API 要求，會發生什麼情況。此外，如果使用者已撤銷授予應用程式的權限，但應用程式仍嘗試透過撤銷的存取權杖授權要求，這個 API 也可以顯示應用程式獲得的 API 回應。
# -*- coding: utf-8 -*-

import os
import flask
import requests

import google.oauth2.credentials
import google_auth_oauthlib.flow
import googleapiclient.discovery

# This variable specifies the name of a file that contains the OAuth 2.0
# information for this application, including its client_id and client_secret.
CLIENT_SECRETS_FILE = "client_secret.json"

# This OAuth 2.0 access scope allows for full read/write access to the
# authenticated user's account and requires requests to use an SSL connection.
SCOPES = ['https://www.googleapis.com/auth/drive.metadata.readonly']
API_SERVICE_NAME = 'drive'
API_VERSION = 'v2'

app = flask.Flask(__name__)
# Note: A secret key is included in the sample so that it works.
# If you use this code in your application, replace this with a truly secret
# key. See https://flask.palletsprojects.com/quickstart/#sessions.
app.secret_key = 'REPLACE ME - this value is here as a placeholder.'


@app.route('/')
def index():
  return print_index_table()


@app.route('/test')
def test_api_request():
  if 'credentials' not in flask.session:
    return flask.redirect('authorize')

  # Load credentials from the session.
  credentials = google.oauth2.credentials.Credentials(
      **flask.session['credentials'])

  drive = googleapiclient.discovery.build(
      API_SERVICE_NAME, API_VERSION, credentials=credentials)

  files = drive.files().list().execute()

  # Save credentials back to session in case access token was refreshed.
  # ACTION ITEM: In a production app, you likely want to save these
  #              credentials in a persistent database instead.
  flask.session['credentials'] = credentials_to_dict(credentials)

  return flask.jsonify(**files)


@app.route('/authorize')
def authorize():
  # Create flow instance to manage the OAuth 2.0 Authorization Grant Flow steps.
  flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
      CLIENT_SECRETS_FILE, scopes=SCOPES)

  # The URI created here must exactly match one of the authorized redirect URIs
  # for the OAuth 2.0 client, which you configured in the API Console. If this
  # value doesn't match an authorized URI, you will get a 'redirect_uri_mismatch'
  # error.
  flow.redirect_uri = flask.url_for('oauth2callback', _external=True)

  authorization_url, state = flow.authorization_url(
      # Enable offline access so that you can refresh an access token without
      # re-prompting the user for permission. Recommended for web server apps.
      access_type='offline',
      # Enable incremental authorization. Recommended as a best practice.
      include_granted_scopes='true')

  # Store the state so the callback can verify the auth server response.
  flask.session['state'] = state

  return flask.redirect(authorization_url)


@app.route('/oauth2callback')
def oauth2callback():
  # Specify the state when creating the flow in the callback so that it can
  # verified in the authorization server response.
  state = flask.session['state']

  flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
      CLIENT_SECRETS_FILE, scopes=SCOPES, state=state)
  flow.redirect_uri = flask.url_for('oauth2callback', _external=True)

  # Use the authorization server's response to fetch the OAuth 2.0 tokens.
  authorization_response = flask.request.url
  flow.fetch_token(authorization_response=authorization_response)

  # Store credentials in the session.
  # ACTION ITEM: In a production app, you likely want to save these
  #              credentials in a persistent database instead.
  credentials = flow.credentials
  flask.session['credentials'] = credentials_to_dict(credentials)

  return flask.redirect(flask.url_for('test_api_request'))


@app.route('/revoke')
def revoke():
  if 'credentials' not in flask.session:
    return ('You need to <a href="/authorize">authorize</a> before ' +
            'testing the code to revoke credentials.')

  credentials = google.oauth2.credentials.Credentials(
    **flask.session['credentials'])

  revoke = requests.post('https://oauth2.googleapis.com/revoke',
      params={'token': credentials.token},
      headers = {'content-type': 'application/x-www-form-urlencoded'})

  status_code = getattr(revoke, 'status_code')
  if status_code == 200:
    return('Credentials successfully revoked.' + print_index_table())
  else:
    return('An error occurred.' + print_index_table())


@app.route('/clear')
def clear_credentials():
  if 'credentials' in flask.session:
    del flask.session['credentials']
  return ('Credentials have been cleared.<br><br>' +
          print_index_table())


def credentials_to_dict(credentials):
  return {'token': credentials.token,
          'refresh_token': credentials.refresh_token,
          'token_uri': credentials.token_uri,
          'client_id': credentials.client_id,
          'client_secret': credentials.client_secret,
          'scopes': credentials.scopes}

def print_index_table():
  return ('<table>' +
          '<tr><td><a href="/test">Test an API request</a></td>' +
          '<td>Submit an API request and see a formatted JSON response. ' +
          '    Go through the authorization flow if there are no stored ' +
          '    credentials for the user.</td></tr>' +
          '<tr><td><a href="/authorize">Test the auth flow directly</a></td>' +
          '<td>Go directly to the authorization flow. If there are stored ' +
          '    credentials, you still might not be prompted to reauthorize ' +
          '    the application.</td></tr>' +
          '<tr><td><a href="/revoke">Revoke current credentials</a></td>' +
          '<td>Revoke the access token associated with the current user ' +
          '    session. After revoking credentials, if you go to the test ' +
          '    page, you should see an <code>invalid_grant</code> error.' +
          '</td></tr>' +
          '<tr><td><a href="/clear">Clear Flask session credentials</a></td>' +
          '<td>Clear the access token currently stored in the user session. ' +
          '    After clearing the token, if you <a href="/test">test the ' +
          '    API request</a> again, you should go back to the auth flow.' +
          '</td></tr></table>')


if __name__ == '__main__':
  # When running locally, disable OAuthlib's HTTPs verification.
  # ACTION ITEM for developers:
  #     When running in production *do not* leave this option enabled.
  os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'

  # Specify a hostname and port that are set as a valid redirect URI
  # for your API project in the Google API Console.
  app.run('localhost', 8080, debug=True)

Ruby

本範例使用 Sinatra 架構。

require 'google/apis/drive_v3'
require 'sinatra'
require 'googleauth'
require 'googleauth/stores/redis_token_store'

configure do
  enable :sessions

  set :client_id, Google::Auth::ClientId.from_file('/path/to/client_secret.json')
  set :scope, Google::Apis::DriveV3::AUTH_DRIVE_METADATA_READONLY
  set :token_store, Google::Auth::Stores::RedisTokenStore.new(redis: Redis.new)
  set :authorizer, Google::Auth::WebUserAuthorizer.new(settings.client_id, settings.scope, settings.token_store, '/oauth2callback')
end

get '/' do
  user_id = settings.client_id.id
  credentials = settings.authorizer.get_credentials(user_id, request)
  if credentials.nil?
    redirect settings.authorizer.get_authorization_url(login_hint: user_id, request: request)
  end
  drive = Google::Apis::DriveV3::DriveService.new
  files = drive.list_files(options: { authorization: credentials })
  "<pre>#{JSON.pretty_generate(files.to_h)}</pre>"
end

get '/oauth2callback' do
  target_url = Google::Auth::WebUserAuthorizer.handle_auth_callback_deferred(request)
  redirect target_url
end

Node.js

如要執行這個範例：

  1. 在 API Console中，將本機電腦的網址新增至重新導向網址清單，例如新增 http://localhost。
  2. 確認您已安裝 LTS、有效 LTS 或目前的 Node.js 版本。
  3. 建立新的目錄並變更目錄。例如： 
    mkdir ~/nodejs-oauth2-example
cd ~/nodejs-oauth2-example
  4. Install the Google API Client Library for Node.js using npm: 
    npm install googleapis
  5. 建立含有下方內容的檔案 main.js。
  6. 執行範例： 
    node .\main.js

main.js

const http = require('http');
const https = require('https');
const url = require('url');
const { google } = require('googleapis');

/**
 * To use OAuth2 authentication, we need access to a CLIENT_ID, CLIENT_SECRET, AND REDIRECT_URI.
 * To get these credentials for your application, visit
 * https://console.cloud.google.com/apis/credentials.
 */
const oauth2Client = new google.auth.OAuth2(
  YOUR_CLIENT_ID,
  YOUR_CLIENT_SECRET,
  YOUR_REDIRECT_URL
);

// Access scopes for read-only Drive activity.
const scopes = [
  'https://www.googleapis.com/auth/drive.metadata.readonly'
];

// Generate a url that asks permissions for the Drive activity scope
const authorizationUrl = oauth2Client.generateAuthUrl({
  // 'online' (default) or 'offline' (gets refresh_token)
  access_type: 'offline',
  /** Pass in the scopes array defined above.
    * Alternatively, if only one scope is needed, you can pass a scope URL as a string */
  scope: scopes,
  // Enable incremental authorization. Recommended as a best practice.
  include_granted_scopes: true
});

/* Global variable that stores user credential in this code example.
 * ACTION ITEM for developers:
 *   Store user's refresh token in your data store if
 *   incorporating this code into your real app.
 *   For more information on handling refresh tokens,
 *   see https://github.com/googleapis/google-api-nodejs-client#handling-refresh-tokens
 */
let userCredential = null;

async function main() {
  const server = http.createServer(async function (req, res) {
    // Example on redirecting user to Google's OAuth 2.0 server.
    if (req.url == '/') {
      res.writeHead(301, { "Location": authorizationUrl });
    }

    // Receive the callback from Google's OAuth 2.0 server.
    if (req.url.startsWith('/oauth2callback')) {
      // Handle the OAuth 2.0 server response
      let q = url.parse(req.url, true).query;

      if (q.error) { // An error response e.g. error=access_denied
        console.log('Error:' + q.error);
      } else { // Get access and refresh tokens (if access_type is offline)
        let { tokens } = await oauth2Client.getToken(q.code);
        oauth2Client.setCredentials(tokens);

        /** Save credential to the global variable in case access token was refreshed.
          * ACTION ITEM: In a production app, you likely want to save the refresh token
          *              in a secure persistent database instead. */
        userCredential = tokens;

        // Example of using Google Drive API to list filenames in user's Drive.
        const drive = google.drive('v3');
        drive.files.list({
          auth: oauth2Client,
          pageSize: 10,
          fields: 'nextPageToken, files(id, name)',
        }, (err1, res1) => {
          if (err1) return console.log('The API returned an error: ' + err1);
          const files = res1.data.files;
          if (files.length) {
            console.log('Files:');
            files.map((file) => {
              console.log(`${file.name} (${file.id})`);
            });
          } else {
            console.log('No files found.');
          }
        });
      }
    }

    // Example on revoking a token
    if (req.url == '/revoke') {
      // Build the string for the POST request
      let postData = "token=" + userCredential.access_token;

      // Options for POST request to Google's OAuth 2.0 server to revoke a token
      let postOptions = {
        host: 'oauth2.googleapis.com',
        port: '443',
        path: '/revoke',
        method: 'POST',
        headers: {
          'Content-Type': 'application/x-www-form-urlencoded',
          'Content-Length': Buffer.byteLength(postData)
        }
      };

      // Set up the request
      const postReq = https.request(postOptions, function (res) {
        res.setEncoding('utf8');
        res.on('data', d => {
          console.log('Response: ' + d);
        });
      });

      postReq.on('error', error => {
        console.log(error)
      });

      // Post the request with data
      postReq.write(postData);
      postReq.end();
    }
    res.end();
  }).listen(80);
}
main().catch(console.error);

HTTP/REST

這個 Python 範例使用 Flask 架構和 Requests 程式庫來示範 OAuth 2.0 網路流程。建議您使用適用於 Python 的 Google API 用戶端程式庫來進行這個流程。(Python 分頁中的範例使用用戶端程式庫)。

import json

import flask
import requests


app = flask.Flask(__name__)

CLIENT_ID = '123456789.apps.googleusercontent.com'
CLIENT_SECRET = 'abc123'  # Read from a file or environmental variable in a real app
SCOPE = 'https://www.googleapis.com/auth/drive.metadata.readonly'
REDIRECT_URI = 'http://example.com/oauth2callback'


@app.route('/')
def index():
  if 'credentials' not in flask.session:
    return flask.redirect(flask.url_for('oauth2callback'))
  credentials = json.loads(flask.session['credentials'])
  if credentials['expires_in'] <= 0:
    return flask.redirect(flask.url_for('oauth2callback'))
  else:
    headers = {'Authorization': 'Bearer {}'.format(credentials['access_token'])}
    req_uri = 'https://www.googleapis.com/drive/v2/files'
    r = requests.get(req_uri, headers=headers)
    return r.text


@app.route('/oauth2callback')
def oauth2callback():
  if 'code' not in flask.request.args:
    auth_uri = ('https://accounts.google.com/o/oauth2/v2/auth?response_type=code'
                '&client_id={}&redirect_uri={}&scope={}').format(CLIENT_ID, REDIRECT_URI, SCOPE)
    return flask.redirect(auth_uri)
  else:
    auth_code = flask.request.args.get('code')
    data = {'code': auth_code,
            'client_id': CLIENT_ID,
            'client_secret': CLIENT_SECRET,
            'redirect_uri': REDIRECT_URI,
            'grant_type': 'authorization_code'}
    r = requests.post('https://oauth2.googleapis.com/token', data=data)
    flask.session['credentials'] = r.text
    return flask.redirect(flask.url_for('index'))


if __name__ == '__main__':
  import uuid
  app.secret_key = str(uuid.uuid4())
  app.debug = False
  app.run()

重新導向 URI 驗證規則

為協助開發人員確保應用程式安全無虞，Google 會對重新導向 URI 套用下列驗證規則。重新導向 URI 必須遵循這些規則。如需網域、主機、路徑、查詢、配置和使用者資訊的定義，請參閱 RFC 3986 第 3 節。

驗證規則
配置

重新導向 URI 必須採用 HTTPS 配置，而非純 HTTP。本機主機 URI (包括 localhost IP 位址 URI) 不受這項規則約束。
主機

主機不得為原始 IP 位址。本機主機 IP 位址不受這項規則的限制。
網域
  • 主機 TLD (頂層網域) 必須屬於公開後置字串清單。
  • 主機網域不得為 “googleusercontent.com”。
  • 重新導向 URI 不得包含網址縮短器網域 (例如 goo.gl)，除非應用程式擁有網域。此外，如果擁有短版網域的應用程式選擇重新導向至該網域，該重新導向 URI 的路徑必須包含 “/google-callback/”，或是結尾是 “/google-callback”。
    		•
    使用者資訊

    重新導向 URI 不得包含 userinfo 子元件。
    路徑

    重新導向 URI 不得包含路徑週遊 (也稱為目錄回溯追蹤)，後者是以 “/..” 或 “\..” 或其網址編碼表示。
    查詢

    重新導向 URI 不得包含開放式重新導向。
    Fragment

    重新導向 URI 不得包含片段元件。
    字元 重新導向 URI 不得包含下列字元：
    • 萬用字元 ('*')
    • 不可列印的 ASCII 字元
    • 百分比編碼無效 (任何未遵循百分比符號的網址編碼形式，後面接著兩個十六進位數字) 的百分比編碼
    • 空值字元 (經過編碼的 NULL 字元，例如%00、%C0%80)

    增量授權

    在 OAuth 2.0 通訊協定中，應用程式會要求存取資源的權限 (依範圍識別)。在需要資源時，您可以為使用者要求授權，這是最佳的使用者體驗。為此，Google 的授權伺服器支援漸進式授權。這項功能可讓您視需要要求範圍。如果使用者授予新範圍的權限，系統會傳回授權碼。該授權碼可能會交換包含使用者授予專案的所有範圍的權杖。

    舉例來說，如果應用程式可讓使用者取樣音樂曲目並建立合輯，在登入時可能只需要少數資源，而這可能不只是登入者的姓名。不過，儲存完成的合輯需要存取 Google 雲端硬碟。不過，如果大多數使用者在實際需要 Google 雲端硬碟時，要求存取 Google 雲端硬碟就很自然。

    在此情況下，應用程式可能會在登入時要求 openid 和 profile 範圍來執行基本登入作業，然後在第一次要求儲存組合時要求 https://www.googleapis.com/auth/drive.file 範圍。

    如要實作漸進式授權，請完成一般流程來要求存取權杖，但請確認授權要求包含先前授予的範圍。如此一來，您的應用程式就不必管理多個存取權杖。

    以下規則適用於透過增量授權取得的存取權杖：

    • 權杖可用來存取與任何納入新合併授權的範圍相對應的資源。
    • 使用更新權杖進行合併授權來取得存取權杖時，存取權杖代表合併授權，且可用於回應中的任何 scope 值。
    • 合併授權包含使用者授予 API 專案的所有範圍，即使相關授權是來自不同的用戶端也一樣。例如，如果使用者透過應用程式的電腦版用戶端授予某個範圍的存取權，然後透過行動用戶端授予另一個範圍的存取權，則合併授權會同時包含這兩個範圍。
    • 如果您撤銷代表合併授權的權杖，則代表關聯使用者存取該授權範圍的所有存取權也會同時撤銷。

    步驟 1：設定授權參數中的特定語言程式碼範例和步驟 2：重新導向至 Google 的 OAuth 2.0 伺服器中的範例 HTTP/REST 重新導向網址都使用漸進式授權。下列程式碼範例也顯示了使用漸進式授權時需要新增的程式碼。

    PHP

    $client->setIncludeGrantedScopes(true);

    Python

    在 Python 中，將 include_granted_scopes 關鍵字引數設為 true，以確保授權要求包含先前授予的範圍。include_granted_scopes 有可能不是您設定的「唯一」關鍵字引數，如以下範例所示。

    authorization_url, state = flow.authorization_url(
    # Enable offline access so that you can refresh an access token without
    # re-prompting the user for permission. Recommended for web server apps.
    access_type='offline',
    # Enable incremental authorization. Recommended as a best practice.
    include_granted_scopes='true')

    Ruby

    auth_client.update!(
  :additional_parameters => {"include_granted_scopes" => "true"}
)

    Node.js

    const authorizationUrl = oauth2Client.generateAuthUrl({
  // 'online' (default) or 'offline' (gets refresh_token)
  access_type: 'offline',
  /** Pass in the scopes array defined above.
    * Alternatively, if only one scope is needed, you can pass a scope URL as a string */
  scope: scopes,
  // Enable incremental authorization. Recommended as a best practice.
  include_granted_scopes: true
});

    HTTP/REST

    GET https://accounts.google.com/o/oauth2/v2/auth?
  client_id=your_client_id&
  response_type=code&
  state=state_parameter_passthrough_value&
  scope=https%3A//www.googleapis.com/auth/drive.file&
  redirect_uri=https%3A//oauth2.example.com/code&
  prompt=consent&
  include_granted_scopes=true

    重新整理存取權杖 (離線存取)

    存取權杖會定期過期，並成為相關 API 要求的無效憑證。如果您為與憑證相關聯的範圍要求離線存取，可以重新整理存取權杖，而不提示使用者授予權限 (包括使用者不存在時)。

    • 如果您使用 Google API 用戶端程式庫，只要將該物件設為可離線存取，用戶端物件就會視需要重新整理存取權杖。
    • 如果您不是使用用戶端程式庫，就必須將使用者重新導向至 Google 的 OAuth 2.0 伺服器時，將 access_type HTTP 查詢參數設為 offline。在這種情況下，Google 的授權伺服器會在您交換存取權杖的授權碼時傳回更新權杖。然後，如果存取權杖過期 (或在任何時間)，您可以使用更新權杖來取得新的存取權杖。

    如果使用者未使用任何應用程式需要存取 Google API，您就需要要求離線存取功能。舉例來說，如果應用程式執行備份服務或在預先指定時間執行動作，在使用者不存在時，應用程式必須能夠重新整理存取權杖。預設存取樣式為 online。

    伺服器端網頁應用程式、已安裝的應用程式和裝置都會在授權程序期間取得更新權杖。重新整理權杖通常無法用於用戶端 (JavaScript) 網頁應用程式。

    PHP

    如果應用程式需要離線存取 Google API，請將 API 用戶端的存取權類型設為 offline：

    $client->setAccessType("offline");

    使用者授予要求範圍的離線存取功能後，您可以繼續使用 API 用戶端，代表使用者離線存取 Google API。用戶端物件會視需要重新整理存取權杖。

    Python

    在 Python 中，將 access_type 關鍵字引數設為 offline，確保您在重新整理存取權杖時，不必重新提示使用者授予權限。access_type 有可能不是您設定的「唯一」關鍵字引數，如以下範例所示。

    authorization_url, state = flow.authorization_url(
    # Enable offline access so that you can refresh an access token without
    # re-prompting the user for permission. Recommended for web server apps.
    access_type='offline',
    # Enable incremental authorization. Recommended as a best practice.
    include_granted_scopes='true')

    使用者授予要求範圍的離線存取功能後，您可以繼續使用 API 用戶端，代表使用者離線存取 Google API。用戶端物件會視需要重新整理存取權杖。

    Ruby

    如果應用程式需要離線存取 Google API，請將 API 用戶端的存取權類型設為 offline：

    auth_client.update!(
  :additional_parameters => {"access_type" => "offline"}
)

    使用者授予要求範圍的離線存取功能後，您可以繼續使用 API 用戶端，代表使用者離線存取 Google API。用戶端物件會視需要重新整理存取權杖。

    Node.js

    如果應用程式需要離線存取 Google API，請將 API 用戶端的存取權類型設為 offline：

    const authorizationUrl = oauth2Client.generateAuthUrl({
  // 'online' (default) or 'offline' (gets refresh_token)
  access_type: 'offline',
  /** Pass in the scopes array defined above.
    * Alternatively, if only one scope is needed, you can pass a scope URL as a string */
  scope: scopes,
  // Enable incremental authorization. Recommended as a best practice.
  include_granted_scopes: true
});

    使用者授予要求範圍的離線存取功能後，您可以繼續使用 API 用戶端，代表使用者離線存取 Google API。用戶端物件會視需要重新整理存取權杖。

    存取權杖會失效。如果存取權杖即將到期，這個程式庫會自動使用更新權杖來取得新的存取權杖。如要確保您一律儲存最新的符記，最簡單的方法是使用符記事件：

    oauth2Client.on('tokens', (tokens) => {
  if (tokens.refresh_token) {
    // store the refresh_token in your secure persistent database
    console.log(tokens.refresh_token);
  }
  console.log(tokens.access_token);
});

    這個權杖事件只會發生在首次授權中，而您必須在呼叫 generateAuthUrl 方法以接收更新權杖時，將 access_type 設為 offline。如果您已向應用程式授予所需權限，但未設定接收更新權杖的適當限制，就必須重新授權應用程式，才能接收新的更新權杖。

    如要稍後再設定 refresh_token，可以使用 setCredentials 方法：

    oauth2Client.setCredentials({
  refresh_token: `STORED_REFRESH_TOKEN`
});

    用戶端取得更新權杖後，系統就會在下次對 API 呼叫時取得存取權杖，並自動重新整理。

    HTTP/REST

    如要重新整理存取權杖，應用程式會傳送 HTTPS POST 要求至 Google 的授權伺服器 (https://oauth2.googleapis.com/token)，其中包含下列參數：

    欄位
    client_id 從 API Console取得的用戶端 ID。
    client_secret 從 API Console取得的用戶端密鑰。
    grant_type 如 OAuth 2.0 規格所定義，這個欄位的值必須設為 refresh_token。
    refresh_token 授權碼交換後傳回的更新權杖。

    以下程式碼片段為要求範例：

    POST /token HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

client_id=your_client_id&
client_secret=your_client_secret&
refresh_token=refresh_token&
grant_type=refresh_token

    只要使用者尚未撤銷授予應用程式的存取權，憑證伺服器就會傳回含有新存取權杖的 JSON 物件。下列程式碼片段顯示回應範例：

    {
  "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
  "expires_in": 3920,
  "scope": "https://www.googleapis.com/auth/drive.metadata.readonly",
  "token_type": "Bearer"
}

    請注意，系統要核發的更新權杖有數量限制，每個用戶端/使用者組合各有一項限制，所有用戶端中每位使用者各有一項限制。請將更新權杖儲存在長期儲存空間中，並在有效期間內繼續使用這些權杖。如果應用程式要求太多重新整理權杖，可能會受到這些限制，而較舊的更新權杖會停止運作。

    撤銷權杖

    在某些情況下，使用者可能會想撤銷應用程式的存取權。使用者可以前往「 帳戶設定」撤銷存取權。詳情請參閱「移除具有您帳戶存取權的第三方網站和應用程式」一節支援文件。

    應用程式也可以透過程式輔助方式撤銷授予的權限。假如使用者取消訂閱、移除應用程式，或應用程式所需的 API 資源有大幅變動，那麼程式輔助撤銷就十分重要。也就是說，移除程序的一部分可以包含 API 要求，確保先前授予應用程式的權限已移除。

    PHP

    如要透過程式輔助方式撤銷權杖，請呼叫 revokeToken()：

    $client->revokeToken();

    Python

    如要透過程式輔助方式撤銷權杖，請向 https://oauth2.googleapis.com/revoke 提出包含權杖做為參數的要求，並設定 Content-Type 標頭：

    requests.post('https://oauth2.googleapis.com/revoke',
    params={'token': credentials.token},
    headers = {'content-type': 'application/x-www-form-urlencoded'})

    Ruby

    如要透過程式輔助方式撤銷權杖，請向 oauth2.revoke 端點發出 HTTP 要求：

    uri = URI('https://oauth2.googleapis.com/revoke')
response = Net::HTTP.post_form(uri, 'token' => auth_client.access_token)

    權杖可以是存取權杖或更新權杖。如果權杖是存取權杖，且有對應的更新權杖，系統就會撤銷更新權杖。

    如果撤銷成功，回應的狀態碼為 200。如果是錯誤狀況，系統會傳回狀態碼 400 和錯誤代碼。

    Node.js

    如要透過程式輔助方式撤銷權杖，請向 /revoke 端點發出 HTTPS POST 要求：

    const https = require('https');

// Build the string for the POST request
let postData = "token=" + userCredential.access_token;

// Options for POST request to Google's OAuth 2.0 server to revoke a token
let postOptions = {
  host: 'oauth2.googleapis.com',
  port: '443',
  path: '/revoke',
  method: 'POST',
  headers: {
    'Content-Type': 'application/x-www-form-urlencoded',
    'Content-Length': Buffer.byteLength(postData)
  }
};

// Set up the request
const postReq = https.request(postOptions, function (res) {
  res.setEncoding('utf8');
  res.on('data', d => {
    console.log('Response: ' + d);
  });
});

postReq.on('error', error => {
  console.log(error)
});

// Post the request with data
postReq.write(postData);
postReq.end();

    Token 參數可以是存取權杖或更新權杖。如果權杖是存取權杖，且有對應的更新權杖，系統就會撤銷更新權杖。

    如果撤銷成功，回應的狀態碼為 200。如果是錯誤狀況，系統會傳回狀態碼 400 和錯誤代碼。

    HTTP/REST

    如要透過程式輔助方式撤銷權杖，應用程式會向 https://oauth2.googleapis.com/revoke 發出要求，並加入權杖做為參數：

    curl -d -X -POST --header "Content-type:application/x-www-form-urlencoded" \
        https://oauth2.googleapis.com/revoke?token={token}

    權杖可以是存取權杖或更新權杖。如果權杖是存取權杖，且有對應的更新權杖，系統就會撤銷更新權杖。

    如果撤銷成功，回應的 HTTP 狀態碼為 200。如果是錯誤狀況，系統會傳回 HTTP 狀態碼 400 和錯誤代碼。