Method: properties.runAccessReport

Hiermit wird ein benutzerdefinierter Bericht mit Datenzugriffsdatensätzen zurückgegeben. Der Bericht enthält Einträge für jede Lesevorgang von Google Analytics-Berichtsdaten. Zugriffsdaten werden bis zu zwei Jahre lang aufbewahrt.

Berichte zum Datenzugriff 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 GA UI-Berichte, GA UI-Expl. Datenanalyse, GA Data API und andere Produkte wie Firebase und AdMob, die Daten über eine Verknüpfung aus Google Analytics abrufen können. Diese Einträge umfassen 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.

Wenn Sie Feedback zu dieser API geben möchten, füllen Sie bitte das Feedback-Formular zu Google Analytics Access Reports aus.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
entity

string

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

Wenn Sie eine Anfrage auf Property-Ebene stellen möchten, sollte das Entitätselement beispielsweise „properties/123“ lauten, wobei „123“ die ID Ihrer Google Analytics-Property ist. Wenn Sie die Daten auf Kontoebene anfordern möchten, sollte das Entitätsobjekt beispielsweise „accounts/1234“ sein, wenn „1234“ die Google Analytics-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 dürfen bis zu 9 Dimensionen enthalten.

metrics[]

object (AccessMetric)

Die angeforderten und in der Antwort angezeigten Messwerte. Anfragen dürfen bis zu 10 Messwerte enthalten.

dateRanges[]

object (AccessDateRange)

Zeiträume der Zugriffsdatensätze, die gelesen werden sollen. Wenn mehrere Zeiträume angefordert werden, enthält jede Antwortzeile einen Index für den Zeitraum, der auf null basiert. Wenn sich zwei Zeiträume überschneiden, werden die Zugriffsdaten für die überschneidenden Tage in den Antwortzeilen für beide Zeiträume berücksichtigt. Es sind bis zu zwei Zeiträume zulässig.

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 angewendet, nachdem die Zeilen des Berichts zusammengefasst wurden, ähnlich wie die SQL-Bedingung „having“. 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 keine Angabe gemacht wird, werden 10.000 Zeilen zurückgegeben. Die API gibt maximal 100.000 Zeilen pro Anfrage zurück,unabhängig davon, wie viele 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 die limit verbleiben. Wenn für die Dimension country beispielsweise weniger als 300 mögliche Werte vorhanden sind, können Sie in Berichten, die nur country enthalten, nicht mehr als 300 Zeilen erhalten, auch wenn Sie limit auf 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 keine Angabe erfolgt, wird die Zeitzone der Property 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 „falsch“ 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 einbezogen, 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. Bestimmt, ob die Nutzer innerhalb von Nutzergruppen zurückgegeben werden. Dieses Feld funktioniert nur, wenn „includeAllUsers“ auf „true“ gesetzt 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