REST Resource: properties.audienceExports

Zasób: AudienceExport

Eksport listy odbiorców to lista użytkowników należących do listy w momencie jej tworzenia. Jedna lista odbiorców może mieć wiele plików eksportu listy odbiorców utworzonych na różne dni.

Zapis JSON 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number
}
Pola
name

string

Tylko dane wyjściowe. Identyfikator. Nazwa zasobu eksportu listy odbiorców przypisanego podczas tworzenia. Ta nazwa zasobu identyfikuje ten element AudienceExport.

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

string

Wymagane. Nazwa zasobu listy odbiorców. Ta nazwa zasobu identyfikuje listę odbiorców i jest udostępniana między interfejsami API Analytics Data i Admin.

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

string

Tylko dane wyjściowe. Opisowa wyświetlana nazwa tej listy odbiorców. Na przykład „Kupujący”.
dimensions[]

object (AudienceDimension)

Wymagane. Wymiary żądane i wyświetlane w odpowiedzi na zapytanie.
creationQuotaTokensCharged

integer

Tylko dane wyjściowe. Łączna liczba tokenów limitu wykorzystana podczas tworzenia pliku AudienceExport. Ponieważ liczba tokenów jest określana na podstawie aktywności w stanie CREATING, po przejściu przez funkcję AudienceExport w stan ACTIVE lub FAILED opłata za te tokeny będzie stała.
state

enum (State)

Tylko dane wyjściowe. Bieżący stan tego pliku eksportu listy odbiorców.
beginCreatingTime

string (Timestamp format)

Tylko dane wyjściowe. Czas wywołania metody audienceExports.create i rozpoczęcia stanu CREATING przez obiekt AudienceExport.

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
rowCount

integer

Tylko dane wyjściowe. Łączna liczba wierszy w wyniku AudienceExport.
errorMessage

string

Tylko dane wyjściowe. Komunikat o błędzie jest wypełniany, gdy eksport listy odbiorców nie powiedzie się podczas tworzenia. Częstą przyczyną takiego błędu jest wyczerpanie limitu.
percentageCompleted

number

Tylko dane wyjściowe. Odsetek danych, które zostały wyeksportowane w przypadku tych list odbiorców, waha się od 0 do 100.

AudienceDimension

Wymiar listy odbiorców to atrybut użytkownika. Użytkownik jest przypisany do konkretnego źródła, które jest następnie zwracane w parametrze QueryAudienceExportResponse.

Zapis JSON 
{
  "dimensionName": string
}
Pola
dimensionName

string

Opcjonalnie: Nazwa wymiaru w interfejsie API. Listę nazw wymiarów znajdziesz w sekcji Wymiary interfejsu API.

Stan

W takim stanie znajduje się obecnie plik AudienceExport.

Wartości w polu enum
STATE_UNSPECIFIED Stan nieokreślony nigdy nie będzie używany.
CREATING Plik AudienceExport jest obecnie tworzony i będzie dostępny w przyszłości. Tworzenie następuje bezpośrednio po wywołaniu audienceExports.create.
ACTIVE Plik AudienceExport został utworzony i jest gotowy do wykonywania zapytań. Obiekt AudienceExport jest aktualizowany do stanu aktywnego asynchronicznie od momentu wysłania żądania. Dzieje się to po pewnym czasie (np. 15 minut) od momentu wywołania metody create.
FAILED Nie udało się utworzyć pliku AudienceExport. Możliwe, że ponowne wysłanie żądania eksportu listy odbiorców zakończy się sukcesem.

Metody

create

 Tworzy plik eksportu listy odbiorców do późniejszego pobrania.

get

 Pobiera metadane konfiguracji dotyczące konkretnego eksportu listy odbiorców.

list

 Wyświetla wszystkie eksporty list odbiorców dla usługi.

query

 Pobiera plik eksportu odbiorców, czyli użytkowników.