Method: accounts.runAccessReport

Gibt einen benutzerdefinierten Bericht mit Datenzugriffsdatensätzen zurück. Der Bericht enthält Daten dazu, wann ein Nutzer Google Analytics-Berichtsdaten liest. Zugriffsdatensätze werden bis zu zwei Jahre aufbewahrt.

Berichte zum Datenzugriff können für eine Property angefordert werden. Die Property muss sich in Google Analytics 360 befinden. Diese Methode steht nur Administratoren zur Verfügung.

Dazu gehören Berichte der GA4-Benutzeroberfläche, das explorative Analysetool der GA4-Benutzeroberfläche, die GA4 Data API und andere Produkte wie Firebase und AdMob, mit denen Daten aus Google Analytics über eine Verknüpfung abgerufen werden können. Diese Einträge enthalten keine Änderungen an der Property-Konfiguration, z. B. das Hinzufügen eines Streams oder das Ändern der Zeitzone einer Property. Den Verlauf der Konfigurationsänderungen finden Sie unter searchChangeHistoryEvents.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
entity

string

Im Bericht zum Datenzugriff können Sie Anfragen auf Property- oder Kontoebene anfordern. Wenn die Berichte auf Kontoebene angefordert werden, umfassen sie den gesamten Zugriff für alle Properties unter diesem Konto.

Für eine Anfrage auf Property-Ebene muss die Entität z. B. „properties/123“ lauten, wenn „123“ Ihre GA4-Property-ID ist. Für eine Anfrage auf Kontoebene sollte die Entität z. B. „accounts/1234“ lauten, wenn „1234“ Ihre GA4-Konto-ID ist.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "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
}
Felder
dimensions[]

object (AccessDimension)

Die angeforderten und in der Antwort angezeigten Dimensionen. Anfragen sind mit bis zu neun Dimensionen zulässig.

metrics[]

object (AccessMetric)

Die angeforderten und in der Antwort angezeigten Messwerte. Anfragen sind für bis zu zehn Messwerte zulässig.

dateRanges[]

object (AccessDateRange)

Zeiträume der zu lesenden Zugriffsdatensätze. Wenn mehrere Zeiträume angefordert werden, enthält jede Antwortzeile einen nullbasierten Zeitraumindex. Wenn sich zwei Zeiträume überschneiden, werden die Zugriffseinträge für die sich überschneidenden Tage in den Antwortzeilen für beide Zeiträume enthalten. Anfragen sind für bis zu zwei Zeiträume zulässig.

dimensionFilter

object (AccessFilterExpression)

Mit Dimensionsfiltern können Sie die Berichtsantwort auf bestimmte Dimensionswerte beschränken, die dem Filter entsprechen. Beispiel: Filtern nach Zugriffsdatensätzen eines einzelnen Nutzers. Weitere Beispiele finden Sie unter Grundlagen von Dimensionsfiltern. Messwerte können in diesem Filter nicht verwendet werden.

metricFilter

object (AccessFilterExpression)

Mit Messwertfiltern können Sie die Berichtsantwort auf bestimmte Messwerte beschränken, die dem Filter entsprechen. Messwertfilter werden nach dem Zusammenführen der Berichtszeilen angewendet, ähnlich wie bei SQL mit Klausel. Dimensionen können in diesem Filter nicht verwendet werden.

offset

string (int64 format)

Die Zeilenanzahl der Startzeile. Die erste Zeile wird als Zeile 0 gezählt. Wenn kein Offset angegeben ist, wird er als 0 behandelt. Wenn der Offset null ist, gibt diese Methode die erste Ergebnisseite mit limit-Einträgen zurück.

Weitere Informationen zu diesem Paginierungsparameter finden Sie unter Paginierung.

limit

string (int64 format)

Die Anzahl der zurückzugebenden Zeilen. Wenn kein Wert angegeben ist, werden 10.000 Zeilen zurückgegeben. Die API gibt maximal 100.000 Zeilen pro Anfrage zurück,unabhängig davon, wie viele Zeilen Sie anfordern. limit muss positiv sein.

Die API gibt möglicherweise weniger Zeilen als die angeforderte limit zurück, wenn nicht so viele Zeilen wie limit übrig sind. Beispielsweise gibt es weniger als 300 mögliche Werte für die Dimension „country“. Wenn Sie einen Bericht nur für country erstellen, können Sie also nicht mehr als 300 Zeilen erhalten, selbst wenn Sie für limit einen höheren Wert festlegen.

Weitere Informationen zu diesem Paginierungsparameter finden Sie unter Paginierung.

timeZone

string

Die Zeitzone dieser Anfrage, falls angegeben. Wenn keine Vorgabe erfolgt, wird die Zeitzone des Attributs verwendet. Die Zeitzone der Anfrage wird verwendet, um das Start- und Enddatum des Berichts zu interpretieren.

Als Strings aus der Zeitzonendatenbank der IANA (https://www.iana.org/time-zones) formatiert, z. B. „America/New_York“ oder „Asia/Tokyo“.

orderBys[]

object (AccessOrderBy)

Gibt an, wie Zeilen in der Antwort sortiert werden.

returnEntityQuota

boolean

Gibt an, ob der aktuelle Status des Kontingents dieser Analytics-Property zurückgegeben werden soll. Das Kontingent wird in AccessQuota zurückgegeben. Bei Anfragen auf Kontoebene muss dieses Feld auf „false“ gesetzt sein.

includeAllUsers

boolean

Optional. Legt fest, ob Nutzer, die noch nie einen API-Aufruf getätigt haben, in die Antwort einbezogen werden. Bei „true“ werden alle Nutzer mit Zugriff auf die angegebene Property oder das angegebene Konto in die Antwort einbezogen, unabhängig davon, ob sie einen API-Aufruf getätigt haben oder nicht. Bei „false“ werden nur die Nutzer berücksichtigt, die einen API-Aufruf getätigt haben.

expandGroups

boolean

Optional. Legt fest, ob die Nutzer innerhalb von Nutzergruppen zurückgegeben werden. Dieses Feld funktioniert nur, wenn includeAllUsers auf „true“ gesetzt ist. Bei „true“ werden alle Nutzer mit Zugriff auf die angegebene Property oder das angegebene Konto zurückgegeben. Bei „false“ werden nur Nutzer mit direktem Zugriff zurückgegeben.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von RunAccessReportResponse.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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