Página principal Guías Referencia Ayuda

Parámetros de consulta estándar

En la tabla siguiente se muestran los parámetros de consulta que se aplican a todas las operaciones de la API de administración de AdSense.

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

  1. El parámetro key es obligatorio en todas las solicitudes, salvo que indiques un token de OAuth 2.0 en la solicitud.
  2. Debes enviar un token de autorización con cada solicitud que esté marcada (AUTHENTICATED). OAuth 2.0 es el protocolo de autorización preferido.
  3. Puedes indicar un token de OAuth 2.0 con cualquier solicitud de dos formas:
    • Utilizando el parámetro de consulta access_token como este: ?access_token=oauth2-token
    • Utilizando el encabezado de HTTP Authorization como este: 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.
callback Función de devolución de llamada.
  • Nombre de la función de devolución de llamada de JavaScript que gestiona la respuesta.
  • Se usa en solicitudes JSON-P de JavaScript.
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 obligatoria salvo que indique un token de OAuth 2.0.
  • La clave de API identifica tu proyecto y te proporciona acceso a la API, cuota e informes.
  • Puedes obtener la clave API de tu proyecto en Google Developers Console.
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: false.
  • 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 Alternativa a userIp.
  • 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 trabajos 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.
  • Anula userIp si se suministran ambos.
  • Más información sobre cómo limitar el uso.
userIp Dirección IP del usuario final para el que se realiza la llamada de la API.
  • Te permite aplicar cuotas por usuario cuando se llama a la API desde una aplicación orientada al servidor.
  • Más información sobre cómo limitar el uso.