REST Resource: properties.audienceExports

Ressource: AudienceExport

Beim Zielgruppenexport handelt es sich um eine Liste der Nutzer in einer Zielgruppe zum Zeitpunkt der Listenerstellung. 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 Ressourcenname des Zielgruppenexports, der bei der Erstellung zugewiesen wurde. Mit diesem Ressourcennamen wird diese AudienceExport identifiziert.

Format: properties/{property}/audienceExports/{audienceExport}

audience

string

Erforderlich. Der Name der Zielgruppenressource. Dieser Ressourcenname identifiziert die aufgeführte Zielgruppe. Er wird von den Analytics Data API und 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 Gesamtkontingenttokens, die beim Erstellen von AudienceExport in Rechnung gestellt wurden. Da die Tokenanzahl auf der Aktivität im Status „CREATING“ basiert, werden die berechneten Tokens korrigiert, sobald ein AudienceExport den Status ACTIVE oder FAILED erreicht.

state

enum (State)

Nur Ausgabe Der aktuelle Status für diesen AudienceExport.

beginCreatingTime

string (Timestamp format)

Nur Ausgabe Der Zeitpunkt, zu dem „audienceExports.create“ aufgerufen wurde und AudienceExport den Status CREATING begann.

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 AudienceExport-Ergebnis.

errorMessage

string

Nur Ausgabe Eine Fehlermeldung wird angezeigt, wenn beim Erstellen eines Zielgruppenexports ein Fehler auftritt. Ein häufiger Grund für solch einen Fehler ist eine Kontingentausschöpfung.

percentageCompleted

number

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

AudienceDimension

Eine Zielgruppendimension ist ein Nutzerattribut. Bestimmte zugeordnete Nutzer werden angefordert und später im 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 AudienceExport ist derzeit in diesem Status vorhanden.

Enums
STATE_UNSPECIFIED Ein nicht angegebener Status wird nie verwendet.
CREATING Der Zielgruppenexport wird gerade erstellt und ist auch in Zukunft verfügbar. Die Erstellung erfolgt unmittelbar nach dem Aufruf vonaudienceExports.create.
ACTIVE AudienceExport ist vollständig erstellt und kann abgefragt werden. AudienceExport wird über eine Anfrage so aktualisiert, dass er asynchron aktiv ist. Dies erfolgt einige Zeit (z. B. 15 Minuten) nach dem ersten Erstellungsaufruf.
FAILED Der AudienceExport konnte nicht erstellt werden. Unter Umständen können Sie diesen Zielgruppenexport noch einmal anfordern.

Methoden

create

Es wird ein Zielgruppenexport erstellt, der später abgerufen werden kann.

get

Ruft Konfigurationsmetadaten zu einem bestimmten Zielgruppenexport ab.

list

Listet alle Zielgruppenexporte für eine Property auf.

query

Ruft einen Zielgruppenexport von Nutzern ab.