REST Resource: properties.audienceLists

Zasób: AudienceList

Lista odbiorców to użytkownicy znajdujący się na liście odbiorców w momencie jej tworzenia. Pojedyncza grupa odbiorców może mieć wiele list odbiorcó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,
  "recurringAudienceList": string
}
Pola
name

string

Tylko dane wyjściowe. Identyfikator. Nazwa zasobu listy odbiorców przypisana podczas tworzenia. Ta nazwa zasobu identyfikuje ten zasób AudienceList.

Format: properties/{property}/audienceLists/{audienceList}
audience

string

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

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)

To pole jest wymagane. Żądane wymiary i wyświetlane w odpowiedzi na zapytanie.
creationQuotaTokensCharged

integer

Tylko dane wyjściowe. Łączna liczba tokenów limitu obciążanych podczas tworzenia listy odbiorców. Ta liczba tokenów jest uzależniona od aktywności w stanie CREATING, dlatego opłata za tokeny zostanie ustalona, gdy lista odbiorców przejdzie do stanu ACTIVE lub FAILED.
state

enum (State)

Tylko dane wyjściowe. Obecny stan tej listy odbiorców.
beginCreatingTime

string (Timestamp format)

Tylko dane wyjściowe. Czas wywołania parametru AudienceLists.create i początku stanu CREATING listy odbiorców.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy 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 listy odbiorców.
errorMessage

string

Tylko dane wyjściowe. Jeśli podczas tworzenia listy odbiorców nie uda się utworzyć listy odbiorców, pojawi się komunikat o błędzie. Częstą przyczyną takiego błędu jest wyczerpanie limitu.
percentageCompleted

number

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

string

Tylko dane wyjściowe. Cykliczna lista odbiorców, która utworzyła tę listę odbiorców. Cykliczne listy odbiorców tworzą listy odbiorców codziennie.

Jeśli listy odbiorców są tworzone bezpośrednio, nie będą miały one powiązanej listy cyklicznej, a to pole będzie puste.

Stan

Lista odbiorców jest obecnie w tym stanie.

Wartości w polu enum
STATE_UNSPECIFIED Stan nieokreślony nie będzie nigdy używany.
CREATING Obecnie trwa tworzenie listy odbiorców i będzie dostępna w przyszłości. Tworzenie ma miejsce natychmiast po wywołaniu AudienceLists.create.
ACTIVE Lista odbiorców została w pełni utworzona i można jej używać do zapytań. Lista odbiorców jest aktualizowana na aktywną asynchronicznie z poziomu żądania. Następuje to jakiś czas (np. 15 minut) po pierwszym wywołaniu tworzenia.
FAILED Nie udało się utworzyć listy odbiorców. Możliwe, że ponownie poprosisz o tę listę odbiorców.

Metody

create

 Tworzy listę odbiorców do późniejszego pobrania.

exportSheet

 Eksportuje listę odbiorców użytkowników do Arkuszy Google.

get

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

list

 Zawiera wszystkie listy odbiorców danej usługi.

query

 Pobiera listę odbiorców użytkowników.