Method: activities.watch

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

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

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

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

पाथ पैरामीटर

पैरामीटर
userKey

string

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

enum (ApplicationName)

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

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

पैरामीटर
actorIpAddress

string

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

string

उस ग्राहक का यूनीक आईडी जिसका डेटा आपको चाहिए.
endTime

string

रिपोर्ट में दिखाई गई समय सीमा का अंत सेट करता है. तारीख, आरएफ़सी 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 स्ट्रक्चर में, API की ओर से रिपोर्ट की गई 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

रिपोर्ट में दिखाई गई समयसीमा की शुरुआत सेट करता है. तारीख, आरएफ़सी 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

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