Method: properties.runAccessReport

Zwraca dostosowany raport rekordów 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.

Raporty o dostępie do danych można zgłaszać w przypadku usługi. Możesz prosić o raporty w przypadku każdej usługi, ale wymiary niezwiązane z limitem można wysyłać tylko w usługach Google Analytics 360. Ta metoda jest dostępna tylko dla administratorów.

Rekordy dostępu do danych obejmują raporty interfejsu użytkownika GA4, narzędzie Eksploracje UI GA4, interfejs GA4 Data API oraz inne usługi, np. Firebase i AdMob, który może pobierać dane z Google Analytics za pomocą połączenia. Rekordy te nie obejmują zmian w 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 o dostępie do danych obsługuje wysyłanie żądań na poziomie usługi lub konta. Raporty o dostępie do danych (jeśli są wymagane na poziomie konta) obejmują pełny dostęp do wszystkich usług na tym koncie.

Aby żądanie na poziomie usługi było możliwe, encja powinna mieć postać np. „properties/123” jeśli "123" to identyfikator usługi w GA4. Aby przesłać prośbę na poziomie konta, element powinien mieć postać np. „accounts/1234” jeśli „1234” to identyfikator 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)

Żądane wymiary i wyświetlane w odpowiedzi. Dozwolonych jest maksymalnie 9 wymiarów.

metrics[]

object (AccessMetric)

Dane żądane i wyświetlone w odpowiedzi. Dozwolonych jest maksymalnie 10 rodzajów danych.

dateRanges[]

object (AccessDateRange)

Zakresy dat rekordów dostępu do odczytu. Jeśli zażądasz wielu 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ą mieć 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. Na przykład filtrowanie według rekordów dostępu pojedynczego użytkownika. Więcej przykładów 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 zagregowaniu wierszy raportu, podobnie jak w przypadku klauzuli 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 przesunięcie nie jest określone, jest ono traktowane jako 0. Jeśli przesunięcie wynosi zero, ta metoda zwróci pierwszą stronę wyników z wpisami limit.

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

limit

string (int64 format)

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

Interfejs API może zwrócić mniej wierszy niż żądane limit, jeśli nie ma ich aż tyle, ile brakuje w wierszu limit. Wymiar country może mieć np. mniej niż 300 możliwych wartości, więc gdy raportujesz tylko element country, nie możesz uzyskać więcej niż 300 wierszy nawet wtedy, gdy ustawisz wyższą wartość w polu 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 określono inaczej, używana jest strefa czasowa usługi. Strefa czasowa żądania jest używana do interpretacji czasu rozpoczęcia & daty zakończenia raportu.

Sformatowane jako ciągi znaków z bazy danych stref czasowych IANA (https://www.iana.org/time-zones). na przykład „Ameryka/Nowy_Jork”. lub „Azja/Tokio”.

orderBys[]

object (AccessOrderBy)

Określa kolejność wierszy w odpowiedzi.

returnEntityQuota

boolean

Określa, czy ma być zwracany bieżący stan limitu usługi Analytics. Limit jest zwracany w polu AccessQuota. W przypadku próśb na poziomie konta to pole musi mieć wartość false (fałsz).

includeAllUsers

boolean

Opcjonalnie: Określa, czy w odpowiedzi mają być uwzględniani użytkownicy, którzy nigdy nie wywołali 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ść false (fałsz), uwzględniani są tylko użytkownicy, którzy wykonali wywołanie interfejsu 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 ustawienie includeAllUsers ma wartość true. Jeśli ma wartość true (prawda), zwrócono wszystkich użytkowników z dostępem do określonej usługi lub określonego konta. Jeśli zasada ma wartość false (fałsz), zwracani są 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 protokołu OAuth:

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