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 हो सकता है. इसके अलावा, उपयोगकर्ता के यूनीक Google Workspace प्रोफ़ाइल आईडी या उसके मुख्य ईमेल पते के लिए, यह userKey हो सकता है. मिटाया गया उपयोगकर्ता नहीं होना चाहिए. मिटाए गए उपयोगकर्ता के लिए, डायरेक्ट्री एपीआई में showDeleted=true के साथ users.list को कॉल करें. इसके बाद, दिए गए ID को userKey के तौर पर इस्तेमाल करें.

applicationName

enum (ApplicationName)

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

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

पैरामीटर
actorIpAddress

string

उस होस्ट का इंटरनेट प्रोटोकॉल (आईपी) पता जहां इवेंट किया गया था. यह उस उपयोगकर्ता के आईपी पते का इस्तेमाल करके, किसी रिपोर्ट की खास जानकारी को फ़िल्टर करने का एक और तरीका है जिसकी गतिविधि की शिकायत की जा रही है. यह आईपी पता, उपयोगकर्ता की जगह की जानकारी दिखा भी सकता है और नहीं भी. उदाहरण के लिए, आईपी पता उपयोगकर्ता के किसी प्रॉक्सी सर्वर का पता या वर्चुअल प्राइवेट नेटवर्क (VPN) पता हो सकता है. यह पैरामीटर 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 से जुड़ी वे सभी गतिविधियां मौजूद हैं जिन्हें एपीआई ने रिपोर्ट किया है. जब कोई एडमिन 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 क्वेरी स्ट्रिंग की वैल्यू डालना ज़रूरी नहीं है. डिफ़ॉल्ट वैल्यू 1000 है.

orgUnitID
(deprecated)

string

Deprecated. यह फ़ील्ड अब काम नहीं करता और अब इसका इस्तेमाल नहीं किया जा सकता.

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

pageToken

string

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

startTime

string

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

groupIdFilter

string

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

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

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

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

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

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

जेएसओएन के काेड में दिखाना
{
  "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

बूलियन वैल्यू से पता चलता है कि पेलोड चाहिए या नहीं. पेलोड ऐसा डेटा होता है जो एचटीटीपी POST, 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 ऐप्लिकेशन की गतिविधि रिपोर्ट, कैलेंडर गतिविधि के कई इवेंट की जानकारी दिखाती हैं.

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

'एंटरप्राइज़ ग्रुप' की गतिविधि रिपोर्ट में, एंटरप्राइज़ ग्रुप गतिविधि के अलग-अलग इवेंट के बारे में जानकारी दिखती है.

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

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

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

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

saml

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

token

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

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 के ग्राहकों के लिए उपलब्ध है.