REST Resource: properties.audienceExports

Zasób: AudienceExport

Eksport odbiorców to lista użytkowników w grupie odbiorców w momencie tworzenia listy. Jedna grupa odbiorców może mieć wiele eksportów utworzonych w różnych dniach.

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 ten element AudienceExport.

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

string

Wymagane. Nazwa zasobu odbiorców. Ta nazwa zasobu identyfikuje grupę odbiorców, która jest wyświetlana, i jest współdzielona przez interfejsy API danych i administracyjne Statystyk.

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

string

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

object (AudienceDimension)

Wymagane. Wymiary, o które poproszono i które są wyświetlane w odpowiedzi na zapytanie.
creationQuotaTokensCharged

integer

Tylko dane wyjściowe. Łączna liczba tokenów limitu wykorzystanych podczas tworzenia elementu AudienceExport. Ponieważ ta liczba tokenów jest oparta na aktywności w stanie CREATING, liczba wykorzystanych tokenów zostanie ustalona, gdy element AudienceExport przejdzie do stanu ACTIVE lub FAILED.
state

enum (State)

Tylko dane wyjściowe. Bieżący stan tego elementu AudienceExport.
beginCreatingTime

string (Timestamp format)

Tylko dane wyjściowe. Czas, w którym wywołano metodę audienceExports.create i element AudienceExport przeszedł do stanu CREATING.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
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 podczas tworzenia eksportu odbiorców wystąpi błąd. Częstą przyczyną takiego błędu jest wyczerpanie limitu.
percentageCompleted

number

Tylko dane wyjściowe. Procent ukończenia tego eksportu odbiorców w zakresie od 0 do 100.

AudienceDimension

Wymiar odbiorców to atrybut użytkownika. Określone atrybuty użytkownika są żądane, a następnie zwracane w elemencie 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

Element AudienceExport znajduje się obecnie w tym stanie.

Wartości w polu enum
STATE_UNSPECIFIED Stan nieokreślony nigdy nie będzie używany.
CREATING Element AudienceExport jest obecnie tworzony i będzie dostępny w przyszłości. Tworzenie następuje natychmiast po wywołaniu metody audienceExports.create.
ACTIVE Element AudienceExport został w pełni utworzony i jest gotowy do wysyłania zapytań. Element AudienceExport jest aktualizowany do stanu aktywnego asynchronicznie na podstawie żądania. Dzieje się to jakiś czas (np. 15 minut) po początkowym wywołaniu metody create.
FAILED Nie udało się utworzyć elementu AudienceExport. Możliwe, że ponowne wysłanie żądania tego eksportu odbiorców zakończy się powodzeniem.

Metody

create

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

get

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

list

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

query

 Pobiera eksport odbiorców.