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 Data API और Admin API के बीच शेयर किया जाता है.

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

string

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

object (AudienceDimension)

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

integer

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

enum (State)

सिर्फ़ आउटपुट. फ़िलहाल, इस AudienceList की स्थिति.
beginCreatingTime

string (Timestamp format)

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

यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".
rowCount

integer

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

string

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

number

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

string

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

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

object (WebhookNotification)

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

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

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

स्थिति

AudienceList फ़िलहाल इस स्थिति में है.

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

तरीके

create

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

get

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

list

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

query

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