Diese Seite wurde von der Cloud Translation API übersetzt.

Method: properties.runAccessReport

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

Hiermit wird ein benutzerdefinierter Bericht mit Datenzugriffsdatensätzen zurückgegeben. Der Bericht zeichnet jedes Mal auf, wenn ein Nutzer Google Analytics-Berichtsdaten liest. Zugriffsdaten werden bis zu zwei Jahre lang aufbewahrt.

Datenzugriffsberichte können für eine Property angefordert werden. Berichte können für jede Property angefordert werden. Dimensionen, die nicht mit dem Kontingent zusammenhängen, können jedoch nur für Google Analytics 360-Properties angefordert werden. Diese Methode ist nur für Administratoren verfügbar.

Zu diesen Datenzugriffssätzen gehören GA4-UI-Berichte, GA4-UI-Expl. Datenanalyse, GA4 Data API und andere Produkte wie Firebase und AdMob, die Daten über eine Verknüpfung aus Google Analytics abrufen 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. Informationen zum Konfigurationsänderungsverlauf 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` Der Bericht zum Datenzugriff unterstützt Anfragen auf Property- oder Kontoebene. Wenn Datenzugriffsberichte auf Kontoebene angefordert werden, enthalten sie den Zugriff für alle Properties in diesem Konto. Wenn Sie eine Anfrage auf Property-Ebene stellen möchten, sollte die Entität beispielsweise „properties/123“ lauten, wenn „123“ die GA4-Property-ID ist. Wenn Sie eine Anfrage auf Kontoebene stellen möchten, sollte die Entität beispielsweise „accounts/1234“ lauten, wenn „1234“ Ihre GA4-Konto-ID ist.

entity

string

Der Bericht zum Datenzugriff unterstützt Anfragen auf Property- oder Kontoebene. Wenn Datenzugriffsberichte auf Kontoebene angefordert werden, enthalten sie den Zugriff für alle Properties in diesem Konto.

Wenn Sie eine Anfrage auf Property-Ebene stellen möchten, sollte die Entität beispielsweise „properties/123“ lauten, wenn „123“ die GA4-Property-ID ist. Wenn Sie eine Anfrage auf Kontoebene stellen möchten, sollte die Entität beispielsweise „accounts/1234“ lauten, 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. Anfragen dürfen bis zu 9 Dimensionen enthalten.
`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, werden die Zugriffsdaten für die überschneidenden Tage in den Antwortzeilen für beide Zeiträume berücksichtigt. Anfragen können aus maximal zwei Zeiträumen bestehen.
`dimensionFilter`	`object (AccessFilterExpression)` Mit Dimensionsfiltern können Sie die Berichtsantwort auf bestimmte Dimensionswerte beschränken, die mit dem Filter übereinstimmen. Beispiel: Filtern nach Zugriffsdatensätzen eines einzelnen Nutzers. 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 Berichtsantwort auf bestimmte Messwertwerte beschränken, die mit dem Filter übereinstimmen. Messwertfilter werden nach dem Aggregieren der Zeilen des Berichts angewendet, ähnlich wie bei der SQL-SQL-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 Parameter für die Paginierung 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 wie die `limit` verbleiben. 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 Parameter für die Paginierung 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 verwendet, um die Start- und Enddaten 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 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. Bestimmt, ob Nutzer, die noch nie einen API-Aufruf getätigt haben, in die Antwort eingeschlossen werden. Wenn „true“ festgelegt ist, 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. Wenn „false“ festgelegt ist, werden nur die Nutzer berücksichtigt, 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. Wenn „true“ festgelegt ist, werden alle Nutzer zurückgegeben, die Zugriff auf die angegebene Property oder das angegebene Konto haben. Wenn „false“ festgelegt ist, 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