REST Resource: properties.audienceLists

Zasób: AudienceList

Lista odbiorców to lista użytkowników znajdujących się na liście odbiorców w momencie jej tworzenia. Każda grupa odbiorców może mieć wiele list odbiorców utworzonych 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,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
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 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 listy odbiorców. Ta liczba tokenów jest uzależniona od aktywności ze stanu CREATING, dlatego opłata za tokeny zostanie ustalona, gdy AudienceList wpisze stan 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 metody AudienceLists.create i początku stanu CREATING na liście odbiorców.

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 listy odbiorców.

errorMessage

string

Tylko dane wyjściowe. Komunikat o błędzie pojawia się, gdy nie uda się utworzyć 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.

recurringAudienceList

string

Tylko dane wyjściowe. Cykliczna lista odbiorców, która utworzyła daną 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 powiązanej cyklicznej listy odbiorców, a to pole będzie puste.

webhookNotification

object (WebhookNotification)

Opcjonalnie. Umożliwia skonfigurowanie wysyłania powiadomień webhook z interfejsu Google Analytics Data API na serwer webhooka. Korzystanie z webhooków jest opcjonalne. Jeśli lista odbiorców jest gotowa do użycia, musisz ją przeprowadzić w tym interfejsie API, jeśli jest nieużywana. Webhooki umożliwiają wysyłanie powiadomień do Twoich serwerów i pozwalają uniknąć konieczności odpytywania.

Do webhooka zostanie wysłane jedno lub dwa żądania POST. Pierwsze żądanie POST zostanie natychmiast wysłane z informacją, że nowo utworzona lista odbiorców jest w stanie TWORZENIA. Drugie żądanie POST jest wysyłane po zakończeniu tworzenia listy odbiorców (w stanie AKTYWNA lub NIEUDANA).

Jeśli żądanie identycznych list odbiorców nastąpi w krótkim czasie, druga i kolejna lista odbiorców może zostać wyświetlona z pamięci podręcznej. W takim przypadku metoda tworzenia listy odbiorców może zwrócić, że lista odbiorców jest już AKTYWNA. W takiej sytuacji do webhooka zostanie wysłane tylko jedno żądanie POST.

Stan

Lista odbiorców jest obecnie w tym stanie.

Wartości w polu enum
STATE_UNSPECIFIED Nieokreślony stan nigdy nie będzie używany.
CREATING Obecnie trwa tworzenie listy odbiorców i będzie dostępna w przyszłości. Tworzenie następuje bezpośrednio po wywołaniu AudienceLists.create.
ACTIVE Lista odbiorców jest w pełni utworzona i gotowa do wysyłania zapytań. Lista odbiorców jest aktualizowana asynchronicznie w wyniku żądania. Następuje to po jakimś czasie (np. 15 minutach) po pierwszym wywołaniu tworzenia.
FAILED Nie udało się utworzyć listy odbiorców. Możliwe, że ponowne wysłanie prośby o tę listę odbiorców się powiedzie.

Metody

create

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

exportSheet

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

get

Pobiera metadane konfiguracji określonej listy odbiorców.

list

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

query

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