REST Resource: properties.audienceLists

Zasób: AudienceList

Lista odbiorców to lista użytkowników należących do listy w momencie jej utworzenia. Jedna lista odbiorców może zawierać kilka 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 listy odbiorców. Ta nazwa zasobu identyfikuje listę odbiorców i jest udostępniana między interfejsami API Analytics Data i Admin.

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 żądane i wyświetlane w odpowiedzi na zapytanie.
creationQuotaTokensCharged

integer

Tylko dane wyjściowe. Łączna liczba tokenów limitu wykorzystana podczas tworzenia listy odbiorców. Ponieważ liczba tokenów jest określana na podstawie aktywności w stanie CREATING, po przejściu AudienceList w stan ACTIVE lub FAILED liczba pobranych tokenów będzie stała.
state

enum (State)

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

string (Timestamp format)

Tylko dane wyjściowe. Czas wywołania metody audienceLists.create i rozpoczęcia przez listę odbiorców CREATING.

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc 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 AudienceList.
errorMessage

string

Tylko dane wyjściowe. Komunikat o błędzie jest wypełniany, 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. Odsetek danych, które zostały wyeksportowane w przypadku tych list odbiorców, waha się 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. Powtarzające się listy odbiorców są tworzone codziennie.

Jeśli listy odbiorców są tworzone bezpośrednio, nie będą mieć powiązanej listy odbiorców o powtarzającym się składzie, a to pole będzie puste.
webhookNotification

object (WebhookNotification)

Opcjonalnie: Konfiguruje powiadomienia webhooka, które mają być wysyłane z interfejsu Google Analytics Data API na serwer webhooka. Korzystanie z webhooków jest opcjonalne. Jeśli nie jest używana, musisz przeprowadzić ankietę za pomocą tego interfejsu API, aby określić, kiedy lista odbiorców będzie gotowa do użycia. Webhooki umożliwiają wysyłanie powiadomień na serwery i unikanie konieczności przeprowadzania ankiet.

Na webhook zostanie wysłane 1 lub 2 żądania POST. Pierwsze żądanie POST zostanie wysłane natychmiast i będzie dotyczyć nowo utworzonej listy odbiorców w stanie CREATING (tworzenie). Drugie żądanie POST zostanie wysłane po zakończeniu tworzenia listy odbiorców (stan AKTYWNA lub NIEPOWIEDNIE).

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

Stan

W takim stanie obiekt AudienceList istnieje obecnie.

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 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 po otrzymaniu żądania. Dzieje się to po pewnym czasie (np. 15 minut) od początkowego wywołania metody create.
FAILED Nie udało się utworzyć listy AudienceList. Możliwe, że ponowne wysłanie żądania dotyczącego tej listy odbiorców zakończy się sukcesem.

Metody

create

 Tworzy listę odbiorców, która będzie dostępna do późniejszego wyszukiwania.

exportSheet

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

get

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

list

 Wyświetla wszystkie listy odbiorców w przypadku danej usługi.

query

 Pobiera listę odbiorców zawierającą użytkowników.