Diese Seite wurde von der Cloud Translation API übersetzt.

Method: properties.runAccessReport

HTTP-Anfrage
Pfadparameter
Anfragetext
- JSON-Darstellung
Antworttext
Autorisierungsbereiche
Testen!

Gibt einen benutzerdefinierten Bericht mit Datensätzen für den Datenzugriff zurück. Der Bericht enthält Daten zu jedem Abrufen von Google Analytics-Berichtsdaten durch einen Nutzer. Zugriffsdatensätze werden bis zu 2 Jahre aufbewahrt.

Berichte zum Datenzugriff können für eine Property angefordert werden. Berichte können für jede Property angefordert werden. Dimensionen, die sich nicht auf das Kontingent beziehen, können hingegen nur für Google Analytics 360-Properties angefordert werden. Diese Methode steht nur Administratoren zur Verfügung.

Dazu gehören Berichte in 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 über eine Verknüpfung aus Google Analytics abgerufen werden können. Änderungen an der Property-Konfiguration, z. B. das Hinzufügen eines Streams oder das Ändern der Zeitzone einer Property, sind darin nicht enthalten. Den Verlauf der Konfigurationsänderungen finden Sie unter searchChangeHistoryEvents.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter

Parameter
`entity`	`string` Im Bericht zum Datenzugriff können Anfragen auf Property- oder Kontoebene erstellt werden. Falls die Berichte auf Kontoebene angefordert werden, enthalten sie den gesamten Zugriff für alle Properties unter diesem Konto. Für Anfragen auf Property-Ebene sollte die Entität z. B. „Properties/123“ sein, wenn „123“ Ihre GA4-Property-ID ist. Für Anfragen auf Kontoebene sollte die Entität z. B. „accounts/1234“ sein, wenn „1234“ Ihre GA4-Konto-ID ist.

entity

string

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

Für Anfragen auf Property-Ebene sollte die Entität z. B. „Properties/123“ sein, wenn „123“ Ihre GA4-Property-ID ist. Für Anfragen auf Kontoebene sollte die Entität z. B. „accounts/1234“ sein, wenn „1234“ Ihre GA4-Konto-ID ist.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung

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 }

{
  "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. Für Anfragen sind bis zu neun Dimensionen zulässig.
`metrics[]`	`object (AccessMetric)` Die angeforderten und in der Antwort angezeigten Messwerte. Anfragen sind bis zu 10 Messwerte zulässig.
`dateRanges[]`	`object (AccessDateRange)` Zeiträume der zu lesenden Zugriffseinträge. 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 aufgeführt. Anfragen sind für bis zu zwei Zeiträume zulässig.
`dimensionFilter`	`object (AccessFilterExpression)` Mit Dimensionsfiltern können Sie Antworten in Berichten auf bestimmte Dimensionswerte beschränken, die mit dem Filter übereinstimmen. Beispiel: Das 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 Antwort auf Berichte auf bestimmte Messwerte beschränken, die dem Filter entsprechen. Messwertfilter werden nach dem Zusammenführen der Berichtszeilen angewendet, ähnlich wie bei SQL mit Klausel. In diesem Filter können keine Dimensionen verwendet werden.
`offset`	`string (int64 format)` Die Zeilenanzahl der Startzeile. Die erste Zeile wird als Zeile 0 gezählt. Wenn „offset“ nicht angegeben ist, wird es als 0 behandelt. Wenn der Versatz null ist, gibt diese Methode die erste Seite der Ergebnisse mit `limit`-Einträgen zurück. Weitere Informationen zu diesem Parameter 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 angeforderten `limit` zurück, wenn nicht so viele Zeilen wie `limit` vorhanden sind. Wenn beispielsweise für die Dimension „`country`“ weniger als 300 Werte möglich sind, können Sie bei Berichten nur für `country` maximal 300 Zeilen erhalten, selbst wenn Sie für `limit` einen höheren Wert festlegen. Weitere Informationen zu diesem Parameter finden Sie unter Paginierung.
`timeZone`	`string` Die Zeitzone der Anfrage, falls angegeben. Wenn keine Angabe gemacht wird, wird die Zeitzone der Property verwendet. Die Zeitzone der Anfrage wird verwendet, um das Start- und Enddatum des Berichts zu interpretieren. Formatiert als Strings aus der Zeitzonendatenbank der IANA (https://www.iana.org/time-zones), 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 das Feld auf „false“ gesetzt sein.
`includeAllUsers`	`boolean` Optional. Legt fest, ob Nutzer, die noch nie einen API-Aufruf getätigt haben, in die Antwort aufgenommen werden. Bei „true“ werden alle Nutzer mit Zugriff auf die angegebene Property oder das angegebene Konto in die Antwort aufgenommen, 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 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