Zachęcamy do korzystania z klienta biblioteki i przykłady do wykorzystania. Jeśli jednak integracja interfejs API ma szczególne potrzeby, np. używanie 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 (takie jak utworzenie, pobranie, zaktualizowanie lub usunięcie zasobu), a serwer wykonuje tę czynność 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. zawierają 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 sekcji Operacje interfejsu API zarządzania AdSense –
Identyfikatory URI interfejsu API do zarządzania AdSense mają następujący format:
https://adsense.googleapis.com/v2/resourceID?parameters
gdzie resourceID
to identyfikator reklamy.
klienta, jednostki reklamowej, kanału URL, kanału niestandardowego lub kolekcji raportów,
parameters
to parametry, do których należy zastosować
i zapytania.
Format rozszerzeń ścieżki resourceID
pozwala zidentyfikować zasób, z którego obecnie korzystasz,
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 każdej obsługiwanej operacji w interfejsie API to dostępne w materiałach referencyjnych dotyczących interfejsu AdSense Management API. dokument.
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, musi korzystać z instrukcji w 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 OAuthMoż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:
- Gdy Twoja aplikacja potrzebuje dostępu do danych użytkownika, prosi Google o konkretny zakres dostępu.
- Google wyświetla użytkownikowi ekran zgody z prośbą o autoryzowanie dostępu aplikacji do niektórych danych.
- Jeśli użytkownik wyrazi zgodę, Google przekazuje Twojej aplikacji ważny przez krótki czas token dostępu.
- Aplikacja żąda danych użytkownika i dołącza do żądania token dostępu.
- 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. Zobacz dokumentację referencyjną dotyczącą konkretnych i informacjami o nich.