API Directory: limites et quotas

Les limites et les quotas protègent l'infrastructure Google d'un processus automatisé qui utilise l'API Directory de manière inappropriée. Un nombre excessif de requêtes provenant d'une API peut résulter d'une faute de frappe inoffensive ou d'un système mal conçu qui effectue des appels d'API inutiles. Quelle qu'en soit la cause, le blocage du trafic provenant d'une source spécifique une fois qu'il atteint un certain niveau est nécessaire pour assurer l'état général du système Google Workspace. Il garantit que les actions d'un développeur ne peuvent pas avoir d'impact négatif sur la communauté au sens large.

Dans le cas peu probable où votre requête API échouerait, l'API renverra un code d'état HTTP ainsi que la raison de l'erreur. De plus, le corps de la réponse contient une description détaillée de la cause de l'erreur.

La liste suivante présente les codes d'erreur possibles, les motifs de refus, les descriptions correspondantes et les actions recommandées pour les erreurs causées par le dépassement des limites de quota.

Coder Motif Description Action recommandée
403 userRateLimitExceeded Indique que la limite autorisée par utilisateur a été dépassée. La valeur par défaut définie dans la console Google Cloud est de 2 400 requêtes par minute,par utilisateur et par projet Google Cloud. Augmentez les limites par utilisateur sur la page Quotas d'API du SDK Admin de votre projet Google Cloud ou ralentissez la fréquence à laquelle vous envoyez les requêtes en utilisant un intervalle exponentiel entre les tentatives.
403 quotaExceeded Indique que la limite de requêtes simultanées pour une opération donnée a été atteinte. Réessayez avec un intervalle exponentiel entre les tentatives. Vous devez ralentir la fréquence à laquelle vous envoyez les requêtes.
429 rateLimitExceeded Indique que la limite de requêtes simultanées pour une opération donnée a été atteinte. Réessayez avec un intervalle exponentiel entre les tentatives. Vous devez ralentir la fréquence à laquelle vous envoyez les requêtes. Cette limite s'applique par compte Google Workspace, et non par client API ni par utilisateur. Cette limite ne peut pas être augmentée.

Mettre en œuvre l'intervalle exponentiel entre les tentatives

L'intervalle exponentiel entre les tentatives est le processus par lequel un client relance régulièrement une requête ayant échoué sur une durée croissante. Il s'agit d'une stratégie standard de gestion des exceptions pour les applications réseau. La mise en œuvre de l'intervalle exponentiel entre les tentatives augmente l'efficacité de l'utilisation de la bande passante, réduit le nombre de requêtes nécessaires pour obtenir une réponse positive et optimise le débit des requêtes dans les environnements simultanés.

La procédure d'implémentation d'un intervalle exponentiel simple entre les tentatives est la suivante.

  1. Envoyer une requête à l'API
  2. Vous recevez une réponse d'erreur avec un code d'erreur pouvant faire l'objet d'une nouvelle tentative.
  3. Patientez 1 s + random_number_milliseconds secondes
  4. Réessayer la requête
  5. Vous recevez une réponse d'erreur avec un code d'erreur pouvant faire l'objet d'une nouvelle tentative.
  6. Patientez 2 + random_number_milliseconds secondes
  7. Réessayer la requête
  8. Vous recevez une réponse d'erreur avec un code d'erreur pouvant faire l'objet d'une nouvelle tentative.
  9. Patientez 4 + random_number_milliseconds secondes
  10. Réessayer la requête
  11. Vous recevez une réponse d'erreur avec un code d'erreur pouvant faire l'objet d'une nouvelle tentative.
  12. Patientez 8 s + random_number_milliseconds secondes
  13. Réessayer la requête
  14. Vous recevez une réponse d'erreur avec un code d'erreur pouvant faire l'objet d'une nouvelle tentative.
  15. Patientez 16 s + random_number_milliseconds secondes
  16. Réessayer la requête
  17. Si l'erreur persiste, arrêtez-la et consignez-la.

Dans le flux ci-dessus, random_number_milliseconds est un nombre aléatoire de millisecondes inférieur ou égal à 1 000. Cela est nécessaire pour éviter certaines erreurs de verrouillage dans certaines implémentations simultanées. random_number_milliseconds doit être redéfini après chaque temps d'attente.

Remarque: L'attente correspond toujours à (2 ^ n) + random_number_milliseconds, où n est un entier augmentant de manière monotone défini initialement sur 0. n est incrémenté de 1 pour chaque itération (chaque requête).

L'algorithme est configuré pour se terminer lorsque "n" vaut 5. Ce plafond a pour seul but d'empêcher les clients d'effectuer des tentatives indéfiniment. Il entraîne un délai total d'environ 32 secondes avant qu'une requête ne soit considérée comme une "erreur irrécupérable". Votre client API peut implémenter un nombre plus élevé de tentatives si nécessaire.

Limites et quotas d'API

Catégories de limites de l'API Limites
Créer des utilisateurs Vous ne pouvez pas créer plus de 10 utilisateurs par domaine et par seconde avec l'API Directory.
Groupe ajouté en tant que membre d'un autre groupe Il peut s'écouler jusqu'à 10 minutes avant que les membres du sous-groupe apparaissent en tant que membres du groupe parent. Cette limite peut changer en fonction de la capacité du système.
Appareils mobiles

Avec l'API Directory, vous pouvez effectuer jusqu'à:

  • 20 requêtes d'action par seconde.
  • 20 requêtes de suppression par seconde
  • 10 requêtes GET par seconde.
  • 10 requêtes de liste par seconde.
Modification du nom des utilisateurs La propagation à tous les services peut prendre jusqu'à 10 minutes. Avant de renommer un utilisateur, il est recommandé de le déconnecter de toutes les sessions du navigateur et de tous les services. Pour en savoir plus, consultez Mettre à jour les utilisateurs.
Créer/Mettre à jour des unités organisationnelles
  • Vous ne pouvez pas créer ou modifier plus d'une unité organisationnelle par client et par seconde avec l'API Directory.
  • La hiérarchie des unités organisationnelles du client est limitée à 35 niveaux de profondeur.
  • Le nombre total d'unités organisationnelles par client ne doit pas dépasser 40 000.
Catégories de quota de l'API Quotas
Appareils Chrome annotatedLocation, nombre maximal de caractères Les informations de localisation d'un appareil peuvent comporter jusqu'à 200 caractères.
Appareils Chrome notes, nombre maximal de caractères Les informations de notes d'un appareil peuvent comporter jusqu'à 500 caractères.
Appareils Google Chrome, user caractères maximum Le nom d'un utilisateur d'un appareil peut comporter jusqu'à 100 caractères.
Alias de domaine, maximum Le nombre maximal d'alias de domaine est de 20.
Groupes, description Une description peut comporter jusqu'à 4 096 caractères.
Groupes par compte Avec un compte G Suite de l'ancienne édition sans frais de G Suite, le nombre de groupes est limité à 10. Le nombre de groupes n'est pas limité dans les autres éditions.
Groupes, membres par groupe Avec un compte G Suite de l'ancienne édition sans frais de G Suite, un groupe peut contenir jusqu'à 100 membres. Dans les autres éditions, le nombre de membres par groupe n'est pas limité. Pour connaître les limites d'appartenance aux groupes par utilisateur, consultez Comprendre les règles et les limites relatives aux groupes.
Chaîne de requête maxResults L'API affiche les éléments suivants :
  • Appareils Chrome et mobiles : 100 entrées par page par défaut et au maximum.
  • Groupes et membres de groupes : 200 entrées par défaut et au maximum par page.
  • Utilisateurs : 100 entrées par défaut et un maximum de 500 entrées par page.
Les alias d'utilisateur et les ressources d'unité organisationnelle n'utilisent pas la pagination des réponses. Toutes les adresses e-mail principales des utilisateurs sont renvoyées dans l'ordre alphabétique, et l'ordre des réponses n'est pas sensible à la casse.
Plusieurs domaines, nombre maximal de domaines autorisé par compte 600 (1 domaine principal + 599 domaines supplémentaires)
Unité organisationnelle, nombre maximal d'utilisateurs déplacés simultanément Vous pouvez déplacer jusqu'à 20 comptes utilisateur à la fois. Les adresses e-mail principales de l'utilisateur doivent déjà exister dans le compte.
Alias utilisateur Le nombre total d'alias autorisés pour chaque compte d'utilisateur est de 30.
Alias d'utilisateur, utilisant un alias supprimé Un alias d'utilisateur supprimé peut être réutilisé immédiatement.

Autres types de limites Limites et consignes
Facturation et création d'utilisateurs Pour les utilisateurs disposant d'un forfait modulable Google Workspace, la création d'utilisateurs à l'aide de cette API aura un impact financier et entraînera des frais sur le compte de facturation de votre client. Par exemple, si vous disposez d'un forfait modulable pour Google Workspace et que vous créez 10 utilisateurs, les frais pour 10 licences Google Workspace seront ajoutés à votre compte, au prorata à compter de la date de création. Si vous disposez d'un forfait annuel, vous vous êtes déjà engagé à payer un certain nombre de licences à l'avance, et vous ne pouvez créer que le nombre d'utilisateurs correspondant à votre engagement. Pour plus d'informations sur les forfaits et votre compte de facturation, consultez le Centre d'aide pour l'administration.
Prénoms et noms Les prénoms et les noms sont limités à 40 caractères. Ils sont compatibles avec les caractères Unicode/UTF-8 et peuvent contenir des espaces, des lettres (a-z), des chiffres (0-9), des tirets (-), des barres obliques (/) et des points (.). Pour plus d'informations sur les règles d'utilisation des caractères, consultez le Centre d'aide pour l'administration.
Groupes, suppression La suppression d'un groupe n'entraîne pas la suppression des comptes utilisateur des membres du groupe.
Groupes et membres de groupes, changement d'adresse e-mail Dans cette version de l'API, l'adresse e-mail d'un groupe peut être modifiée avant l'activation du service Google Workspace. Utilisez la console d'administration pour modifier l'adresse e-mail d'un membre du groupe. Une fois la modification effectuée, l'API prend automatiquement en compte les changements apportés à l'adresse e-mail.
Groupes, paramètres Vous pouvez gérer les paramètres d'accès, les options de partage, la surveillance et l'archivage des discussions dans la console d'administration. Pour plus d'informations sur les paramètres des groupes, consultez le Centre d'aide pour les administrateurs.
Groupes, envoi de messages Pour dissuader le spam et l'utilisation abusive des messageries, Google limite le nombre de destinataires externes. Lorsque vous envoyez un message à un groupe, chaque membre externe est comptabilisé comme un destinataire. Pour en savoir plus, consultez Limites d'envoi d'e-mails et Empêcher le blocage ou le placement dans le dossier "Spam" des messages envoyés aux utilisateurs Gmail .
Groupes, envoi de rapports de non-distribution Vous ne pouvez pas envoyer ni transférer de rapport d'échec de distribution (ou "retour à l'expéditeur") à un groupe.
Groupes créés par des utilisateurs, limites Pour connaître les limites applicables aux groupes créés par les utilisateurs, consultez le Centre d'aide pour les administrateurs.
Unité organisationnelle, activer/désactiver des services La console d'administration vous permet de gérer l'activation et la désactivation des services pour une unité organisationnelle.
Mots de passe Peut contenir n'importe quelle combinaison de caractères. Il doit comporter au moins huit caractères. La longueur ne doit pas dépasser 100 caractères.
Photos Dans cette version de l'API, la photo correspond à la dernière photo du profil Google de l'utilisateur.
Noms d'utilisateur Les noms d'utilisateur peuvent contenir des lettres (a-z), des chiffres (0-9), des tirets (-) et des traits de soulignement (_). Google Workspace reconnaît les points ou les points (.). Ce n'est pas la même chose que Gmail. Un nom d'utilisateur ne doit pas contenir de signe égal (=), de crochets (<,>) ni plusieurs points (.) à la suite. Pour en savoir plus, consultez le Centre d'aide pour les administrateurs.
Noms d'utilisateur, changement de nom Google Hangouts supprime toutes les invitations au chat mémorisées après le changement de nom. L'utilisateur doit demander l'autorisation de discuter à nouveau avec ses amis. L'ancien nom d'utilisateur est conservé en tant qu'alias d'adresse e-mail afin d'assurer la distribution continue des messages dans le cas des paramètres de transfert d'e-mails. Il ne sera pas disponible en tant que nouveau nom d'utilisateur. Pour en savoir plus sur l'impact du changement d'un nom d'utilisateur, consultez le Centre d'aide pour les administrateurs. L'opération Supprimer l'alias d'un utilisateur vous permet de supprimer l'alias d'adresse e-mail après le changement de nom.
Utilisateurs de plusieurs domaines Un compte Google Workspace peut inclure n'importe lequel de vos domaines. Dans un compte comportant plusieurs domaines, les utilisateurs d'un domaine peuvent partager des services avec les utilisateurs d'autres domaines de compte. Les composants de plusieurs domaines sont les suivants :
  • Domaine principal : le domaine principal de votre compte est celui de l'administrateur qui a accepté les conditions d'utilisation de Google Workspace. Ce domaine est défini au niveau du compte dans l'unité organisationnelle racine. Lorsque vous créez un compte Google Workspace, nous vous recommandons d'utiliser le domaine principal de votre entreprise et de réserver vos autres domaines à des fins spécialisées telles que les pilotes et les tests.
    • Tous les super-administrateurs peuvent gérer l'intégralité du compte.
    • L'API ne peut pas modifier ni déplacer le domaine principal du compte Google Workspace. Cependant, l'API peut renommer le compte d'un utilisateur, en changeant son adresse e-mail d'un domaine à un autre.
    • Pour les comptes Google Workspace, vous disposez de 21 jours pour valider la propriété du domaine principal. Pour les domaines supplémentaires, vous devez valider la propriété de votre domaine avant de l'utiliser comme adresse e-mail principale d'un utilisateur. Dans ce cas, le délai de grâce de 21 jours ne s'applique pas.
    • Dans cette version de l'API, les paramètres du domaine principal s'appliquent à tous les domaines associés au compte, à l'exception de l'accès utilisateur aux services Google Workspace.
  • Domaines de compte supplémentaires : une fois que vous avez défini votre domaine principal et configuré votre compte, vous pouvez ajouter vos domaines supplémentaires au compte. Pour les domaines supplémentaires, validez votre propriété lors de la configuration de ce domaine et avant de l'utiliser comme adresse e-mail principale.
  • Domaine d'accueil de l'utilisateur : le domaine utilisé dans son adresse e-mail principale est son domaine d'origine. Il peut s'agir de n'importe quel domaine du compte, y compris le domaine principal.
Pour connaître les dernières limites liées aux domaines multiples, consultez Limites applicables aux domaines multiples. y compris des informations sur les alias de domaine, la fusion de comptes, etc.
Avertissements concernant les membres du groupe GROUP_CANNOT_CONTAIN_CYCLE – L'API n'autorise pas un cycle dans les adhésions à des groupes. Par exemple, si groupe1 est membre de groupe2, groupe2 ne peut pas être membre de groupe1.