Halaman ini diterjemahkan oleh Cloud Translation API.

Penautan Akun Google dengan OAuth

Akun ditautkan menggunakan alur implisit dan kode otorisasi OAuth 2.0 standar industri. Layanan Anda harus mendukung endpoint otorisasi dan pertukaran token yang mematuhi OAuth 2.0.

Pada alur implisit, Google membuka endpoint otorisasi Anda di browser pengguna. Setelah berhasil login, Anda menampilkan token akses berumur panjang ke Google. Token akses ini sekarang disertakan dalam setiap permintaan yang dikirim dari Google.

Dalam alur kode otorisasi, Anda memerlukan dua endpoint:

Endpoint otorisasi, yang menampilkan UI login kepada pengguna yang belum login. Endpoint otorisasi juga membuat kode otorisasi berumur pendek untuk mencatat izin pengguna atas akses yang diminta.
Endpoint pertukaran token, yang bertanggung jawab untuk dua jenis pertukaran:
1. Menukarkan kode otorisasi untuk token refresh yang berumur panjang dan token akses yang berumur pendek. Pertukaran ini terjadi saat pengguna melalui alur penautan akun.
2. Menukarkan token refresh yang berumur panjang dengan token akses yang berumur pendek. Pertukaran ini terjadi jika Google memerlukan token akses baru karena token tersebut sudah tidak berlaku.

Memilih alur OAuth 2.0

Meskipun alur implisit lebih mudah diimplementasikan, Google merekomendasikan agar token akses yang dikeluarkan oleh alur implisit tidak pernah berakhir masa berlakunya. Hal ini karena pengguna dipaksa untuk menautkan akun lagi setelah token berakhir dengan alur implisit. Jika Anda memerlukan masa berlaku token untuk alasan keamanan, sebaiknya gunakan alur kode otorisasi.

Panduan desain

Bagian ini menjelaskan persyaratan desain dan rekomendasi untuk layar pengguna yang Anda hosting untuk alur penautan OAuth. Setelah dipanggil oleh aplikasi Google, platform Anda akan menampilkan halaman login ke halaman Google dan layar izin penautan akun kepada pengguna. Pengguna diarahkan kembali ke aplikasi Google setelah memberikan izin untuk menautkan akun.

Gambar ini menunjukkan langkah-langkah bagi pengguna untuk menautkan Akun Google mereka ke sistem autentikasi Anda. Screenshot pertama menunjukkan penautan yang dimulai pengguna dari platform Anda. Gambar kedua menunjukkan proses login pengguna ke Google, sementara gambar ketiga menunjukkan izin dan konfirmasi pengguna untuk menautkan Akun Google mereka ke aplikasi Anda. Screenshot terakhir menampilkan akun pengguna yang berhasil ditautkan di aplikasi Google. — **Gambar 1.** Pengguna yang menautkan akun login ke Google dan layar izin.

Persyaratan

Anda harus menginformasikan bahwa akun pengguna akan ditautkan ke Google, bukan produk Google tertentu seperti Google Home atau Asisten Google.

Rekomendasi

Sebaiknya Anda melakukan hal berikut:

Tampilkan Kebijakan Privasi Google. Sertakan link ke Kebijakan Privasi Google di layar izin.
Data yang akan dibagikan. Gunakan bahasa yang jelas dan ringkas untuk memberi tahu pengguna data apa yang diperlukan Google beserta alasannya.
Pesan ajakan (CTA) yang jelas. Nyatakan pesan ajakan (CTA) yang jelas di layar izin Anda, seperti “Setuju dan tautkan”. Hal ini karena pengguna perlu memahami data apa yang harus mereka bagikan kepada Google untuk menautkan akun mereka.
Kemampuan untuk membatalkan. Berikan cara bagi pengguna untuk kembali atau membatalkan, jika mereka memilih untuk tidak menautkan.
Hapus proses login. Pastikan bahwa pengguna memiliki metode yang jelas untuk login ke Akun Google mereka, seperti kolom untuk nama pengguna dan sandi mereka atau Login dengan Google.
Kemampuan untuk membatalkan tautan. Tawarkan mekanisme bagi pengguna untuk membatalkan tautan, seperti URL ke setelan akun mereka di platform Anda. Atau, Anda dapat menyertakan link ke Akun Google tempat pengguna dapat mengelola akun tertaut mereka.
Kemampuan untuk mengubah akun pengguna. Menyarankan metode bagi pengguna untuk berganti akun. Hal ini sangat bermanfaat jika pengguna cenderung memiliki beberapa akun.
- Jika pengguna harus menutup layar izin untuk beralih akun, kirimkan error yang dapat dipulihkan ke Google sehingga pengguna dapat login ke akun yang diinginkan dengan penautan OAuth dan alur implisit.
Sertakan logo. Menampilkan logo perusahaan di layar izin. Gunakan pedoman gaya untuk menempatkan logo Anda. Jika ingin menampilkan logo Google, lihat Logo dan merek dagang.

创建项目

如需创建项目以使用帐号关联，请按以下步骤操作：

Go to the Google API Console.
Klik Buat proyek .
Masukkan nama atau terima saran yang dihasilkan.
Konfirmasikan atau edit bidang yang tersisa.
Klik Buat .

Untuk melihat ID proyek Anda:

Go to the Google API Console.
Temukan proyek Anda di tabel di halaman arahan. ID proyek muncul di kolom ID .

配置 OAuth 权限请求页面

Google 帐号关联流程包括一个同意屏幕，用于告知用户请求访问其数据的应用、用户要求的数据类型以及适用的条款。您需要先配置 OAuth 权限请求页面，然后才能生成 Google API 客户端 ID。

打开 Google API 控制台的 OAuth 同意屏幕页面。
如果出现提示，请选择您刚刚创建的项目。
在“OAuth 同意屏幕”页面上，填写表单，然后点击“保存”按钮。

应用名称：请求用户同意的应用的名称。该名称应准确反映您的应用，并与用户在别处看到的应用名称保持一致。应用名称将显示在帐号关联同意屏幕上。

应用徽标：同意屏幕上的图片，有助于用户识别您的应用。徽标会显示在帐号关联同意屏幕和帐号设置中

支持电子邮件地址：供用户就其同意情况与您联系。

Google API 的范围：范围允许您的应用访问用户的私有 Google 数据。对于 Google 帐号关联用例，默认范围（电子邮件、个人资料、OpenID）就足够了，您无需添加任何敏感范围。最佳做法一般是在需要访问时逐步请求作用域，而不是预先请求。了解详情。

已获授权的网域：为保护您和您的用户，Google 仅允许使用 OAuth 进行身份验证的应用使用已获授权的网域。您应用的链接必须托管在已获授权的网域上。了解详情。

应用首页链接：您的应用的首页。必须托管在已获授权的网域上。

应用隐私权政策链接：在 Google 帐号关联同意屏幕上显示。必须托管在已获授权的网域上。

应用服务条款链接（可选）：必须托管在已获授权的网域上。

图 1. 一款虚构应用 Tunery 的 Google 帐号关联同意屏幕
查看“验证状态”。如果您的申请需要验证，请点击“提交验证”按钮，提交您的申请。如需了解详情，请参阅 OAuth 验证要求。

Mengimplementasikan server OAuth

Sebuah OAuth pelaksanaan 2.0 server dari aliran kode otorisasi terdiri dari dua endpoint, yang layanan Anda membuat tersedia dengan HTTPS. Titik akhir pertama adalah titik akhir otorisasi, yang bertanggung jawab untuk menemukan atau memperoleh persetujuan dari pengguna untuk akses data. Titik akhir otorisasi menyajikan UI masuk ke pengguna Anda yang belum masuk dan mencatat persetujuan untuk akses yang diminta. Titik akhir kedua adalah titik akhir pertukaran token, yang digunakan untuk mendapatkan string terenkripsi, yang disebut token, yang memberi wewenang kepada pengguna untuk mengakses layanan Anda.

Saat aplikasi Google perlu memanggil salah satu API layanan Anda, Google menggunakan titik akhir ini bersama-sama untuk mendapatkan izin dari pengguna Anda untuk memanggil API ini atas nama mereka.

Sesi alur kode otorisasi OAuth 2.0 yang dimulai oleh Google memiliki alur berikut:

Google membuka titik akhir otorisasi Anda di browser pengguna. Jika alur dimulai pada perangkat khusus suara untuk Tindakan, Google mentransfer eksekusi ke telepon.
Pengguna masuk, jika belum masuk, dan memberikan izin kepada Google untuk mengakses data mereka dengan API Anda, jika mereka belum memberikan izin.
Layanan Anda menciptakan kode otorisasi dan kembali ke Google. Untuk melakukannya, arahkan kembali browser pengguna ke Google dengan kode otorisasi yang dilampirkan pada permintaan.
Google mengirimkan kode otorisasi untuk endpoint pertukaran token Anda, yang memverifikasi keaslian kode dan mengembalikan sebuah token dan refresh token akses. Token akses adalah token berumur pendek yang diterima layanan Anda sebagai kredensial untuk mengakses API. Token penyegaran adalah token berumur panjang yang dapat disimpan dan digunakan oleh Google untuk memperoleh token akses baru saat token tersebut kedaluwarsa.
Setelah pengguna menyelesaikan alur penautan akun, setiap permintaan berikutnya yang dikirim dari Google berisi token akses.

Menangani permintaan otorisasi

Saat Anda perlu melakukan penautan akun menggunakan alur kode otorisasi OAuth 2.0, Google mengirimkan pengguna ke titik akhir otorisasi Anda dengan permintaan yang menyertakan parameter berikut:

Parameter titik akhir otorisasi
`client_id`	ID Klien yang Anda tetapkan ke Google.
`redirect_uri`	URL tujuan Anda mengirim tanggapan atas permintaan ini.
`state`	Nilai pembukuan yang diteruskan kembali ke Google tidak berubah di URI pengalihan.
`scope`	Opsional: Sebuah set ruang-delimited string lingkup yang menentukan data Google meminta otorisasi untuk.
`response_type`	Jenis nilai yang akan dikembalikan dalam respons. Untuk aliran kode 2.0 otorisasi OAuth, jenis respon selalu `code` .
`user_locale`	Akun Google pengaturan bahasa di RFC5646 format yang, digunakan untuk melokalisasi konten Anda dalam bahasa pilihan pengguna.

Misalnya, jika endpoint otorisasi Anda tersedia di https://myservice.example.com/auth , permintaan akan terlihat seperti berikut ini:

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&scope=REQUESTED_SCOPES&response_type=code&user_locale=LOCALE

Agar titik akhir otorisasi Anda menangani permintaan masuk, lakukan langkah-langkah berikut:

Verifikasi bahwa client_id sesuai dengan ID Klien Anda ditugaskan untuk Google, dan bahwa redirect_uri cocok URL redirect yang disediakan oleh Google untuk layanan Anda. Pemeriksaan ini penting untuk mencegah pemberian akses ke aplikasi klien yang tidak diinginkan atau salah dikonfigurasi. Jika Anda mendukung beberapa OAuth 2.0 arus, juga mengkonfirmasi bahwa response_type adalah code .
Periksa apakah pengguna masuk ke layanan Anda. Jika pengguna tidak masuk, selesaikan alur masuk atau pendaftaran layanan Anda.
Buat kode otorisasi untuk digunakan Google untuk mengakses API Anda. Kode otorisasi dapat berupa nilai string apa pun, tetapi harus secara unik mewakili pengguna, klien yang menjadi tujuan token, dan waktu kedaluwarsa kode, dan kode tersebut tidak boleh ditebak. Anda biasanya mengeluarkan kode otorisasi yang kedaluwarsa setelah sekitar 10 menit.

Konfirmasi bahwa URL yang ditentukan oleh redirect_uri parameter memiliki bentuk sebagai berikut:

  https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
  https://oauth-redirect-sandbox.googleusercontent.com/r/YOUR_PROJECT_ID

Mengarahkan browser pengguna ke URL yang ditentukan oleh redirect_uri parameter. Sertakan kode otorisasi Anda hanya dihasilkan dan yang asli, dimodifikasi nilai negara ketika Anda mengarahkan dengan menambahkan code dan state parameter. Berikut ini adalah contoh dari URL yang dihasilkan:
```
https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING
```

Menangani permintaan pertukaran token

Titik akhir pertukaran token layanan Anda bertanggung jawab atas dua jenis pertukaran token:

Tukarkan kode otorisasi untuk token akses dan token penyegaran
Tukarkan token penyegaran untuk token akses

Permintaan pertukaran token mencakup parameter berikut:

Parameter titik akhir pertukaran token
`client_id`	String yang mengidentifikasi asal permintaan sebagai Google. String ini harus terdaftar dalam sistem Anda sebagai pengenal unik Google.
`client_secret`	String rahasia yang Anda daftarkan ke Google untuk layanan Anda.
`grant_type`	Jenis token yang dipertukarkan. Ini baik `authorization_code` atau `refresh_token` .
`code`	Ketika `grant_type=authorization_code` , parameter ini adalah kode Google yang diterima dari baik masuk atau pertukaran endpoint tanda.
`redirect_uri`	Ketika `grant_type=authorization_code` , parameter ini adalah URL yang digunakan dalam permintaan otorisasi awal.
`refresh_token`	Ketika `grant_type=refresh_token` , parameter ini adalah refresh tanda Google yang diterima dari endpoint pertukaran token Anda.

Tukarkan kode otorisasi untuk token akses dan token penyegaran

Setelah pengguna masuk dan titik akhir otorisasi Anda mengembalikan kode otorisasi yang berumur pendek ke Google, Google mengirimkan permintaan ke titik akhir pertukaran token Anda untuk menukar kode otorisasi dengan token akses dan token penyegaran.

Untuk permintaan ini, nilai grant_type adalah authorization_code , dan nilai code adalah nilai kode otorisasi sebelumnya Anda diberikan kepada Google. Berikut ini adalah contoh permintaan pertukaran kode otorisasi untuk token akses dan token penyegaran:

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

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=REDIRECT_URI

Untuk bertukar kode otorisasi untuk akses token dan refresh token, token Anda pertukaran endpoint merespon untuk POST permintaan dengan menjalankan langkah-langkah berikut:

Verifikasi bahwa client_id mengidentifikasi permintaan asal sebagai asal berwenang, dan bahwa client_secret sesuai dengan nilai yang diharapkan.
Verifikasi bahwa kode otorisasi valid dan tidak kedaluwarsa, dan bahwa ID klien yang ditentukan dalam permintaan cocok dengan ID klien yang terkait dengan kode otorisasi.
Konfirmasi bahwa URL yang ditentukan oleh redirect_uri parameter identik dengan nilai yang digunakan dalam permintaan otorisasi awal.
Jika Anda tidak dapat memverifikasi semua kriteria di atas, kembali HTTP 400 Bad Request kesalahan dengan {"error": "invalid_grant"} sebagai tubuh.
Jika tidak, gunakan ID pengguna dari kode otorisasi untuk menghasilkan token penyegaran dan token akses. Token ini dapat berupa nilai string apa pun, tetapi harus secara unik mewakili pengguna dan klien yang menjadi tujuan token tersebut, dan tidak boleh dapat ditebak. Untuk token akses, catat juga waktu kedaluwarsa token, yang biasanya satu jam setelah Anda mengeluarkan token. Segarkan token tidak kedaluwarsa.

Kembalikan JSON objek berikut dalam tubuh respon HTTPS:

{
"token_type": "Bearer",
"access_token": "ACCESS_TOKEN",
"refresh_token": "REFRESH_TOKEN",
"expires_in": SECONDS_TO_EXPIRATION
}

Google menyimpan token akses dan token penyegaran untuk pengguna dan mencatat masa berlaku token akses. Saat token akses kedaluwarsa, Google menggunakan token penyegaran untuk mendapatkan token akses baru dari titik akhir pertukaran token Anda.

Tukarkan token penyegaran untuk token akses

Saat token akses kedaluwarsa, Google mengirimkan permintaan ke titik akhir pertukaran token Anda untuk menukar token penyegaran dengan token akses baru.

Untuk permintaan ini, nilai grant_type adalah refresh_token , dan nilai refresh_token adalah nilai refresh tanda sebelumnya diberikan kepada Google. Berikut ini adalah contoh permintaan untuk menukar token penyegaran dengan token akses:

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

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

Untuk bertukar refresh tanda untuk token akses, token Anda pertukaran endpoint merespon untuk POST permintaan dengan menjalankan langkah-langkah berikut:

Verifikasi bahwa client_id mengidentifikasi permintaan asal Google, dan bahwa client_secret sesuai dengan nilai yang diharapkan.
Pastikan token penyegaran valid, dan ID klien yang ditentukan dalam permintaan cocok dengan ID klien yang terkait dengan token penyegaran.
Jika Anda tidak dapat memverifikasi semua kriteria di atas, kembali HTTP 400 Bad Request kesalahan dengan {"error": "invalid_grant"} sebagai tubuh.
Jika tidak, gunakan ID pengguna dari token penyegaran untuk menghasilkan token akses. Token ini dapat berupa nilai string apa pun, tetapi harus secara unik mewakili pengguna dan klien yang menjadi tujuan token tersebut, dan tidak boleh dapat ditebak. Untuk token akses, catat juga waktu kedaluwarsa token, biasanya satu jam setelah Anda mengeluarkan token.

Kembalikan objek JSON berikut di badan respons HTTPS:

{
"token_type": "Bearer",
"access_token": " ACCESS_TOKEN ",
"expires_in": SECONDS_TO_EXPIRATION
}

处理用户信息请求

该用户信息终端是一个OAuth 2.0保护的资源，对链接的用户返回的权利要求。实现和托管 userinfo 端点是可选的，以下用例除外：

链接帐户登录与谷歌一个水龙头。
无摩擦订阅的AndroidTV。

从您的令牌端点成功检索访问令牌后，Google 会向您的 userinfo 端点发送请求，以检索有关链接用户的基本个人资料信息。

userinfo 端点请求标头
`Authorization header`	Bearer 类型的访问令牌。

例如，如果你的用户信息终端可在https://myservice.example.com/userinfo ，请求看起来像下面这样：

GET /userinfo HTTP/1.1
Host: myservice.example.com
Authorization: Bearer ACCESS_TOKEN

要让您的 userinfo 端点处理请求，请执行以下步骤：

从 Authorization 标头中提取访问令牌并返回与访问令牌关联的用户的信息。
如果访问令牌无效，返回HTTP 401错误未经授权使用的WWW-Authenticate响应头。下面是一个userinfo的错误响应的一个示例：
```
HTTP/1.1 401 Unauthorized
WWW-Authenticate: error="invalid_token",
error_description="The Access Token expired"
```
如果一个401未经授权，或任何其它不成功错误响应在关联过程返回时，误差将是不可恢复的，所检索的令牌将被丢弃，并且用户将必须再次启动链接过程。

如果访问令牌是有效的，回国与以下JSON对象在HTTPS响应的身体HTTP 200回应：

{
"sub": "USER_UUID",
"email": "EMAIL_ADDRESS",
"given_name": "FIRST_NAME",
"family_name": "LAST_NAME",
"name": "FULL_NAME",
"picture": "PROFILE_PICTURE",
}

如果你的用户信息端点返回一个HTTP 200成功响应，检索到的令牌和索赔登记针对用户的谷歌帐户。

用户信息端点响应
`sub`	标识系统中用户的唯一 ID。
`email`	用户的电子邮件地址。
`given_name`	可选：用户的名字。
`family_name`	可选：用户的姓氏。
`name`	可选：用户的全名。
`picture`	可选：用户的档案图片。

Memvalidasi implementasi

您可以通过使用验证实现的OAuth 2.0游乐场工具。

在工具中，执行以下步骤：

单击配置打开的OAuth 2.0配置窗口。
在OAuth流场中，选择客户端。
在OAuth端点字段中，选择自定义。
在相应字段中指定您的 OAuth 2.0 端点和您分配给 Google 的客户端 ID。
在步骤1部分，不要选择任何谷歌范围。相反，将此字段留空或键入对您的服务器有效的范围（如果不使用 OAuth 范围，则输入任意字符串）。当您完成后，单击授权的API。
在步骤2和步骤3段，完成OAuth 2.0流程和验证每个步骤按预期工作。

您可以通过验证您的实现谷歌帐户链接演示工具。

在工具中，执行以下步骤：

点击登录在与谷歌按钮。
选择您要关联的帐户。
输入服务标识。
（可选）输入您将请求访问的一个或多个范围。
单击开始演示。
出现提示时，确认您可以同意并拒绝链接请求。
确认您被重定向到您的平台。