REST Resource: properties.audienceLists

Zasób: AudienceList

Lista odbiorców to lista użytkowników należących do odbiorców w momencie jej utworzenia. Jeden odbiorca może mieć wiele list odbiorców utworzonych na różne 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 element AudienceList.

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

string

Wymagane. Nazwa zasobu związanego z odbiorcami. Ta nazwa zasobu identyfikuje listę odbiorców i jest udostępniana interfejsom Analytics Data API i 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)

Wymagane. Wymiary, o które poproszono i które zostały wyświetlone w odpowiedzi na zapytanie.
creationQuotaTokensCharged

integer

Tylko dane wyjściowe. Łączna liczba tokenów limitu wykorzystanych podczas tworzenia listy odbiorców. Liczba tokenów jest obliczana na podstawie aktywności w stanie CREATING, więc opłata za tokeny będzie stała, gdy lista odbiorców przejdzie do stanu ACTIVE lub FAILED.
state

enum (State)

Tylko dane wyjściowe. Bieżący stan tej listy odbiorców.
beginCreatingTime

string (Timestamp format)

Tylko dane wyjściowe. Czas, w którym wywołano metodę audienceLists.create i lista odbiorców rozpoczęła stan 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 AudienceList.
errorMessage

string

Tylko dane wyjściowe. Komunikat o błędzie jest wyświetlany, gdy podczas tworzenia listy odbiorców wystąpi błąd. Częstą przyczyną takiego błędu jest wyczerpanie limitu.
percentageCompleted

number

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

string

Tylko dane wyjściowe. Powtarzająca się lista odbiorców, na podstawie której została utworzona ta lista odbiorców. Listy odbiorców tworzone cyklicznie są aktualizowane 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. Konfiguruje wysyłanie powiadomień webhook z interfejsu Google Analytics Data API na serwer webhook. Korzystanie z webhooków jest opcjonalne. Jeśli nie jest używany, musisz wysyłać do tego interfejsu API zapytania, aby określić, kiedy lista odbiorców będzie gotowa do użycia. Webhooki umożliwiają wysyłanie powiadomień na Twoje serwery i eliminują potrzebę sondowania.

Do webhooka zostaną wysłane 1 lub 2 żądania POST. Pierwsza prośba POST zostanie wysłana natychmiast, a nowo utworzona lista odbiorców będzie miała stan CREATING. Drugie żądanie POST zostanie wysłane po utworzeniu listy odbiorców (w stanie AKTYWNY lub NIEUDANY).

Jeśli identyczne listy odbiorców są przesyłane w krótkich odstępach czasu, druga i kolejne listy mogą być wyświetlane z pamięci podręcznej. W takim przypadku metoda tworzenia listy odbiorców może zwrócić informację, że lista odbiorców jest już AKTYWNA. W takim przypadku do webhooka zostanie wysłane tylko 1 żądanie POST.

Stan

Lista odbiorców jest obecnie w tym stanie.

Wartości w polu enum
STATE_UNSPECIFIED Stan nieokreślony nigdy nie będzie używany.
CREATING Lista odbiorców jest obecnie tworzona i będzie dostępna w przyszłości. Tworzenie następuje natychmiast po wywołaniu funkcji audienceLists.create.
ACTIVE Lista odbiorców jest w pełni utworzona i gotowa do wysyłania zapytań. Lista odbiorców jest aktualizowana do stanu aktywnego asynchronicznie w odpowiedzi na żądanie. Dzieje się to jakiś czas (np. 15 minut) po początkowym wywołaniu funkcji tworzenia.
FAILED Nie udało się utworzyć listy odbiorców. Możliwe, że ponowne przesłanie prośby o tę listę odbiorców zakończy się powodzeniem.

Metody

create

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

get

 Pobiera metadane konfiguracji dotyczące konkretnej listy odbiorców.

list

 Wyświetla wszystkie listy odbiorców w usłudze.

query

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