Krótkie wprowadzenie do interfejsu API przy użyciu wiersza poleceń

Na tej stronie dowiesz się, jak zacząć korzystać z interfejsu Google Analytics Data API v1 za pomocą wiersza poleceń.

Krok 1. Włącz API

Kliknij ten przycisk, aby utworzyć nowy projekt Cloud Platform, automatycznie włączyć interfejs Google Analytics Data API w wersji 1 i utworzyć dane logowania OAuth2 potrzebne w tym samouczku:

Włączanie interfejsu Google Analytics Data API w wersji 1

Nastąpi automatyczne przekierowanie do okna konfiguracji danych logowania OAuth2. Gdy pojawi się pytanie „Skąd dzwonisz?”, wybierz „Komputer”

W wyświetlonym oknie kliknij POBIERZ KONFIGURACJĘ KLIENTA i zapisz plik credentials.json w katalogu roboczym.

Możesz też wykonać te kroki, aby ręcznie utworzyć dane uwierzytelniające OAuth2 w istniejącym projekcie.

Krok 2. Zainstaluj i zainicjuj pakiet SDK Cloud

Musisz mieć zainstalowane narzędzie wiersza poleceń gcloud.

Krok 3. Wykonaj wywołanie interfejsu API

Teraz możesz używać interfejsu Google Analytics Data API do wysyłania zapytań do usługi Google Analytics 4.

Wybierz podmiot zgłaszający

W tym samouczku będziemy używać zmiennej środowiskowej GA4_PROPERTY_ID do przechowywania identyfikatora usługi, który ma być używany w żądaniach do interfejsu API.

Aby ustawić zmienną GA4_PROPERTY_ID, wpisz w wierszu poleceń te polecenie:

export GA4_PROPERTY_ID=[YOUR-GA4-PROPERTY-ID]

Zastąp [YOUR-GA4-PROPERTY-ID] swoim identyfikatorem usługi w Google Analytics 4. Na przykład:

export GA4_PROPERTY_ID=1234567890

Tworzenie pliku JSON żądania

Poniższy plik request.json pokazuje, jak utworzyć prosty raport.

Utwórz żądanie JSON o podanej niżej treści i zapisz go jako zwykły plik tekstowy request.json w katalogu roboczym:

request.json

{
  "dateRanges": [{ "startDate": "2020-09-01", "endDate": "2020-09-15" }],
  "dimensions": [{ "name": "country" }],
  "metrics": [{ "name": "activeUsers" }]
}

Uwierzytelnij

Aby uzyskać dane logowania użytkownika w tym przykładzie, uruchom poniższe polecenie i użyj ścieżki do pliku JSON z danymi logowania pobranego w kroku 1:

gcloud auth application-default login \
    --scopes=https://www.googleapis.com/auth/analytics.readonly \
    --client-id-file=[PATH/TO/credentials.json]

W nowym oknie przeglądarki otworzy się okno zgody użytkownika OAuth.

Wysyłanie żądania

Użyj curl i treści z pliku request.json, aby wysłać żądanie do interfejsu Google Analytics Data API. W wierszu poleceń wpisz:

  curl -X POST \
  -H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
  -H "Content-Type: application/json; charset=utf-8" \
  https://analyticsdata.googleapis.com/v1beta/properties/$GA4_PROPERTY_ID:runReport -d @request.json

Polecenie curl pobiera token uwierzytelniania za pomocą polecenia gcloud auth application-default print-access-token.

Pamiętaj, że aby przekazać nazwę pliku do curl, użyj opcji -d (dla „danych”) i poprzedzaj nazwę pliku znakiem @. Powinien on znajdować się w tym samym katalogu, w którym wykonujesz polecenie curl.

Gratulacje! Udało Ci się wysłać pierwsze żądanie do interfejsu Google Analytics Data API.