- Żądanie HTTP
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- Użytkownik
- UserIdType
- ActivityType
- UserActivitySession
- Aktywność
- CustomDimension:
- PageviewData
- ScreenviewData
- EcommerceData (Dane e-commerce)
- ECommerceAction
- TransactionData
- ProductData
- EcommerceType
- GoalSetData
- GoalData
- EventData
- Wypróbuj
Zwraca dane dotyczące aktywności użytkownika.
Żądanie HTTP
POST https://analyticsreporting.googleapis.com/v4/userActivity:search
Adres URL używa składni transkodowania gRPC.
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON | |
---|---|
{ "dateRange": { object( |
Pola | |
---|---|
dateRange |
Zakres dat, z którego ma zostać pobrana aktywność użytkownika. Jeśli zakres dat nie zostanie podany, domyślny zakres dat to (startDate: bieżąca data – 7 dni, data zakończenia: data bieżąca – 1 dzień). |
viewId |
Wymagane. Identyfikator widoku danych w Analytics, z którego mają być pobierane dane. Każdy element SearchUserActivityRequest musi zawierać parametr |
user |
Wymagane. Unikalny identyfikator użytkownika, którego ma dotyczyć zapytanie. Każdy element SearchUserActivityRequest musi zawierać to pole. |
activityTypes[] |
Zbiór wszystkich typów żądanych aktywności. W odpowiedzi zostaną zwrócone tylko te działania, które pasują do tych typów. Jeśli pole jest puste, wszystkie aktywności zostaną zwrócone. |
pageSize |
Rozmiar strony służy do podziału na strony i określa maksymalną liczbę zwracanych wierszy. Rozmiar strony powinien być większy niż 0. Jeśli wartość wynosi 0 lub pole nie zostało określone, żądanie zwraca domyślnie 1000 wierszy na stronę. |
pageToken |
Token kontynuacji, który pozwala wyświetlić następną stronę wyników. Dodanie tego kodu do żądania spowoduje zwrócenie wierszy po parametrze pageToken. Wartość pageToken powinna być wartością zwracaną w parametrze nextPageToken w odpowiedzi na żądanie SearchUserActivityRequest. |
Treść odpowiedzi
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Odpowiedź z połączenia w usłudze userActivity:get
.
Zapis JSON | |
---|---|
{
"sessions": [
{
object( |
Pola | |
---|---|
sessions[] |
Każdy rekord reprezentuje sesję (szczegóły urządzenia, czas trwania itd.). |
totalRows |
Łączna liczba wierszy zwróconych przez to zapytanie (na różnych stronach). |
nextPageToken |
Należy go przekazać do SearchUserActivityRequest, aby pobrać następną stronę. |
sampleRate |
To pole określa częstotliwość próbkowania dla danego żądania i jest liczbą z zakresu od 0,0 do 1,0. Więcej informacji znajdziesz w przewodniku dla programistów. |
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
Użytkownik
Zawiera informacje umożliwiające jednoznaczną identyfikację konkretnego użytkownika.
Zapis JSON | |
---|---|
{
"type": enum( |
Pola | |
---|---|
type |
Typ użytkownika w żądaniu. Pole |
userId |
Unikalny identyfikator użytkownika, w przypadku którego wysłano żądanie danych. |
UserIdType
Reprezentuje różne dostępne rodzaje identyfikacji użytkownika.
Wartości w polu enum | |
---|---|
USER_ID_TYPE_UNSPECIFIED |
Jeśli typ identyfikatora użytkownika nie jest określony, domyślnym typem będzie CLIENT_ID. |
USER_ID |
Pojedynczego użytkownika, np. konto z zalogowanym użytkownikiem, który może korzystać z treści za pomocą co najmniej jednego urządzenia lub instancji przeglądarki. |
CLIENT_ID |
Identyfikator clientId przypisany przez Analytics. |
ActivityType
Wartości w polu enum | |
---|---|
ACTIVITY_TYPE_UNSPECIFIED |
ActivityType nigdy nie będzie miał tej wartości w odpowiedzi. Użycie tego typu w żądaniu spowoduje błąd. |
PAGEVIEW |
Używana, gdy działanie jest wynikiem wyświetlenia strony przez użytkownika. |
SCREENVIEW |
Używana, gdy działanie jest wynikiem korzystania przez użytkownika z aplikacji na urządzeniu mobilnym. |
GOAL |
Wskazuje, że aktywność jest związana z celem. |
ECOMMERCE |
Użytkownik na stronie dokonał transakcji e-commerce. |
EVENT |
Używana, gdy aktywność jest zdarzeniem. |
UserActivitySession
Odnosi się to do sesji użytkownika wykonanej w wybranym czasie na określonym urządzeniu w określonym czasie.
Zapis JSON | |
---|---|
{
"sessionId": string,
"deviceCategory": string,
"platform": string,
"dataSource": string,
"activities": [
{
object( |
Pola | |
---|---|
sessionId |
Unikalny identyfikator sesji. |
deviceCategory |
Rodzaj użytego urządzenia: „komórka”, „tablet” itp. |
platform |
Platforma, na której miała miejsce aktywność: „android”, „ios” itp. |
dataSource |
Źródło danych działania. Domyślnie działania wysyłane przez kod analytics.js są oznaczone w raportach jako „internet”, a działania wysyłane z mobilnych pakietów SDK – jako „aplikacja”. Wartości te można zastępować w usłudze Measurement Protocol. |
activities[] |
Przedstawia szczegółowy widok każdego działania w tej sesji. |
sessionDate |
Data tej sesji w formacie ISO-8601. |
Aktywność
Aktywność reprezentuje dane o aktywności użytkownika. Pamiętaj, że działanie to nie to samo co działanie. Działanie może skutkować wieloma aktywnościami. Jeśli na przykład działanie obejmuje transakcję i realizację celu, będą dla niego dostępne dwie protopy aktywności: jedna dla ECOMMERCE i jedna dla celu GOAL. I na odwrót, wiele działań może też utworzyć jedno działanie. W klasycznej wersji e-commerce dane o jednej transakcji mogą być wysyłane w ramach wielu działań. Te działania zostaną scalone w jedną aktywność ECOMMERCE.
Zapis JSON | |
---|---|
{ "activityTime": string, "source": string, "medium": string, "channelGrouping": string, "campaign": string, "keyword": string, "hostname": string, "landingPagePath": string, "activityType": enum( |
Pola | ||
---|---|---|
activityTime |
Sygnatura czasowa aktywności. Znacznik czasu w formacie RFC3339 UTC „Zulu”, z dokładnością do nanosekund. Przykład: |
|
source |
Źródło odesłań. W przypadku ręcznego śledzenia kampanii jest to wartość parametru śledzenia kampanii utm_source. W przypadku automatycznego tagowania AdWords jest to google. Jeżeli nie korzystasz z żadnego z tych adresów, będzie to domena źródła (np. dokument.strona odsyłająca), która odsyła użytkowników. Może też zawierać adres portu. Jeśli użytkownicy przybyli na stronę bez strony odsyłającej, wartością jest (bezpośrednie). |
|
medium |
Typ odesłań. W przypadku ręcznego śledzenia kampanii jest to wartość parametru śledzenia kampanii utm_medium. W przypadku automatycznego tagowania AdWords jest to cpc. Jeśli użytkownicy trafili do witryny z wyszukiwarki wykrytej przez Google Analytics, to jest to bezpłatne. Jeśli strona odsyłająca nie jest wyszukiwarką, jest to odesłanie. Jeśli użytkownicy przeszli bezpośrednio do usługi, a dokument document.referrer jest pusty, jego wartość to „(none)”. |
|
channelGrouping |
Grupa kanałów powiązana z sesją użytkownika w tym widoku danych (zdefiniowana przez grupowania kanałów danego widoku). |
|
campaign |
W przypadku ręcznego śledzenia kampanii jest to wartość parametru śledzenia kampanii utm_campaign. W przypadku automatycznego tagowania AdWords jest to nazwy kampanii online (kampanii), które są wykorzystywane w przypadku danej usługi. Jeśli nie użyjesz żadnej z nich, jego wartością będzie (nie ustawiono). |
|
keyword |
W przypadku ręcznego śledzenia kampanii jest to wartość parametru śledzenia kampanii utm_term. W przypadku ruchu z AdWords zawiera najlepiej pasujące kryteria kierowania. W przypadku sieci reklamowej, w przypadku której wyświetlenie reklamy mogło zostać spowodowane przez wiele kryteriów kierowania, zwraca ona najlepiej pasujące kryteria kierowania wybrane przez Google Ads. Może to być display_keyword, miejsce docelowe witryny, boomuserlist, user_interest, wiek lub płeć. W przeciwnym razie jego wartość jest ustawiona na „(not set)”. |
|
hostname |
Nazwa hosta, z którego wysłano żądanie śledzenia. |
|
landingPagePath |
Pierwsza strona w sesjach użytkowników lub strona docelowa. |
|
activityType |
Typ tej aktywności. |
|
customDimension[] |
Lista wszystkich wymiarów niestandardowych powiązanych z tą aktywnością. |
|
Pole sumy activity_details . W zależności od activity_type ustawione zostanie dokładnie jedno z tych pól. activity_details może być tylko jedną z tych wartości: |
||
pageview |
Wartość zostanie ustawiona, jeśli |
|
appview |
Wartość zostanie ustawiona, jeśli |
|
ecommerce |
Wartość zostanie ustawiona, jeśli |
|
goals |
To pole zawiera listę wszystkich celów, które zostały osiągnięte w ramach tej aktywności, gdy |
|
event |
To pole zawiera wszystkie szczegóły dotyczące zdarzenia i zostanie ustawione, jeśli |
CustomDimension
Wymiar niestandardowy.
Zapis JSON | |
---|---|
{ "index": number, "value": string } |
Pola | |
---|---|
index |
Numer przedziału wymiaru niestandardowego. |
value |
Wartość wymiaru niestandardowego. Wartość domyślna (tzn. pusty ciąg znaków) wskazuje usunięcie wartości niestandardowego wymiaru sesji lub użytkownika. |
PageviewData
Reprezentuje szczegóły zbierane, gdy użytkownik wyświetla stronę.
Zapis JSON | |
---|---|
{ "pagePath": string, "pageTitle": string } |
Pola | |
---|---|
pagePath |
Adres URL strony wyświetlonej przez użytkownika. |
pageTitle |
Tytuł strony wyświetlonej przez użytkownika. |
ScreenviewData
Zapis JSON | |
---|---|
{ "screenName": string, "mobileDeviceBranding": string, "mobileDeviceModel": string, "appName": string } |
Pola | |
---|---|
screenName |
Nazwa ekranu. |
mobileDeviceBranding |
Producent lub marka urządzenia mobilnego. Na przykład: „Google”, „Apple” itd. |
mobileDeviceModel |
Model urządzenia mobilnego. Na przykład: „Pixel”, „iPhone” itp. |
appName |
Nazwa aplikacji. |
EcommerceData
Szczegóły transakcji e-commerce powiązane z aktywnością użytkownika.
Zapis JSON | |
---|---|
{ "actionType": enum( |
Pola | |
---|---|
actionType |
Działanie powiązane z tym działaniem e-commerce. |
transaction |
Szczegóły transakcji związane z tym działaniem e-commerce. |
products[] |
Szczegóły produktów w tej transakcji. |
ecommerceType |
Typ tej aktywności e-commerce. |
ECommerceAction
Zbiór wszystkich działań powiązanych z działaniem e-commerce.
Wartości w polu enum | |
---|---|
UNKNOWN |
Nieznany typ działania. |
CLICK |
Klikalność list produktów. |
DETAILS_VIEW |
Widoki szczegółów produktu. |
ADD_TO_CART |
Dodaj produkty do koszyka. |
REMOVE_FROM_CART |
Usuń produkty z koszyka. |
CHECKOUT |
Sfinalizuj transakcję. |
PAYMENT |
Zakup został sfinalizowany. |
REFUND |
Zwrot środków za zakup. |
CHECKOUT_OPTION |
Opcje płatności. |
TransactionData
Reprezentuje szczegóły zbierane, gdy użytkownik realizuje transakcję na stronie.
Zapis JSON | |
---|---|
{ "transactionId": string, "transactionRevenue": number, "transactionTax": number, "transactionShipping": number } |
Pola | |
---|---|
transactionId |
Dostarczany przez metodę śledzenia e-commerce identyfikator transakcji zakupu w koszyku. |
transactionRevenue |
Łączne przychody ze sprzedaży (bez kosztów dostawy i podatku) z transakcji. |
transactionTax |
Łączna kwota podatku od transakcji. |
transactionShipping |
Całkowity koszt dostawy. |
ProductData
Szczegóły produktów w transakcji e-commerce.
Zapis JSON | |
---|---|
{ "productSku": string, "productName": string, "itemRevenue": number, "productQuantity": string } |
Pola | |
---|---|
productSku |
Unikalny kod, który reprezentuje produkt. |
productName |
Nazwa zakupionego produktu wyświetlana przez aplikację do śledzenia e-commerce. |
itemRevenue |
Łączne przychody z zakupionych produktów. |
productQuantity |
Łączna liczba jednostek danego produktu w transakcji. |
EcommerceType
Reprezentuje typ zwracanych danych e-commerce.
Wartości w polu enum | |
---|---|
ECOMMERCE_TYPE_UNSPECIFIED |
Używana, gdy typ aktywności e-commerce jest nieokreślony. |
CLASSIC |
Używana, gdy aktywność zawiera klasyczne (nieulepszone) informacje e-commerce. |
ENHANCED |
Używana, gdy aktywność wzbogaca informacje e-commerce. |
GoalSetData
Reprezentuje zbiór celów, które zostały osiągnięte w aktywności.
Zapis JSON | |
---|---|
{
"goals": [
{
object( |
Pola | |
---|---|
goals[] |
Wszystkie cele, które zostały osiągnięte w bieżącej aktywności. |
GoalData
Reprezentuje wszystkie szczegóły dotyczące celu.
Zapis JSON | |
---|---|
{ "goalIndex": number, "goalCompletions": string, "goalValue": number, "goalCompletionLocation": string, "goalPreviousStep1": string, "goalPreviousStep2": string, "goalPreviousStep3": string, "goalName": string } |
Pola | |
---|---|
goalIndex |
Identyfikuje on cel zgodnie z konfiguracją profilu. |
goalCompletions |
Łączna liczba realizacji celu w ramach tej aktywności. |
goalValue |
Wartość w tym celu. |
goalCompletionLocation |
Adres URL strony, na której zrealizowano cel. |
goalPreviousStep1 |
Adres URL strony o krok przed realizacją celu. |
goalPreviousStep2 |
adres URL strony o dwa kroki przed realizacją celu. |
goalPreviousStep3 |
Adres URL strony 3 kroków przed realizacją celu. |
goalName |
Nazwa celu. |
EventData
Reprezentuje wszystkie szczegóły związane z wydarzeniem.
Zapis JSON | |
---|---|
{ "eventCategory": string, "eventAction": string, "eventLabel": string, "eventValue": string, "eventCount": string } |
Pola | |
---|---|
eventCategory |
Obiekt na stronie, z którym nastąpiła interakcja. Na przykład: „Wideo”. |
eventAction |
Typ interakcji z obiektem. Na przykład: „odtwórz”. |
eventLabel |
Etykieta dodana do zdarzenia. |
eventValue |
Wartość liczbowa powiązana ze zdarzeniem. |
eventCount |
Liczba takich zdarzeń w tej aktywności. |