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}

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

अनुरोध के मुख्य भाग में, नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:

JSON के काेड में दिखाना 
{
  "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 से कम पंक्तियां भी दिखा सकता है.

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

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

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

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

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

object (AudienceRow)

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

object (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

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

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

object (AudienceDimensionValue)

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

AudienceDimensionValue

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

JSON के काेड में दिखाना 
{

  // 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

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