Instalowanie i używanie Asystenta programisty interfejsu Google Ads API

Wymagania wstępne

Zanim zaczniesz, upewnij się, że:

  1. Dostęp do interfejsu Google Ads API:

  2. Oprogramowanie:

    • Python w wersji 3.10 lub nowszej. Python jest językiem domyślnym, więc musisz go zainstalować i dodać do ścieżki.
    • zainstalowane narzędzie gemini-cli;
    • jq (procesor JSON w wierszu poleceń). Jeśli go nie ma, skrypt instalacyjny spróbuje go zainstalować.
  3. Repozytorium:

Rozpocznij

  1. Przejdź do katalogu projektu:

    cd <full path>/google-ads-api-developer-assistant
    
  2. Uruchom skrypt konfiguracji: ten skrypt konfiguruje narzędzie gemini-cli do używania plików kontekstu GEMINI.md asystenta i niezbędnych narzędzi.

    ./install.sh
    

    Jeśli korzystasz z systemu Windows, uruchom skrypt PowerShell setup.ps1.

  3. Uruchom narzędzie gemini-cli:

    gemini
    
  4. Wejdź w interakcję z asystentem: możesz teraz zadawać pytania lub wydawać polecenia w języku naturalnym.

Najważniejsze funkcje

  • Pytania i odpowiedzi w języku naturalnym: zadawaj pytania dotyczące funkcji interfejsu Google Ads API, sprawdzonych metod lub konkretnych zasobów.

    • „Jakie są dostępne typy kampanii?”
    • „Jak filtrować według daty w GAQL?”
    • „Wyjaśnij różnicę między click_view a impression_view”.
  • Generowanie kodu: generuj zapytania GAQL i wykonywalne fragmenty kodu w Pythonie.

    • „Pokaż kampanie z największą liczbą konwersji w ciągu ostatnich 30 dni”
    • „Pobierz wszystkie włączone nazwy grup reklam dla kampanii o identyfikatorze kampanii 12345”
    • „Znajdź odrzucone reklamy we wszystkich kampaniach” Wygenerowany kod jest zapisywany w katalogu saved_code/.
  • Bezpośrednie wykonywanie interfejsu API: uruchamiaj wygenerowane skrypty Pythona tylko do odczytu bezpośrednio z narzędzia gemini-cli i wyświetlaj sformatowane wyniki w terminalu. Gdy asystent wygeneruje kod, zobaczysz na ekranie prośbę:

To run this script, you will need to replace YOUR_CUSTOMER_ID with your actual
Google Ads customer ID and execute the following command in
your shell: <command>

Wpisz run, a skrypt zostanie wykonany w kontekście asystenta, jeśli Twoim językiem domyślnym jest Python, Ruby lub PHP. Ze względu na zasady bezpieczeństwa języki skompilowane nie będą działać.

  • Eksport do CSV: zapisuj wyniki tabelaryczne z wywołań interfejsu API w pliku CSV.

    • „Zapisz wyniki w pliku CSV” Pliki są zapisywane w katalogu saved_csv/.
  • Pomoc w rozwiązywaniu problemów: uzyskaj pomoc dotyczącą komunikatów o błędach lub nieoczekiwanego działania interfejsu API.

    • „Wystąpił błąd »AuthenticationError.OAUTH_TOKEN_INVALID«. Co mam zrobić?”
    • „Dlaczego nie widzę żadnych wyników zapytania?”
  • Dodatkowy kontekst: dodaj bazę kodu, aby uzyskać kontekst.

    • Od wersji 2.3.0 używaj flagi context_dir, aby uwzględnić pliki projektu: ./update.sh --context_dir /path/to/your/codebase Dzięki temu asystent może uwzględniać logikę aplikacji podczas tworzenia odpowiedzi.
    • Ta funkcja umożliwia asystentowi tworzenie zapisanych przykładów kodu w wybranym języku, zapewniając wsparcie nawet wtedy, gdy oficjalna biblioteka klienta jest niedostępna.
    • Zanim poprosisz o wygenerowanie kodu, powiedz asystentowi: write saved code examples in <language of your application>.

Przykłady użycia

  • Raportowanie:
    • „Pobierz 5 najpopularniejszych słów kluczowych według kosztu za ostatni miesiąc dla klienta 12345678”
  • Struktura konta:
    • „Wyświetl wszystkie nazwy kampanii i ich identyfikatory”
  • Rozwiązywanie problemów:
    • „Przesłałem 100 konwersji, ale w interfejsie widzę tylko 78. Jak mogę to sprawdzić za pomocą interfejsu API?”
  • Nauka:
    • „/explain co to jest zestaw wspólny”
  • Generowanie kodu:
    • „Napisz kod, aby utworzyć kampanię Performance Max dla company name

Społeczność i pomoc

Wytyczne dotyczące udziału

Zachęcamy do udziału! Wytyczne znajdziesz w pliku CONTRIBUTING.md w repozytorium GitHub.