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

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

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

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

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

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 गतिविधि की रिपोर्ट में, एंटरप्राइज़ ग्रुप की गतिविधि के इवेंट के बारे में जानकारी मिलती है.
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 के ग्राहकों के लिए उपलब्ध है.