Antes de que comiences a codificar tu primera aplicación cliente, debes realizar algunas acciones, si es que todavía no lo hiciste.
Cree una Cuenta de Google y obtenga los permisos de Search Ads 360
Para usar la API de Search Ads 360, necesita una Cuenta de Google y los permisos adecuados para esa cuenta desde Search Ads 360:
Si aún no tienes una Cuenta de Google, crea una.
Solicite a un administrador de agencias de Search Ads 360 que cree un usuario de Search Ads 360 para su Cuenta de Google.
Para descargar informes, necesitará permiso de lectura para los anunciantes con los que desea trabajar.
Para agregar o editar conversiones, necesitará permiso de edición para los anunciantes con los que trabajará. En una configuración compartida de Floodlight, debes tener permiso de edición para cada anunciante secundario al que desees subir las conversiones. No necesita tener acceso al anunciante principal ni a los anunciantes secundarios en los que no sube las conversiones. Si utiliza los ID de clic para atribuir las conversiones a las visitas, asegúrese 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á de forma correcta.
El administrador de agencias puede configurar tu cuenta como un usuario anunciante con acceso a anunciantes específicos, o bien, configurar tu cuenta con un nivel de acceso más alto, como usuario de la agencia, con acceso a todos los anunciantes de la agencia.
Active el Servicio de conversión de la API
Si desea subir datos sobre conversiones, un usuario de Search Ads 360 con privilegios de administrador de agencia debe acceder a la IU de Search Ads 360 y activar el servicio de conversión de la API. Consulta el Centro de ayuda de Search Ads 360 para obtener instrucciones.
Crea un proyecto en la Consola de API 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 guía 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 Registrar tu aplicación, selecciona un proyecto existente o Crear un proyecto. Luego, haz clic en Continuar.
- Después de que la Consola de 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 se ofrece para ayudarte a crear un ID de cliente OAuth 2.0.
- Sigue el resto de los pasos de 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 intentar enviar y recibir datos antes de diseñar y escribir una aplicación completa. Puedes copiar muchos de los ejemplos JSON en este sitio de la documentación y, luego, ingresarlos directamente en la secuencia de comandos.
Para instalar la secuencia de comandos, haz lo siguiente:
- Instala Python 2.7.
La secuencia de comandos no funciona con Python 3.x. - Instala cURL.
- Descarga sa360Api.zip.
- Extrae
sa360Api.pydesa360Api.zip. - Haz que
sa360Api.pysea 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 conceptos 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 el acrónimo en inglés de "Transferencia de estado representacional". En el contexto de las API de Google, se refiere al uso de verbos HTTP para recuperar y modificar representaciones de los datos que almacena 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 de RESTful 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 forma:
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 los URI que se usan en 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 la solicitud. 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.