- Ressource: AudienceList
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Bundesland
- Methoden
Ressource: AudienceList
Eine Zielgruppenliste ist eine Liste der Nutzer, die sich zum Zeitpunkt ihrer Erstellung in einer Zielgruppe befanden. Für eine Zielgruppe können mehrere Zielgruppenlisten für verschiedene Tage erstellt worden sein.
JSON-Darstellung |
---|
{ "name": string, "audience": string, "audienceDisplayName": string, "dimensions": [ { object ( |
Felder | |
---|---|
name |
Nur Ausgabe. Kennung. Der Ressourcenname der Zielgruppenliste, der bei der Erstellung zugewiesen wurde. Dieser Ressourcenname identifiziert dieses Format: |
audience |
Erforderlich. Der Name der Zielgruppenressource. Dieser Ressourcenname kennzeichnet die aufgelistete Zielgruppe und wird zwischen den Analytics-Daten und Admin-APIs. Format: |
audienceDisplayName |
Nur Ausgabe. Der beschreibende Anzeigename für diese Zielgruppe. Beispiel: „Käufer“. |
dimensions[] |
Erforderlich. Die angeforderten und in der Abfrageantwort angezeigten Dimensionen. |
creationQuotaTokensCharged |
Nur Ausgabe. Die gesamten Kontingenttokens, die beim Erstellen der Zielgruppenliste in Rechnung gestellt werden. Da diese Tokenanzahl auf Aktivitäten mit dem Status |
state |
Nur Ausgabe. Der aktuelle Status dieser Zielgruppenliste. |
beginCreatingTime |
Nur Ausgabe. Der Zeitpunkt, zu dem „audienceLists.create“ aufgerufen wurde und die Zielgruppenliste den Status Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
rowCount |
Nur Ausgabe. Die Gesamtzahl der Zeilen im Zielgruppenlisten-Ergebnis. |
errorMessage |
Nur Ausgabe. Es wird eine Fehlermeldung angezeigt, wenn beim Erstellen einer Zielgruppenliste ein Fehler auftritt. Ein häufiger Grund für einen solchen Fehler ist eine Erschöpfung des Kontingents. |
percentageCompleted |
Nur Ausgabe. Der abgeschlossene Prozentsatz für diesen Zielgruppenexport zwischen 0 und 100. |
recurringAudienceList |
Nur Ausgabe. Die wiederkehrende Zielgruppenliste, über die diese Zielgruppenliste erstellt wurde. Zielgruppenlisten werden täglich erstellt. Wenn Zielgruppenlisten direkt erstellt werden, ist keine wiederkehrende Zielgruppenliste damit verknüpft und dieses Feld ist leer. |
webhookNotification |
Optional. Konfiguriert Webhook-Benachrichtigungen, die von der Google Analytics Data API an Ihren Webhook-Server gesendet werden. Die Verwendung von Webhooks ist optional. Wird sie nicht verwendet, müssen Sie diese API abfragen, um festzustellen, wann eine Zielgruppenliste verwendet werden kann. Mit Webhooks können Benachrichtigungen an Ihre Server und ohne dass Abfragen erforderlich sind. Es werden entweder eine oder zwei POST-Anfragen an den Webhook gesendet. Die erste POST-Anfrage wird sofort gesendet. Die neu erstellte Zielgruppenliste wird im Status WIRD ERSTELLT angezeigt. Die zweite POST-Anfrage wird gesendet, nachdem die Zielgruppenliste erstellt wurde (AKTIV oder FEHLGESCHLAGEN). Wenn identische Zielgruppenlisten schnell nacheinander angefordert werden, werden die können nachfolgende Zielgruppenlisten aus dem Cache bereitgestellt werden. In diesem Fall kann mit der Methode zum Erstellen einer Zielgruppenliste zurückgegeben werden, dass eine Zielgruppenliste bereits AKTIV ist. In diesem Szenario wird nur eine POST-Anfrage an den Webhook gesendet. |
Status
Die Zielgruppenliste hat derzeit diesen Status.
Enums | |
---|---|
STATE_UNSPECIFIED |
Ein nicht angegebener Status wird nie verwendet. |
CREATING |
Die Zielgruppenliste wird derzeit erstellt und ist in Zukunft verfügbar. Die Erstellung erfolgt unmittelbar nach dem Aufruf „audienceLists.create“. |
ACTIVE |
Die Zielgruppenliste ist vollständig erstellt und kann abgefragt werden. Eine Zielgruppenliste wird asynchron über eine Anfrage in "aktiv" geändert. geschieht dies einige Zeit (zum Beispiel 15 Minuten) nach dem ersten Aufruf zum Erstellen. |
FAILED |
Die Zielgruppenliste konnte nicht erstellt werden. Möglicherweise wird diese Zielgruppenliste noch einmal angefordert. |
Methoden |
|
---|---|
|
Erstellt eine Zielgruppenliste zum späteren Abrufen. |
|
Exportiert eine Zielgruppenliste mit Nutzern in eine Google-Tabelle. |
|
Ruft Konfigurationsmetadaten zu einer bestimmten Zielgruppenliste ab. |
|
Listet alle Zielgruppenlisten für eine Property auf. |
|
Ruft eine Zielgruppenliste mit Nutzern ab. |