Peringatan: Data ini disediakan berdasarkan Kebijakan Data Pengguna Google. Harap tinjau dan patuhi kebijakan tersebut. Ketidakpatuhan terhadap persyaratan tersebut dapat mengakibatkan penangguhan project atau akun.

Login di TV dan Perangkat Input Terbatas

Anda dapat mengizinkan pengguna login ke aplikasi Anda dengan Akun Google mereka di perangkat dengan kemampuan input terbatas, seperti TV yang terhubung ke internet.

Aplikasi akan menampilkan kode singkat dan URL login kepada pengguna. Kemudian, pengguna membuka URL login di browser web, memasukkan kode, dan memberikan izin kepada aplikasi untuk mengakses informasi login pengguna. Terakhir, aplikasi akan menerima konfirmasi dan pengguna sudah login.

Untuk menggunakan alur login ini, aplikasi harus berjalan pada perangkat yang memenuhi kriteria berikut:

  • Perangkat harus dapat menampilkan URL 40 karakter dan kode pengguna 15 karakter, beserta petunjuk kepada pengguna.
  • Perangkat harus terhubung ke internet.

Mendapatkan client ID dan rahasia klien

Aplikasi Anda memerlukan client ID dan rahasia klien OAuth 2.0 untuk membuat permintaan ke endpoint login Google.

Untuk menemukan client ID dan rahasia klien project Anda, lakukan hal berikut:

  1. Pilih kredensial OAuth 2.0 yang sudah ada atau buka halaman Kredensial.
  2. Jika belum melakukannya, buat kredensial OAuth 2.0 project Anda dengan mengklik Buat kredensial > client ID OAuth, dan memberikan informasi yang diperlukan untuk membuat kredensial.
  3. Cari Client ID di bagian Client ID OAuth 2.0. Untuk detail, klik client ID.

Jika Anda membuat client ID baru, pilih jenis aplikasi TV dan Perangkat Input Terbatas.

Memperoleh kode pengguna dan URL verifikasi

Setelah pengguna meminta login menggunakan Akun Google, Anda mendapatkan kode pengguna dan URL verifikasi dengan mengirim permintaan HTTP POST ke endpoint perangkat OAuth 2.0, https://oauth2.googleapis.com/device/code. Sertakan client ID dan daftar cakupan yang Anda perlukan dengan permintaan. Jika Anda hanya ingin memproses login dengan akun Google pengguna, minta hanya cakupan profile dan email; atau, jika ingin meminta izin untuk memanggil API yang didukung atas nama pengguna, minta cakupan yang diperlukan selain cakupan profile dan email.

Berikut adalah contoh permintaan untuk kode pengguna:

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

client_id=CLIENT_ID&scope=email%20profile

Menggunakan curl:

curl -d "client_id=CLIENT_ID&scope=email profile" https://oauth2.googleapis.com/device/code

Respons dikembalikan sebagai objek JSON:

{
  "device_code" : "4/4-GMMhmHCXhWEzkobqIHGG_EnNYYsAkukHspeYUk9E8",
  "user_code" : "GQVQ-JKEC",
  "verification_url" : "https://www.google.com/device",
  "expires_in" : 1800,
  "interval" : 5
}

Aplikasi Anda menampilkan nilai user_code dan verification_url kepada pengguna, dan, pada saat yang sama, melakukan polling endpoint login pada interval yang ditentukan hingga pengguna login atau waktu yang ditentukan oleh expires_in telah berlalu.

Menampilkan kode pengguna dan URL verifikasi

Setelah Anda menerima kode pengguna dan URL verifikasi dari endpoint perangkat, tampilkan dan minta pengguna untuk membuka URL dan memasukkan kode pengguna.

Nilai verification_url dan user_code dapat berubah sewaktu-waktu. Desain UI dengan cara yang dapat menangani batas berikut:

  • user_code harus ditampilkan dalam kolom yang cukup lebar untuk menangani 15 karakter berukuran W.
  • verification_url harus ditampilkan dalam kolom yang cukup lebar untuk menangani string URL dengan panjang 40 karakter.

Kedua string dapat berisi karakter yang dapat dicetak dari himpunan karakter US-ASCII.

Saat Anda menampilkan string user_code, jangan ubah string dengan cara apa pun (seperti mengubah huruf besar/kecil atau menyisipkan karakter pemformatan lainnya), karena aplikasi Anda mungkin akan rusak jika format kode berubah di masa mendatang.

Anda dapat mengubah string verification_url dengan menghapus skema dari URL untuk tujuan tampilan jika menginginkannya. Jika melakukannya, pastikan aplikasi Anda dapat menangani varian "http" dan "https" varian. Jika tidak, jangan ubah string verification_url.

Saat membuka URL verifikasi, pengguna akan melihat halaman yang mirip dengan berikut ini:

Hubungkan perangkat dengan memasukkan kode

Setelah pengguna memasukkan kode pengguna, situs login Google akan menampilkan layar izin yang mirip dengan yang berikut:

Contoh layar izin untuk klien perangkat

Jika pengguna mengklik Izinkan, aplikasi Anda dapat memperoleh token ID untuk mengidentifikasi pengguna, token akses untuk memanggil Google API, dan token refresh untuk mendapatkan token baru.

Memperoleh token ID dan token refresh

Setelah aplikasi Anda menampilkan kode pengguna dan URL verifikasi, mulai polling endpoint token (https://oauth2.googleapis.com/token) dengan kode perangkat yang Anda terima dari endpoint perangkat. Lakukan polling endpoint token pada interval, dalam detik, yang ditentukan oleh nilai interval.

Berikut adalah contoh permintaan:

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

client_id=CLIENT_ID&client_secret=CLIENT_SECRET&code=DEVICE_CODE&grant_type=http://oauth.net/grant_type/device/1.0

Menggunakan curl:

curl -d "client_id=CLIENT_ID&client_secret=CLIENT_SECRET&code=DEVICE_CODE&grant_type=http://oauth.net/grant_type/device/1.0" https://oauth2.googleapis.com/token

Jika pengguna belum menyetujui permintaan tersebut, responsnya adalah sebagai berikut:

{
  "error" : "authorization_pending"
}

Aplikasi Anda harus mengulangi permintaan ini pada tingkat yang tidak melebihi nilai interval. Jika aplikasi Anda melakukan polling terlalu cepat, responsnya adalah sebagai berikut:

{
  "error" : "slow_down"
}

Setelah pengguna login dan memberi aplikasi Anda akses ke cakupan yang Anda minta, respons terhadap permintaan berikutnya dari aplikasi Anda akan mencakup token ID, token akses, dan token refresh:

{
  "access_token" : "ya29.AHES6ZSuY8f6WFLswSv0HZLP2J4cCvFSj-8GiZM0Pr6cgXU",
  "token_type" : "Bearer",
  "expires_in" : 3600,
  "refresh_token" : "1/551G1yXUqgkDGnkfFk6ZbjMMMDIMxo3JFc8lY8CAR-Q",
  "id_token": "eyJhbGciOiJSUzI..."
}

Setelah menerima respons ini, aplikasi Anda dapat mendekode token ID untuk mendapatkan informasi profil dasar tentang pengguna yang login, atau mengirim token ID ke server backend aplikasi Anda untuk mengautentikasi dengan aman ke server. Selain itu, aplikasi Anda dapat menggunakan token akses untuk memanggil Google API yang diizinkan oleh pengguna.

Token akses dan ID memiliki masa berlaku yang terbatas. Untuk mempertahankan pengguna agar tetap login melebihi token' masa aktif, simpan token refresh dan gunakan untuk meminta token baru.

Mendapatkan informasi profil pengguna dari token ID

Anda dapat memperoleh informasi profil tentang pengguna yang login dengan mendekode token ID menggunakan library decoding JWT. Misalnya, menggunakan library JavaScript jwt-decode Auth0:

var user_profile = jwt_decode(id_token);

// The "sub" field is available on all ID tokens. This value is unique for each
// Google account and can be used to identify the user. (But do not send this
// value to your server; instead, send the whole ID token so its authenticity
// can be verified.)
var user_id = user_profile["sub"];

// These values are available when you request the "profile" and "email" scopes.
var user_email = user_profile["email"];
var email_verified = user_profile["email_verified"];
var user_name = user_profile["name"];
var user_photo_url = user_profile["picture"];
var user_given_name = user_profile["given_name"];
var user_family_name = user_profile["family_name"];
var user_locale = user_profile["locale"];

Informasi selengkapnya