Bagian ini menjelaskan kumpulan definisi kolom pesan standar yang harus digunakan saat konsep serupa diperlukan. Tindakan ini akan memastikan konsep yang sama memiliki nama dan semantik yang sama di API yang berbeda.
| Nama | Jenis | Deskripsi |
|---|---|---|
name |
string |
Kolom name harus berisi nama resource relatif. |
parent |
string |
Untuk definisi resource dan permintaan Daftar/Buat, kolom parent harus berisi nama resource relatif induk. |
create_time |
Timestamp |
Stempel waktu pembuatan entity. |
update_time |
Timestamp |
Stempel waktu update terakhir suatu entity. Catatan: update_time diperbarui saat operasi create/patch/delete dilakukan. |
delete_time |
Timestamp |
Stempel waktu penghapusan entity, hanya jika entitas mendukung retensi. |
expire_time |
Timestamp |
Stempel waktu habis masa berlaku suatu entitas jika masa berlakunya telah habis. |
start_time |
Timestamp |
Stempel waktu yang menandai awal dari beberapa jangka waktu. |
end_time |
Timestamp |
Stempel waktu yang menandai akhir dari beberapa jangka waktu atau operasi (terlepas dari keberhasilannya). |
read_time |
Timestamp |
Stempel waktu saat entity tertentu harus dibaca (jika digunakan dalam permintaan) atau dibaca (jika digunakan dalam respons). |
time_zone |
string |
Nama zona waktu. Nama tersebut harus berupa nama IANA TZ, seperti "America/Los_Angeles". Untuk informasi selengkapnya, lihat https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
region_code |
string |
Kode negara/wilayah (CLDR) Unicode untuk lokasi, seperti "US" dan "419". Untuk informasi selengkapnya, lihat http://www.unicode.org/reports/tr35/#unicode_region_subtag. |
language_code |
string |
Kode bahasa BCP-47, seperti "en-US" atau "sr-Latn". Untuk informasi selengkapnya, lihat http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. |
mime_type |
string |
Jenis MIME yang dipublikasikan IANA (juga disebut sebagai jenis media). Untuk informasi selengkapnya, lihat https://www.iana.org/assignments/media-types/media-types.xhtml. |
display_name |
string |
Nama tampilan entity. |
title |
string |
Nama resmi entitas, seperti nama perusahaan. Versi ini harus diperlakukan sebagai versi formal display_name. |
description |
string |
Satu atau beberapa paragraf deskripsi teks entitas. |
filter |
string |
Parameter filter standar untuk metode Daftar. Lihat AIP-160. |
query |
string |
Sama seperti filter jika diterapkan ke metode penelusuran (yaitu :search) |
page_token |
string |
Token penomoran halaman dalam permintaan Daftar. |
page_size |
int32 |
Ukuran penomoran halaman dalam permintaan Daftar. |
total_size |
int32 |
Jumlah total item dalam daftar, terlepas dari penomoran halaman. |
next_page_token |
string |
Token penomoran halaman berikutnya dalam respons List. Class ini harus digunakan sebagai page_token untuk permintaan berikut. Nilai kosong berarti tidak ada hasil lagi. |
order_by |
string |
Menentukan pengurutan hasil untuk permintaan Daftar. |
progress_percent |
int32 |
Menentukan progres tindakan dalam persentase (0-100). Nilai -1 berarti progres tidak diketahui. |
request_id |
string |
ID string unik yang digunakan untuk mendeteksi permintaan duplikat. |
resume_token |
string |
Token buram yang digunakan untuk melanjutkan permintaan streaming. |
labels |
map<string, string> |
Mewakili label resource Cloud. |
show_deleted |
bool |
Jika resource memungkinkan perilaku pembatalan penghapusan, metode Daftar yang sesuai harus memiliki kolom show_deleted agar klien dapat menemukan resource yang dihapus. |
update_mask |
FieldMask |
Ini digunakan untuk pesan permintaan Update guna melakukan update parsial pada resource. Mask ini relatif terhadap resource, bukan dengan pesan permintaan. |
validate_only |
bool |
Jika true (benar), ini menunjukkan bahwa permintaan yang diberikan hanya boleh divalidasi, bukan dieksekusi. |
Parameter Sistem
Selain kolom standar, Google API juga mendukung serangkaian parameter permintaan umum yang tersedia di semua metode API. Parameter ini dikenal sebagai parameter sistem. Untuk mengetahui informasi selengkapnya, lihat Parameter Sistem.