Method: activities.watch

खाते की गतिविधियों के बारे में सूचनाएं पाना शुरू करें. ज़्यादा जानकारी के लिए, पुश नोटिफ़िकेशन पाना लेख पढ़ें.

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

POST https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}/watch

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

पाथ पैरामीटर

पैरामीटर
userKey or all

string

यह उस प्रोफ़ाइल आईडी या उपयोगकर्ता के ईमेल पते को दिखाता है जिसके लिए डेटा को फ़िल्टर किया जाना चाहिए. all सभी जानकारी के लिए या userKey किसी उपयोगकर्ता के यूनीक Google Workspace प्रोफ़ाइल आईडी या उसके मुख्य ईमेल पते के लिए हो सकता है. वह उपयोगकर्ता, मिटाया गया उपयोगकर्ता नहीं होना चाहिए. मिटाए गए उपयोगकर्ता के लिए, Directory API में showDeleted=true के साथ users.list को कॉल करें. इसके बाद, मिले हुए ID को userKey के तौर पर इस्तेमाल करें.

applicationName

enum (ApplicationName)

उस ऐप्लिकेशन का नाम जिसके लिए इवेंट वापस पाने हैं.

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

पैरामीटर
actorIpAddress

string

उस होस्ट का इंटरनेट प्रोटोकॉल (आईपी) पता जहां इवेंट हुआ था. यह रिपोर्ट की खास जानकारी को फ़िल्टर करने का एक और तरीका है. इसके लिए, उस उपयोगकर्ता के आईपी पते का इस्तेमाल किया जाता है जिसकी गतिविधि की रिपोर्ट की जा रही है. यह आईपी पता, उपयोगकर्ता की मौजूदा जगह की जानकारी दिखा सकता है या नहीं भी दिखा सकता है. उदाहरण के लिए, आईपी पता उपयोगकर्ता के प्रॉक्सी सर्वर का पता या वर्चुअल प्राइवेट नेटवर्क (वीपीएन) का पता हो सकता है. यह पैरामीटर, IPv4 और IPv6, दोनों वर्शन के पतों के साथ काम करता है.

customerId

string

जिस ग्राहक का डेटा वापस पाना है उसका यूनीक आईडी.

endTime

string

रिपोर्ट में दिखाए गए समय की सीमा खत्म होने की तारीख सेट करता है. तारीख RFC 3339 फ़ॉर्मैट में होती है. उदाहरण के लिए, 2010-10-28T10:26:35.000Z. डिफ़ॉल्ट वैल्यू, एपीआई अनुरोध का अनुमानित समय होती है. एपीआई रिपोर्ट में समय से जुड़े तीन बुनियादी कॉन्सेप्ट होते हैं:

  • रिपोर्ट के लिए एपीआई के अनुरोध की तारीख: जब एपीआई ने रिपोर्ट बनाई और उसे वापस पाया.
  • रिपोर्ट के शुरू होने का समय: रिपोर्ट में दिखाए गए समयसीमा की शुरुआत. startTime का समय, endTime (अगर दिया गया है) और अनुरोध किए जाने के मौजूदा समय से पहले का होना चाहिए. ऐसा न होने पर, एपीआई गड़बड़ी का मैसेज दिखाएगा.
  • रिपोर्ट के लिए समयसीमा खत्म होने का समय: रिपोर्ट में दिखाए गए समय का आखिरी हिस्सा. उदाहरण के लिए, किसी रिपोर्ट में शामिल इवेंट का समय अप्रैल से मई तक हो सकता है. हालांकि, रिपोर्ट का अनुरोध अगस्त में किया जा सकता है.
अगर endTime तय नहीं किया जाता है, तो रिपोर्ट में startTime से लेकर मौजूदा समय तक की सभी गतिविधियां दिखती हैं. अगर startTime 180 दिन से ज़्यादा पुराना है, तो रिपोर्ट में पिछले 180 दिनों की गतिविधियां दिखती हैं.

eventName

string

एपीआई जिस इवेंट के बारे में क्वेरी कर रहा है उसका नाम. हर eventName, Google Workspace की किसी सेवा या सुविधा से जुड़ा होता है. एपीआई, इन्हें अलग-अलग तरह के इवेंट में व्यवस्थित करता है. उदाहरण के लिए, Admin console ऐप्लिकेशन की रिपोर्ट में Google Calendar के इवेंट. Calendar की सेटिंग type स्ट्रक्चर में, Calendar eventName की वे सभी गतिविधियां शामिल होती हैं जिनकी जानकारी API देता है. जब कोई एडमिन Calendar की सेटिंग में बदलाव करता है, तो एपीआई इस गतिविधि की जानकारी Calendar की सेटिंग के type और eventName पैरामीटर में देता है. eventName क्वेरी स्ट्रिंग और पैरामीटर के बारे में ज़्यादा जानकारी के लिए, applicationName में दिए गए अलग-अलग ऐप्लिकेशन के इवेंट के नामों की सूची देखें.

filters

string

filters क्वेरी स्ट्रिंग, कॉमा लगाकर अलग की गई एक सूची होती है. इसमें इवेंट पैरामीटर होते हैं, जिन्हें रिलेशनल ऑपरेटर की मदद से बदला जाता है. इवेंट पैरामीटर, {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},... के फ़ॉर्म में होते हैं

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

Drive में की गई गतिविधि के इन उदाहरणों में, दिखाई गई सूची में वे सभी edit इवेंट शामिल हैं जिनमें doc_id पैरामीटर की वैल्यू, रिलेशनल ऑपरेटर की तय की गई शर्तों से मेल खाती है. पहले उदाहरण में, अनुरोध से उन सभी दस्तावेज़ों की जानकारी मिलती है जिनमें बदलाव किया गया है और जिनकी doc_id वैल्यू 12345 के बराबर है. दूसरे उदाहरण में, रिपोर्ट में ऐसे सभी दस्तावेज़ दिखते हैं जिनमें बदलाव किया गया है और जिनमें doc_id की वैल्यू, 98765 के बराबर नहीं है. <> ऑपरेटर को अनुरोध की क्वेरी स्ट्रिंग (%3C%3E) में यूआरएल के तौर पर कोड में बदला गया है:

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

filters क्वेरी में इन रिलेशनल ऑपरेटर का इस्तेमाल किया जा सकता है:

  • ==—'बराबर है'.
  • <>—'इसके बराबर नहीं है'. इसे यूआरएल-कोड में बदला गया होना चाहिए (%3C%3E).
  • <—'इससे कम'. इसे यूआरएल-कोड में बदला गया होना चाहिए (%3C).
  • <=—'इससे कम या इसके बराबर'. इसे यूआरएल के लिए कोड में बदला गया होना चाहिए (%3C=).
  • >—'इससे ज़्यादा'. इसे यूआरएल-कोड में बदला गया होना चाहिए (%3E).
  • >=—'इससे ज़्यादा या इसके बराबर'. इसे यूआरएल के लिए कोड में बदला गया होना चाहिए (%3E=).

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

maxResults

integer

इस कुकी से यह तय होता है कि हर जवाब वाले पेज पर गतिविधि के कितने रिकॉर्ड दिखाए जाएं. उदाहरण के लिए, अगर अनुरोध में maxResults=1 सेट किया गया है और रिपोर्ट में दो गतिविधियां हैं, तो रिपोर्ट में दो पेज होंगे. जवाब की nextPageToken प्रॉपर्टी में, दूसरे पेज का टोकन होता है. अनुरोध में maxResults क्वेरी स्ट्रिंग देना ज़रूरी नहीं है. डिफ़ॉल्ट वैल्यू 1,000 है.

orgUnitID
(deprecated)

string

Deprecated. यह फ़ील्ड अब काम नहीं करता.

जिस संगठन की इकाई के बारे में शिकायत करनी है उसका आईडी. गतिविधि के रिकॉर्ड सिर्फ़ उन उपयोगकर्ताओं को दिखेंगे जो बताई गई संगठन की इकाई से जुड़े हैं.

pageToken

string

अगले पेज के बारे में बताने वाला टोकन. एक से ज़्यादा पेजों वाली रिपोर्ट के रिस्पॉन्स में nextPageToken प्रॉपर्टी होती है. रिपोर्ट का अगला पेज पाने के लिए, फ़ॉलो-ऑन अनुरोध में nextPageToken वैल्यू को pageToken क्वेरी स्ट्रिंग में डालें.

startTime

string

रिपोर्ट में दिखाए गए समय की सीमा की शुरुआत सेट करता है. तारीख RFC 3339 फ़ॉर्मैट में होती है. उदाहरण के लिए, 2010-10-28T10:26:35.000Z. रिपोर्ट में, startTime से लेकर endTime तक की सभी गतिविधियां दिखती हैं. startTime का समय, endTime (अगर दिया गया है) और अनुरोध किए जाने के मौजूदा समय से पहले का होना चाहिए. ऐसा न होने पर, एपीआई गड़बड़ी का मैसेज दिखाएगा.

groupIdFilter
(deprecated)

string

Deprecated. यह फ़ील्ड अब काम नहीं करता.

कॉमा लगाकर अलग किए गए ग्रुप आईडी (धुंधले किए गए) जिनके आधार पर उपयोगकर्ता की गतिविधियों को फ़िल्टर किया जाता है. इसका मतलब है कि जवाब में सिर्फ़ उन उपयोगकर्ताओं की गतिविधियां शामिल होंगी जो यहां बताए गए कम से कम एक ग्रुप आईडी का हिस्सा हैं. फ़ॉर्मैट: "id:abc123,id:xyz456"

लेख पढ़ें

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

अनुरोध के मुख्य भाग में SubscriptionChannel का उदाहरण है.

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

यह सूचना चैनल, संसाधन में हुए बदलावों को ट्रैक करने के लिए इस्तेमाल किया जाता है.

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

JSON के काेड में दिखाना
{
  "id": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    string: string,
    ...
  },
  "resourceId": string,
  "resourceUri": string,
  "kind": string
}
फ़ील्ड
id

string

यह चैनल की पहचान करने वाला यूयूआईडी या इसी तरह की कोई यूनीक स्ट्रिंग है.

token

string

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

expiration

string (int64 format)

सूचना चैनल की समयसीमा खत्म होने की तारीख और समय. इसे यूनिक्स टाइमस्टैंप के तौर पर, मिलीसेकंड में दिखाया जाता है. ज़रूरी नहीं.

type

string

इस चैनल के लिए इस्तेमाल किए गए डिलीवरी मैकेनिज़्म का टाइप. वैल्यू "web_hook" पर सेट होनी चाहिए.

address

string

वह पता जहां इस चैनल के लिए सूचनाएं भेजी जाती हैं.

payload

boolean

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

params

map (key: string, value: string)

डिलीवरी चैनल के व्यवहार को कंट्रोल करने वाले अतिरिक्त पैरामीटर. ज़रूरी नहीं.

यह एक ऐसा ऑब्जेक्ट है जिसमें "key": value जोड़े की सूची होती है. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

resourceId

string

यह एक ओपेक आईडी है. इससे उस संसाधन की पहचान होती है जिसे इस चैनल पर देखा जा रहा है. एपीआई के अलग-अलग वर्शन पर स्टेबल.

resourceUri

string

देखे गए संसाधन के लिए, वर्शन के हिसाब से आइडेंटिफ़ायर.

kind

string

इससे यह पता चलता है कि यह सूचना चैनल, किसी संसाधन में होने वाले बदलावों को देखने के लिए इस्तेमाल किया जाता है. यह संसाधन "api#channel" है.

अनुमति के स्कोप

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/admin.reports.audit.readonly

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.

ApplicationName

उस ऐप्लिकेशन का नाम जिसके लिए इवेंट वापस पाने हैं.

Enums
access_transparency

Google Workspace की ऐक्सेस ट्रांसपेरंसी (पारदर्शिता) गतिविधि की रिपोर्ट में, अलग-अलग तरह के ऐक्सेस ट्रांसपेरंसी (पारदर्शिता) गतिविधि इवेंट के बारे में जानकारी मिलती है.

admin

Admin console ऐप्लिकेशन की गतिविधि रिपोर्ट में, अलग-अलग तरह के एडमिन की गतिविधि से जुड़े इवेंट के बारे में खाते की जानकारी मिलती है.

calendar

Google Calendar ऐप्लिकेशन की गतिविधि रिपोर्ट में, Calendar में की गई अलग-अलग गतिविधियों के बारे में जानकारी मिलती है.

chat Chat में की गई गतिविधि की रिपोर्ट से, अलग-अलग Chat गतिविधि इवेंट के बारे में जानकारी मिलती है.
drive

Google Drive ऐप्लिकेशन की गतिविधि की रिपोर्ट में, Google Drive की अलग-अलग गतिविधियों के बारे में जानकारी मिलती है. Drive में की गई गतिविधि की रिपोर्ट, सिर्फ़ Google Workspace Business और Google Workspace Enterprise के ग्राहकों के लिए उपलब्ध है.

gcp Google Cloud Platform ऐप्लिकेशन की गतिविधि की रिपोर्ट से, अलग-अलग GCP गतिविधि इवेंट के बारे में जानकारी मिलती है.
gplus Google+ ऐप्लिकेशन की गतिविधि रिपोर्ट में, Google+ गतिविधि से जुड़े अलग-अलग इवेंट के बारे में जानकारी मिलती है.
groups

Google Groups ऐप्लिकेशन की गतिविधि रिपोर्ट में, Groups ऐक्टिविटी इवेंट के बारे में जानकारी मिलती है.

groups_enterprise

Enterprise Groups की गतिविधि रिपोर्ट में, अलग-अलग Enterprise group की गतिविधि से जुड़े इवेंट की जानकारी मिलती है.

jamboard Jamboard की गतिविधि की रिपोर्ट से, Jamboard की गतिविधि से जुड़े अलग-अलग इवेंट के बारे में जानकारी मिलती है.
login

लॉगिन ऐप्लिकेशन की गतिविधि रिपोर्ट में, अलग-अलग तरह के लॉगिन गतिविधि इवेंट के बारे में खाते की जानकारी मिलती है.

meet मीटिंग की ऑडिट गतिविधि की रिपोर्ट में, अलग-अलग तरह के मीटिंग की ऑडिट गतिविधि के इवेंट के बारे में जानकारी मिलती है.
mobile डिवाइस ऑडिट की गतिविधि की रिपोर्ट से, अलग-अलग तरह के डिवाइस ऑडिट की गतिविधि के इवेंट के बारे में जानकारी मिलती है.
rules

नियमों से जुड़ी गतिविधि की रिपोर्ट में, अलग-अलग तरह के नियमों से जुड़ी गतिविधि के इवेंट की जानकारी मिलती है.

saml

एसएएमएल गतिविधि की रिपोर्ट में, अलग-अलग तरह के एसएएमएल गतिविधि इवेंट की जानकारी मिलती है.

token

टोकन ऐप्लिकेशन की गतिविधि की रिपोर्ट से, अलग-अलग तरह के टोकन गतिविधि इवेंट के बारे में खाते की जानकारी मिलती है.

user_accounts

User Accounts ऐप्लिकेशन की गतिविधि रिपोर्ट में, अलग-अलग तरह के User Accounts ऐप्लिकेशन की गतिविधि से जुड़े इवेंट की जानकारी मिलती है.

context_aware_access

कॉन्टेक्स्ट अवेयर ऐक्सेस की गतिविधि की रिपोर्ट से, उन उपयोगकर्ताओं के बारे में जानकारी मिलती है जिन्हें कॉन्टेक्स्ट अवेयर ऐक्सेस के नियमों की वजह से ऐक्सेस नहीं दिया गया.

chrome

Chrome पर की गई गतिविधि की रिपोर्ट में, Chrome ब्राउज़र और Chrome OS पर हुई गतिविधियों के बारे में जानकारी मिलती है.

data_studio Data Studio की गतिविधि रिपोर्ट में, अलग-अलग तरह के Data Studio गतिविधि इवेंट के बारे में जानकारी मिलती है.
keep Keep ऐप्लिकेशन की गतिविधि रिपोर्ट से, Google Keep की गतिविधि से जुड़े अलग-अलग इवेंट के बारे में जानकारी मिलती है. Keep की गतिविधि की रिपोर्ट, सिर्फ़ Google Workspace Business और Enterprise के ग्राहकों के लिए उपलब्ध है.
classroom Classroom की गतिविधि की रिपोर्ट से, अलग-अलग तरह के Classroom की गतिविधि से जुड़े इवेंट की जानकारी मिलती है.