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 Datenzugriffsdatensätzen zurück. Im Bericht wird jedes Mal erfasst, wenn ein Nutzer Google Analytics-Berichtsdaten liest. Zugriffsdatensätze werden bis zu 2 Jahre aufbewahrt.

Datenzugriffsberichte können für eine Property angefordert werden. Die Property muss sich in Google Analytics 360 befinden. Diese Methode ist nur für Administratoren verfügbar.

Zu diesen Datenzugriffsdatensätzen 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 aus Google Analytics über eine Verknüpfung abgerufen werden können. Diese Datensätze 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/v1alpha/{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 angefordert werden. Wenn sie auf Kontoebene angefordert werden, enthalten Datenzugriffsberichte alle Zugriffsrechte für alle Properties in diesem Konto. Bei Anfragen auf Property-Ebene sollte die Entität z. B. „properties/123“ sein, wenn Ihre GA4-Property-ID „123“ ist. Für eine Anfrage auf Kontoebene muss 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 angefordert werden. Wenn sie auf Kontoebene angefordert werden, enthalten Datenzugriffsberichte alle Zugriffsrechte für alle Properties in diesem Konto.

Bei Anfragen auf Property-Ebene sollte die Entität z. B. „properties/123“ sein, wenn Ihre GA4-Property-ID „123“ ist. Für eine Anfrage auf Kontoebene muss 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 Dimensionen, die in der Antwort angefordert und angezeigt werden. 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)` Datumsbereiche 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 enthalten. 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 dem Filter entsprechen. Beispiel: Filterung nach Zugriffseinträgen 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 Aggregieren der Berichtszeilen angewendet, ähnlich wie bei SQL-Klauseln. 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 Offset 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 angefordert werden. `limit` muss positiv sein. Die API gibt möglicherweise weniger Zeilen als die angeforderten `limit` zurück, wenn nicht so viele Zeilen wie `limit` übrig sind. Für die Dimension "`country`" sind beispielsweise weniger als 300 Werte möglich. Wenn Sie also nur einen Bericht für "`country`" erstellen, können Sie nicht mehr als 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 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 IANA-Zeitzonendatenbank (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 angeordnet 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 in diesem Feld der Wert „false“ festgelegt 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 einbezogen, unabhängig davon, ob sie einen API-Aufruf getätigt haben oder nicht. Bei „false“ werden nur Nutzer berücksichtigt, die einen API-Aufruf getätigt haben.
`expandGroups`	`boolean` Optional. Legt fest, ob die User innerhalb von User-Gruppen 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