Zanim zaczniesz pisać pierwszą aplikację kliencką, musisz wykonać kilka czynności:
Załóż konto Google
Aby utworzyć projekt w Konsoli interfejsów API Google, musisz mieć konto Google. Jeśli masz już konto, nie musisz nic więcej robić.
Możesz też potrzebować osobnego konta Google do celów testowych.
Wypróbuj Raport na temat widoczności reklamy w Google
W tej dokumentacji interfejsu API zakładamy, że korzystasz z Raportu o jakości reklam w Google i znasz koncepcje programowania internetowego oraz formaty danych internetowych.
Jeśli nie korzystasz jeszcze z Raportu o jakości reklam w Google, przed rozpoczęciem kodowania wypróbuj interfejs użytkownika.
Tworzenie projektu dla klienta
Aby móc wysyłać żądania do raportu Google o wrażeniach użytkowników z reklam, musisz poinformować Google o swoim kliencie i aktywować dostęp do interfejsu API. W tym celu musisz użyć konsoli interfejsów API Google, by utworzyć projekt, czyli nazwany zbiór ustawień i informacji dostępowych interfejsu API, oraz zarejestrować swoją aplikację.
Podstawowe informacje o REST
Interfejs API można wywołać na 2 sposoby:
- Wysyłanie żądań HTTP i parsowanie odpowiedzi.
- Korzystanie z bibliotek klienta.
Jeśli zdecydujesz się nie korzystać z bibliotek klienta, musisz poznać podstawy REST.
REST to styl architektury oprogramowania, który zapewnia wygodne i spójne podejście do wysyłania żądań dotyczących danych i ich modyfikowania.
REST to skrót od „Representational State Transfer”. W kontekście interfejsów API Google oznacza to używanie 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. utworzył, pobrał, zaktualizował lub usunął zasób), 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. Określa zasób za pomocą unikalnego globalnie identyfikatora URI w tej postaci:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Ponieważ wszystkie zasoby interfejsu API mają unikalne identyfikatory URI dostępne przez HTTP, REST umożliwia buforowanie danych i jest zoptymalizowany pod kątem współpracy z rozproszoną infrastrukturą internetu.
W dokumentacji standardów HTTP 1.1 znajdziesz definicje metod, w tym specyfikacje metod GET, POST, PUT i DELETE.
REST w interfejsie Ad Experience Report API
Operacje interfejsu Google Ad Experience Report API są bezpośrednio powiązane z czasownikami HTTP REST.
Adresy URI interfejsu Google Ad Experience Report API mają te formaty:
https://adexperiencereport.googleapis.com/v1/resourcePath?parameters
Pełny zestaw identyfikatorów URI używanych w przypadku każdej obsługiwanej operacji w interfejsie API znajdziesz w dokumencie Google Ad Experience Report API Reference (w języku angielskim).
Podstawy JSON
Interfejs Google Ad Experience Report API zwraca dane w formacie JSON.
JSON (JavaScript Object Notation) to popularny, niezależny od języka format danych, który zapewnia prostą tekstową reprezentację dowolnych struktur danych. Więcej informacji znajdziesz na stronie json.org.