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 über Datenzugriffsdatensätze zurück. Der Bericht zeichnet jedes Mal auf, wenn ein Nutzer Google Analytics-Berichtsdaten liest. Zugriffsdatensätze werden bis zu 2 Jahre lang aufbewahrt.

Datenzugriffsberichte 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 jedoch nur für Google Analytics 360-Properties angefordert werden. Diese Methode ist nur für Administratoren verfügbar.

Zu diesen Datenzugriffsdatensätzen gehören GA4-UI-Berichte, explorative Datenanalysen in GA4, die GA4 Data API sowie andere Produkte wie Firebase und AdMob, das über eine Verknüpfung Daten aus Google Analytics abrufen kann Diese Einträge enthalten keine Änderungen an der Property-Konfiguration wie das Hinzufügen eines Streams oder das Ändern der Zeitzone einer Property. Informationen zum Änderungsverlauf der Konfiguration 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` Der Bericht zum Datenzugriff unterstützt Anfragen auf Property- oder Kontoebene. Auf Kontoebene umfassen Datenzugriffsberichte sämtliche Zugriffsrechte für alle Properties unter diesem Konto. Für eine Anfrage auf Property-Ebene sollte die Entität beispielsweise „properties/123“ sein. wenn „123“ ist die ID Ihrer GA4-Property. Wenn Sie eine Anfrage auf Kontoebene stellen möchten, sollte die Entität beispielsweise „accounts/1234“ lauten. wenn „1234“ ist Ihre GA4-Konto-ID.

entity

string

Der Bericht zum Datenzugriff unterstützt Anfragen auf Property- oder Kontoebene. Auf Kontoebene umfassen Datenzugriffsberichte sämtliche Zugriffsrechte für alle Properties unter diesem Konto.

Für eine Anfrage auf Property-Ebene sollte die Entität beispielsweise „properties/123“ sein. wenn „123“ ist die ID Ihrer GA4-Property. Wenn Sie eine Anfrage auf Kontoebene stellen möchten, sollte die Entität beispielsweise „accounts/1234“ lauten. wenn „1234“ ist Ihre GA4-Konto-ID.

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. Anfragen sind bis zu neun Dimensionen zulässig.
`metrics[]`	`object (AccessMetric)` Die angeforderten und in der Antwort angezeigten Messwerte. Für Anfragen sind 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, sind die Zugriffsdatensätze für die sich überschneidenden Tage in den Antwortzeilen für beide Zeiträume enthalten. Anfragen können aus maximal zwei Zeiträumen bestehen.
`dimensionFilter`	`object (AccessFilterExpression)` Mit Dimensionsfiltern können Sie Berichtsantworten auf bestimmte Dimensionswerte beschränken, die dem Filter entsprechen. Beispielsweise wird nach Zugriffsdatensätzen eines einzelnen Nutzers gefiltert. Weitere Informationen finden Sie unter Grundlagen von Dimensionsfiltern. In diesem Filter können keine Messwerte verwendet werden.
`metricFilter`	`object (AccessFilterExpression)` Mit Messwertfiltern können Sie die Antwort in Berichten auf bestimmte Messwerte beschränken, die dem Filter entsprechen. Messwertfilter werden nach dem Aggregieren der Zeilen des Berichts angewendet, ähnlich wie bei der SQL-SQL-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 der Offset nicht 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 nicht angegeben, 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 angeforderte `limit` zurück, wenn nicht so viele Zeilen übrig sind als die `limit`. Für die Dimension `country` sind beispielsweise weniger als 300 Werte möglich. Wenn Sie also nur Daten für `country` erstellen, können Sie nicht mehr als 300 Zeilen abrufen, 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 kein Wert angegeben ist, wird die Zeitzone des Attributs verwendet. Die Zeitzone der Anfrage wird für die Interpretation des Start- und Enddaten des Berichts. als Strings aus der Zeitzonendatenbank der IANA (https://www.iana.org/time-zones)) formatiert Beispiel: „America/New_York“ oder „Asien/Tokio“.
`orderBys[]`	`object (AccessOrderBy)` Gibt an, wie Zeilen in der Antwort angeordnet werden.
`returnEntityQuota`	`boolean` Mit dieser Option kann festgelegt werden, 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. Bestimmt, ob Nutzer, die noch nie einen API-Aufruf getätigt haben, in die Antwort einbezogen werden sollen. Bei Einstellung auf „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 einbezogen, die einen API-Aufruf getätigt haben.
`expandGroups`	`boolean` Optional. Entscheidet, ob die User innerhalb der User-Gruppen zurückgegeben werden. Dieses Feld funktioniert nur, wenn „includeAllUsers“ auf „true“ festgelegt ist. Bei „true“ werden alle Nutzer mit Zugriff auf die angegebene Property oder das angegebene Konto zurückgegeben. Bei „false“ werden nur die 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