Method: properties.runAccessReport

Zwraca niestandardowy raport rekordów dostępu do danych. Raport zawiera zapis każdego odczytu przez użytkownika danych raportowania Google Analytics. Rekordy dostępu są przechowywane przez maksymalnie 2 lata.

Istnieje możliwość wysyłania raportów dotyczących dostępu do danych dotyczących usługi. Żądania raportów można wysyłać dla dowolnej usługi, ale wymiary niezwiązane z limitami można żądać tylko w usługach w Google Analytics 360. Ta metoda jest dostępna tylko dla administratorów.

Te rekordy dostępu do danych obejmują m.in. raporty w interfejsie GA4, narzędzie GA4 Eksploracje interfejsu użytkownika, interfejs GA4 Data API i inne usługi, np. Firebase i AdMob, które mogą pobierać dane z Google Analytics przez połączenie kont. Nie obejmują one zmian w konfiguracji usług, takich jak dodanie strumienia czy zmiana strefy czasowej usługi. Informacje o historii zmian konfiguracji znajdziesz w sekcji searchChangeHistoryEvents.

Żądanie HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{entity=properties/*}:runAccessReport

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
entity

string

Raport o dostępie do danych obsługuje żądania na poziomie usługi lub konta. Raporty o dostępie do danych, o ile jest to wymagane na poziomie konta, obejmują cały dostęp do wszystkich usług na danym koncie.

Jeśli chcesz wysyłać żądania na poziomie usługi, element powinien mieć np. nazwę „properties/123”, jeśli Twoim identyfikatorem usługi w GA4 jest „123”. Jeśli chcesz przesłać żądanie na poziomie konta, element powinien mieć postać np. „accounts/1234”, jeśli Twoim identyfikatorem konta GA4 jest „1234”.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean,
  "includeAllUsers": boolean,
  "expandGroups": boolean
}
Pola
dimensions[]

object (AccessDimension)

Wymiary żądane i wyświetlone w odpowiedzi. Żądania może zawierać maksymalnie 9 wymiarów.

metrics[]

object (AccessMetric)

Wskaźniki, o które prosisz, i które wyświetlają się w odpowiedzi. Żądania mogą obejmować maksymalnie 10 rodzajów danych.

dateRanges[]

object (AccessDateRange)

Zakresy dat rekordów dostępu do odczytu. Jeśli zażądasz kilku zakresów dat, każdy wiersz odpowiedzi będzie zawierał indeks zakresu dat liczony od zera. Jeśli 2 zakresy dat się nakładają, rekordy dostępu z pokrywających się dni są uwzględniane w wierszach odpowiedzi dla obu zakresów dat. Żądania mogą obejmować maksymalnie 2 zakresy dat.

dimensionFilter

object (AccessFilterExpression)

Filtry wymiarów pozwalają ograniczyć odpowiedzi w raporcie do określonych wartości wymiarów pasujących do filtra. Dotyczy to na przykład filtrowania rekordów dostępu pojedynczego użytkownika. Więcej informacji znajdziesz w artykule Podstawy filtrów wymiarów. W tym filtrze nie można używać danych.

metricFilter

object (AccessFilterExpression)

Filtry danych umożliwiają ograniczenie odpowiedzi w raporcie do określonych wartości danych pasujących do filtra. Filtry wskaźników są stosowane po agregacji wierszy raportu, podobnie jak w kodzie SQL zawierającym klauzulę. W tym filtrze nie można używać wymiarów.

offset

string (int64 format)

Liczba wierszy wiersza początkowego. Pierwszy wiersz jest liczony jako wiersz 0. Jeśli przesunięcie nie jest określone, jest traktowane jako 0. Jeśli przesunięcie wynosi zero, ta metoda zwróci pierwszą stronę wyników zawierającą limit pozycji.

Więcej informacji o tym parametrze podziału na strony znajdziesz w artykule Podział na strony.

limit

string (int64 format)

Liczba wierszy do zwrócenia. Jeśli nie określono inaczej, zwracanych jest 10 000 wierszy. Interfejs API zwraca maksymalnie 100 tys. wierszy na żądanie,niezależnie od tego, ile zażądasz. limit musi być liczbą dodatnią.

Interfejs API może zwrócić mniej wierszy niż żądana wartość limit, jeśli nie ma tylu pozostałych wierszy co w elemencie limit. Na przykład możliwych wartości wymiaru country jest mniej niż 300, więc w raporcie tylko dla wymiaru country nie możesz uzyskać więcej niż 300 wierszy, nawet jeśli ustawisz w polu limit wyższą wartość.

Więcej informacji o tym parametrze podziału na strony znajdziesz w artykule Podział na strony.

timeZone

string

Strefa czasowa tego żądania, jeśli została określona. Jeśli nie określono inaczej, używana jest strefa czasowa właściwości. Strefa czasowa żądania jest używana do interpretacji dat rozpoczęcia i zakończenia raportu.

Formatowany jako ciągi znaków z bazy danych strefy czasowej IANA (https://www.iana.org/time-zones), np. „Ameryka/Nowy_Jork” lub „Azja/Tokio”.

orderBys[]

object (AccessOrderBy)

Określa kolejność wierszy w odpowiedzi.

returnEntityQuota

boolean

Określa, czy zwracać bieżący stan limitu tej usługi Analytics. Limit jest zwracany w kolumnie AccessQuota. W przypadku żądań na poziomie konta to pole musi mieć wartość false (fałsz).

includeAllUsers

boolean

Opcjonalnie. Określa, czy uwzględnić w odpowiedzi użytkowników, którzy nigdy nie wywołali interfejsu API. Jeśli ma wartość true (prawda), odpowiedź obejmuje wszystkich użytkowników z dostępem do określonej usługi lub określonego konta niezależnie od tego, czy wykonali wywołanie interfejsu API. Jeśli ma wartość false (fałsz), uwzględniani będą tylko użytkownicy, którzy wywołali interfejs API.

expandGroups

boolean

Opcjonalnie. Określa, czy zwrócić użytkowników należących do grup użytkowników. To pole działa tylko wtedy, gdy zasada includeAllUsers ma wartość Prawda. Jeśli ma wartość true (prawda), zwróci wszystkich użytkowników mających dostęp do określonej usługi lub określonego konta. Jeśli ma wartość false (fałsz), zwracane będą tylko użytkownicy z bezpośrednim dostępem.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu RunAccessReportResponse.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit