REST Resource: properties.audienceLists

Zasób: AudienceList

Lista odbiorców to lista użytkowników znajdujących się na liście odbiorców w chwili jej tworzenia. Jedna grupa odbiorców 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 zasób AudienceList.

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

string

Wymagane. Nazwa zasobu związanego z odbiorcami. Ta nazwa zasobu identyfikuje wymienioną listę odbiorców i jest współdzielona przez dane Analytics i API dla administratorów.

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

string

Tylko dane wyjściowe. Opisowa wyświetlana nazwa grupy odbiorców. np. „Kupujący”.
dimensions[]

object (AudienceDimension)

Wymagane. Żądane wymiary i wyświetlane w odpowiedzi na zapytanie.
creationQuotaTokensCharged

integer

Tylko dane wyjściowe. Łączna liczba tokenów limitu naliczanego podczas tworzenia listy odbiorców. Ponieważ liczba tokenów jest określana na podstawie aktywności w stanie CREATING, opłaty za te tokeny zostaną ustalone, gdy lista odbiorców otrzyma stan 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 wywołania listy odbiorców z użyciem listy AudienceLists.create i rozpoczęcie odtwarzania stanu CREATING.

Sygnatura czasowa w RFC3339 UTC „Zulu” 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 AudienceList.
errorMessage

string

Tylko dane wyjściowe. Komunikat o błędzie pojawia się, gdy podczas tworzenia listy odbiorców zakończy się niepowodzeniem. Częstą przyczyną takiej sytuacji jest wyczerpanie limitu.
percentageCompleted

number

Tylko dane wyjściowe. Procent ukończenia eksportu tej listy 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 codziennie tworzą listy odbiorców.

Jeśli listy odbiorców tworzysz 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ń webhooka do serwera webhooka z interfejsu Google Analytics Data API. Korzystanie z webhooków jest opcjonalne. Jeśli nie używasz tej funkcji, musisz przeprowadzić sondowanie tego interfejsu API, aby określić, kiedy lista odbiorców będzie gotowa do użycia. Webhooki umożliwiają wysyłanie powiadomień do serwerów aby uniknąć konieczności przeprowadzania ankiet.

Do webhooka zostanie wysłane jedno lub 2 żądania POST. Pierwsze żądanie POST zostanie natychmiast wysłane i będzie zawierać nowo utworzoną listę odbiorców w stanie TWORZENIA. Drugie żądanie POST zostanie wysłane po zakończeniu tworzenia listy odbiorców (ze stanem AKTYWNY lub NIEPRAWIDŁOWY).

Jeśli po krótkim czasie następuje żądanie identycznych list odbiorców, drugi parametr & 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 takim przypadku do webhooka zostanie wysłane tylko jedno żądanie POST.

Stan

W tym stanie znajduje się obecnie lista odbiorców.

Wartości w polu enum
STATE_UNSPECIFIED Stan nieokreślony nigdy nie będzie używany.
CREATING Trwa tworzenie listy odbiorców i będzie ona 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 można tworzyć zapytania. Lista odbiorców jest aktualizowana asynchronicznie na podstawie żądania. nastąpi to jakiś czas (na przykład 15 minut) po pierwszym wywołaniu utworzenia.
FAILED Nie udało się utworzyć listy odbiorców. Ponowne żądanie tej listy odbiorców może się udać.

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 dotyczące określonej listy odbiorców.

list

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

query

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