Respostas de erro

Quando uma solicitação de API é bem-sucedida, a API retorna um código de status 200 OK com os dados solicitados no corpo da resposta. Se ocorrer um erro, a API retornará um dos códigos de erro canônicos definidos pelas APIs do Google, mapeados para um código de status HTTP e um corpo de resposta contendo informações de erro. Ao encontrar um erro, inspecione os campos message e status no corpo da resposta JSON para detalhes específicos que ajudem na depuração.

Formato de erro

Se uma solicitação resultar em um erro, a API retornará um código de status HTTP apropriado e um corpo de resposta JSON. A resposta de erro contém um objeto error com a seguinte estrutura:

{
  "error": {
    "code": 403,
    "message": "User does not have sufficient permissions for this property.",
    "status": "PERMISSION_DENIED"
  }
}

O objeto error contém estes campos:

Campo	Descrição
código	O código de status HTTP, como 400, 401, 403, 429 ou 500.
message	uma breve descrição do erro.
status	O código de erro canônico, como INVALID_ARGUMENT, UNAUTHENTICATED, PERMISSION_DENIED, RESOURCE_EXHAUSTED ou INTERNAL.

Erros comuns

A tabela a seguir lista os erros comuns retornados pela API.

Código de status HTTP	Código canônico	Motivo	Descrição
400	INVALID_ARGUMENT	Solicitação inválida	A solicitação está formatada incorretamente. Isso pode ser causado por parâmetros ausentes ou inválidos, como um período incorreto ou um filtro malformado.
401	UNAUTHENTICATED	Credenciais inválidas	A solicitação não tem credenciais de autenticação válidas para o recurso de destino. Isso pode acontecer se o token de acesso do OAuth 2.0 estiver ausente, inválido ou expirado. Siga as instruções em Autenticação com o OAuth 2.0 para receber um token válido.
403	PERMISSION_DENIED	Permissões insuficientes	O usuário autenticado não tem acesso à propriedade do Google Analytics solicitada.
429	RESOURCE_EXHAUSTED	Cota excedida	A solicitação foi negada devido aos limites de cota da API. Consulte Limites e cotas da API Data para mais informações. Você pode estar excedendo os limites por projeto ou por propriedade.
500	INTERNAL	Erro interno do servidor	Ocorreu um erro inesperado no servidor. Esse geralmente é um problema temporário. Recomendamos tentar a solicitação novamente com a espera exponencial. Para evitar exceder as cotas de erro do servidor, é importante implementar a espera exponencial com limites de nova tentativa.
503	UNAVAILABLE	Serviço indisponível	O serviço está temporariamente indisponível. Esse geralmente é um problema temporário. Recomendamos tentar a solicitação novamente com a espera exponencial. Para evitar exceder as cotas de erro do servidor, é importante implementar a espera exponencial com limites de nova tentativa.