Method: properties.audienceLists.query

Kullanıcıların kitle listesini alır. Bir kitle oluşturulduktan sonra kullanıcılar hemen listelenemez. Öncelikle, kullanıcılardan oluşan bir kitle listesi oluşturmak için audienceLists.create'e bir istek gönderilmesi gerekir. Ardından, bu yöntem kitle listesindeki kullanıcıları almak için kullanılır.

Kitle listelerine örneklerle giriş için Kitle listesi oluşturma başlıklı makaleyi inceleyin.

Google Analytics 4'teki kitleler, kullanıcılarınızı işletmeniz için önemli olan şekillerde segmentlere ayırmanıza olanak tanır. Daha fazla bilgi için https://support.google.com/analytics/answer/9267572 adresini ziyaret edin.

Bu yöntem, beta kararlılığında audienceExports.query adresinde kullanılabilir. Bu API hakkında geri bildirimde bulunmak için Google Analytics Audience Export API Geri Bildirimi 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 metni aşağıdaki yapıyla birlikte 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.

Sayfalandırmada ilk istek, ofseti belirtmez veya eşdeğer olarak ofseti 0 olarak ayarlar. İlk istek, ilk limit satırı döndürür. İkinci istek, ofseti ilk isteğinin limit değerine ayarlar; ikinci istek, satırların ikinci limit değerini döndürür.

Bu sayfalandırma parametresi hakkında daha fazla bilgi edinmek için Sayfalandırma bölümüne bakın.
limit

string (int64 format)

İsteğe bağlı. Döndürülecek satır sayısı. Belirtilmemişse 10.000 satır döndürülür. API, kaç tane isterseniz isteyin istek başına en fazla 250.000 satır döndürür. limit pozitif olmalıdır.

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

Bu sayfalandırma parametresi hakkında daha fazla bilgi edinmek için Sayfalandı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 kullanıcı için satırlar. Bu yanıttaki satır sayısı, isteğin sayfa boyutundan az veya bu boyuta eşit olur.
audienceList

object (AudienceList)

AudienceList ile ilgili yapılandırma verileri sorgulanıyor. Bu yanıttaki kitle satırlarını yorumlamaya yardımcı olmak için döndürülür. Örneğin, bu AudienceList'teki boyutlar AudienceRows'taki 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ı, limit istek parametresi ve offset istek parametresinden bağımsızdır. Örneğin, bir sorgu 175 satır döndürüyorsa ve API isteğinde 50 tane limit içeriyorsa yanıtta 175 tane rowCount bulunur ancak yalnızca 50 satır vardır.

Bu sayfalandırma parametresi hakkında daha fazla bilgi edinmek için Sayfalandı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ı için boyut değeri özellikleri.

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

object (AudienceDimensionValue)

Bir kitle kullanıcısı için her 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
Birlik alanı one_value. Bir tür boyut değeri. one_value yalnızca aşağıdakilerden biri olabilir:
value

string

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