Directory API: Batas dan Kuota

Batas dan kuota melindungi infrastruktur Google dari proses otomatis yang menggunakan Directory API dengan cara yang tidak pantas. Permintaan yang berlebihan dari API mungkin disebabkan oleh kesalahan ketik yang tidak berbahaya, atau mungkin disebabkan oleh sistem yang dirancang secara tidak efisien yang membuat panggilan API yang tidak perlu. Apa pun penyebabnya, memblokir traffic dari sumber tertentu setelah mencapai tingkat tertentu diperlukan untuk kesehatan sistem Google Workspace secara keseluruhan. Hal ini memastikan bahwa tindakan satu developer tidak dapat berdampak negatif terhadap komunitas yang lebih besar.

Jika permintaan API Anda gagal, API akan menampilkan kode status HTTP dan alasan error. Selain itu, isi respons berisi deskripsi mendetail tentang penyebab error.

Daftar berikut menunjukkan kemungkinan kode error, alasan, deskripsi yang sesuai, dan tindakan yang direkomendasikan untuk error yang disebabkan oleh batas kuota.

Kode Alasan Deskripsi Tindakan yang Disarankan
403 userRateLimitExceeded Menunjukkan bahwa batas kapasitas pengguna telah terlampaui. Nilai default yang ditetapkan di konsol Google Cloud adalah 2.400 kueri per menit per pengguna per project Google Cloud. Tingkatkan batas per pengguna dari halaman Kuota Admin SDK API project Google Cloud Anda, atau perlambat kecepatan pengiriman permintaan menggunakan backoff eksponensial.
403 quotaExceeded Menunjukkan bahwa batas permintaan serentak untuk operasi tertentu telah tercapai. Coba lagi menggunakan backoff eksponensial. Anda perlu memperlambat kecepatan pengiriman permintaan.
429 rateLimitExceeded Menunjukkan bahwa batas permintaan serentak untuk operasi tertentu telah tercapai. Coba lagi menggunakan backoff eksponensial. Anda harus memperlambat kecepatan pengiriman permintaan. Batasan ini berlaku per akun Google Workspace, bukan per klien API atau per pengguna. Batas ini tidak dapat ditingkatkan.

Mengimplementasikan Backoff Eksponensial

Backoff eksponensial adalah proses klien yang secara berkala mencoba kembali permintaan yang gagal dengan menambah lamanya penundaan antara setiap permintaan yang gagal. Ini adalah strategi penanganan error standar untuk aplikasi jaringan. Penggunaan backoff eksponensial akan meningkatkan efisiensi penggunaan bandwidth, mengurangi jumlah permintaan yang diperlukan untuk mendapatkan respons yang berhasil, dan memaksimalkan throughput permintaan dalam lingkungan serentak.

Alur untuk mengimplementasikan backoff eksponensial sederhana adalah sebagai berikut.

  1. Membuat permintaan ke API
  2. Menerima respons error yang memiliki kode error yang dapat dicoba ulang
  3. Tunggu 1 detik + random_number_milliseconds detik
  4. Mencoba kembali permintaan
  5. Menerima respons error yang memiliki kode error yang dapat dicoba ulang
  6. Tunggu 2 detik + random_number_milliseconds detik
  7. Mencoba kembali permintaan
  8. Menerima respons error yang memiliki kode error yang dapat dicoba ulang
  9. Tunggu 4 detik + random_number_milliseconds detik
  10. Mencoba kembali permintaan
  11. Menerima respons error yang memiliki kode error yang dapat dicoba ulang
  12. Tunggu 8 detik + random_number_milliseconds detik
  13. Mencoba kembali permintaan
  14. Menerima respons error yang memiliki kode error yang dapat dicoba ulang
  15. Tunggu 16 detik + random_number_milliseconds detik
  16. Mencoba kembali permintaan
  17. Jika Anda masih mendapatkan error, hentikan dan catat error tersebut.

Pada alur di atas, random_number_milliseconds adalah angka acak milidetik yang kurang dari atau sama dengan 1.000. Hal ini diperlukan untuk menghindari error kunci tertentu dalam beberapa implementasi serentak. random_number_milliseconds harus ditentukan ulang setelah setiap periode tunggu.

Catatan: periode tunggu selalu (2 ^ n) + random_number_milliseconds, dengan n adalah bilangan bulat yang meningkat secara monotonik, yang awalnya ditetapkan sebagai 0. n bertambah 1 untuk setiap iterasi (setiap permintaan).

Algoritma disetel untuk dihentikan jika n adalah 5. Batas ini hanya diterapkan untuk menghentikan klien agar tidak terus mencoba tanpa batas, dan mengakibatkan penundaan total sekitar 32 detik sebelum permintaan dianggap "error yang tidak dapat dipulihkan". Klien API Anda dapat menerapkan jumlah percobaan yang lebih tinggi jika diperlukan.

Batas dan Kuota API

Kategori Batas API Batas
Membuat pengguna Anda tidak dapat membuat lebih dari 10 pengguna per domain per detik menggunakan Directory API.
Grup ditambahkan sebagai anggota ke grup lain Mungkin ada penundaan hingga 10 menit sebelum anggota grup turunan muncul sebagai anggota grup induk. Batas ini dapat berubah bergantung pada kapasitas sistem.
Perangkat seluler

Dengan menggunakan Directory API, Anda dapat melakukan hingga:

  • 20 permintaan tindakan per detik.
  • 20 permintaan hapus per detik.
  • 10 permintaan get per detik.
  • 10 permintaan daftar per detik.
Mengganti nama pengguna Diperlukan waktu hingga 10 menit untuk diterapkan di semua layanan. Sebelum mengganti nama pengguna, sebaiknya logout pengguna dari semua sesi dan layanan browser. Untuk mengetahui detail selengkapnya, lihat Memperbarui pengguna.
Membuat/memperbarui Unit Organisasi
  • Anda tidak dapat membuat/memperbarui lebih dari 1 unit organisasi per pelanggan per detik menggunakan Directory API.
  • Hierarki unit organisasi pelanggan dibatasi hingga 35 tingkat kedalaman.
  • Jumlah total unit organisasi per pelanggan tidak boleh melebihi 40.000.
Kategori Kuota API Kuota
Perangkat Chrome annotatedLocation, karakter maksimum Jumlah karakter maksimum untuk informasi lokasi perangkat adalah 200.
Perangkat Chrome notes, karakter maksimum Jumlah maksimum karakter untuk informasi catatan perangkat adalah 500.
Perangkat Chrome, maksimal user karakter Jumlah maksimum karakter untuk nama pengguna perangkat adalah 100.
Alias domain, maksimum Jumlah maksimum alias domain adalah 20.
Grup, deskripsi Jumlah karakter maksimum dalam deskripsi adalah 4.096.
Grup, per akun Dengan akun G Suite Edisi Gratis Versi Lama, jumlah grup dibatasi hingga 10. Edisi lain tidak memiliki batas jumlah grup.
Grup, anggota per grup Dengan akun G Suite Edisi Gratis yang Lama, grup dapat berisi maksimal 100 anggota. Edisi lain tidak memiliki batasan jumlah anggota yang dapat dimiliki grup. Untuk mengetahui batas keanggotaan grup per pengguna, lihat Memahami kebijakan dan batas Grup
String kueri maxResults API menampilkan:
  • Chrome dan perangkat seluler – Default dan maksimum 100 entri per halaman.
  • Grup dan anggota grup – Default dan maksimum 200 entri per halaman.
  • Pengguna – Default 100 entri dan maksimum 500 entri per halaman.
Resource alias pengguna dan unit organisasi tidak menggunakan penomoran halaman respons. Semua email utama pengguna ditampilkan dalam urutan abjad dan urutan respons tidak peka huruf besar/kecil.
Beberapa domain, jumlah maksimum domain yang diizinkan di akun 600 (1 domain utama + 599 domain tambahan)
Unit Organisasi, jumlah maksimum pengguna yang dipindahkan sekaligus 20 pengguna dapat dipindahkan sekaligus. Selain itu, alamat email utama pengguna harus sudah ada di akun.
Alias pengguna Jumlah total alias yang diizinkan untuk setiap akun pengguna adalah 30.
Alias pengguna, menggunakan alias yang dihapus Alias pengguna yang dihapus dapat segera digunakan kembali.

Jenis Batas Lainnya Batasan dan Panduan
Penagihan dan pembuatan pengguna Untuk pengguna yang menggunakan paket fleksibel untuk Google Workspace, membuat pengguna menggunakan API ini akan berdampak finansial, dan akan menimbulkan tagihan ke akun penagihan pelanggan Anda. Misalnya, jika Anda menggunakan paket fleksibel untuk Google Workspace, membuat 10 pengguna akan mengakibatkan tagihan untuk 10 lisensi Google Workspace yang diposting ke akun Anda, yang dihitung prorata sejak pembuatan selesai. Jika menggunakan paket tahunan, Anda telah berkomitmen untuk membayar sejumlah lisensi di awal, dan Anda hanya dapat membuat pengguna sebanyak komitmen Anda. Untuk informasi selengkapnya tentang paket penagihan dan akun penagihan Anda, lihat pusat bantuan administrasi.
Nama Depan dan Belakang Nama depan dan belakang memiliki maksimum 40 karakter. Nama sebutan channel mendukung karakter Unicode/UTF-8, dan dapat berisi spasi, huruf (a-z), angka (0-9), tanda hubung (-), garis miring (/), dan titik (.). Untuk informasi selengkapnya tentang aturan penggunaan karakter, lihat pusat bantuan administrasi.
Grup, penghapusan Menghapus grup tidak akan menghapus akun pengguna anggota grup.
Grup dan anggota grup, perubahan alamat email Dalam versi API ini, alamat email grup dapat diubah sebelum layanan Google Workspace diaktifkan. Gunakan konsol Admin untuk mengubah alamat email anggota grup. Setelah diubah, API akan otomatis mencerminkan perubahan alamat email.
Grup, setelan Setelan akses grup, opsi berbagi, pemantauan, dan arsip diskusi dikelola menggunakan konsol Admin. Untuk informasi selengkapnya tentang setelan grup, lihat pusat bantuan administrasi.
Grup, mengirim pesan Untuk mencegah spam dan penyalahgunaan email, Google membatasi jumlah pesan yang dapat Anda kirim sekaligus kepada penerima eksternal. Jika Anda mengirim pesan ke grup, setiap anggota eksternal dihitung sebagai satu penerima. Untuk mengetahui informasi selengkapnya, lihat Batas pengiriman email dan Mencegah email ke pengguna Gmail diblokir atau dikirim ke spam .
Grup, mengirim pesan NDR Anda tidak dapat mengirim atau meneruskan laporan tidak terkirim (NDR), juga disebut "pesan email tidak terkirim", ke grup.
Grup yang dibuat pengguna, batasan Untuk mengetahui batas grup yang dibuat pengguna, lihat pusat bantuan administrasi
Unit Organisasi, mengaktifkan/menonaktifkan layanan Gunakan konsol Admin untuk mengelola pengaktifan dan penonaktifan layanan untuk unit organisasi.
Sandi Dapat berisi kombinasi karakter apa pun. Diperlukan minimal 8 karakter. Panjang maksimumnya adalah 100 karakter.
Foto Dalam versi API ini, foto adalah foto profil Google terbaru pengguna.
Nama pengguna Nama pengguna dapat berisi huruf (a-z), angka (0-9), tanda hubung (-), garis bawah (_), dan Google Workspace mengenali titik atau titik (.). Hal ini tidak sama dengan Gmail. Nama pengguna tidak boleh berisi tanda sama dengan (=), tanda kurung (<,>), atau lebih dari satu titik (.) secara berturut-turut. Untuk informasi selengkapnya, lihat pusat bantuan administrasi.
Nama pengguna, penggantian nama Google Hangouts akan menghapus semua undangan chat yang diingat setelah nama diubah. Pengguna harus meminta izin untuk melakukan chat dengan teman lagi. Nama pengguna lama akan dipertahankan sebagai alias email untuk memastikan pengiriman email bisa terus berlanjut jika ada setelan penerusan email dan tidak akan tersedia sebagai nama pengguna baru. Untuk mengetahui detail penting tentang dampak penggantian nama pengguna, lihat pusat bantuan administrasi. Gunakan operasi Menghapus alias pengguna untuk menghapus alias email setelah mengganti namanya.
Pengguna di beberapa domain Akun Google Workspace dapat menyertakan domain Anda. Di akun beberapa domain, pengguna di satu domain dapat berbagi layanan dengan pengguna di domain akun lain. Komponen beberapa domain adalah:
  • Domain utama -- Domain utama akun Anda adalah domain administrator yang menyetujui perjanjian Persyaratan Layanan Google Workspace. Domain ini berada di tingkat akun dalam unit organisasi tingkat teratas. Saat mendaftar ke akun Google Workspace, sebaiknya gunakan domain bisnis Anda untuk domain utama, dan siapkan domain lain untuk penggunaan khusus seperti uji coba dan pengujian.
    • Semua administrator super dapat mengelola akun lengkap.
    • API ini tidak dapat mengubah atau memindahkan domain primer akun Google Workspace. Namun, API dapat mengganti nama akun pengguna, mengubah alamat emailnya dari satu domain ke domain lain.
    • Untuk akun Google Workspace, Anda memiliki waktu 21 hari untuk memverifikasi kepemilikan domain utama. Untuk domain tambahan, Anda harus memverifikasi kepemilikan domain sebelum menggunakan domain untuk alamat email utama pengguna. Dalam hal ini, masa tenggang 21 hari tidak berlaku.
    • Dalam versi API ini, setelan domain primer berlaku untuk semua domain yang terkait dengan akun, kecuali untuk akses pengguna ke layanan Google Workspace.
  • Domain akun tambahan -- Setelah menetapkan domain primer dan menyiapkan akun, Anda dapat menambahkan domain tambahan ke akun. Untuk domain tambahan, verifikasi kepemilikan Anda saat menyiapkan domain ini dan sebelum menggunakan domain untuk alamat email utama pengguna.
  • Domain rumah pengguna -- Domain yang digunakan di alamat email utama pengguna adalah domain rumah pengguna. Domain ini dapat berupa domain apa pun di akun, termasuk domain primer.
Untuk mengetahui batasan beberapa domain terbaru, lihat batasan beberapa domain. Informasi ini mencakup informasi untuk alias domain, penggabungan akun, dll.
Peringatan, anggota grup GROUP_CANNOT_CONTAIN_CYCLE – API tidak mengizinkan siklus dalam keanggotaan grup. Misalnya, jika group1 adalah anggota group2, group2 tidak boleh menjadi anggota group1.