Cómo realizar solicitudes directas

Te recomendamos que uses las bibliotecas de cliente y los ejemplos correspondientes a tu implementación. No obstante, si tu integración con la API tiene necesidades especiales, como el uso de un lenguaje incompatible, puedes realizar solicitudes directas tal como se describe más adelante.

Contenido

Estilo de llamada

REST es un estilo de arquitectura de software que proporciona un modo cómodo y coherente de solicitar y modificar datos.

El término REST es la abreviatura en inglés de "Representational State Transfer" (transferencia de estado representacional). En el contexto de las API de Google, hace referencia al uso de verbos HTTP para recuperar y modificar representaciones de datos almacenados por Google.

En un sistema en el que se utiliza REST los recursos se guardan en un almacén de datos; un cliente envía una solicitud para que el servidor realice una determinada acción (como crear, recuperar, actualizar o suprimir un recurso) y el servidor lleva a cabo la acción y envía una respuesta, normalmente como una representación del recurso especificado.

En las API de Google en las que se utiliza REST, el cliente especifica una acción mediante un verbo HTTP, como POST, GET, PUT o DELETE. Especifica un recurso mediante un identificador URI exclusivo global con el siguiente formato:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Debido a que todos los recursos de la API tienen URI accesibles mediante HTTP, REST permite almacenar los datos en caché y está optimizado para trabajar con la infraestructura distribuida de la Web.

Estos documentos de terceros te pueden resultar útiles para obtener más información sobre REST:

REST en la API de administración de AdSense

Las operaciones compatibles se asignan directamente a verbos HTTP de REST, tal como se describe en Operaciones de la API de administración de AdSense.

El formato específico para los URI de la API de administración de AdSense es:

https://www.googleapis.com/adsense/v1.4/resourceID?parameters

donde resourceID es el identificador de un cliente publicitario, un bloque de anuncios, un canal de URL, un canal personalizado o la colección reports; mientras que parameters corresponde a los parámetros que se aplican a la consulta.

El formato de las extensiones de ruta de resourceID te permite identificar el recurso en el que operas actualmente, por ejemplo:

https://www.googleapis.com/adsense/v1.4/adclients
https://www.googleapis.com/adsense/v1.4/adclients/adClientId
https://www.googleapis.com/adsense/v1.4/adclients/adClientId/adunits
https://www.googleapis.com/adsense/v1.4/adclients/adClientId/adunits/adUnitId
https://www.googleapis.com/adsense/v1.4/adclients/adClientId/urlchannels
...

El conjunto completo de los URI empleados para cada operación admitida en la API se resume en el documento Referencia de la API de administración de AdSense.

A continuación, te ofrecemos un par de ejemplos de cómo funciona en la API de administración de AdSense.

Enumerar los clientes publicitarios:

GET https://www.googleapis.com/adsense/v1.4/adclients/

Enumerar los bloques de anuncios del cliente publicitario ca-pub-1234567890123456:

GET https://www.googleapis.com/adsense/v1.4/adClients/ca-pub-1234567890123456/adunits

Formato de datos

JSON (JavaScript Object Notation, Notación de objetos JavaScript) es un formato de datos común e independiente del lenguaje que proporciona una representación de texto simple de estructuras de datos arbitrarios. Para obtener más información, consulta json.org.

Cómo autorizar solicitudes

Cada solicitud que tu aplicación envíe a la API de administración de AdSense debe incluir un token de autorización. El token también identifica tu aplicación en Google.

Acerca de los protocolos de autorización

Tu aplicación debe utilizar OAuth 2.0 para autorizar las solicitudes. No se admite ningún otro protocolo de autorización.

Cómo autorizar solicitudes con OAuth 2.0

Todas las solicitudes a la API de administración de AdSense las debe autorizar un usuario autenticado.

Los detalles del proceso de autorización, o "flujo", para OAuth 2.0 varían dependiendo del tipo de aplicación que estés escribiendo. El siguiente proceso general se aplica a todos los tipos de aplicación:

  1. Cuando hayas creado tu aplicación, regístrala utilizando Google Developers Console. A continuación, Google te proporcionará la información que necesitarás posteriormente, como un ID de cliente y un secreto de cliente.
  2. Activa la API de administración de AdSense en Google Developers Console (si no aparece en la consola, omite este paso).
  3. Cuando tu aplicación deba acceder a los datos de usuario, pedirá a Google un determinado ámbito de acceso.
  4. Google muestra una pantalla de consentimiento al usuario pidiéndole su autorización para que la aplicación le solicite algunos datos.
  5. Si el usuario aprueba esta petición, Google ofrecerá a la aplicación un token de acceso de corta duración.
  6. Tu aplicación solicita los datos del usuario y adjunta el token de acceso a la solicitud.
  7. Si Google determina que tu solicitud y el token son válidos, mpstrará los datos solicitados.

Algunos flujos incluyen pasos adicionales, como el uso de tokens de actualización para adquirir nuevos tokens de acceso. Para obtener información detallada sobre los flujos de distintos tipos de aplicaciones, consulta la documentación de OAuth 2.0 de Google.

A continuación, te indicamos la información de ámbito de OAuth 2.0 para la API de administración de AdSense:

Ámbito Significado
https://www.googleapis.com/auth/adsense Acceso de lectura/escritura a los datos de AdSense.
https://www.googleapis.com/auth/adsense.readonly Acceso de solo lectura a los datos de AdSense.

Para solicitar el acceso utilizando OAuth 2.0, tu aplicación necesita la información del ámbito, así como la información que proporciona Google durante el registro de la aplicación (como el ID y el secreto de cliente).

Consejo: Las bibliotecas de cliente de las API de Google pueden realizar algunos de los procesos de autorización de forma automática. Están disponibles para varios lenguajes de programación; consulta la página con bibliotecas y ejemplos para obtener más detalles.

Cómo realizar una solicitud

El paso final es realizar una solicitud de la API. Consulta la documentación de referencia para obtener información específica.