REST Resource: properties.audienceLists

Kaynak: AudienceList

Kitle listesi, listenin oluşturulduğu sırada bir kitlede bulunan kullanıcıların listesidir. Bir kitle, farklı günler için oluşturulmuş birden fazla kitle listesine sahip olabilir.

JSON gösterimi 
{
  "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)
  }
}
Alanlar
name

string

Yalnızca çıkış. Tanımlayıcı. Oluşturma sırasında atanan kitle listesi kaynak adı. Bu kaynak adı, bu AudienceList öğesini tanımlar.

Biçim: properties/{property}/audienceLists/{audienceList}
audience

string

Zorunlu. Kitle kaynak adı. Bu kaynak adı, listelenen kitleyi tanımlar ve Analytics Veri ve Yönetici API'leri arasında paylaşılır.

Biçim: properties/{property}/audiences/{audience}
audienceDisplayName

string

Yalnızca çıkış. Bu kitle için açıklayıcı görünen ad. Örneğin, "Alıcılar".
dimensions[]

object (AudienceDimension)

Zorunlu. Sorgu yanıtında istenen ve görüntülenen boyutlar.
creationQuotaTokensCharged

integer

Yalnızca çıkış. AudienceList oluşturulurken alınan toplam kota jetonu sayısı. Bu jeton sayısı CREATING durumundaki etkinliğe dayandığından, bir AudienceList ACTIVE veya FAILED durumlarına girdiğinde alınan jetonlar sabitlenir.
state

enum (State)

Yalnızca çıkış. Bu AudienceList'in mevcut durumu.
beginCreatingTime

string (Timestamp format)

Yalnızca çıkış. audienceLists.create çağrıldığında ve AudienceList'in CREATING durumuna başladığı zaman.

RFC3339 UTC "Zulu" biçiminde bir zaman damgası (nanosaniye çözünürlüğe ve en fazla dokuz kesirli basamağa sahip). Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
rowCount

integer

Yalnızca çıkış. AudienceList sonucundaki toplam satır sayısı.
errorMessage

string

Yalnızca çıkış. Kitle listesi oluşturulurken hata oluştuğunda hata mesajı gösterilir. Bu tür bir hatanın yaygın nedeni kota tükenmesidir.
percentageCompleted

number

Yalnızca çıkış. Bu kitle dışa aktarma işlemi için tamamlanma yüzdesi (0 ile 100 arasında).
recurringAudienceList

string

Yalnızca çıkış. Bu kitle listesini oluşturan yinelenen kitle listesi. Yinelenen kitle listeleri, her gün kitle listeleri oluşturur.

Kitle listeleri doğrudan oluşturulursa ilişkili yinelenen kitle listesi olmaz ve bu alan boş kalır.
webhookNotification

object (WebhookNotification)

İsteğe bağlı. Google Analytics Data API'den webhook sunucunuza gönderilecek webhook bildirimlerini yapılandırır. Webhook kullanımı isteğe bağlıdır. Kullanılmıyorsa bir kitle listesinin ne zaman kullanıma hazır olduğunu belirlemek için bu API'yi yoklamanız gerekir. Webhook'lar, sunucularınıza bildirim gönderilmesine olanak tanır ve yoklama ihtiyacını ortadan kaldırır.

Webhook'a bir veya iki POST isteği gönderilir. İlk POST isteği, yeni oluşturulan kitle listesini CREATING (OLUŞTURULUYOR) durumunda gösterecek şekilde hemen gönderilir. İkinci POST isteği, kitle listesi oluşturma işlemi tamamlandıktan sonra (ETKİN veya BAŞARISIZ durumda) gönderilir.

Aynı kitle listeleri kısa süre içinde tekrar tekrar istenirse ikinci ve sonraki kitle listeleri önbellekten sunulabilir. Bu durumda, kitle listesi oluşturma yöntemi, kitle listesinin zaten ETKİN olduğunu döndürebilir. Bu senaryoda, webhook'a yalnızca bir POST isteği gönderilir.

Eyalet

AudienceList şu anda bu durumda.

Sıralamalar
STATE_UNSPECIFIED Belirtilmeyen durum hiçbir zaman kullanılmaz.
CREATING AudienceList şu anda oluşturuluyor ve gelecekte kullanıma sunulacak. Oluşturma işlemi, audienceLists.create çağrısından hemen sonra gerçekleşir.
ACTIVE AudienceList tamamen oluşturulmuş ve sorgulanmaya hazırdır. Bir AudienceList, istekten bağımsız olarak etkin olacak şekilde güncellenir. Bu işlem, ilk oluşturma çağrısından bir süre sonra (örneğin 15 dakika) gerçekleşir.
FAILED Kitle listesi oluşturulamadı. Bu kitle listesinin yeniden istenmesi başarılı olabilir.

Yöntemler

create

 Daha sonra alınmak üzere bir kitle listesi oluşturur.

get

 Belirli bir kitle listesiyle ilgili yapılandırma meta verilerini alır.

list

 Bir mülkle ilgili tüm kitle listelerini gösterir.

query

 Kullanıcıların kitle listesini alır.