Bezpośrednie prośby

Zachęcamy do korzystania z bibliotek klienta i przykładów do implementacji. Jeśli jednak integracja z interfejsem API ma specjalne potrzeby, np. używasz nieobsługiwanego języka, możesz wysyłać bezpośrednie żądania w sposób opisany poniżej.

Styl połączeń

REST to styl architektury oprogramowania, który zapewnia wygodne i spójne podejście do żądania i modyfikowania danych.

Skrót REST to reprezentatywny transfer stanowy. 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 REST 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 działanie i wysyła odpowiedź, często w formie reprezentacji określonego zasobu.

W interfejsach API typu REST firmy 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

Ponieważ wszystkie zasoby interfejsu API mają unikalne identyfikatory URI dostępne przez HTTP, interfejs REST umożliwia buforowanie danych i jest zoptymalizowany pod kątem pracy z rozproszoną infrastrukturą sieciową.

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

REST w interfejsie AdSense Management API

Obsługiwane operacje są mapowane bezpośrednio na czasowniki HTTP REST zgodnie z opisem w artykule Operacje interfejsu AdSense Management API.

Identyfikatory URI interfejsu API do zarządzania AdSense mają następujący format:

https://adsense.googleapis.com/v2/resourceID?parameters

gdzie resourceID to identyfikator klienta reklam, jednostki reklamowej, kanału URL, kanału niestandardowego lub zbioru raportów, a parameters to parametry, które mają być stosowane do zapytania.

Format rozszerzeń ścieżek resourceID pozwala zidentyfikować zasób, na którym obecnie działasz, na przykład:

https://adsense.googleapis.com/v2/accounts/account_id/adclients
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/adunits/adUnitId
https://adsense.googleapis.com/v2/accounts/account_id/adclients/adClientId/urlchannels
...

Pełny zestaw identyfikatorów URI używanych w przypadku poszczególnych obsługiwanych operacji w interfejsie API można znaleźć w dokumentacji interfejsu AdSense Management API.

Oto kilka przykładów, jak to działa w interfejsie AdSense Management API.

Lista klientów reklamowych:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/

Wyświetl jednostki reklamowe w ca-pub-1234567890123456 w kliencie reklam:

GET https://adsense.googleapis.com/v2/accounts/account_id/adclients/ca-pub-1234567890123456/adunits

Format danych

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.

Autoryzowanie zapytań

Pamiętaj, że AdSense nie obsługuje kont usługi. Zamiast tego musisz skorzystać z procedury zainstalowanej aplikacji.

Każde żądanie wysyłane przez aplikację do interfejsu AdSense Management API musi zawierać token autoryzacji. Token stanowi też dla Google identyfikator aplikacji.

Informacje o protokołach autoryzacji

Twoja aplikacja musi autoryzować żądania za pomocą protokołu OAuth 2.0. Inne protokoły nie są obsługiwane. Jeśli aplikacja używa funkcji Zaloguj się przez Google, niektórymi aspektami autoryzacji nie musisz się zajmować.

Autoryzowanie żądań za pomocą protokołu OAuth 2.0

Wszystkie żądania wysyłane do interfejsu AdSense Management API muszą być autoryzowane przez uwierzytelnionego użytkownika.

Ten proces odbywa się za pomocą identyfikatora klienta OAuth.

Uzyskaj identyfikator klienta OAuth

Możesz też utworzyć je na stronie Dane logowania.

Szczegóły procesu autoryzacji z użyciem protokołu OAuth 2.0 różnią się nieznacznie w zależności od rodzaju projektowanej aplikacji. Do większości typów aplikacji ma zastosowanie ten ogólny proces:

  1. Gdy Twoja aplikacja potrzebuje dostępu do danych użytkownika, prosi Google o konkretny zakres dostępu.
  2. Google wyświetla użytkownikowi ekran zgody z prośbą o autoryzowanie dostępu aplikacji do niektórych danych.
  3. Jeśli użytkownik wyrazi zgodę, Google przekazuje Twojej aplikacji ważny przez krótki czas token dostępu.
  4. Aplikacja żąda danych użytkownika i dołącza do żądania token dostępu.
  5. Jeśli Google uzna, że żądanie i token są prawidłowe, przesyła dane, o które prosisz.

Niektóre procesy obejmują dodatkowe kroki, takie jak wykorzystanie tokenów odświeżania do uzyskania nowych tokenów dostępu. Szczegółowe informacje o procesach obowiązujących w przypadku różnych typów aplikacji znajdziesz w dokumencie Google na temat protokołu OAuth 2.0.

Oto informacje o zakresie protokołu OAuth 2.0 dla interfejsu AdSense Management API:

Zakres Znaczenie
https://www.googleapis.com/auth/adsense Uprawnienia do zapisu i odczytu danych AdSense.
https://www.googleapis.com/auth/adsense.readonly Dostęp tylko do odczytu do danych AdSense.

Aby poprosić o dostęp przy użyciu protokołu OAuth 2.0, aplikacja potrzebuje danych z zakresu oraz informacji przekazywanych przez Google po zarejestrowaniu aplikacji (takich jak identyfikator klienta i tajny klucz klienta).

Wskazówka: biblioteki klienta interfejsów API Google mogą wykonać niektóre procesy autoryzacji za Ciebie. Są dostępne dla różnych języków programowania. Więcej szczegółów znajdziesz na stronie z bibliotekami i próbkami.

Przesyłanie prośby

Ostatnim krokiem jest wysłanie żądania do interfejsu API. Szczegółowe informacje znajdziesz w dokumentacji referencyjnej.