Te recomendamos que utilices el archivo client bibliotecas y muestras para tu implementación. Sin embargo, si tu integración con la API tiene necesidades especiales, como usar un idioma no compatible, puedes realizar solicitudes directas como se describe a continuación.
Estilo de la llamada
REST es un estilo de arquitectura de software que proporciona un enfoque conveniente y coherente para solicitar y modificar datos.
El término REST es la abreviatura de "Representational State Transfer" (transferencia de estado representacional). En el contexto de las API de Google, se refiere al uso de los verbos HTTP para recuperar y modificar las representaciones de los datos almacenados por Google.
En un sistema RESTful, los recursos se almacenan en un almacén de datos; un cliente envía una solicitud para que el servidor ejecute una acción en particular (como crear, recuperar, actualizar o borrar un recurso) y el servidor ejecuta la acción y envía una respuesta que, por lo general, es una representación del recurso especificado.
En las API con tecnología REST de Google, el cliente especifica una acción con un verbo HTTP como POST
, GET
, PUT
o DELETE
. Especifica un recurso mediante un URI único a nivel global de la siguiente manera:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Dado que todos los recursos de API tienen URI únicos accesibles a través de HTTP, REST permite el almacenamiento de datos en caché y está optimizado para funcionar con la infraestructura distribuida de la Web.
Puedes encontrar las definiciones de métodos en la documentación de estándares del HTTP 1.1, los que incluyen especificaciones para GET
, POST
, PUT
y DELETE
.
REST en la API de AdSense Management
Las operaciones admitidas se asignan directamente a los verbos HTTP de REST, como se describe en Operaciones de la API de AdSense Management.
El formato específico de los URIs de la API de AdSense Management es el siguiente:
https://adsense.googleapis.com/v2/resourceID?parameters
En el ejemplo anterior, resourceID
es el identificador de un anuncio.
cliente, unidad de anuncios, canal URL, canal personalizado o la colección de informes
parameters
son cualquier parámetro para aplicar
la consulta.
El formato de las extensiones de ruta de acceso resourceID
te permite identificar el recurso en el que estás operando actualmente, por
ejemplo:
https://adsense.googleapis.com/v2/accounts/account_id/adclients https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits/adUnitId https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/urlchannels ...
El conjunto completo de URI que se usa para cada operación compatible en la API se se resume en la referencia de la API de AdSense Management. .
A continuación, se muestran algunos ejemplos de cómo funciona esto en la API de AdSense Management.
Clientes de anuncios de listas:
GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/
Enumera unidades de anuncios en el cliente de anuncios ca-pub-1234567890123456:
GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/ca-pub-1234567890123456/adunits
Formato de los datos
JSON (JavaScript Object Notation) es un formato de datos común y, también, independiente del lenguaje que proporciona una representación de texto simple de estructuras de datos arbitrarias. Para obtener más información, visita json.org.
Autoriza solicitudes
Ten en cuenta que AdSense no admite cuentas de servicio; en su lugar, debe usar el flujo de la Aplicación instalada.
Todas las solicitudes que se envíen a la API de AdSense Management deben incluir un token de autorización. El token también identifica tu aplicación ante Google.
Acerca de los protocolos de autorización
Tu aplicación debe usar OAuth 2.0 para autorizar solicitudes. No se admiten otros protocolos de autorización. Si tu aplicación usa Acceder con Google, tú controlarás algunos aspectos de la autorización.
Solicitudes de autorización con OAuth 2.0
Todas las solicitudes a la API de AdSense Management deben estar autorizadas por un usuario autenticado.
Este proceso se facilita con un ID de cliente de OAuth.
Obtén un ID de cliente de OAuthTambién puedes crear una en la página Credenciales.
Los detalles del proceso de autorización, o "flujo", para OAuth 2.0 varían de alguna manera según el tipo de aplicación que estás escribiendo. El siguiente proceso general se aplica a todos los tipos de aplicación:
- Cuando la aplicación necesite acceder a datos del usuario, solicita a Google un alcance de acceso en particular.
- Google mostrará una pantalla de consentimiento al usuario, en la que le pedirá que permita a la aplicación solicitar algunos de sus datos.
- Si el usuario la aprueba, Google le otorgará a la aplicación un token de acceso de corta duración.
- La aplicación solicitará los datos del usuario y adjuntará el token de acceso a la solicitud.
- Si Google determina que la solicitud y el token son válidos, mostrará los datos solicitados.
Algunos flujos requieren pasos adicionales, como el uso de tokens de actualización, para adquirir nuevos tokens de acceso. Si deseas obtener información detallada sobre los flujos para varios tipos de aplicaciones, consulta la documentación de OAuth 2.0 de Google.
A continuación, encontrarás información del alcance de OAuth 2.0 para la API de AdSense Management:
Alcance | Significado |
---|---|
https://www.googleapis.com/auth/adsense |
Tiene acceso de lectura/escritura a los datos de AdSense. |
https://www.googleapis.com/auth/adsense.readonly |
Tiene acceso de solo lectura a los datos de AdSense. |
Para solicitar acceso con OAuth 2.0, tu aplicación necesita los datos del alcance, además de la información que Google proporciona cuando registras la aplicación (como el ID y el secreto del cliente).
Sugerencia: Las bibliotecas cliente de las API de Google pueden controlar algunos de los procesos de autorización por ti. Están disponibles para una variedad de lenguajes de programación. Si quieres obtener más detalles, consulta la página que incluye bibliotecas y ejemplos.
Cómo realizar una solicitud
El último paso es realizar la solicitud a la API. Consulta la documentación de referencia información.