Method: properties.reportingDataAnnotations.list

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

एचटीटीपी अनुरोध

GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/reportingDataAnnotations

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. प्रॉपर्टी के संसाधन का नाम. फ़ॉर्मैट: properties/property_id उदाहरण: properties/123

क्वेरी पैरामीटर

पैरामीटर
filter

string

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

इन फ़ील्ड में यह सुविधा काम करती है:

  • 'name'
  • title
  • description
  • annotationDate
  • annotationDateRange
  • color

इसके अलावा, यह एपीआई ये सहायक फ़ंक्शन भी उपलब्ध कराता है:

  • annotation_duration() : यह एनोटेशन, durations को मार्क करने के लिए, वीडियो की कुल अवधि को दिखाता है. सेकंड की संख्या के बाद s सफ़िक्स होना चाहिए.
  • is_annotation_in_range(startDate, endDate) : यह फ़ंक्शन यह पता लगाता है कि एनोटेशन, startDate और endDate की तय की गई सीमा में है या नहीं. तारीखें ISO-8601 फ़ॉर्मैट में होनी चाहिए. उदाहरण के लिए, 2031-06-28.

ये ऑपरेशन किए जा सकते हैं:

  • = : बराबर है
  • != : बराबर नहीं है
  • < : इससे कम
  • > : इससे ज़्यादा
  • <= : इससे कम या इसके बराबर
  • >= : इससे ज़्यादा या इसके बराबर
  • : : has ऑपरेटर
  • =~ : रेगुलर एक्सप्रेशन मैच
  • !~ : रेगुलर एक्सप्रेशन मैच नहीं होता
  • NOT : लॉजिकल नॉट
  • AND : लॉजिकल ऐंड
  • OR : लॉजिकल ऑर

उदाहरण:

  1. title="Holiday Sale"
  2. description=~"[Bb]ig [Gg]ame.*[Ss]ale"
  3. is_annotation_in_range("2025-12-25", "2026-01-16") = true
  4. annotation_duration() >= 172800s AND title:BOGO
pageSize

integer

ज़रूरी नहीं. ज़्यादा से ज़्यादा कितने संसाधन दिखाने हैं. अतिरिक्त पेज होने पर भी, सेवा इस वैल्यू से कम नतीजे दिखा सकती है. अगर कोई वैल्यू नहीं दी जाती है, तो ज़्यादा से ज़्यादा 50 संसाधन दिखाए जाएंगे. ज़्यादा से ज़्यादा वैल्यू 200 हो सकती है; (ज़्यादा वैल्यू को ज़्यादा से ज़्यादा वैल्यू पर सेट कर दिया जाएगा)
pageToken

string

ज़रूरी नहीं. पेज टोकन, जो पिछले reportingDataAnnotations.list कॉल से मिला था. अगला पेज देखने के लिए, यह डालें. पेजेशन करते समय, reportingDataAnnotations.list को दिए गए सभी अन्य पैरामीटर, उस कॉल से मेल खाने चाहिए जिसने पेज टोकन दिया था.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

ListReportingDataAnnotation RPC के लिए रिस्पॉन्स मैसेज.

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

JSON के काेड में दिखाना 
{
  "reportingDataAnnotations": [
    {
      object (ReportingDataAnnotation)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
reportingDataAnnotations[]

object (ReportingDataAnnotation)

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

string

एक टोकन, जिसे अगले पेज को वापस पाने के लिए pageToken के तौर पर भेजा जा सकता है. अगर इस फ़ील्ड को छोड़ा जाता है, तो इसके बाद कोई पेज नहीं दिखेगा.

अनुमति के दायरे

इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit