Platform API Google menyediakan sekumpulan fungsi umum untuk semua Google API yang dibuat menggunakan platform tersebut. Untuk menggunakan dan mengontrol fungsi tersebut, platform menentukan terlebih dahulu kumpulan parameter permintaan khusus yang disebut parameter sistem. Parameter ini tersedia di semua Google REST API dan gRPC API. Parameter sistem dapat ditentukan menggunakan parameter kueri HTTP atau header HTTP. Untuk Google gRPC API, hanya header HTTP yang didukung.
Sebagian besar pengguna tidak perlu menggunakan parameter ini secara langsung. Namun, library ini sering digunakan oleh library klien yang disediakan Google. Jika Anda perlu menulis kode kustom untuk mengakses Google API secara langsung, parameter sistem dapat berguna dalam kasus-kasus seperti mengontrol proses cetak yang ada di JSON atau menentukan Kunci API.
Pemetaan HTTP
Untuk permintaan HTTP, parameter sistem dikirim sebagai parameter kueri URL atau header permintaan HTTP. Misalnya, jika Anda memiliki parameter sistem $foo, parameter tersebut
akan dikirim sebagai ?$foo=xxx dalam URL, atau ?%24foo=xxx jika dienkode ke URL. Lihat tabel di bawah untuk mengetahui detailnya.
Pemetaan gRPC
Untuk permintaan gRPC, parameter sistem dikirim sebagai header permintaan HTTP dengan kunci dalam huruf kecil. Lihat tabel di bawah untuk mengetahui detailnya.
Definisi
Tabel berikut mencantumkan semua parameter sistem dan definisinya.
| Parameter Kueri URL | Header HTTP/gRPC | Deskripsi |
|---|---|---|
Authorization |
Kredensial autentikasi. Lihat Ringkasan autentikasi untuk mengetahui detailnya. | |
$alt,alt |
Format respons alternatif. Nilai yang didukung adalah json (default), media, proto, sse (aliran JSON). |
|
$.xgafv |
Format error JSON. Nilai yang didukung adalah 1, 2 (default). Format error 1 hanya boleh digunakan oleh Library Klien Google API. |
|
$callback,callback |
Parameter callback JSONP. | |
$ct |
Content-Type |
Penggantian header permintaan Jenis Konten HTTP. |
$fields,fields |
X-Goog-FieldMask |
FieldMask digunakan untuk pemfilteran respons. Jika kosong, semua kolom harus ditampilkan kecuali jika dinyatakan lain. |
X-HTTP-Method-Override |
Metode HTTP yang dimaksudkan untuk permintaan. Beberapa proxy jaringan tidak menerima semua metode HTTP. | |
$key,key |
X-Goog-Api-Key |
Kunci Google API. Lihat https://cloud.google.com/docs/authentication/api-keys untuk mengetahui detailnya. |
passwd,password |
Dicadangkan untuk mencegah sandi ditempatkan di URL. | |
$prettyPrint,prettyPrint |
Respons JSON Pretty-print. Nilai yang didukung adalah true (default), false. |
|
quotaUser |
X-Goog-Quota-User |
ID pengguna pseudo untuk menagih kuota per pengguna. Jika tidak ditentukan, akun utama yang diautentikasi akan digunakan. Jika tidak ada akun utama yang diautentikasi, alamat IP klien akan digunakan. Jika ditetapkan, kunci API yang valid dengan pembatasan layanan harus digunakan untuk mengidentifikasi project kuota. Jika tidak, parameter ini akan diabaikan. |
$outputDefaults |
Paksa untuk menghasilkan nilai default proto untuk respons JSON. | |
$unique |
Parameter kueri unik untuk menonaktifkan penyimpanan permintaan ke cache. | |
X-Goog-Api-Client |
Identifikasi klien API. Nilainya adalah daftar string NAME "/" SEMVER yang dipisahkan spasi, dengan NAME hanya boleh berisi huruf kecil, angka, serta "-", dan SEMVER harus berupa string versi semantik. Misalnya: X-Goog-Api-Client: python/3.5.0 grpc-google-pubsub-v1/0.1.0-beta2 linux/2.7.0. |
|
X-Goog-Request-Reason |
Berisi alasan untuk membuat permintaan, yang dimaksudkan untuk dicatat dalam logging audit. Contohnya adalah nomor tiket kasus dukungan. | |
$userProject |
X-Goog-User-Project |
Project yang ditentukan pemanggil untuk tujuan kuota dan penagihan. Pemanggil harus memiliki izin serviceusage.services.use di project. |
X-Server-Timeout |
Waktu tunggu (dalam detik, nilai float) bagi server untuk menyelesaikan pemrosesan permintaan. Parameter sistem ini hanya berlaku untuk REST API yang waktu tunggu sisi kliennya tidak berlaku. | |
x-goog-request-params |
Meneruskan parameter tambahan untuk permintaan gRPC dalam format kueri URL. Misalnya: x-goog-request-params: service=pubsub.googleapis.com&release=2021-11-01r0. |
Log Perubahan
- 11-2021 Dokumentasi yang dipublikasikan untuk
x-goog-request-params. - 02-2021 Dokumentasi yang dipublikasikan untuk
quotaUser. - 07-2020 Parameter kueri OAuth 2.0 yang tidak digunakan lagi.
- 2019-10 Memperkenalkan parameter sistem
X-Server-Timeout. - 2017-10 Memperkenalkan parameter sistem
X-Goog-User-Project.