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. Öncelikle, kullanıcıların kitle listesi oluşturmak için audienceLists.create isteğinde bulunmak gerekir. İkinci olarak, bu yöntem kitle listesindeki kullanıcıları almak için kullanılır.

Örneklerle Kitle Listeleri'ne 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 için ö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 adresine bakın.

Bu yöntem, beta sürüme geçmeden önce söz dizimi ve özelliklerle ilgili geri bildirim toplamak amacıyla alfa kararlılığında kullanıma sunulmuştur. 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 gövdesi, aşağıdaki yapıyla veriler 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 benzer şekilde, ofseti 0 olarak ayarlar. İlk istek satırların ilk limit kadarını döndürür. İkinci istek, ilk isteğin limit değerine göre ofseti ayarlar; ikinci istek, satırların ikinci limit kadarını döndürür.

Bu sayfalara ayırma parametresi hakkında daha fazla bilgi edinmek 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ı. Belirtilmemesi durumunda 10.000 satır döndürülür. API, istediğiniz sayıda satırdan bağımsız olarak istek başına maksimum 250.000 satır döndürür. limit pozitif olmalıdır.

Ayrıca, limit kadar çok 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 edinmek için Sayfalara ayırma bölümüne bakın.

Yanıt gövdesi

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 küçük veya ona eşit olur.
audienceList

object (AudienceList)

Sorgulanan AudienceList ile ilgili yapılandırma verileri. Bu yanıttaki kitle satırlarını yorumlamaya yardımcı olması için döndürüldü. Örneğin, bu AudienceList'teki boyutlar AudienceRows'daki 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ürse ve API isteğine limit/50 satır içeriyorsa yanıt, 175 satırdan rowCount tanesini, ancak yalnızca 50 satırı içerir.

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

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

object (AudienceDimensionValue)

Kitle kullanıcısı için her boyut değer ö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 şunlardan yalnızca biri olabilir:
value

string

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