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 यूटीसी के "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 अनुरोध तुरंत भेजा जाएगा. इसमें, नई बनाई गई ऑडियंस सूची को CREATING स्थिति में दिखाया जाएगा. दूसरा POST अनुरोध, ऑडियंस की सूची बन जाने के बाद भेजा जाएगा. सूची का स्टेटस, ACTIVE या FAILED में से कोई एक होगा.

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

स्थिति

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

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

तरीके

create

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

get

 किसी ऑडियंस लिस्ट के कॉन्फ़िगरेशन मेटाडेटा को ऐक्सेस करता है.

list

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

query

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