Zanim zaczniesz kodować swoją pierwszą aplikację kliencką, musisz wykonać kilka czynności.
Tworzenie konta Google i uzyskiwanie uprawnień dotyczących Search Ads 360
Aby używać interfejsu Search Ads 360 API, musisz mieć konto Google i odpowiednie uprawnienia przyznane temu kontu:
Jeśli nie masz jeszcze konta Google, załóż je.
Poproś menedżera agencji Search Ads 360 o utworzenie użytkownika Search Ads 360 na potrzeby Twojego konta Google.
Aby pobierać raporty, musisz mieć uprawnienia do wyświetlania kont reklamodawców, z którymi współpracujesz.
Aby dodawać lub edytować konwersje, musisz mieć uprawnienia do edycji reklamodawców, z którymi współpracujesz. W udostępnionej konfiguracji Floodlight musisz mieć uprawnienia do edycji każdego reklamodawcy podrzędnego, do którego chcesz przesłać konwersje. Nie musisz mieć dostępu do reklamodawcy nadrzędnego ani reklamodawców podrzędnych, do których nie przesyłasz konwersji. Jeśli używasz identyfikatorów kliknięć do przypisywania konwersji do wizyt, upewnij się, że masz uprawnienia do edycji reklamodawcy, który wygenerował ten identyfikator. Jeśli określisz identyfikator kliknięcia od reklamodawcy, do którego nie masz uprawnień do edycji, żądanie się nie powiedzie.
Menedżer agencji może skonfigurować Twoje konto jako użytkownika reklamodawcy z dostępem do konkretnych reklamodawców lub skonfigurować konto z wyższym poziomem dostępu, np. użytkownik w agencji z dostępem do wszystkich reklamodawców w agencji.
Aktywowanie usługi konwersji API
Jeśli chcesz przesłać dane o konwersjach, użytkownik Search Ads 360 z uprawnieniami menedżera agencji musi zalogować się w interfejsie Search Ads 360 i aktywować usługę konwersji interfejsu API. Instrukcje znajdziesz w Centrum pomocy Search Ads 360.
Tworzenie projektu w Konsoli interfejsów API Google i danych logowania OAuth dla klienta
- Uruchom narzędzie konfiguracji konsoli interfejsu Google API.
Narzędzie konfiguracji przeprowadzi Cię przez proces tworzenia (lub użycia istniejącego projektu), włączania interfejsu Search Ads 360 API i tworzenia danych logowania OAuth 2.0. - Na stronie Zarejestruj aplikację wybierz istniejący projekt lub kliknij Utwórz projekt. Następnie kliknij Dalej.
- Gdy Konsola interfejsów API Google włączy interfejs Search Ads 360 API, kliknij przycisk Otwórz dane logowania.
- Na stronie Utwórz dane logowania wpisz te informacje:
- Którego interfejsu API używasz? Interfejs API Search Ads 360
- Do jakich danych będziesz mieć dostęp?: Dane użytkownika
- Kliknij przycisk Dalej.
Teraz narzędzie do konfiguracji pomoże Ci utworzyć identyfikator klienta OAuth 2.0.
- Wykonaj pozostałe kroki w narzędziu konfiguracji.
Zainstaluj sa360Api.py
Search Ads 360 udostępnia skrypt narzędziowy, który ułatwia proces autoryzacji. Możesz też użyć tego skryptu do wysyłania i odbierania danych w formacie JSON, jeśli chcesz wysyłać i odbierać dane przed zaprojektowaniem i zapisaniem pełnej aplikacji. Możesz skopiować wiele przykładów kodu JSON z tej dokumentacji i wprowadzić je bezpośrednio do skryptu.
Aby zainstalować skrypt:
- Zainstaluj Pythona 2.7.
Skrypt nie działa z Pythonem 3.x. - Zainstaluj cURL.
- Pobierz plik sa360Api.zip.
- Wyodrębnij plik
sa360Api.pyz:sa360Api.zip. - Ustaw plik
sa360Api.pyjako wykonywalny.
Poznaj podstawy REST
Interfejs API można wywołać na 2 sposoby:
- korzystanie z bibliotek klienta.
- Wysyłanie żądań HTTP i analizowanie odpowiedzi.
Jeśli zdecydujesz się nie korzystać z bibliotek klienta, zapoznaj się z podstawami REST.
REST to styl architektury oprogramowania, który zapewnia wygodne i spójne podejście do żądania i modyfikowania danych.
Termin „EST” to skrót od „Representational State Transfer”. W kontekście interfejsów API Google oznacza to używanie czasowników HTTP w celu pobierania i modyfikowania informacji przechowywanych przez Google.
W systemie REST zasoby są przechowywane w magazynie danych. Klient wysyła żądanie wykonania określonego działania (na przykład utworzenia, pobrania, zaktualizowania lub usunięcia zasobu), a serwer wykonuje tę czynność i wysyła odpowiedź, często w postaci reprezentacji określonego zasobu.
W interfejsach API REST Google klient wskazuje działanie za pomocą czasownika HTTP, np. POST, GET, PUT lub DELETE. Określa zasób przez globalnie unikalny identyfikator URI tego formularza:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Wszystkie zasoby API mają unikalne identyfikatory URI dostępne w protokole HTTP, dlatego funkcja REST umożliwia przechowywanie danych w pamięci podręcznej i zoptymalizowanie jej do pracy z rozproszoną infrastrukturą internetową.
Definicje metod znajdziesz w dokumentacji standardów HTTP 1.1. Zawierają one specyfikacje GET, POST, PUT i DELETE.
REST w interfejsie Search Ads 360 API
Operacje interfejsu API Search Ads 360 są mapowane bezpośrednio na czasowniki HTTP REST.
Konkretny format identyfikatorów URI Search Ads 360 to:
https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters
Pełny zestaw identyfikatorów URI używanych w każdej obsługiwanej operacji w interfejsie API można znaleźć w dokumentacji API.
Poznaj podstawy JSON
Jeśli używasz interfejsu API REST, musisz używać formatu JSON w treściach żądań. Odpowiedzi możesz podawać w formacie JSON lub CSV.
JSON (JavaScript Object Notation) jest popularnym formatem danych niezależnym od języka, który w prosty sposób prezentuje dowolne struktury danych. Więcej informacji znajdziesz na stronie json.org.