REST Resource: properties.audienceLists

रिसॉर्स: AudienceList

ऑडियंस की सूची, सूची बनाने के समय ऑडियंस में मौजूद उपयोगकर्ताओं की सूची होती है. एक ऑडियंस में, अलग-अलग दिनों के लिए कई ऑडियंस सूचियां बनाई जा सकती हैं.

JSON के काेड में दिखाना 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
फ़ील्ड
name

string

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

फ़ॉर्मैट: properties/{property}/audienceLists/{audienceList}
audience

string

ज़रूरी है. ऑडियंस के संसाधन का नाम. इस संसाधन के नाम से, सूची में शामिल ऑडियंस की पहचान की जाती है. साथ ही, इसे Analytics डेटा और एडमिन एपीआई के बीच शेयर किया जाता है.

फ़ॉर्मैट: properties/{property}/audiences/{audience}
audienceDisplayName

string

सिर्फ़ आउटपुट के लिए. इस ऑडियंस का जानकारी देने वाला डिसप्ले नेम. उदाहरण के लिए, "खरीदार".
dimensions[]

object (AudienceDimension)

ज़रूरी है. क्वेरी के जवाब में दिखाए गए और जिनका अनुरोध किया गया है वे डाइमेंशन.
creationQuotaTokensCharged

integer

सिर्फ़ आउटपुट के लिए. ऑडियंस की सूची बनाते समय, टोकन के कुल कोटे पर लगने वाला शुल्क. CREATING स्टेटस की गतिविधि के आधार पर, टोकन की यह संख्या तय होती है. इसलिए, जब ऑडियंस की सूची ACTIVE या FAILED स्टेटस में जाएगी, तब टोकन की यह संख्या तय हो जाएगी.
state

enum (State)

सिर्फ़ आउटपुट के लिए. इस ऑडियंस की सूची की मौजूदा स्थिति.
beginCreatingTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह समय जब audienceLists.create को कॉल किया गया था और ऑडियंस की सूची CREATING स्टेटस में चली गई थी.

आरएफ़सी3339 यूटीसी के "Zulu" फ़ॉर्मैट में एक टाइमस्टैंप, नैनोसेकंड रिज़ॉल्यूशन और नौ दशमलव अंकों के साथ. उदाहरण के लिए: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
rowCount

integer

सिर्फ़ आउटपुट के लिए. AudienceList के नतीजे में लाइनों की कुल संख्या.
errorMessage

string

सिर्फ़ आउटपुट के लिए. ऑडियंस की सूची बनाते समय कोई गड़बड़ी होने पर, गड़बड़ी का मैसेज दिखता है. ऐसा होने की सबसे आम वजह यह है कि कोटा खत्म हो गया है.
percentageCompleted

number

सिर्फ़ आउटपुट के लिए. इस ऑडियंस एक्सपोर्ट के लिए, पूरा होने का प्रतिशत 0 से 100 के बीच होता है.
recurringAudienceList

string

सिर्फ़ आउटपुट के लिए. बार-बार जनरेट होने वाली ऑडियंस सूची, जिसकी मदद से यह ऑडियंस सूची बनाई गई है. बार-बार जनरेट होने वाली ऑडियंस की सूचियां, हर दिन ऑडियंस की सूचियां बनाती हैं.

अगर ऑडियंस की सूचियां सीधे तौर पर बनाई जाती हैं, तो उनसे जुड़ी कोई बार-बार होने वाली ऑडियंस सूची नहीं होगी और यह फ़ील्ड खाली रहेगा.
webhookNotification

object (WebhookNotification)

ज़रूरी नहीं. Google Analytics Data API से आपके वेबहुक सर्वर पर भेजी जाने वाली वेबहुक सूचनाओं को कॉन्फ़िगर करता है. वेबहुक का इस्तेमाल करना ज़रूरी नहीं है. अगर ऑडियंस सूची का इस्तेमाल नहीं किया गया है, तो आपको इस एपीआई को पोल करके यह तय करना होगा कि ऑडियंस सूची का इस्तेमाल कब किया जा सकता है. वेबहुक की मदद से, आपके सर्वर पर सूचना भेजी जा सकती है. साथ ही, पोलिंग की ज़रूरत भी नहीं पड़ती.

वेबहुक पर एक या दो पोस्ट अनुरोध भेजे जाएंगे. पहला POST अनुरोध तुरंत भेजा जाएगा. इसमें, नई ऑडियंस सूची को 'बनाया जा रहा है' स्थिति में दिखाया जाएगा. ऑडियंस सूची बनाने के बाद, दूसरा POST अनुरोध भेजा जाएगा. यह अनुरोध तब भेजा जाएगा, जब ऑडियंस सूची का स्टेटस 'चालू है' या 'पूरा नहीं हुआ' हो.

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

स्थिति

फ़िलहाल, AudienceList इस स्थिति में मौजूद है.

Enums
STATE_UNSPECIFIED 'जानकारी नहीं दी गई' स्थिति का कभी इस्तेमाल नहीं किया जाएगा.
CREATING फ़िलहाल, ऑडियंस की सूची बनाई जा रही है. यह आने वाले समय में उपलब्ध होगी. ऑडियंस बनाने की प्रोसेस, audienceLists.create कॉल के तुरंत बाद शुरू हो जाती है.
ACTIVE ऑडियंस की सूची पूरी तरह से बन गई है और क्वेरी करने के लिए तैयार है. किसी अनुरोध से, ऑडियंस की सूची को ऐक्टिव करने के लिए, उसे सिंक नहीं किया जाता. ऐसा, बनाने के लिए किए गए शुरुआती कॉल के कुछ समय (उदाहरण के लिए, 15 मिनट) बाद होता है.
FAILED ऑडियंस की सूची नहीं बनाई जा सकी. ऐसा हो सकता है कि इस ऑडियंस सूची का फिर से अनुरोध करने पर, वह उपलब्ध हो जाए.

तरीके

create

 बाद में वापस पाने के लिए, ऑडियंस की सूची बनाता है.

exportSheet

 उपयोगकर्ताओं की ऑडियंस सूची को Google शीट में एक्सपोर्ट करता है.

get

 किसी खास ऑडियंस सूची के बारे में कॉन्फ़िगरेशन मेटाडेटा पाता है.

list

 किसी प्रॉपर्टी के लिए, ऑडियंस की सभी सूचियों की सूची बनाता है.

query

 उपयोगकर्ताओं की ऑडियंस सूची दिखाता है.