Method: properties.audienceLists.query

Kullanıcıların kitle listesini alır. Kitle oluşturulduktan sonra kullanıcılar hemen listelenemez. Öncelikle, kullanıcıların kitle listesini oluşturmak için audienceLists.create isteği gerekir. Ardından, bu yöntem kitle listesindeki kullanıcıları almak için kullanılır.

Kitle listelerine örneklerle birlikte giriş yapmak için Kitle Listesi Oluşturma başlıklı makaleyi inceleyin.

Google Analytics'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 adresinde beta kararlılığında 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 metni

İstek içeriği 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.

Sayfalama sırasında ilk istekte ofset belirtilmez veya ofset 0 olarak ayarlanır. İlk istek, satırların ilk limit'sini döndürür. İkinci istek, ilk isteğin limit değerini ofset olarak ayarlar. İkinci istek, satırların ikinci limit değerini döndürür.

Bu sayfalama parametresi hakkında daha fazla bilgi edinmek için Sayfalama başlıklı makaleyi inceleyin.
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ç satır isterseniz isteyin istek başına en fazla 250.000 satır döndürür. limit pozitif olmalıdır.

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

Bu sayfalama parametresi hakkında daha fazla bilgi edinmek için Sayfalama başlıklı makaleyi inceleyin.

Yanıt metni

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 bu değere eşit olacaktır.
audienceList

object (AudienceList)

Sorgulanan AudienceList hakkında 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'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ğinde 50 limit içeriyorsa yanıtta 175 rowCount bulunur ancak yalnızca 50 satır yer alır.

Bu sayfalama parametresi hakkında daha fazla bilgi edinmek için Sayfalama başlıklı makaleyi inceleyin.

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ının 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
one_value birleşik alanı. Bir tür boyut değeri. one_value aşağıdakilerden yalnızca biri olabilir:
value

string

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