REST Resource: properties.reportingDataAnnotations

रिसॉर्स: ReportingDataAnnotation

रिपोर्टिंग डेटा एनोटेशन, रिपोर्टिंग डेटा के लिए कुछ तारीखों से जुड़ी टिप्पणी होती है.

JSON के काेड में दिखाना
{
  "name": string,
  "title": string,
  "description": string,
  "color": enum (Color),
  "systemGenerated": boolean,

  // Union field target can be only one of the following:
  "annotationDate": {
    object (Date)
  },
  "annotationDateRange": {
    object (DateRange)
  }
  // End of list of possible types for union field target.
}
फ़ील्ड
name

string

ज़रूरी है. आइडेंटिफ़ायर. इस रिपोर्टिंग डेटा एनोटेशन का रिसॉर्स का नाम. फ़ॉर्मैट: 'properties/{property_id}/reportingDataAnnotations/{reportingDataAnnotation}' फ़ॉर्मैट: 'properties/123/reportingDataAnnotations/456'

title

string

ज़रूरी है. रिपोर्टिंग डेटा एनोटेशन का ऐसा टाइटल जिसे कोई भी व्यक्ति आसानी से पढ़ सकता है.

description

string

ज़रूरी नहीं. रिपोर्टिंग डेटा के इस एनोटेशन के बारे में जानकारी.

color

enum (Color)

ज़रूरी है. रिपोर्टिंग डेटा एनोटेशन को दिखाने के लिए इस्तेमाल किया जाने वाला रंग.

systemGenerated

boolean

सिर्फ़ आउटपुट के लिए. अगर यह सही है, तो इसका मतलब है कि यह एनोटेशन, Google Analytics सिस्टम ने जनरेट किया है. सिस्टम से जनरेट किए गए एनोटेशन को अपडेट या मिटाया नहीं जा सकता.

यूनियन फ़ील्ड target. इस रिपोर्टिंग डेटा एनोटेशन target के लिए, इनमें से सिर्फ़ एक टारगेट हो सकता है:
annotationDate

object (Date)

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

annotationDateRange

object (DateRange)

अगर सेट किया गया है, तो रिपोर्टिंग डेटा एनोटेशन, इस फ़ील्ड में दी गई तारीख की सीमा के लिए है.

तारीख

कैलेंडर की पूरी या कुछ तारीख दिखाता है, जैसे कि जन्मदिन. दिन का समय और टाइम ज़ोन, कहीं और बताया गया है या यह जानकारी ज़रूरी नहीं है. तारीख, ग्रेगोरियन कैलेंडर के हिसाब से होती है. यह इनमें से किसी एक को दिखा सकता है:

  • साल, महीने, और दिन की वैल्यू शून्य से ज़्यादा होनी चाहिए.
  • साल के तौर पर शून्य के साथ महीना और दिन (उदाहरण के लिए, सालगिरह).
  • साल, जिसमें महीना और दिन शून्य है.
  • साल और महीना, जिसमें दिन की वैल्यू शून्य हो. उदाहरण के लिए, क्रेडिट कार्ड के खत्म होने की तारीख.

मिलते-जुलते टाइप:

JSON के काेड में दिखाना
{
  "year": integer,
  "month": integer,
  "day": integer
}
फ़ील्ड
year

integer

तारीख का साल. यह संख्या 1 से 9999 के बीच होनी चाहिए. अगर साल के बिना तारीख बतानी है, तो 0 डालें.

month

integer

साल का महीना. यह 1 से 12 के बीच की कोई संख्या होनी चाहिए. अगर महीने और दिन के बिना साल की जानकारी देनी है, तो 0 डालें.

day

integer

महीने का दिन. यह वैल्यू 1 से 31 के बीच की होनी चाहिए. साथ ही, यह साल और महीने के लिए मान्य होनी चाहिए. इसके अलावा, साल या साल और महीने के लिए 0 भी डाला जा सकता है, जहां दिन की वैल्यू का कोई मतलब नहीं है.

DateRange

रिपोर्टिंग डेटा एनोटेशन की तारीख की सीमा दिखाता है. इसमें शुरू और खत्म होने की तारीखें शामिल होती हैं. टाइम ज़ोन, पैरंट प्रॉपर्टी के हिसाब से तय होते हैं.

JSON के काेड में दिखाना
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
फ़ील्ड
startDate

object (Date)

ज़रूरी है. इस सीमा के शुरू होने की तारीख. साल, महीना, और दिन सेट की गई मान्य तारीख होनी चाहिए. तारीख, बीते समय, मौजूदा समय या आने वाले समय की हो सकती है.

endDate

object (Date)

ज़रूरी है. इस सीमा के खत्म होने की तारीख. साल, महीना, और दिन सेट की गई मान्य तारीख होनी चाहिए. यह तारीख, शुरू होने की तारीख से ज़्यादा या उसके बराबर होनी चाहिए.

रंग

रिपोर्टिंग डेटा के एनोटेशन के लिए इस्तेमाल किए जा सकने वाले रंग

Enums
COLOR_UNSPECIFIED रंग की जानकारी मौजूद नहीं है या इसकी जानकारी नहीं दी गई है.
PURPLE बैंगनी रंग.
BROWN भूरा रंग.
BLUE नीला रंग.
GREEN हरा रंग.
RED लाल रंग.
CYAN सायैन रंग.
ORANGE नारंगी रंग. (सिर्फ़ सिस्टम से जनरेट किए गए एनोटेशन के लिए इस्तेमाल किया जाता है)

तरीके

create

रिपोर्टिंग डेटा एनोटेशन बनाता है.

delete

रिपोर्टिंग डेटा एनोटेशन मिटाता है.

get

रिपोर्टिंग डेटा का एक एनोटेशन देखें.

list

किसी प्रॉपर्टी पर रिपोर्टिंग डेटा के सभी एनोटेशन की सूची बनाएं.

patch

रिपोर्टिंग डेटा एनोटेशन को अपडेट करता है.