Limites e cotas

Os limites e as cotas protegem a infraestrutura do Google de processos automatizados que usam a API Reports de maneira inadequada. O excesso de solicitações de uma API pode ser causado por um erro de digitação inofensivo ou por um sistema projetado de forma ineficiente que faz chamadas desnecessárias para a API. Seja qual for a causa, bloquear o tráfego de uma fonte específica assim que ele atinge um limite é necessário para garantir a integridade geral do sistema do Google Workspace. Elas garantem que as ações de um desenvolvedor não afetem negativamente a comunidade de modo mais amplo.

No caso improvável de falha da sua solicitação de API, você vai receber uma resposta com um código de status HTTP. Um código de status 403 tem informações de erro sobre entrada incorreta, e um código de status HTTP 503 tem informações de erro indicando quais cotas de API foram excedidas. Essas respostas permitem que seu aplicativo personalizado detecte esses erros e tome as medidas adequadas.

Se as solicitações precisarem ser concluídas em um período fixo, envie-as em paralelo ou use várias linhas de execução no aplicativo Java ou C#. Um exemplo de solicitações paralelas é pedir pequenos lotes de e-mails de diferentes usuários em vez de adicionar ou remover muitos e-mails de um usuário simultaneamente. No caso de conversas, tente começar com 10, uma por e-mail do usuário. A recomendação de encadeamento tem compensações e não é útil para todas as situações de API. Se o número de solicitações ficar muito alto, ocorrerão erros de cota.

Para todos os erros baseados em tempo (máximo de N itens por N segundos por linha de execução), especialmente os erros de código de status 503, recomendamos que seu código capture a exceção e, usando um algoritmo de espera exponencial, aguarde um pequeno atraso antes de tentar novamente a chamada com falha. Um exemplo da API Reports para uma linha de execução é esperar 5 segundos e tentar novamente a chamada com falha. Se a solicitação for bem-sucedida, repita esse padrão para as outras linhas de execução. Se a segunda solicitação não for bem-sucedida, o aplicativo vai reduzir a frequência até que uma chamada seja bem-sucedida. Por exemplo, aumente o atraso inicial de 5 segundos para 10 segundos e tente fazer a chamada novamente. Além disso, decida um limite de novas tentativas. Por exemplo, tente fazer uma solicitação de 5 a 7 vezes com tempos de espera diferentes antes que o aplicativo retorne um erro ao usuário.

Limites

Categorias de limites de API Limites
Informar taxas de QPS e QPD A API limita o número de solicitações do seu projeto do Google Cloud. O valor padrão definido no console do Google Cloud é de 2.400 consultas por minuto por usuário e por projeto do Google Cloud. É possível aumentar esse limite na página de cotas da API Admin SDK do seu projeto do Google Cloud.

Se esses limites forem excedidos, o servidor vai retornar um código de status HTTP 503. Use o algoritmo de espera exponencial ao repetir as solicitações.

Outros limites para activities.list A API activities.list tem um limite adicional de 250 consultas de filtro por minuto (15.000 consultas de filtro por hora). Uma consulta de filtro é uma solicitação de API que contém pelo menos um dos seguintes parâmetros de consulta:
  • userKey
  • actorIpAddress
  • eventName
  • filters
  • orgUnitID
  • groupIdFilter
Categorias de cota da API Cotas
maxResults O número de registros listados em cada página da resposta de uma API é de 0 a 1.000. O padrão é 1.000 registros.

Outros tipos de limites

Outros tipos de limites Limitações e diretrizes
Formato de dados, padrão O formato de dados padrão é JSON. A API também é compatível com o formato Atom.
Solicitações não autorizadas O Google não permite solicitações não autorizadas à API. Uma solicitação é considerada não autorizada se nenhum token de autorização for fornecido. Para mais informações, consulte Autorizar solicitações.
Mensagens de aviso
  • Dados não disponíveis: os dados deste aplicativo e desta data não estão disponíveis e não estarão disponíveis no futuro.
  • Dados parciais disponíveis: os dados desse aplicativo e dessa data podem estar disponíveis no futuro.
Para a sintaxe de aviso da API Reports, consulte a referência da API para clientes e usuários.

Práticas recomendadas para "activities.list"

O método activities.list deve ser usado para investigações de auditoria. Para ter o melhor desempenho, seu pedido precisa incluir um período usando os parâmetros startTime e endTime. Intervalos de tempo menores resultam em tempos de resposta significativamente mais rápidos. Esse método não foi criado para recuperação de alto volume de registros de auditoria. Se você estiver esgotando regularmente sua cota de solicitações de filtro "activities.list", considere as seguintes opções:

  • Configure a exportação de registros do Google Workspace para o BigQuery e use as APIs de consulta avançadas do BigQuery para recuperar e analisar os dados necessários sem restrições de cota de API.
  • Use solicitações sem filtro com período e faça a filtragem do lado do cliente (ou seja, a lógica de filtragem no seu aplicativo), em vez de usar solicitações de filtro. Isso permite que você ultrapasse o limite de 250 consultas de filtro por minuto,mas ainda está sujeito ao limite de 2.400 consultas por minuto por usuário por projeto do Google Cloud.