Antes de que comiences a escribir el código de tu primera aplicación cliente, hay unas cuantas tareas que debes realizar si aún no las has hecho.
Crea una Cuenta de Google y obtén permisos de Search Ads 360
Para usar la API de Search Ads 360, necesitas una Cuenta de Google y los permisos adecuados que se le otorgaron de Search Ads 360:
Si aún no tienes una Cuenta de Google, créala.
Pídele a un administrador de la agencia de Search Ads 360 que cree un usuario de Search Ads 360 para tu Cuenta de Google.
Para descargar informes, necesitarás permiso de lectura de los anunciantes con los que trabajarás.
Para agregar o editar conversiones, deberás tener permiso de edición para los anunciantes con los que trabajarás. En una configuración de Floodlight compartida, debes tener permiso de edición para cada anunciante secundario al que desees subir conversiones. No necesitas tener acceso al anunciante principal ni a los anunciantes secundarios a los que no vayas a subir conversiones. Si usas los IDs de clic para atribuir las conversiones a las visitas, asegúrate de tener acceso de edición al anunciante que generó el ID de clic. Si especificas un ID de clic de un anunciante al que no tienes acceso de edición, la solicitud no se realizará correctamente.
El administrador de la agencia puede configurar tu cuenta como usuario de anunciante con acceso a anunciantes específicos o con un nivel de acceso más alto, como usuario de la agencia con acceso a todos los anunciantes de la agencia.
Activa el servicio de conversiones de la API
Si deseas subir datos sobre las conversiones, un usuario de Search Ads 360 con privilegios de administrador de la agencia debe acceder a la IU de Search Ads 360 y activar el servicio de conversiones de la API. Consulta el Centro de ayuda de Search Ads 360 para obtener instrucciones.
Crea un proyecto de la Consola de APIs de Google y credenciales de OAuth para tu cliente
- Inicia la
herramienta de configuración de la Consola de API de Google.
La herramienta de configuración te guiará para crear un proyecto (o usar uno existente), habilitar la API de Search Ads 360 y crear credenciales de OAuth 2.0. - En la página Registra tu aplicación, selecciona un proyecto existente o Crear un proyecto. Luego, haz clic en Continuar.
- Después de que la Consola de la API de Google habilite la API de Search Ads 360, haz clic en el botón Ir a credenciales.
- En la página Crear credenciales, ingresa la siguiente información:
- ¿Qué API estás usando?: API de Search Ads 360
- ¿A qué datos accederás?: Datos del usuario
- Haz clic en el botón Siguiente.
La herramienta de configuración ahora te ofrece ayuda para crear un ID de cliente de OAuth 2.0.
- Sigue el resto de los pasos en la herramienta de configuración.
Instala sa360Api.py
Search Ads 360 proporciona una secuencia de comandos de utilidad para facilitar el proceso de configuración de la autorización. También puedes usar esta secuencia de comandos para enviar y recibir datos en formato JSON si deseas probar el envío y la recepción de datos antes de diseñar y escribir una aplicación completa. Puedes copiar muchos de los ejemplos de JSON en este sitio de documentación y, luego, ingresarlos directamente en la secuencia de comandos.
Para instalar la secuencia de comandos, sigue estos pasos:
- Instala Python 2.7.
La secuencia de comandos no funciona con Python 3.x. - Instala cURL.
- Descarga sa360Api.zip.
- Se extrajo
sa360Api.py
desa360Api.zip
. - Haz que
sa360Api.py
sea ejecutable.
Obtén información sobre los aspectos básicos de REST
Existen dos maneras de invocar la API:
- Usar bibliotecas cliente
- Enviar solicitudes HTTP y analizar las respuestas
Si decides no usar bibliotecas cliente, deberás comprender los aspectos básicos de REST.
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 Search Ads 360
Las operaciones de la API de Search Ads 360 se asignan directamente a los verbos HTTP de REST.
El formato específico para los URI de la API de Search Ads 360 es el siguiente:
https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters
El conjunto completo de URIs que se usan para cada operación compatible en la API se resume en la Referencia de la API.
Obtén información sobre los aspectos básicos de JSON
Si usas REST, deberás usar el formato JSON para los cuerpos de las solicitudes. Puedes especificar que las respuestas estén en formato JSON o CSV.
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.