REST Resource: properties.audienceLists

Kaynak: AudienceList

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

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ı, listelenen kitleyi tanımlar ve Analytics Verileri ile Yönetici API'leri.

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 ücretlendirilen toplam kota jetonları. Bu jeton sayısı CREATING durumundaki etkinliğe dayandığından, bir AudienceList ACTIVE veya FAILED durumları ulaştığında, jetondan alınan bu jeton ücreti sabitlenir.
state

enum (State)

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

string (Timestamp format)

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

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Ö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 sırasında başarısız olursa hata mesajı doldurulur. Bu tür hataların yaygın bir nedeni kotanın tükenmesidir.
percentageCompleted

number

Yalnızca çıkış. 0 ile 100 arasında değişen bu kitle dışa aktarma işlemi için tamamlanan yüzde.
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 bunların ilişkilendirilmiş yinelenen kitle listesi olmaz ve bu alan boş olur.
webhookNotification

object (WebhookNotification)

İsteğe bağlı. Google Analytics Data API'den webhook sunucunuza gönderilecek web kancası bildirimlerini yapılandırır. Webhook kullanımı isteğe bağlıdır. Kullanılmayan 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 ve anket yapmak zorunda kalmayacaksınız.

Webhook'a bir veya iki POST isteği gönderilir. Yeni oluşturulan kitle listesini CREATING durumunda gösteren ilk POST isteği hemen gönderilir. İkinci POST isteği, kitle listesi oluşturma işlemini tamamladıktan sonra gönderilir (ETKİN veya BAŞARISIZ durumu).

Özdeş kitle listeleri hızlı bir şekilde arka arkaya istenirse, ikinci ve sonraki kitle listeleri önbellekten sunulabilir. Bu durumda, kitle listesi oluşturma yöntemi bir kitle listesini zaten ETKİN olarak 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 Belirtilmemiş durum hiçbir zaman kullanılmaz.
CREATING Kitle Listesi ş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 istekten eşzamansız olarak etkin olacak şekilde güncellenir. Bu işlem, ilk oluşturma çağrısından biraz sonra (örneğin, 15 dakika) gerçekleşir.
FAILED Kitle Listesi oluşturulamadı. Bu kitle listesi için yeniden istek gönderme işlemi başarılı olabilir.

Yöntemler

create

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

exportSheet

 Kullanıcıların yer aldığı kitle listesini Google E-Tablosu'na aktarır.

get

 Belirli bir kitle listesi hakkında yapılandırma meta verilerini alır.

list

 Bir mülkün tüm kitle listelerini listeler.

query

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