REST Resource: properties.audienceExports

Ressource: AudienceExport

Bei einem 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 worden sein.

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 für den Zielgruppenexport, der bei der Erstellung zugewiesen wurde. Dieser Ressourcenname identifiziert dieses AudienceExport.

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

string

Erforderlich. Der Name der Zielgruppenressource. Dieser Ressourcenname kennzeichnet die aufgelistete Zielgruppe und wird zwischen den Analytics-Daten und Admin-APIs.

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

string

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

object (AudienceDimension)

Erforderlich. Die angeforderten und in der Abfrageantwort angezeigten Dimensionen.
creationQuotaTokensCharged

integer

Nur Ausgabe. Die gesamten Kontingenttokens, die während der Erstellung von AudienceExport berechnet wurden. Da diese Token-Anzahl auf Aktivitäten mit dem Status CREATING basiert, werden die in Rechnung gestellten Tokens korrigiert, sobald ein AudienceExport in den Bundesstaat ACTIVE oder FAILED übergeht.
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 der AudienceExport-Status den Status CREATING hatte.

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

string

Nur Ausgabe. Es wird eine Fehlermeldung angezeigt, wenn der Zielgruppenexport bei der Erstellung fehlschlägt. Ein häufiger Grund für einen solchen Fehler ist eine Erschöpfung des Kontingents.
percentageCompleted

number

Nur Ausgabe. Der abgeschlossene Prozentsatz für diesen Zielgruppenexport 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 befindet sich derzeit in diesem Status.

Enums
STATE_UNSPECIFIED Ein nicht angegebener Status wird nie verwendet.
CREATING Der AudienceExport wird derzeit erstellt und ist in Zukunft verfügbar. Die Erstellung erfolgt unmittelbar nach dem Aufruf „audienceExports.create“.
ACTIVE Der AudienceExport ist vollständig erstellt und kann abgefragt werden. Ein AudienceExport wird asynchron über eine Anfrage in einen aktiven Status aktualisiert. geschieht dies einige Zeit (zum Beispiel 15 Minuten) nach dem ersten Aufruf zum Erstellen.
FAILED Der AudienceExport konnte nicht erstellt werden. Möglicherweise gelingt es Ihnen, diesen Zielgruppenexport noch einmal anzufordern.

Methoden

create

 Erstellt einen Zielgruppenexport zum späteren Abrufen.

get

 Ruft Konfigurationsmetadaten für einen bestimmten Zielgruppenexport ab.

list

 Listet alle Zielgruppenexporte für eine Property auf.

query

 Ruft einen Zielgruppenexport von Nutzern ab.