REST Resource: properties.audienceLists

Kaynak: AudienceList

Kitle listesi, listenin oluşturulduğu sırada kitlede bulunan kullanıcıların listesidir. Bir kitlenin farklı günler için oluşturulmuş birden fazla kitle listesi 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 kaynağının adı. Bu kaynak adı, listelenmekte olan 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 kitle için açıklayıcı bir görünen ad. Örneğin, "Alıcılar".
dimensions[]

object (AudienceDimension)

Zorunlu. Sorgu yanıtında istenen ve gösterilen boyutlar.
creationQuotaTokensCharged

integer

Yalnızca çıkış. AudienceList oluşturulurken alınan toplam kota jetonları. Bu jeton sayısı CREATING durumundaki etkinliği temel aldığından, ücretlendirilen bu jetonlar, bir AudienceList ACTIVE veya FAILED durumuna girdiğinde sabitlenir.
state

enum (State)

Yalnızca çıkış. Bu Kitle Listesi için mevcut durum.
beginCreatingTime

string (Timestamp format)

Yalnızca çıkış. AudienceLists.create değerinin çağrıldığı ve AudienceList'in CREATING durumunu başlattığı zaman.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, 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ış. Kitle listesi oluşturma işlemi başarısız olduğunda hata mesajı doldurulur. Bu başarısızlığın yaygın bir nedeni kotanın tükenmesidir.
percentageCompleted

number

Yalnızca çıkış. Bu kitle dışa aktarma işlemi için tamamlanan yüzde 0 ile 100 arasındadır.
recurringAudienceList

string

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

Kitle listeleri doğrudan oluşturulursa, ilişkili yinelenen kitle listeleri olmaz ve bu alan boş olur.
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ılmayan kitle listelerinin 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. Yeni oluşturulan kitle listesini CREATING durumunda gösterecek şekilde ilk POST isteği hemen gönderilir. İkinci POST isteği, kitle listesinin oluşturulması tamamlandıktan sonra gönderilir (ETKİN veya BAŞARISIZ durumu).

Hızlı bir şekilde arka arkaya benzer kitle listeleri istenirse ikinci ve sonraki kitle listeleri önbellekten sunulabilir. Bu durumda, kitle listesi oluşturma yöntemi zaten ETKİN olan bir kitle listesi döndürebilir. Bu senaryoda webhook'a yalnızca bir POST isteği gönderilir.

Eyalet

AudienceList şu anda bu durumda bulunmaktadır.

Sıralamalar
STATE_UNSPECIFIED Belirtilmemiş durum hiçbir zaman kullanılmaz.
CREATING AudienceList şu anda oluşturuluyor ve gelecekte kullanılabilir. Oluşturma, audienceLists.create çağrısından hemen sonra gerçekleşir.
ACTIVE AudienceList tamamen oluşturuldu ve sorgulanmaya hazır. AudienceList, istekten eşzamansız olarak etkin olacak şekilde güncellenir. Bu durum, ilk create çağrısından bir süre sonra (örneğin 15 dakika) gerçekleşir.
FAILED AudienceList oluşturulamadı. Bu kitle listesini yeniden isteme işlemi başarılı olabilir.

Yöntemler

create

 Daha sonra almak üzere bir kitle listesi oluşturur.

exportSheet

 Kullanıcı kitle listesini bir Google E-Tablosu'na aktarır.

get

 Belirli bir kitle listesiyle 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.