REST Resource: properties.audienceLists

Ressource: AudienceList

Eine Zielgruppenliste ist eine Liste von Nutzern, die zum Zeitpunkt der Erstellung in einer Zielgruppe enthalten sind. Für eine Zielgruppe können mehrere Zielgruppenlisten an verschiedenen Tagen erstellt werden.

JSON-Darstellung 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
Felder
name

string

Nur Ausgabe. ID. Der Ressourcenname der Zielgruppenliste, der bei der Erstellung zugewiesen wurde. Dieser Ressourcenname identifiziert diese AudienceList.

Format: properties/{property}/audienceLists/{audienceList}
audience

string

Erforderlich. Der Name der Zielgruppenressource. Dieser Ressourcenname kennzeichnet die aufgeführte Zielgruppe und wird von den Analytics Data & Admin APIs gemeinsam verwendet.

Format: properties/{property}/audiences/{audience}
audienceDisplayName

string

Nur Ausgabe. Der beschreibende Anzeigename für diese Zielgruppe. Beispiel: „Käufer“.
dimensions[]

object (AudienceDimension)

Erforderlich. Die Dimensionen, die in der Abfrageantwort angefordert und angezeigt werden.
creationQuotaTokensCharged

integer

Nur Ausgabe. Die Gesamtzahl der Kontingenttokens, die beim Erstellen der Zielgruppenliste in Rechnung gestellt werden. Da die Anzahl der Tokens auf Aktivitäten aus dem Status „CREATING“ basiert, werden die Kosten für diese Tokens festgelegt, sobald eine Zielgruppenliste den Status ACTIVE oder FAILED erhält.
state

enum (State)

Nur Ausgabe. Der aktuelle Status für diese Zielgruppenliste.
beginCreatingTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem „audienceLists.create“ aufgerufen wurde und die Zielgruppenlisten den Status CREATING hatten.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
rowCount

integer

Nur Ausgabe. Die Gesamtzahl der Zeilen im Zielgruppenlisten-Ergebnis.
errorMessage

string

Nur Ausgabe. Eine Fehlermeldung wird eingefügt, wenn beim Erstellen einer Zielgruppenliste ein Fehler auftritt. Ein häufiger Grund für solch einen Fehler ist die Erschöpfung des Kontingents.
percentageCompleted

number

Nur Ausgabe. Der für diesen Zielgruppenexport abgeschlossene Prozentsatz zwischen 0 und 100.
recurringAudienceList

string

Nur Ausgabe. Die wiederkehrende Zielgruppenliste, von der diese Zielgruppenliste erstellt wurde. Mit wiederkehrenden Zielgruppenlisten werden täglich Zielgruppenlisten erstellt.

Wenn Zielgruppenlisten direkt erstellt werden, ist keine wiederkehrende Zielgruppenliste verknüpft. Das Feld ist dann leer.
webhookNotification

object (WebhookNotification)

Optional. Mit dieser Richtlinie werden Webhook-Benachrichtigungen konfiguriert, 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 kann eine Benachrichtigung an Ihre Server gesendet werden, sodass keine Abfragen erforderlich sind.

Eine oder zwei POST-Anfragen werden an den Webhook gesendet. Die erste POST-Anfrage wird sofort mit der neu erstellten Zielgruppenliste im Status CREATING gesendet. Die zweite POST-Anfrage wird gesendet, nachdem die Erstellung der Zielgruppenliste abgeschlossen ist (mit dem Status AKTIV oder FEHLGESCHLAGEN).

Wenn identische Zielgruppenlisten schnell hintereinander angefordert werden, können die zweite und nachfolgende Zielgruppenlisten aus dem Cache bereitgestellt werden. In diesem Fall kann über die Methode zum Erstellen von Zielgruppenlisten eine Zielgruppenliste zurückgegeben werden, die bereits AKTIV ist. In diesem Szenario wird nur eine POST-Anfrage an den Webhook gesendet.

Status

Die Zielgruppenliste ist derzeit mit diesem Status vorhanden.

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 Zielgruppenlisten sind vollständig erstellt und können abgefragt werden. Eine Zielgruppenliste wird über eine Anfrage asynchron so aktualisiert, dass sie aktiv ist. Dies erfolgt einige Zeit (z. B. 15 Minuten) nach dem ersten Erstellungsaufruf.
FAILED Die Zielgruppenliste konnte nicht erstellt werden. Möglicherweise können Sie diese Zielgruppenliste noch einmal anfordern.

Methoden

create

 Erstellt eine Zielgruppenliste zum späteren Abrufen

exportSheet

 Exportiert eine Zielgruppenliste mit Nutzern in eine Google-Tabelle.

get

 Ruft Konfigurationsmetadaten zu einer bestimmten Zielgruppenliste ab.

list

 Listet alle Zielgruppenlisten für eine Property auf.

query

 Ruft eine Zielgruppenliste mit Nutzern ab.