Twoja pierwsza aplikacja: wymagania wstępne

Zanim zaczniesz kodować swoją pierwszą aplikację kliencką, musisz wykonać kilka czynności.

Tworzenie konta Google i uzyskiwanie uprawnień Search Ads 360

Aby korzystać z interfejsu Search Ads 360 API, musisz mieć konto Google i odpowiednie uprawnienia przyznane temu kontu przez Search Ads 360:

  1. Jeśli nie masz jeszcze konta Google, utwórz je.

  2. Poproś menedżera agencji Search Ads 360 o  utworzenie użytkownika Search Ads 360 na Twoim koncie Google.

    Aby pobierać raporty, musisz mieć uprawnienia do wyświetlania danych reklamodawców, z którymi będziesz współpracować.

    Aby dodawać lub edytować konwersje, musisz mieć uprawnienia do edytowania właściwości reklamodawców, z którymi będziesz współpracować. W przypadku udostępnionej konfiguracji Floodlight potrzebujesz uprawnień do edycji każdego reklamodawcy podrzędnego, do którego chcesz przesyłać konwersje. Nie potrzebujesz dostępu do reklamodawcy nadrzędnego ani podrzędnego, do którego nie przesyłasz konwersji. Jeśli do przypisywania konwersji do wizyt używasz identyfikatorów kliknięć, upewnij się, że masz uprawnienia do edycji na koncie reklamodawcy, które wygenerowało dany identyfikator kliknięcia. Jeśli określisz identyfikator kliknięcia od reklamodawcy, do którego nie masz uprawnień dostępu, przesyłanie się nie powiedzie.

    Menedżer agencji może skonfigurować Twoje konto jako Użytkownik na poziomie 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 za pomocą interfejsu API

Jeśli chcesz przesył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 API. Instrukcje znajdziesz w Centrum pomocy Search Ads 360.

Utwórz projekt Konsoli interfejsów API Google i dane logowania OAuth dla klienta

  1. Uruchom narzędzie do konfiguracji w Konsoli interfejsów API Google.
    Narzędzie do konfiguracji przeprowadzi Cię przez proces tworzenia projektu (lub korzystania z istniejącego projektu), włączania interfejsu Search Ads 360 API i tworzenia danych logowania OAuth 2.0.
  2. Na stronie Zarejestruj aplikację wybierz istniejący projekt lub kliknij Utwórz projekt. Następnie kliknij Dalej.
  3. Gdy konsola interfejsów API Google włączy interfejs Search Ads 360 API, kliknij przycisk Przejdź do danych logowania.
  4. Na stronie Utwórz dane logowania podaj te informacje:
    • Którego interfejsu API używasz?: Interfejs API Search Ads 360
    • Do jakich danych będziesz mieć dostęp?: Dane użytkownika
  5. Kliknij przycisk Dalej.

    Narzędzie konfiguracyjne pomaga teraz w tworzeniu identyfikatora klienta OAuth 2.0.

  6. Wykonaj pozostałe kroki opisane w narzędziu konfiguracji.

Zainstaluj plik sa360Api.py

Search Ads 360 udostępnia skrypt narzędziowy ułatwiający konfigurowanie autoryzacji. Możesz też użyć tego skryptu do wysyłania i odbierania danych w formacie JSON, jeśli chcesz przetestować wysyłanie i odbieranie danych, zanim zaprojektujesz i napiszesz pełną aplikację. Możesz skopiować wiele przykładów kodu JSON z tej strony z dokumentacją i wstawić je bezpośrednio do skryptu.

Aby zainstalować skrypt:

  1. Zainstaluj Pythona 2.7.
    Skrypt nie działa z Pythonem 3.x.
  2. Zainstaluj cURL.
  3. Pobierz plik sa360Api.zip.
  4. Wyodrębnij sa360Api.py z sa360Api.zip.
  5. Utwórz plik wykonywalny sa360Api.py.

Podstawy protokołu REST

Interfejs API można wywołać na 2 sposoby:

  • Korzystanie z bibliotek klienta.
  • wysyłać żądania HTTP i analizować odpowiedzi;

Jeśli zdecydujesz się nie używać bibliotek klienta, musisz znać podstawy REST.

REST to styl architektury oprogramowania, który zapewnia wygodne i spójne podejście do wysyłania żądań i modyfikowania danych.

Termin REST to skrót od Representational State Transfer. W kontekście interfejsów API Google odnosi się to używania czasowników HTTP do pobierania i modyfikowania reprezentacji danych przechowywanych przez Google.

W systemie RESTful zasoby są przechowywane w magazynie danych. Klient wysyła żądanie, aby serwer wykonał określone działanie (np. utworzenie, pobranie, zaktualizowanie lub usunięcie zasobu), a serwer wykonuje to działanie i wysyła odpowiedź, często w formie reprezentacji określonego zasobu.

W interfejsach API REST Google klient określa działanie za pomocą czasownika HTTP, takiego jak POST, GET, PUT lub DELETE. Wskazuje zasób za pomocą globalnie unikalnego identyfikatora URI o następującej postaci:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Wszystkie zasoby interfejsu API mają unikalne identyfikatory URI dostępne w ramach protokołu HTTP, a dzięki temu REST umożliwia buforowanie danych i jest zoptymalizowany pod kątem pracy z rozproszoną infrastrukturą sieci.

Definicje metod znajdziesz w dokumentacji standardów HTTP 1.1. Obejmują one specyfikacje GET, POST, PUT i DELETE.

Interfejs REST w Search Ads 360 API

Operacje interfejsu Search Ads 360 API są mapowane bezpośrednio na czasowniki HTTP REST.

Format URI interfejsu Search Ads 360 to:

https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters

Pełny zestaw identyfikatorów URI używanych do każdej obsługiwanej operacji w interfejsie API jest podsumowany w przewodniku po interfejsie API.

Podstawy formatu JSON

Jeśli korzystasz z interfejsu REST, musisz używać formatu JSON w treści żądania. Możesz określić, że odpowiedzi będą w formacie JSON lub CSV.

JSON (JavaScript Object Notation) to popularny, niezależny od języka format danych, który w prosty sposób przedstawia dowolne struktury danych w formie tekstowej. Więcej informacji znajdziesz na stronie json.org.