REST Resource: properties.audienceExports

Ressource: AudienceExport

Ein Zielgruppenexport ist eine Liste von Nutzern 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. ID. Der Ressourcenname für den Zielgruppenexport, der bei der Erstellung zugewiesen wurde. Dieser Ressourcenname identifiziert diese AudienceExport.

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

string

Erforderlich. Der Name der Zielgruppenressource. Mit diesem Ressourcennamen wird die Zielgruppe identifiziert, die aufgeführt wird. Er wird von den Analytics Data API und 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 in der Abfrageantwort angeforderten und angezeigten Dimensionen.
creationQuotaTokensCharged

integer

Nur Ausgabe. Die Gesamtzahl der Kontingent-Tokens, die während der Erstellung des AudienceExport berechnet wurden. Da diese Tokenanzahl auf Aktivitäten im Status CREATING basiert, sind die in Rechnung gestellten Tokens festgelegt, sobald ein AudienceExport in den Status ACTIVE oder FAILED wechselt.
state

enum (State)

Nur Ausgabe. Der aktuelle Status dieses AudienceExport.
beginCreatingTime

string (Timestamp format)

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

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
rowCount

integer

Nur Ausgabe. Die Gesamtzahl der Zeilen im AudienceExport-Ergebnis.
errorMessage

string

Nur Ausgabe. Eine Fehlermeldung wird angezeigt, wenn ein Zielgruppenexport während der Erstellung fehlschlägt. 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.

AudienceDimension

Eine Zielgruppendimension ist ein Nutzerattribut. Bestimmte Nutzerattribute werden angefordert und später in 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.

Bundesland

Der AudienceExport befindet sich derzeit in diesem Status.

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

Methoden

create

 Erstellt einen Zielgruppenexport, 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.