Requisitos previos
Antes de comenzar, asegúrate de tener lo siguiente:
Acceso a la API de Google Ads:
- Un token de desarrollador de la API de Google Ads.
- Un archivo de configuración de Google Ads configurado con tu token de desarrollador, credenciales de OAuth 2.0 y el ID de cliente, ubicado en tu directorio principal (consulta la guía de configuración de la biblioteca cliente)
- Conocimiento de los conceptos y la autenticación de la API de Google Ads
Software:
- Python 3.10 o versiones posteriores. (Python es el lenguaje predeterminado, por lo que debes tenerlo instalado y en tu ruta de acceso)
- La herramienta de línea de comandos de Google Antigravity instalada.
- jq (procesador JSON de línea de comandos) (la secuencia de comandos de instalación intentará instalarlo si falta)
Repositorio:
- Una clonación local del
google-ads-api-developer-assistantrepositorio de GitHub
- Una clonación local del
Comenzar
Navega al directorio del proyecto:
cd <full path>/google-ads-api-developer-assistant(Nota: Si tienes habilitada la integración de shell de Antigravity, ingresar a este directorio inicializará automáticamente la sesión del asistente).
Ejecuta la secuencia de comandos de instalación: Esta secuencia de comandos inicializa el entorno de desarrollo y clona las bibliotecas cliente de Google Ads necesarias (Python se instala de forma predeterminada).
./install.shSi usas Windows, ejecuta la secuencia de comandos de PowerShell
install.ps1.Configura las credenciales: Asegúrate de que tu archivo
google-ads.yaml(o su equivalente en el idioma) esté ubicado en tu directorio principal.Interactúa con el Asistente: Una vez que la sesión esté activa, podrás interactuar con el Asistente usando lenguaje natural directamente en tu terminal.
Características clave
Preguntas y respuestas en lenguaje natural: Haz preguntas sobre las funciones, las prácticas recomendadas o los recursos específicos de la API de Google Ads.
- "¿Cuáles son los tipos de campaña disponibles?"
- "¿Cómo filtro por fecha en GAQL?"
- "Explica la diferencia entre click_view y impression_view."
Generación de código: Genera consultas de GAQL y fragmentos de código de Python ejecutables.
- "Muéstrame las campañas con la mayor cantidad de conversiones en los últimos 30 días."
- "Obtén todos los nombres de los grupos de anuncios habilitados para el ID de campaña 12345."
- "Busca anuncios rechazados en todas las campañas."
El código generado se analiza automáticamente con
ruffy se guarda en el directoriosaved/code/.
Ejecución directa de la API: Ejecuta secuencias de comandos de Python de solo lectura generadas directamente en un entorno virtual aislado (
.venv) y visualiza los resultados con formato como tablas en tu terminal.- Solo dile al Asistente: "Ejecuta el código" o "Ejecuta la secuencia de comandos".
- Por seguridad, las operaciones de mutación (crear, actualizar, borrar) se generan, pero nunca se ejecutan.
Exportación de CSV: Guarda los resultados tabulares de las llamadas a la API en un archivo CSV.
- "Guarda los resultados en un archivo CSV."
Los archivos se guardan en el directorio
saved/csv/.
- "Guarda los resultados en un archivo CSV."
Los archivos se guardan en el directorio
Diagnóstico y solución de problemas avanzados: Obtén ayuda con mensajes de error, comportamiento inesperado de la API o problemas de conversiones sin conexión.
- "¿Por qué no veo ningún resultado para mi consulta?"
- "Soluciona los problemas de mis conversiones para el cliente 123-456-7890." (Genera un informe de diagnóstico detallado en
saved/data/).
Contexto adicional: Agrega tu propia base de código o bibliotecas personalizadas para el contexto.
- Usa la secuencia de comandos
update.shcon la opción--context_pathpara registrar los archivos de tu proyecto:none ./update.sh --context_path /path/to/your/codebase. - Esto permite que el Asistente incluya la lógica de tu aplicación en su razonamiento cuando crea respuestas o genera código en tu idioma preferido.
- Usa la secuencia de comandos
Ejemplos de casos de uso
- Informes:
- "Obtén las 5 palabras clave principales por costo del mes pasado para el cliente 12345678."
- Estructura de la cuenta:
- "Enumera todos los nombres de las campañas y sus IDs."
- Solución de problemas:
- "Subí 100 conversiones, pero solo aparecen 78 en la IU. ¿Cómo puedo depurar esto con la API?"
- Aprendizaje:
- "/explain qué es un conjunto compartido"
- Generación de código:
- "Escribe código para crear una campaña de máximo rendimiento para company name."
Comunidad y asistencia
- Problemas de GitHub: Informa errores, sugiere funciones o solicita ayuda en la pestaña Issues del repositorio.
- Discord: Únete al debate en el canal
#ads-api-ai-toolsdel servidor de Discord de la comunidad de Google Advertising and Measurement. - Comentarios: Comparte tus comentarios a través de este formulario de encuesta.
Lineamientos para las contribuciones
Agradecemos tus contribuciones. Consulta el archivo CONTRIBUTING.md en el repositorio de GitHub para obtener los lineamientos.