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 के काेड में दिखाना 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string
  // End of mutually exclusive fields.
}
फ़ील्ड
डाइमेंशन वैल्यू का एक टाइप. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
value

string

अगर डाइमेंशन टाइप स्ट्रिंग है, तो वैल्यू को स्ट्रिंग के तौर पर दिखाया जाता है.
एक-दूसरे से अलग फ़ील्ड के आखिर में.