Method: properties.runAccessReport

Zwraca niestandardowy raport z rekordami dostępu do danych. Raport zawiera informacje o każdym odczytaniu przez użytkownika danych raportowania Google Analytics. Rekordy dostępu są przechowywane przez maksymalnie 2 lata.

W przypadku usługi możesz poprosić o raporty dostępu do danych. Raporty mogą być żądane w przypadku dowolnej usługi, ale wymiary, które nie są związane z kwotą, mogą być żądane tylko w usługach Google Analytics 360. Ta metoda jest dostępna tylko dla administratorów.

Te rekordy dostępu do danych obejmują raportowanie w interfejsie użytkownika GA4, eksploracje w interfejsie użytkownika GA4, interfejs API danych GA4 oraz inne usługi, takie jak Firebase i AdMob, które mogą pobierać dane z Google Analytics za pomocą połączenia. Te rekordy nie obejmują zmian konfiguracji usługi, takich jak dodanie strumienia czy zmiana strefy czasowej usługi. Historię zmian konfiguracji znajdziesz w sekcji searchChangeHistoryEvents.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
entity

string

Raport Dostęp do danych obsługuje żądania na poziomie usługi lub konta. Jeśli prośba dotyczy poziomu konta, raporty dostępu do danych obejmują wszystkie usługi na tym koncie.

Aby można było wysłać żądanie na poziomie usługi, encja powinna mieć postać np. „properties/123”, jeśli identyfikator usługi w GA4 to „123”. Aby wysłać żądanie na poziomie konta, elementem powinno być np. „accounts/1234”, jeśli „1234” to identyfikator Twojego konta GA4.

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świetlane w odpowiedzi. W zapytaniach można podać maksymalnie 9 wymiarów.

metrics[]

object (AccessMetric)

Dane żądane i wyświetlane w odpowiedzi. W żądaniu można podać maksymalnie 10 danych.

dateRanges[]

object (AccessDateRange)

Zakresy dat rekordów dostępu do odczytu. Jeśli zostanie podany zakres dat, każdy wiersz odpowiedzi będzie zawierać indeks zakresu dat oparty na 0. Jeśli 2 zakresy dat się pokrywają, rekordy dostępu dotyczące nakładających się dni są uwzględniane w wierszach odpowiedzi dla obu zakresów dat. W prośbach można podać maksymalnie 2 zakresy dat.

dimensionFilter

object (AccessFilterExpression)

Filtry wymiarów pozwalają ograniczyć odpowiedź raportu do określonych wartości wymiarów, które pasują do filtra. Może to być na przykład filtrowanie według rekordów dostępu pojedynczego użytkownika. Więcej informacji i przykłady 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 raportu do określonych wartości danych pasujących do filtra. Filtry danych są stosowane po zsumowaniu wierszy raportu, podobnie jak w przypadku klauzuli having w języku SQL. W tym filtrze nie można używać wymiarów.

offset

string (int64 format)

Liczba wierszy w wierszu początkowym. Pierwszy wiersz jest liczony jako wiersz 0. Jeśli offset nie jest określony, jest traktowany jako 0. Jeśli offset jest równy 0, ta metoda zwróci pierwszą stronę wyników z wejściami limit.

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

limit

string (int64 format)

Liczba wierszy do zwrócenia. Jeśli nie podasz tej wartości, zwróci się 10 tys. wierszy. Interfejs API zwraca maksymalnie 100 000 wierszy na żądanie bez względu na to, o ile prosisz. Wartość limit musi być liczbą dodatnią.

Jeśli nie ma tylu wierszy, ile jest w parametry limit, interfejs API może zwrócić mniej wierszy niż limit. Na przykład w przypadku wymiaru country jest mniej niż 300 możliwych wartości, więc w raportach dotyczących tylko wymiaru country nie możesz uzyskać więcej niż 300 wierszy, nawet jeśli ustawisz większą wartość dla wymiaru limit.

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

timeZone

string

Strefa czasowa tego żądania, jeśli została określona. Jeśli nie zostanie podana, używana jest strefa czasowa usługi. Strefa czasowa żądania służy do interpretacji dat rozpoczęcia i zakończenia raportu.

W formacie ciągów znaków z bazy danych stref czasowych IANA (https://www.iana.org/time-zones), np. „Ameryka/Nowy_York” 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 w Analytics. Limit jest zwracany w AccessQuota. W przypadku żądań na poziomie konta to pole musi być ustawione na wartość false.

includeAllUsers

boolean

Opcjonalnie: Określa, czy w odpowiedzi mają być uwzględniani użytkownicy, którzy nigdy nie wykonali wywołania interfejsu API. Jeśli zasada ma wartość prawda, w odpowiedzi uwzględniani są wszyscy użytkownicy 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ść fałsz, uwzględniane są tylko te osoby, które wykonały wywołanie interfejsu API.

expandGroups

boolean

Opcjonalnie: Określa, czy zwrócić użytkowników w grupach użytkowników. To pole działa tylko wtedy, gdy ustawienie includeAllUsers ma wartość true. Jeśli ma wartość prawda, zwraca wszystkich użytkowników z dostępem do określonej usługi lub określonego konta. Jeśli ma wartość fałsz, zwrócone zostaną tylko te osoby, które mają bezpośredni dostęp.

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