REST Resource: properties.audienceLists

Ressource: AudienceList

Eine Zielgruppenliste ist eine Liste der Nutzer 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. Kennung. Der Name der Zielgruppenlistenressource, 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 identifiziert die aufgeführte Zielgruppe und wird von der Analytics Data API und der Admin API gemeinsam verwendet.

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

string

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

object (AudienceDimension)

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

integer

Nur Ausgabe. Die Gesamtzahl der Kontingent-Tokens, die beim Erstellen der Zielgruppenliste in Rechnung gestellt wurden. Da diese Tokenanzahl auf Aktivitäten im Status CREATING basiert, werden diese in Rechnung gestellten Tokens festgelegt, sobald eine Zielgruppenliste den Status ACTIVE oder FAILED erreicht.
state

enum (State)

Nur Ausgabe. Der aktuelle Status dieser Zielgruppenliste.
beginCreatingTime

string (Timestamp format)

Nur Ausgabe. Die Zeit, zu der „audienceLists.create“ aufgerufen wurde und die Zielgruppenliste den Status CREATING erhielt.

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 Ergebnis „Zielgruppenliste“.
errorMessage

string

Nur Ausgabe. Diese Fehlermeldung wird angezeigt, wenn beim Erstellen einer Zielgruppenliste ein Fehler auftritt. Eine häufige Ursache für einen solchen Fehler ist das Erreichen des Kontingents.
percentageCompleted

number

Nur Ausgabe. Der Prozentsatz des abgeschlossenen Exportes dieser Zielgruppe, der zwischen 0 und 100 liegt.
recurringAudienceList

string

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

Wenn Zielgruppenlisten direkt erstellt werden, ist dieses Feld leer, da sie keine wiederkehrende Zielgruppenliste haben.
webhookNotification

object (WebhookNotification)

Optional. Hiermit werden Webhook-Benachrichtigungen konfiguriert, die von der Google Analytics Data API an Ihren Webhook-Server gesendet werden. Die Verwendung von Webhooks ist optional. Wenn die Funktion nicht verwendet wird, müssen Sie diese API abfragen, um festzustellen, wann eine Zielgruppenliste einsatzbereit ist. Mit Webhooks kann eine Benachrichtigung an Ihre Server gesendet werden, sodass keine Abfragen erforderlich sind.

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

Wenn identische Zielgruppenlisten in schneller Folge angefordert werden, können die zweite und nachfolgenden Zielgruppenlisten aus dem Cache ausgeliefert 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 Zielgruppenliste befindet sich derzeit in diesem Status.

Enums
STATE_UNSPECIFIED Der Status „Nicht angegeben“ wird nie verwendet.
CREATING Die Zielgruppenliste wird derzeit erstellt und ist in Zukunft verfügbar. Die Erstellung erfolgt unmittelbar nach dem Aufruf von „audienceLists.create“.
ACTIVE Die Zielgruppenliste ist vollständig erstellt und kann abgefragt werden. Eine Zielgruppenliste wird asynchron über eine Anfrage auf „aktiv“ gesetzt. Das geschieht einige Zeit (z. B. 15 Minuten) nach dem ursprünglichen Erstellungsaufruf.
FAILED Die Zielgruppenliste konnte nicht erstellt werden. Möglicherweise ist die Anfrage dieser Zielgruppenliste beim nächsten Mal erfolgreich.

Methoden

create

 Erstellt eine Zielgruppenliste für den späteren Abruf.

exportSheet

 Eine Zielgruppenliste mit Nutzern wird in eine Google-Tabelle exportiert.

get

 Ruft Konfigurationsmetadaten zu einer bestimmten Zielgruppenliste ab.

list

 Listet alle Zielgruppenlisten für eine Property auf.

query

 Ruft eine Zielgruppenliste mit Nutzern ab.