REST Resource: properties.audienceExports

Ressource: AudienceExport

Ein Zielgruppenexport ist eine Liste der Nutzer in einer Zielgruppe zum Zeitpunkt der Erstellung der Liste. Für eine Zielgruppe können mehrere Zielgruppenexporte 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
}
Felder
name

string

Nur Ausgabe. Kennung. Der Name der Zielgruppenexportressource, der bei der Erstellung zugewiesen wurde. Dieser Ressourcenname identifiziert diese AudienceExport.

Format: properties/{property}/audienceExports/{audienceExport}
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 des Zielgruppenexports in Anspruch genommen wurden. Da diese Tokenanzahl auf Aktivitäten im Status CREATING basiert, werden diese in Rechnung gestellten Tokens korrigiert, sobald ein AudienceExport den Status ACTIVE oder FAILED erreicht.
state

enum (State)

Nur Ausgabe. Der aktuelle Status dieses Zielgruppenexports.
beginCreatingTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der „audienceExports.create“ aufgerufen wurde und der AudienceExport 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 von „AudienceExport“.
errorMessage

string

Nur Ausgabe. Diese Fehlermeldung wird angezeigt, wenn beim Erstellen eines Zielgruppenexports 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.

AudienceDimension

Eine Zielgruppendimension ist ein Nutzerattribut. Bestimmte Nutzerattribute werden angefordert und später in der QueryAudienceExportResponse zurückgegeben.

JSON-Darstellung 
{
  "dimensionName": string
}
Felder
dimensionName

string

Optional. Der API-Name der Dimension. Eine Liste der Dimensionsnamen finden Sie unter API-Dimensionen.

Status

Der Zielgruppenexport befindet sich derzeit in diesem Status.

Enums
STATE_UNSPECIFIED Der Status „Nicht angegeben“ wird nie verwendet.
CREATING Der AudienceExport wird derzeit erstellt und ist in Zukunft verfügbar. Die Erstellung erfolgt unmittelbar nach dem Aufruf von „audienceExports.create“.
ACTIVE Der AudienceExport ist vollständig erstellt und kann abgefragt werden. Ein AudienceExport wird asynchron über eine Anfrage auf „aktiv“ gesetzt. Das geschieht einige Zeit (z. B. 15 Minuten) nach dem ursprünglichen Aufruf zum Erstellen.
FAILED Der AudienceExport konnte nicht erstellt werden. Möglicherweise ist der Export dieser Zielgruppe erfolgreich, wenn Sie ihn noch einmal anfordern.

Methoden

create

 Erstellt einen Zielgruppenexport für den späteren Abruf.

get

 Ruft Konfigurationsmetadaten zu einem bestimmten Zielgruppenexport ab.

list

 Listet alle Zielgruppenexporte für eine Property auf.

query

 Ruft einen Zielgruppenexport von Nutzern ab.