Respuestas de error

Respuestas de error estándar

Si una solicitud de la API de informes se realiza correctamente, la API devuelve el código de estado 200. Si se produce un error en una solicitud, la API devuelve un código de estado HTTP y un motivo en la respuesta según el tipo de error. Además, el cuerpo de la respuesta contiene una descripción detallada de lo que ha provocado el error. A continuación se presenta un ejemplo de una respuesta de error:

{
 "error": {
  "code": 403,
  "message": "User does not have sufficient permissions for this profile.",
  "status": "PERMISSION_DENIED",
  "details": [
   {
    "@type": "type.googleapis.com/google.rpc.DebugInfo",
    "detail": "[ORIGINAL ERROR] generic::permission_denied: User does not have sufficient permissions for this profile. [google.rpc.error_details_ext] { message: \"User does not have sufficient permissions for this profile.\" }"
   }
  ]
 }
}

Tabla de errores

Código Estado Descripción Acción recomendada
400 INVALID_ARGUMENT La solicitud no es válida. Es posible que falte un argumento obligatorio, se hayan superado los límites de cuota o uno de los valores no sea válido. Para obtener información detallada, lee el mensaje de error. Si el cliente vuelve a realizar la acción, se producirá el error de nuevo.
401 UNAUTHENTICATED El cliente no se ha autenticado correctamente. No vuelvas a intentar la acción sin antes corregir el problema. Debes obtener un nuevo token de autenticación.
403 PERMISSION_DENIED Indica la solicitud de datos a los que el usuario no tiene acceso. No vuelvas a intentar la acción sin antes corregir el problema. Debes obtener permisos suficientes para realizar la operación en la entidad especificada.
429 RESOURCE_EXHAUSTED AnalyticsDefaultGroupCLIENT_PROJECT-1d Indica que se ha agotado la cuota de solicitudes diarias por proyecto. No vuelvas a intentar la acción sin antes corregir el problema. Has agotado tu cuota diaria.
429 RESOURCE_EXHAUSTED AnalyticsDefaultGroupCLIENT_PROJECT-100s Indica que se ha agotado la cuota de solicitudes por cada 100 segundos por proyecto. Vuelve a intentarlo con un retardo exponencial. Debes reducir la frecuencia con la que envías las solicitudes.
429 RESOURCE_EXHAUSTED AnalyticsDefaultGroupUSER-100s Indica que se ha agotado la cuota de solicitudes por cada 100 segundos por usuario y proyecto. Vuelve a intentarlo con un retardo exponencial. Debes reducir la frecuencia con la que envías las solicitudes.
429 RESOURCE_EXHAUSTED DiscoveryGroupCLIENT_PROJECT-100s Indica que se ha agotado la cuota de solicitudes de detección por cada 100 segundos. La respuesta de detección no cambia muy a menudo; guarda localmente la respuesta de detección en la caché o intenta utilizar un retardo exponencial de nuevo. Debes reducir la frecuencia con la que envías las solicitudes.
500 INTERNAL Se ha producido un error interno inesperado del servidor. No reintentes esta consulta más de una vez.
503 BACKEND_ERROR El servidor ha devuelto un error. No reintentes esta consulta más de una vez.
503 UNAVAILABLE El servicio no ha podido procesar la solicitud. Suele ser una situación transitoria que puede corregirse si se vuelve a aplicar un retardo exponencial.

Implementar un retardo exponencial

El retardo exponencial es el proceso de un cliente que reintenta periódicamente una solicitud con error durante un periodo que se va incrementando. Se trata de una estrategia de gestión de errores estándar para las aplicaciones de red. La API de informes se ha diseñado con la expectativa de que los clientes que deciden reintentar las solicitudes con error lo hagan con un retardo exponencial. Además de ser "obligatorio", el uso del retardo exponencial aumenta la eficiencia del uso del ancho de banda, reduce el número de solicitudes necesarias para obtener una respuesta correcta y maximiza el rendimiento de las solicitudes en entornos simultáneos.

A continuación se indica el flujo para implementar el retardo exponencial simple.

  1. Realizar una solicitud a la API
  2. Recibir una respuesta de error que tenga un código de error que se pueda recuperar
  3. Esperar un segundo más número_aleatorio_de_milisegundos segundos
  4. Reintentar la solicitud
  5. Recibir una respuesta de error que tenga un código de error que se pueda recuperar
  6. Esperar dos segundos más número_aleatorio_de_milisegundos segundos
  7. Reintentar la solicitud
  8. Recibir una respuesta de error que tenga un código de error que se pueda recuperar
  9. Esperar cuatro segundos más número_aleatorio_de_milisegundos segundos
  10. Reintentar la solicitud
  11. Recibir una respuesta de error que tenga un código de error que se pueda recuperar
  12. Esperar ocho segundos más número_aleatorio_de_milisegundos segundos
  13. Reintentar la solicitud
  14. Recibir una respuesta de error que tenga un código de error que se pueda recuperar
  15. Esperar dieciséis segundos más número_aleatorio_de_milisegundos segundos
  16. Reintentar la solicitud
  17. Si se sigue obteniendo un error, detener la solicitud y registrar el error.

En el flujo anterior, número_aleatorio_de_milisegundos es un número menor o igual que 1000. Esto es necesario para evitar determinados errores de bloqueo en algunas implementaciones simultáneas. El valor de random_number_milliseconds se debe redefinir después de cada espera.

Nota: La espera siempre es (2 ^ n) + número_aleatorio_de_milisegundos, donde n es un entero que se incrementa monotónicamente definido inicialmente como 0. El valor de n se incrementa en 1 en cada iteración (cada solicitud).

El algoritmo está configurado para terminar cuando n es 5. Este límite solo se aplica para impedir que los clientes vuelvan a intentar la operación indefinidamente. El resultado es un retardo total de 32 segundos antes de que una solicitud se considere "un error irrecuperable".

El siguiente código Python es una implementación del flujo anterior para restablecer la solicitud tras los errores que se producen en un método denominado makeRequest.

import random
import time
from apiclient.errors import HttpError

def makeRequestWithExponentialBackoff(analytics):
  """Wrapper to request Google Analytics data with exponential backoff.

  The makeRequest method accepts the analytics service object, makes API
  requests and returns the response. If any error occurs, the makeRequest
  method is retried using exponential backoff.

  Args:
    analytics: The analytics service object

  Returns:
    The API response from the makeRequest method.
  """
  for n in range(0, 5):
    try:
      return makeRequest(analytics)

    except HttpError, error:
      if error.resp.reason in ['userRateLimitExceeded', 'quotaExceeded',
                               'internalServerError', 'backendError']:
        time.sleep((2 ** n) + random.random())
      else:
        break

  print "There has been an error, the request never succeeded."