Method: properties.audienceLists.query

Kullanıcıların kitle listesini alır. Kitle oluşturulduktan sonra kullanıcılar listelenmeye hemen uygun olmaz. Öncelikle, kullanıcıların kitle listesini oluşturmak için audienceLists.create isteğinde bulunmak gerekir. Daha sonra, bu yöntem kitle listesindeki kullanıcıları geri almak için 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 için önemli olan şekillerde segmentlere ayırmanızı sağlar. Daha fazla bilgi için https://support.google.com/analytics/answer/9267572 adresini inceleyin.

Bu yöntem, audienceExports.query adresindeki beta kararlılığında kullanılabilir. Bu API ile ilgili 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

İsteğin gövdesi, aşağıdaki yapıya sahip 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ıdır. İ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 değerine ayarlar; ilk istek satırların ilk limit değerini döndürür. İkinci istek, ofseti ilk isteğin limit değerine 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 Sayfaları numaralandırma konusuna bakın.
limit

string (int64 format)

İsteğe bağlı. Döndürülecek satır sayısı. Belirtilmemesi halinde 10.000 satır döndürülür. API, kaç tane istediğinize bakılmaksızın 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 satırdan daha az satır döndürebilir.

Bu sayfalara ayırma parametresi hakkında daha fazla bilgi için Sayfaları numaralandırma konusuna 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ın yorumlanmasına yardımcı olmak 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üyorsa ve API isteğine limit/50 satırı dahil ediyorsa yanıt, 175 satırdan rowCount tanesini ancak 50 satırı içerir.

Bu sayfalara ayırma parametresi hakkında daha fazla bilgi için Sayfaları numaralandırma konusuna 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ına ait 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
Birleştirme alanı one_value. Bir tür boyut değeri. one_value şunlardan yalnızca biri olabilir:
value

string

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