REST Resource: properties.audienceExports

Zasób: AudienceExport

Eksport listy odbiorców to lista użytkowników znajdujących się na liście odbiorców w momencie jej tworzenia. Dla jednej listy odbiorców może być utworzonych wiele eksportów list odbiorców na potrzeby różnych 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 przypisana podczas tworzenia. Ta nazwa zasobu identyfikuje ten zasób (AudienceExport).

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

audience

string

To pole jest wymagane. Nazwa zasobu listy odbiorców. Ta nazwa zasobu określa listę odbiorców i jest udostępniana przez interfejsy Analytics Data & Admin API.

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

audienceDisplayName

string

Tylko dane wyjściowe. Wyświetlana nazwa opisowa dla tej listy odbiorców. Na przykład „Kupujący”.

dimensions[]

object (AudienceDimension)

To pole jest wymagane. Wymiary żądane i wyświetlone w odpowiedzi na zapytanie.

creationQuotaTokensCharged

integer

Tylko dane wyjściowe. Łączna liczba tokenów limitu opłaconych podczas tworzenia AudienceExport. Ta liczba tokenów jest uzależniona od aktywności ze stanu CREATING, dlatego opłata za tokeny zostanie ustalona, gdy AudienceExport zacznie mieć stan ACTIVE lub FAILED.

state

enum (State)

Tylko dane wyjściowe. Obecny stan tego elementu AudienceExport.

beginCreatingTime

string (Timestamp format)

Tylko dane wyjściowe. Godzina wywołania stanu AudienceExports.create i początku stanu CREATING w polu AudienceExport.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi 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 pojawia się, gdy podczas tworzenia nie uda się wyeksportować listy odbiorców. Częstą przyczyną takich problemów jest wyczerpanie limitu.

percentageCompleted

number

Tylko dane wyjściowe. Procent ukończenia eksportu list odbiorców z zakresu od 0 do 100.

AudienceDimension

Wymiar odbiorców to atrybut użytkownika. Żądanie dotyczące konkretnego użytkownika jest przypisywane, a później zwracane w polu QueryAudienceExportResponse.

Zapis JSON
{
  "dimensionName": string
}
Pola
dimensionName

string

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

Stan

W tym stanie obecnie występuje element AudienceExport.

Wartości w polu enum
STATE_UNSPECIFIED Nieokreślony stan nigdy nie będzie używany.
CREATING Obecnie trwa tworzenie raportu AudienceExport, który będzie dostępny w przyszłości. Tworzenie następuje bezpośrednio po wywołaniu audienceExports.create.
ACTIVE Interfejs AudienceExport został w pełni utworzony i można go używać do zapytań. Wartość AudienceExport jest asynchronicznie aktualizowana na podstawie żądania. Następuje to po jakimś czasie (np. 15 minutach) po pierwszym wywołaniu tworzenia.
FAILED Nie udało się utworzyć elementu AudienceExport. Możliwe, że ponowna prośba o eksport listy odbiorców się uda.

Metody

create

Tworzy eksport listy odbiorców do późniejszego pobrania.

get

Pobiera metadane konfiguracji dotyczące eksportu określonej listy odbiorców.

list

Wyświetla listę wszystkich eksportów list odbiorców z usługi.

query

Pobiera eksport listy odbiorców z listą użytkowników.