REST Resource: properties.audienceLists

संसाधन: AudienceList

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

जेएसओएन के काेड में दिखाना 
{
  "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

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

enum (State)

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

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह समय, जब AudienceLists.create को कॉल किया गया था और AudienceList ने CREATING स्थिति को शुरू किया था.

RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड का रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण: "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 से आपके वेबहुक सर्वर पर भेजी जाने वाली वेबहुक सूचनाओं को कॉन्फ़िगर करती है. वेबहुक का इस्तेमाल करना ज़रूरी नहीं है. अगर इस्तेमाल नहीं किया गया है, तो आपको इस एपीआई का इस्तेमाल करके यह पता लगाना होगा कि ऑडियंस की सूची का इस्तेमाल कब किया जा सकता है. वेबहुक की मदद से, आपके सर्वर पर सूचना भेजी जा सकती है और पोल कराने की ज़रूरत नहीं पड़ती.

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

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

स्थिति

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

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

तरीके

create

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

exportSheet

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

get

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

list

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

query

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