Method: properties.audienceLists.exportSheet

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

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

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

यह तरीका बीटा वर्शन पर जाने से पहले लॉन्च किया गया है, ताकि ऐल्फ़ा के लेवल पर सिंटैक्स और सुविधाओं के बारे में सुझाव इकट्ठा किया जा सके. इस एपीआई के बारे में सुझाव/राय देने या शिकायत करने के लिए, Google Analytics Audience Export API के बारे में सुझाव, शिकायत या राय वाला फ़ॉर्म भरें.

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

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

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

पाथ पैरामीटर

पैरामीटर
name

string

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

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

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

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

string (int64 format)

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

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

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

limit

string (int64 format)

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

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

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

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

ऑडियंस की सूची में मौजूद उपयोगकर्ताओं की सूची के साथ बनाई गई Google शीट.

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

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

string

Google शीट देखने के लिए अपने ब्राउज़र में जाने के लिए यूआरआई.

spreadsheetId

string

ऐसा आईडी जो बनाए गए 'Google शीट' संसाधन की पहचान करता है.

rowCount

integer

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

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

audienceList

object (AudienceList)

AudienceList को एक्सपोर्ट किए जाने के बारे में कॉन्फ़िगरेशन डेटा. इस जवाब की Google शीट में, AudienceList को समझने में मदद करने के लिए लौटाया गया.

उदाहरण के लिए, AudienceList में Google शीट में मौजूद लाइनों से ज़्यादा लाइनें हो सकती हैं. ऐसे में, हो सकता है कि आप अतिरिक्त Google शीट में पंक्तियों के अगले पेज को फिर से पाने के लिए, अलग offset वैल्यू के साथ शीट एक्सपोर्ट करने का एक और अनुरोध भेजना चाहें.

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

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

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets