Method: properties.audienceLists.exportSheet

Exportiert eine Zielgruppenliste mit Nutzern in eine Google-Tabelle. Nutzer, die eine Zielgruppe erstellt haben, können nicht sofort aufgelistet werden. Zuerst ist eine Anfrage an audienceLists.create erforderlich, um eine Zielgruppenliste mit Nutzern zu erstellen. Anschließend werden die Nutzer mit dieser Methode in eine Google-Tabelle exportiert.

Eine Einführung in Zielgruppenlisten mit Beispielen finden Sie unter Zielgruppenlisten erstellen.

Mit Zielgruppen in Google Analytics 4 können Sie Ihre Nutzer so segmentieren, wie es für Sie sinnvoll ist. Weitere Informationen finden Sie unter https://support.google.com/analytics/answer/9267572.

Diese Methode wird in der Alpha-Entwicklungsphase eingeführt, um vor der Betaphase Feedback zu Syntax und Funktionen einzuholen. Wenn Sie uns Feedback zu dieser API geben möchten, füllen Sie bitte das Feedback-Formular zur Google Analytics Audience Export API aus.

HTTP-Anfrage

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:exportSheet

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Der Name der Zielgruppenliste, aus der Nutzer abgerufen werden sollen. Format: properties/{property}/audienceLists/{audienceList}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "offset": string,
  "limit": string
}
Felder
offset

string (int64 format)

Optional. Die Zeilenanzahl der Startzeile. Die erste Zeile wird als Zeile 0 gezählt.

Beim Paging wird in der ersten Anfrage kein „offset“ angegeben oder entsprechend „offset“ auf 0. Die erste Anfrage gibt die erste limit der Zeilen zurück. Die zweite Anfrage legt „Offset“ auf den limit der ersten Anfrage fest. Die zweite Anfrage gibt die zweite limit der Zeilen zurück.

Weitere Informationen zu diesem Parameter finden Sie unter Paginierung.
limit

string (int64 format)

Optional. Die Anzahl der zurückzugebenden Zeilen. Wenn kein Wert angegeben ist, werden 10.000 Zeilen zurückgegeben. Die API gibt maximal 250.000 Zeilen pro Anfrage zurück,unabhängig davon, wie viele Zeilen Sie anfordern. limit muss positiv sein.

Die API kann auch weniger Zeilen als vom angeforderten limit zurückgeben, wenn nicht so viele Dimensionswerte wie limit vorhanden sind.

Weitere Informationen zu diesem Parameter finden Sie unter Paginierung.

Antworttext

Die erstellte Google-Tabelle mit der Liste der Nutzer in einer Zielgruppenliste.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "spreadsheetUri": string,
  "spreadsheetId": string,
  "rowCount": integer,
  "audienceList": {
    object (AudienceList)
  }
}
Felder
spreadsheetUri

string

Ein URI, den Sie in Ihrem Browser aufrufen können, um die Google-Tabelle anzusehen.
spreadsheetId

string

Eine ID, die die erstellte Google Tabellen-Ressource identifiziert.
rowCount

integer

Die Gesamtzahl der Zeilen im Zielgruppenlisten-Ergebnis. rowCount ist unabhängig von der Anzahl der in der Antwort zurückgegebenen Zeilen, dem Anfrageparameter limit und dem Anfrageparameter offset. Wenn eine Abfrage beispielsweise 175 Zeilen zurückgibt und die API-Anfrage für limit den Wert 50 enthält, enthält die Antwort rowCount von 175, aber nur 50 Zeilen.

Weitere Informationen zu diesem Parameter finden Sie unter Paginierung.
audienceList

object (AudienceList)

Konfigurationsdaten zur exportierten Zielgruppenlisten Wird zurückgegeben, um die Interpretation der Zielgruppenliste in der Google-Tabelle dieser Antwort zu erleichtern.

Beispiel: Die Zielgruppenlisten können mehr Zeilen enthalten, als in der Google-Tabelle vorhanden sind. In diesem Fall können Sie eine zusätzliche Anfrage zum Exportieren einer Tabelle mit einem anderen offset-Wert senden, um die nächste Seite mit Zeilen in einer zusätzlichen Google-Tabelle abzurufen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets