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 chwili jej tworzenia. Jedna lista odbiorców może mieć wiele eksportów list odbiorców utworzonych dla 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 odbiorców przypisana podczas tworzenia. Ta nazwa zasobu identyfikuje zasób AudienceExport.

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

string

Wymagane. Nazwa zasobu związanego z odbiorcami. Ta nazwa zasobu identyfikuje wymienioną listę odbiorców i jest współdzielona przez dane Analytics i API dla administratorów.

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

string

Tylko dane wyjściowe. Opisowa wyświetlana nazwa grupy odbiorców. np. „Kupujący”.
dimensions[]

object (AudienceDimension)

Wymagane. Żądane wymiary i wyświetlane w odpowiedzi na zapytanie.
creationQuotaTokensCharged

integer

Tylko dane wyjściowe. Łączna liczba tokenów limitów naliczona podczas tworzenia AudienceExport. Ta liczba tokenów jest określana na podstawie aktywności w stanie CREATING, dlatego opłaty za te tokeny zostaną ustalone, gdy AudienceExport otrzyma stan ACTIVE lub FAILED.
state

enum (State)

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

string (Timestamp format)

Tylko dane wyjściowe. Czas wywołania parametru audienceExports.create i polecenia AudienceExport stan CREATING.

Sygnatura czasowa w RFC3339 UTC „Zulu” 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 nie uda się wyeksportować listy odbiorców podczas tworzenia. Częstą przyczyną takiej sytuacji jest wyczerpanie limitu.
percentageCompleted

number

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

AudienceDimension

Wymiar dotyczący odbiorców to atrybut użytkownika. Po zgłoszeniu prośby o przypisanie konkretnego użytkownika zostanie on później zwrócony w QueryAudienceExportResponse.

Zapis JSON 
{
  "dimensionName": string
}
Pola
dimensionName

string

Opcjonalnie: Nazwa interfejsu API wymiaru. Lista nazw wymiarów znajdziesz w artykule Wymiary interfejsu API.

Stan

W takim stanie jest obecnie eksportowany przez odbiorców AudienceExport.

Wartości w polu enum
STATE_UNSPECIFIED Stan nieokreślony nigdy nie będzie używany.
CREATING Trwa tworzenie komponentu AudienceExport. Będzie on dostępny w przyszłości. Tworzenie następuje bezpośrednio po wywołaniu audienceExports.create.
ACTIVE Narzędzie AudienceExport zostało w pełni utworzone i jest gotowe do obsługi zapytań. Komponent AudienceExport jest aktualizowany asynchronicznie na podstawie żądania. nastąpi to jakiś czas (na przykład 15 minut) po pierwszym wywołaniu utworzenia.
FAILED Nie udało się utworzyć parametru AudienceExport. Ponowne wysłanie prośby o eksport listy odbiorców może się udać.

Metody

create

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

get

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

list

 Wyświetla listę wszystkich eksportów list odbiorców związanych z usługą.

query

 Pobiera eksport list odbiorców z użytkownikami.