Parámetros de consulta estándar

Los parámetros de consulta siguientes se pueden utilizar con todos los métodos y recursos de la API.

Los parámetros de consulta que se usan en todas las operaciones de la versión 4 de la API de informes de Analytics se muestran en la tabla siguiente.

Notas (sobre las claves de la API y los tokens de autenticación):

  1. El parámetro key es obligatorio en todas las solicitudes, a menos que proporciones un token de OAuth 2.0 en la solicitud.
  2. Debes enviar un token de autorización en todas las solicitudes que requieran el ámbito de OAuth. OAuth 2.0 es el único protocolo de autorización admitido.
  3. Puedes indicar un token de OAuth 2.0 con cualquier solicitud de dos formas:
    • Utilizando el parámetro de consulta access_token así: ?access_token=oauth2-token
    • Utilizando el encabezado de HTTP Authorization así: Authorization: Bearer oauth2-token

Todos los parámetros son opcionales, a menos que se indique lo contrario.

Parámetro Significado Notas
access_token Token de OAuth 2.0 para el usuario actual.
alt

Formato de datos de la respuesta.

  • Valores válidos: json, media y proto
  • Valor predeterminado: json
fields Selector que especifica un subconjunto de campos para incluirlos en la respuesta.
  • Para obtener más información, consulta la sección de respuesta parcial en el documento Consejos para el rendimiento.
  • Se utiliza para mejorar el rendimiento.
key Clave de la API (OBLIGATORIA*)
  • *Es obligatorio, salvo si proporciona un token de OAuth 2.0.
  • La clave de la API identifica tu proyecto y te proporciona acceso a la API, a la cuota y a los informes.
  • Puedes obtener la clave de la API de tu proyecto en la consola de la API de Google.
prettyPrint

Muestra la respuesta con sangrados y saltos de línea.

  • Devuelve la respuesta con un formato legible si el valor es true.
  • Valor predeterminado: true.
  • Cuando el valor es false, puede reducir el tamaño de la carga útil de la respuesta, lo que puede conllevar una mejora del rendimiento en algunos entornos.
quotaUser Cadena arbitraria que identifica de forma exclusiva a un usuario.
  • Te permite aplicar cuotas por usuario desde una aplicación orientada al servidor, incluso en aquellos casos en los que no se conoce la dirección IP del usuario. Esto puede ocurrir, por ejemplo, con aplicaciones que ejecutan tareas cron en App Engine en nombre de un usuario.
  • Puedes elegir cualquier cadena arbitraria que identifique de forma exclusiva a un usuario, pero se limita a 40 caracteres.
  • Obtén más información sobre cómo limitar el uso de la API.