Menginstal dan menggunakan Asisten Developer Google Ads API

Prasyarat

Sebelum memulai, pastikan Anda memiliki hal-hal berikut:

  1. Akses Google Ads API:

  2. 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.
  3. Repositori:

Mulai

  1. 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).

  2. Jalankan skrip penginstalan: Skrip ini menginisialisasi lingkungan pengembangan dan meng-clone library klien Google Ads yang diperlukan (Python diinstal secara default).

    ./install.sh
    

    Jika Anda menggunakan Windows, jalankan skrip PowerShell install.ps1.

  3. Konfigurasi kredensial: Pastikan google-ads.yaml (atau yang setara dengan bahasa) ditempatkan di direktori beranda Anda.

  4. 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 ruff dan disimpan di direktori saved/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/.
  • 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.sh dengan opsi --context_path untuk 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.

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

Panduan kontribusi

Kami menerima kontribusi. Lihat file CONTRIBUTING.md di repositori GitHub untuk mengetahui panduannya.