REST Resource: properties.audienceLists

Ressource: AudienceList

Eine Zielgruppenliste ist eine Liste von Nutzern in einer Zielgruppe zum Zeitpunkt der Erstellung der Liste. Für eine Zielgruppe können mehrere Zielgruppenlisten für verschiedene Tage 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 Name der Zielgruppenlistenressource, der bei der Erstellung zugewiesen wurde. Dieser Ressourcenname identifiziert diese AudienceList.

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

string

Erforderlich. Der Ressourcenname der Zielgruppe. Mit diesem Ressourcennamen wird die Zielgruppe identifiziert, die aufgeführt wird. Er 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 in der Abfrageantwort angeforderten und angezeigten Dimensionen.
creationQuotaTokensCharged

integer

Nur Ausgabe. Die Gesamtzahl der Kontingent-Tokens, die bei der Erstellung der AudienceList berechnet wurden. Da diese Anzahl von Tokens auf Aktivitäten im Status CREATING basiert, ist die Anzahl der berechneten Tokens festgelegt, sobald eine AudienceList den Status ACTIVE oder FAILED erreicht.
state

enum (State)

Nur Ausgabe. Der aktuelle Status dieser AudienceList.
beginCreatingTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem „audienceLists.create“ aufgerufen wurde und die AudienceList den Status CREATING erreicht hat.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich 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 AudienceList-Ergebnis.
errorMessage

string

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

number

Nur Ausgabe. Der Prozentsatz des Zielgruppenexports, der abgeschlossen wurde. Der Wert liegt zwischen 0 und 100.
recurringAudienceList

string

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

Wenn Zielgruppenlisten direkt erstellt werden, ist keine wiederkehrende Zielgruppenliste zugeordnet und dieses Feld ist leer.
webhookNotification

object (WebhookNotification)

Optional. Konfiguriert Webhook-Benachrichtigungen, die von der Google Analytics Data API an Ihren Webhook-Server gesendet werden. Die Verwendung von Webhooks ist optional. Wenn sie nicht verwendet wird, müssen Sie diese API regelmäßig abfragen, um festzustellen, wann eine Zielgruppenliste verwendet werden kann. Webhooks ermöglichen es, eine Benachrichtigung an Ihre Server zu senden, sodass kein Polling erforderlich ist.

Es werden entweder eine oder zwei POST-Anfragen an den Webhook gesendet. Die erste POST-Anfrage wird sofort gesendet und die neu erstellte Zielgruppenliste wird im Status CREATING angezeigt. Die zweite POST-Anfrage wird gesendet, nachdem die Zielgruppenliste erstellt wurde (entweder im Status „AKTIV“ oder „FEHLGESCHLAGEN“).

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

Status

Die AudienceList ist derzeit in diesem Status.

Enums
STATE_UNSPECIFIED Der nicht angegebene Status wird nie verwendet.
CREATING Die AudienceList wird gerade erstellt und ist in Zukunft verfügbar. Die Erstellung erfolgt unmittelbar nach dem Aufruf von audienceLists.create.
ACTIVE Die AudienceList wurde vollständig erstellt und kann abgefragt werden. Eine AudienceList wird asynchron über eine Anfrage auf „Aktiv“ aktualisiert. Dies geschieht einige Zeit (z. B. 15 Minuten) nach dem ursprünglichen Erstellungsaufruf.
FAILED Die Zielgruppenliste konnte nicht erstellt werden. Möglicherweise ist die erneute Anfrage für diese Zielgruppenliste erfolgreich.

Methoden

create

 Erstellt eine Zielgruppenliste, die später abgerufen werden kann.

get

 Ruft Konfigurationsmetadaten zu einer bestimmten Zielgruppenliste ab.

list

 Listet alle Zielgruppenlisten für eine Property auf.

query

 Ruft eine Zielgruppenliste mit Nutzern ab.