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

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

enum (State)

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

string (Timestamp format)

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

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

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