Method: properties.audienceLists.query

उपयोगकर्ताओं की ऑडियंस सूची फिर से हासिल करता है. ऑडियंस बनाने के बाद, उपयोगकर्ता तुरंत लिस्टिंग के लिए उपलब्ध नहीं होते हैं. सबसे पहले, उपयोगकर्ताओं की ऑडियंस सूची बनाने के लिए audienceLists.create का अनुरोध करना ज़रूरी है. इसके बाद, ऑडियंस की सूची में शामिल उपयोगकर्ताओं को फिर से पाने के लिए इस तरीके का इस्तेमाल किया जाता है.

उदाहरणों के साथ ऑडियंस की सूची के बारे में जानने के लिए, ऑडियंस की सूची बनाना देखें.

Google Analytics 4 में ऑडियंस की मदद से, उपयोगकर्ताओं को कारोबार की अहमियत के मुताबिक अलग-अलग सेगमेंट में बांटा जा सकता है. ज़्यादा जानने के लिए, https://support.google.com/analytics/answer/9267572 देखें.

यह तरीका audienceExports.query पर बीटा स्थिरता के लिए उपलब्ध है. इस एपीआई के बारे में सुझाव/राय देने या शिकायत करने के लिए, Google Analytics Audience Export API का फ़ीडबैक फ़ॉर्म भरें.

एचटीटीपी अनुरोध

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

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ के पैरामीटर

पैरामीटर
name

string

ज़रूरी है. उस ऑडियंस की सूची का नाम जिससे उपयोगकर्ताओं को वापस लाना है. फ़ॉर्मैट: properties/{property}/audienceLists/{audienceList}

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, इस तरह का डेटा शामिल होता है:

जेएसओएन के काेड में दिखाना 
{
  "offset": string,
  "limit": string
}
फ़ील्ड
offset

string (int64 format)

ज़रूरी नहीं. शुरुआती पंक्ति के लिए पंक्तियों की संख्या. पहली लाइन की गिनती पंक्ति 0 के तौर पर की जाती है.

पेजिंग करते समय, पहला अनुरोध ऑफ़सेट तय नहीं करता है; या इसके बराबर, ऑफ़सेट को 0 पर सेट करता है; पहला अनुरोध पंक्तियों का पहली limit देता है. दूसरा अनुरोध पहले अनुरोध के limit पर ऑफ़सेट सेट करता है; दूसरा अनुरोध पंक्तियों का दूसरा limit दिखाता है.

पेज पर नंबर डालने वाले इस पैरामीटर के बारे में ज़्यादा जानने के लिए, पेज पर नंबर डालना देखें.
limit

string (int64 format)

ज़रूरी नहीं. दिखाई जाने वाली पंक्तियों की संख्या. इन्हें तय न करने पर, 10,000 लाइनें दिखती हैं. एपीआई हर अनुरोध में ज़्यादा से ज़्यादा 2,50,000 लाइनें दिखाता है, चाहे आपने कितनी भी लाइनें मांगी हों. limit पॉज़िटिव होना चाहिए.

अगर limit की संख्या ज़्यादा डाइमेंशन वैल्यू नहीं है, तो एपीआई, अनुरोध किए गए limit से कम लाइनें भी दिखा सकता है.

पेज पर नंबर डालने वाले इस पैरामीटर के बारे में ज़्यादा जानने के लिए, पेज पर नंबर डालना देखें.

जवाब का मुख्य भाग

ऑडियंस की सूची में मौजूद उपयोगकर्ताओं की सूची.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
फ़ील्ड
audienceRows[]

object (AudienceRow)

ऑडियंस की सूची में हर उपयोगकर्ता के लिए लाइनें. इस जवाब में पंक्तियों की संख्या, अनुरोध वाले पेज के साइज़ से कम या उसके बराबर होगी.
audienceList

object (AudienceList)

AudienceList से क्वेरी की जाने के बारे में कॉन्फ़िगरेशन डेटा. इस जवाब में, ऑडियंस की लाइनों को समझने के लिए, पेज को फिर से दिखाया गया है. उदाहरण के लिए, इस AudienceList के डाइमेंशन, AudienceRows के कॉलम से मेल खाते हैं.
rowCount

integer

AudienceList नतीजे में पंक्तियों की कुल संख्या होती है. rowCount, रिस्पॉन्स में मिली लाइनों की संख्या, limit अनुरोध पैरामीटर, और offset अनुरोध पैरामीटर से अलग है. उदाहरण के लिए, अगर कोई क्वेरी 175 लाइनें दिखाती है और एपीआई अनुरोध में 50 में से limit को शामिल करती है, तो रिस्पॉन्स में 175 में से rowCount, लेकिन सिर्फ़ 50 लाइनें शामिल होंगी.

पेज पर नंबर डालने वाले इस पैरामीटर के बारे में ज़्यादा जानने के लिए, पेज पर नंबर डालना देखें.

अनुमति के दायरे

इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:

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

AudienceRow

ऑडियंस की उपयोगकर्ता लाइन के लिए, डाइमेंशन की वैल्यू वाले एट्रिब्यूट.

जेएसओएन के काेड में दिखाना 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
फ़ील्ड
dimensionValues[]

object (AudienceDimensionValue)

किसी ऑडियंस उपयोगकर्ता के लिए, हर डाइमेंशन वैल्यू एट्रिब्यूट की वैल्यू. अनुरोध किए गए हर डाइमेंशन कॉलम के लिए, एक डाइमेंशन वैल्यू जोड़ दी जाएगी.

AudienceDimensionValue

किसी डाइमेंशन की वैल्यू.

जेएसओएन के काेड में दिखाना 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
फ़ील्ड
यूनियन फ़ील्ड one_value. एक तरह की डाइमेंशन वैल्यू. one_value इनमें से सिर्फ़ एक हो सकती है:
value

string

अगर डाइमेंशन टाइप कोई स्ट्रिंग है, तो वैल्यू को स्ट्रिंग के तौर पर डालें.