REST Resource: properties.audienceLists

Kaynak: AudienceList

Kitle listesi, liste oluşturulduğu sırada bir kitledeki kullanıcıların listesidir. Bir kitle için farklı günlere ait birden fazla kitle listesi oluşturulabilir.

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 Verileri ile Yönetici API'leri arasında paylaşılır.

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

string

Yalnızca çıkış. Bu kitlenin 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 dayalı olduğundan, AudienceList ACTIVE veya FAILED durumlarına girdiğinde bu jetonlar düzeltilir.
state

enum (State)

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

string (Timestamp format)

Yalnızca çıkış. audienceLists.create işlevinin çağrıldığı ve AudienceList'in CREATING durumuna geçtiği zaman.

Nanosaniye çözünürlüğüne sahip ve en fazla dokuz kesirli basamak içeren RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Ö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ış. Bir kitle listesi oluşturulurken başarısız olduğunda hata mesajı doldurulur. Bu tür bir hatanın yaygın nedenlerinden biri kotanın tükenmesidir.
percentageCompleted

number

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

string

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

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

object (WebhookNotification)

İsteğe bağlı. Webhook bildirimlerinin Google Analytics Data API'den webhook sunucunuza gönderilmesini yapılandırır. Webhook kullanımı isteğe bağlıdır. Kullanılmayan bir kitle listesinin ne zaman kullanıma hazır olduğunu belirlemek için bu API'yi sorgulamak gerekir. Webhook'lar, sunucularınıza bildirim gönderilmesine olanak tanır ve anket yapılması 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 durumunda gösterir ve hemen gönderilir. İkinci POST isteği, kitle listesi oluşturulduktan sonra (ETKİN veya BAŞARISIZ durumu) gönderilir.

Aynı kitle listeleri kısa süre içinde arka arkaya istenirse ikinci ve sonraki kitle listeleri önbellekten yayınlanabilir. Bu durumda, kitle listesi oluşturma yöntemi zaten ETKİLİ olan bir kitle listesi döndürebilir. Bu senaryoda, webhook'a yalnızca bir POST isteği gönderilir.

Eyalet

AudienceList şu anda bu durumdadır.

Sıralamalar
STATE_UNSPECIFIED Belirtilmemiş 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şturuldu ve sorgulanmaya hazır. AudienceList, bir istek üzerinden etkin olarak asenkron olarak güncellenir. Bu işlem, ilk oluşturma çağrısından bir süre sonra (ör. 15 dakika) gerçekleşir.
FAILED AudienceList oluşturulamadı. Bu kitle listesini yeniden istemenin başarılı olması mümkündür.

Yöntemler

create

 Daha sonra geri alınabilecek bir kitle listesi oluşturur.

exportSheet

 Kullanıcılardan oluşan bir kitle listesini Google E-Tablosu'na aktarır.

get

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

list

 Bir mülk için tüm kitle listelerini listeler.

query

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