Method: properties.audienceLists.query

Kullanıcıların kitle listesini alır. Kitle oluşturulduktan sonra, kullanıcılar listeleme için hemen kullanılamaz. İlk olarak, kullanıcılardan oluşan bir kitle listesi oluşturmak için audienceLists.create isteği gerekir. İkinci olarak, kitle listesindeki kullanıcıları almak için bu yöntem kullanılır.

Örnekler içeren Kitle Listelerine giriş için Kitle Listesi Oluşturma bölümüne bakın.

Google Analytics 4'teki kitleler, kullanıcılarınızı işletmeniz açısından önem taşıyan ölçütlere göre segmentlere ayırmanızı sağlar. Daha fazla bilgi için https://support.google.com/analytics/answer/9267572 adresini ziyaret edin.

Bu yöntem, audienceExports.query adresindeki beta kararlılığında kullanılabilir. Bu API hakkında geri bildirimde bulunmak için Google Analytics Audience Export API Geri Bildirim formunu doldurun.

HTTP isteği

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
name

string

Zorunlu. Kullanıcıların alınacağı kitle listesinin adı. Biçim: properties/{property}/audienceLists/{audienceList}

İstek içeriği

İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:

JSON gösterimi 
{
  "offset": string,
  "limit": string
}
Alanlar
offset

string (int64 format)

İsteğe bağlı. Başlangıç satırının satır sayısı. İlk satır, 0. satır olarak sayılır.

Sayfalara ayırma sırasında ilk istek ofseti belirtmez; veya eşdeğer olarak, ofseti 0'a ayarlar; ilk istek, satırların ilk limit tanesini döndürür. İkinci istek, ilk isteğin limit farkını ayarlar; ikinci istek, satırların ikinci limit değerini döndürür.

Bu sayfalara ayırma parametresi hakkında daha fazla bilgi için Sayfalara ayırma bölümüne bakın.
limit

string (int64 format)

İsteğe bağlı. Döndürülecek satır sayısı. Belirtilmezse 10.000 satır döndürülür. API, istediğiniz sayıda satırdan bağımsız olarak istek başına en fazla 250.000 satır döndürür. limit pozitif olmalıdır.

Ayrıca, limit kadar boyut değeri yoksa API, istenen limit değerinden daha az satır döndürebilir.

Bu sayfalara ayırma parametresi hakkında daha fazla bilgi için Sayfalara ayırma bölümüne bakın.

Yanıt gövdesi

Bir kitle listesindeki kullanıcıların listesi.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
Alanlar
audienceRows[]

object (AudienceRow)

Kitle listesindeki her bir kullanıcının satırları. Bu yanıttaki satır sayısı, isteğin sayfa boyutundan az veya bu boyuta eşit olacaktır.
audienceList

object (AudienceList)

Sorgulanmakta olan AudienceList ile ilgili yapılandırma verileri. Bu yanıttaki kitle satırlarını yorumlamaya yardımcı olmak için döndürüldü. Örneğin, bu AudienceList'teki boyutlar AudienceRows sütunundaki sütunlara karşılık gelir.
rowCount

integer

AudienceList sonucundaki toplam satır sayısı. rowCount, yanıtta döndürülen satır sayısından, limit istek parametresinden ve offset istek parametresinden bağımsızdır. Örneğin, bir sorgu 175 satır döndürüyorsa ve API isteğinde 50 satırdan limit tanesini içeriyorsa yanıt, 175 satırdan rowCount tanesini, ancak yalnızca 50 satırı içerecek.

Bu sayfalara ayırma parametresi hakkında daha fazla bilgi için Sayfalara ayırma bölümüne bakın.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

AudienceRow

Kitle kullanıcı satırının boyut değeri özellikleri.

JSON gösterimi 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
Alanlar
dimensionValues[]

object (AudienceDimensionValue)

Bir kitle kullanıcısına ait her bir boyut değeri özelliği. İstenen her boyut sütunu için bir boyut değeri eklenir.

AudienceDimensionValue

Bir boyutun değeri.

JSON gösterimi 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
Alanlar
Birleştirme alanı one_value. Bir tür boyut değeri. one_value şunlardan yalnızca biri olabilir:
value

string

Boyut türü bir dizeyse dize olarak değer.