W tym dokumencie opisujemy, co należy zrobić przed napisaniem pierwszej aplikacji klienckiej.
Załóż konto Google
Aby korzystać z tego interfejsu API, musisz mieć konto Google. Aby można było wywołać tę metodę w danej usłudze, Twoje konto musi mieć odpowiednie uprawnienia Search Console w danej usłudze. Aby na przykład uruchomić polecenie searchAnalytics.query, musisz mieć w tej usłudze uprawnienia do odczytu.
Wypróbuj Google Search Console
W tej dokumentacji zakładamy, że korzystasz z Google Search Console i znasz zagadnienia programowania stron internetowych oraz znasz formaty danych z sieci.
Jeśli nie znasz jeszcze Google Search Console, to zanim zaczniesz pisać kod, wypróbuj interfejs tej usługi. Każdy interfejs API odpowiada funkcjom raportu w Search Console. Przed użyciem interfejsu API przeczytaj dokumentację odpowiedniego raportu, aby zrozumieć otrzymywane dane.
Utwórz projekt i dane logowania dla klienta
Aby móc wysyłać żądania do Google Search Console, musisz powiadomić Google o swoim kliencie i aktywować dostęp do interfejsu API. W tym celu użyj konsoli interfejsów API Google, aby utworzyć projekt, czyli nazwany zbiór ustawień i informacji o dostępie do interfejsu API, a następnie zarejestrować swoją aplikację.
Wszystkie interfejsy API Search Console z wyjątkiem interfejsu Testing Tools API wymagają danych logowania OAuth2. Krótkie przewodniki po Pythonie i Javie zawierają szczegółowe informacje o tym, jak utworzyć projekt i uzyskać dane logowania klienta.
Podstawowe informacje o REST
Interfejs API można wywołać na 2 sposoby:
- wysyłanie żądań HTTP i analizowanie odpowiedzi;
- Za pomocą bibliotek klienta.
Jeśli zdecydujesz się nie używać bibliotek klienta, musisz znać podstawy REST.
Podstawowe informacje o REST
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 Google Search Console API
Operacje interfejsu Google Search Console API są mapowane bezpośrednio na czasowniki HTTP REST.
Format większości identyfikatorów URI interfejsu Google Search Console API jest podobny do tego:
VERB https://www.googleapis.com/webmasters/v3/resourcePath?parameters
Pełny zestaw identyfikatorów URI i czasowników używanych w przypadku poszczególnych metod znajdziesz w dokumentacji interfejsu API Google Search Console.
Podstawy kodu JSON
Interfejs Google Search Console API zwraca dane w formacie JSON.
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.