Prasyarat
Sebelum memulai, pastikan Anda memiliki hal-hal berikut:
Akses Google Ads API:
- Token developer Google Ads API.
- File Konfigurasi Google Ads yang dikonfigurasi dengan token developer, kredensial OAuth 2.0, dan ID pelanggan Anda, yang berada di direktori beranda Anda. Lihat panduan konfigurasi library klien.
- Memahami konsep dan autentikasi Google Ads API.
Software:
- Python 3.10 atau yang lebih baru. Python adalah bahasa default, jadi Anda harus menginstal dan menyertakannya di jalur Anda.
- Alat command line Google Antigravity sudah diinstal.
- jq (pemroses JSON command line). Skrip penginstalan akan mencoba menginstal ini jika tidak ada.
Repositori:
- Clone lokal repositori
google-ads-api-developer-assistantdari GitHub.
- Clone lokal repositori
Mulai
Buka direktori project:
cd <full path>/google-ads-api-developer-assistant(Catatan: Jika Anda mengaktifkan integrasi shell Antigravity, memasukkan direktori ini akan otomatis memulai sesi asisten).
Jalankan skrip penginstalan: Skrip ini menginisialisasi lingkungan pengembangan dan meng-clone library klien Google Ads yang diperlukan (Python diinstal secara default).
./install.shJika Anda menggunakan Windows, jalankan skrip PowerShell
install.ps1.Konfigurasi kredensial: Pastikan
google-ads.yaml(atau yang setara dengan bahasa) ditempatkan di direktori beranda Anda.Berinteraksi dengan Asisten: Setelah sesi aktif, Anda dapat berinteraksi dengan Asisten menggunakan bahasa alami langsung di terminal.
Fitur utama
Tanya jawab bahasa alami: Ajukan pertanyaan tentang fitur Google Ads API, praktik terbaik, atau resource tertentu.
- "Apa saja jenis kampanye yang tersedia?"
- "Bagaimana cara memfilter menurut tanggal di GAQL?"
- "Jelaskan perbedaan antara click_view dan impression_view."
Pembuatan kode: Buat kueri GAQL dan cuplikan kode Python yang dapat dieksekusi.
- "Tampilkan kampanye dengan konversi terbanyak dalam 30 hari terakhir."
- "Dapatkan semua nama grup iklan yang diaktifkan untuk ID kampanye 12345."
- "Temukan iklan yang tidak disetujui di semua kampanye."
Kode yang dibuat akan otomatis di-lint menggunakan
ruffdan disimpan di direktorisaved/code/.
Eksekusi API langsung: Jalankan skrip Python hanya baca yang dihasilkan secara langsung dalam lingkungan virtual yang terisolasi (
.venv) dan lihat hasil yang diformat sebagai tabel di terminal Anda.- Cukup beri tahu Asisten: "Run the code" atau "Execute the script".
- Untuk keamanan, operasi mutasi (buat, perbarui, hapus) dibuat, tetapi tidak pernah dieksekusi.
Ekspor CSV: Simpan hasil tabular dari panggilan API ke file CSV.
- "Simpan hasil ke file CSV."
File disimpan di direktori
saved/csv/.
- "Simpan hasil ke file CSV."
File disimpan di direktori
Diagnostik dan pemecahan masalah lanjutan: Dapatkan bantuan terkait pesan error, perilaku API yang tidak terduga, atau masalah konversi offline.
- "Mengapa saya tidak melihat hasil apa pun untuk kueri saya?"
- "Troubleshoot konversi saya untuk pelanggan 123-456-7890." (Membuat laporan diagnostik
mendetail di
saved/data/).
Konteks tambahan: Tambahkan codebase atau library kustom Anda sendiri untuk konteks.
- Gunakan skrip
update.shdengan opsi--context_pathuntuk mendaftarkan file project Anda:none ./update.sh --context_path /path/to/your/codebase - Dengan begitu, Asisten dapat menyertakan logika aplikasi Anda dalam penalarannya saat membuat respons atau menghasilkan kode dalam bahasa pilihan Anda.
- Gunakan skrip
Contoh kasus penggunaan
- Pelaporan:
- "Get me the top 5 keywords by cost for last month for customer 12345678." (Berikan 5 kata kunci teratas menurut biaya untuk bulan lalu bagi pelanggan 12345678).
- Struktur akun:
- "Cantumkan semua nama kampanye dan ID-nya."
- Pemecahan masalah:
- "Saya mengupload 100 konversi, tetapi hanya 78 yang muncul di UI. Bagaimana cara men-debugnya menggunakan API?"
- Pembelajaran:
- "/explain what a shared set is" (jelaskan apa itu set bersama)
- Pembuatan Kode:
- "Tulis kode untuk membuat kampanye Performa Maksimal untuk company name."
Komunitas dan dukungan
- Masalah GitHub: Laporkan bug, sarankan fitur, atau minta bantuan di tab Masalah di repositori.
- Discord: Bergabunglah dalam diskusi di channel
#ads-api-ai-toolsdi server Discord Komunitas Google Advertising and Measurement. - Masukan: Sampaikan masukan Anda melalui formulir survei ini.
Panduan kontribusi
Kami menerima kontribusi. Lihat file CONTRIBUTING.md di repositori GitHub untuk mengetahui panduannya.