Obsługa administracyjna kont kontrolowanych przez partnerów – przewodnik dla programistów interfejsu API

Wstęp

createAccountTree to część interfejsu API do obsługi administracyjnej, dzięki której można tworzyć nowe konta Google Analytics na dużą skalę. W przeciwieństwie do createAccountTicket proces createAccountTree nie wymaga żadnych działań ze strony użytkownika, aby dokończyć tworzenie konta. Ten proces jest całkowicie automatyczny. Jest to przydatne, gdy musisz udostępnić konto Analytics, które kontrolujesz w imieniu klienta, a także gdzie udostępniasz klientowi niestandardowy widok tych danych.

Ten interfejs API jest zarezerwowany dla partnerów, którzy kontrolują witryny lub usługi internetowe użytkowników. Jeśli Twoi użytkownicy samodzielnie zarządzają witrynami lub usługami internetowymi, zamiast tego należy utworzyć zarządzane przez nich konta Analytics.

Zanim zaczniesz

Dostęp do wszystkich interfejsów API Google Analytics uzyskuje się w podobny sposób. Zanim zaczniesz korzystać z interfejsu API do obsługi administracyjnej, musisz wykonać te czynności:

  • Na stronie bibliotek klienta znajdziesz pełną listę bibliotek klienta dla poszczególnych języków programowania, które współpracują z interfejsem API.
  • Przeczytaj Przewodnik, aby poznać interfejs API i dowiedzieć się, jak uzyskać dostęp do danych bez użycia biblioteki klienta.

Każda biblioteka klienta zapewnia pojedynczy obiekt usługi analitycznej, by uzyskać dostęp do interfejsu API do obsługi administracyjnej. Aby utworzyć obiekt usługi, zazwyczaj musisz wykonać te czynności:

  1. Zarejestruj aplikację w Konsoli interfejsów API Google.
  2. Autoryzuj, aby utworzyć nowe konto Google Analytics.
  3. Utwórz obiekt usługi Analytics.

Jeśli nie udało Ci się wykonać tych czynności, zatrzymaj się i przeczytaj samouczek interfejsu Hello Google Analytics API. W tym samouczku omawiamy pierwsze kroki tworzenia aplikacji interfejsu Google Analytics API. Po ukończeniu kursu dowiesz się, jak uzyskać dostęp do interfejsów API Google Analytics w celu wykonywania codziennych zadań.

Konto wzorcowe

W ramach autoryzacji do korzystania z tego interfejsu API musisz podać nowe konto Google Analytics, które pełni funkcję szablonu konta dla tego interfejsu API. Po utworzeniu nowe konta dziedziczą różne ustawienia z konta szablonu, w tym warunki korzystania z usługi, organizację i różne ustawienia udostępniania danych. Więcej informacji o koncie szablonu, w tym listę wszystkich dziedziczonych danych, znajdziesz w dokumentacji elementu createAccountTree.

Obsługa administracyjna konta

Aby udostępnić nowe konto Google Analytics, wyślij żądanie do punktu końcowego interfejsu API createAccountTree. Potrzebujesz tych informacji na temat obsługi administracyjnej:

  • Pola Account (Konto)
    • accountName dla konta.
  • Pola usługi internetowej
    • Identyfikator webpropertyName usługi.
    • websiteUrl. Powinien to być adres URL powiązany z właściwością użytkownika na tym koncie Analytics.
  • Pola widoku
    • profileName dla widoku.
    • timezone dla widoku.

Po przygotowaniu szczegółów wykonaj uwierzytelnione wywołanie punktu końcowego interfejsu API:

POST https://www.googleapis.com/analytics/v3/provisioning/createAccountTree
{
    "accountName": "Analytics Account",
    "webpropertyName": "Default Property",
    "profileName": "Default View",
    "timezone": "America/Los_Angeles",
    "websiteUrl": "www.example-pet-store.com",
}

Jeśli operacja się uda, interfejs API poda w odpowiedzi szczegóły nowo utworzonego konta, usługi internetowej i widoku:

{
    "account": {
        "id": "999999999",
        "name": "Analytics Account",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "webproperty": {
        "id": "UA-999999999-1",
        "name": "Default Property",
        "websiteUrl": "www.example-pet-store.com",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "profile": {
        "id": "999999999",
        "name": "Default View",
        "timezone": "America/Los_Angeles",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    ...
}

Własność konta i zarządzanie nim

Utworzone konto Google Analytics będzie należeć do konta użytkownika, który autoryzował odpowiedź za pomocą protokołu OAuth. Dlatego zalecamy, aby do zarządzania kontem Analytics organizacja korzystała z konta usługi, a nie z kont poszczególnych użytkowników.

Po utworzeniu konta możesz je skonfigurować za pomocą interfejsu Management API. Oto kilka typowych czynności do wykonania w przypadku nowo utworzonego konta:

Wyjaśnienie relacji między kontami

Podobnie jak w przypadku wszystkich interfejsów API Google, projekt Google Cloud jest wymagany jako punkt wyjściowy do autoryzacji żądań. Zgodnie z opisem w dokumentacji protokołu OAuth 2.0 na tym koncie możesz zarządzać danymi logowania do żądań do interfejsu API. Utworzone konto Google Analytics nie jest jednak w żaden sposób bezpośrednio powiązane z projektem Cloud ani z jego kontami zarządzającymi. Jest powiązane tylko z kontem użytkownika lub usługi, które autoryzowało żądanie. Aby skonfigurować dostęp do konta Analytics, możesz użyć interfejsu API zarządzania Google Analytics.