Reports API: इकाइयों के इस्तेमाल की रिपोर्ट
संग्रह की मदद से व्यवस्थित रहें
अपनी प्राथमिकताओं के आधार पर, कॉन्टेंट को सेव करें और कैटगरी में बांटें.
इकाइयों के इस्तेमाल की रिपोर्ट में, इकाइयों से जुड़ी Google Workspace की सेवाओं से जुड़ी गतिविधियां दिखती हैं
जो आपके खाते के उपयोगकर्ता इस्तेमाल करते हैं. इन रिपोर्ट को खास इस्तेमाल के हिसाब से, ज़रूरत के मुताबिक बनाया और फ़िल्टर किया जा सकता है
जानकारी. पिछले 30 दिनों का डेटा उपलब्ध है.
इकाइयों के इस्तेमाल की रिपोर्ट का इस्तेमाल, सिर्फ़ कानूनी वजहों से
पर लागू होता है. ये रिपोर्ट इन पर भी लागू होती हैं
Google Workspace और Education.
सभी इकाइयों की उपयोग गतिविधियां फिर से पाएं
फ़िलहाल, इस एपीआई के साथ काम करने वाली इकाई का सिर्फ़ Google+ समुदाय ही है. वापस पाने के लिए
आपके खाते में मौजूद ऐप्लिकेशन की इकाइयों से जुड़ी सभी गतिविधियों की रिपोर्ट डाउनलोड करे, तो इनका इस्तेमाल करें
GET
एचटीटीपी अनुरोध और इसमें बताया गया अनुमति टोकन शामिल करें
अनुमति से जुड़े दस्तावेज़. इसके लिए
रीडबिलिटी के लिए सेट किया गया है, नीचे दिया गया उदाहरण लाइन रिटर्न के साथ फ़ॉर्मैट किया गया है:
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/date
?parameters=applicationParameters
&filters=parameterFilters
&maxResults=maxResults
date की वैल्यू, इस्तेमाल होने की तारीख है और टाइमस्टैंप
ISO 8601 फ़ॉर्मैट, yyyy-mm-dd. हमारा सुझाव है कि आप
इसके लिए अपने खाते के टाइम ज़ोन का इस्तेमाल करें. क्वेरी स्ट्रिंग पैरामीटर और क्वेरी स्ट्रिंग पैरामीटर
रिस्पॉन्स प्रॉपर्टी के लिए, एपीआई
रेफ़रंस. इकाइयों के इस्तेमाल की रिपोर्ट में मौजूद पैरामीटर से जुड़ी जानकारी के लिए, यहां जाएं:
इकाइयों के इस्तेमाल के पैरामीटर
संदर्भ देखें.
applicationParameters, कॉमा लगाकर अलग की गई उन पैरामीटर की सूची है जिन्हें आपको फिर से हासिल करना है.
हर पैरामीटर को application:parameter_name
के तौर पर फ़ॉर्मैट किया जाता है. उदाहरण के लिए,
gplus:community_name
. उपलब्ध पैरामीटर यहां दिए गए हैं:
इकाइयों के इस्तेमाल के पैरामीटर
संदर्भ देखें. अगर कोई पैरामीटर तय नहीं किया जाता है, तो सभी पैरामीटर लौटाए जाते हैं.
parameterFilters, नतीजों पर लागू करने के लिए फ़िल्टर की कॉमा-सेपरेटेड लिस्ट होती है. हर
फ़िल्टर को इस तरह फ़ॉर्मैट किया गया है
application:parameter_name[relational_operator]parameter_value
. उदाहरण के लिए,
फ़िल्टर gplus:num_total_members>100
, नतीजों को सिर्फ़ शामिल करने के लिए फ़िल्टर करता है
जहां gplus:num_total_members
पैरामीटर की वैल्यू 100 से ज़्यादा है.
एक फ़ेच में दिए जाने वाले नतीजों की ज़्यादा से ज़्यादा संख्या maxResults है. अगर कुल
नतीजों की संख्या इससे ज़्यादा है, तो जवाब छोटा कर दिया जाएगा और
nextPageToken
को शामिल किया जाएगा (देखें
यहां JSON रिस्पॉन्स का उदाहरण दिया गया है).
उदाहरण
नीचे दिए गए उदाहरण में सभी पैरामीटर वाली रिपोर्ट दी गई है
सभी gplus_communities
इकाइयों के लिए.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all
/dates/2017-12-11
यहां दिए गए उदाहरण में, community_name
पैरामीटर वाली रिपोर्ट दी गई है
सभी gplus_communities
इकाइयों के लिए.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all
/dates/2017-12-11?parameters=gplus:community_name
नीचे दिए गए उदाहरण में community_name
की रिपोर्ट दी गई है और
हर gplus_communities
इकाई के लिए, num_total_members
. इसके हिसाब से फ़िल्टर किया गया है
100 से ज़्यादा सदस्यों वाले समुदाय. एपीआई से मिले रिस्पॉन्स के उदाहरण के लिए, यहां देखें
JSON रिस्पॉन्स का उदाहरण.
GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-11
?parameters=gplus:community_name,gplus:num_total_members&filters=gplus:num_total_members>100
किसी खास इकाई की रिपोर्ट वापस पाना
किसी खास इकाई की रिपोर्ट वापस पाने के लिए, इस GET
एचटीटीपी अनुरोध का इस्तेमाल करें और
में बताया गया अनुमति टोकन शामिल करें
अनुमति से जुड़े दस्तावेज़. इसके लिए
रीडबिलिटी के लिए सेट किया गया है, नीचे दिया गया उदाहरण लाइन रिटर्न के साथ फ़ॉर्मैट किया गया है.
GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date
?parameters=applicationParameters
&filters=parameterFilters
&maxResults=maxResults
entityKey एक इकाई आइडेंटिफ़ायर है, जो खास तौर पर उस ऐप्लिकेशन के लिए होता है जहां
करना. एपीआई देखें
अगर आपको किसी खास इकाई के लिए, entityKey पाने का तरीका जानना है, तो इस बारे में जानकारी पाएं
दिलचस्पी है. अन्य पैरामीटर, ऊपर
सभी इकाइयों के इस्तेमाल से जुड़ी गतिविधियां वापस पाना.
क्वेरी स्ट्रिंग पैरामीटर और रिस्पॉन्स प्रॉपर्टी के बारे में ज़्यादा जानकारी के लिए, एपीआई का संदर्भ देखें. जानकारी के लिए
इकाइयों के इस्तेमाल की रिपोर्ट में दिए पैरामीटर के बारे में जानने के लिए,
इकाइयों के इस्तेमाल के पैरामीटर
संदर्भ देखें.
उदाहरण
नीचे दिए गए उदाहरण में, ऐसी gplus_community
इकाई की इकाई रिपोर्ट दी गई है जिसका
entityKey "1234".
https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11
इस्तेमाल की रिपोर्ट के तौर पर JSON रिस्पॉन्स का उदाहरण
सही रिस्पॉन्स मिलने पर एचटीटीपी 200 स्टेटस कोड दिखता है. इसके साथ
तो रिस्पॉन्स में रिपोर्ट दिखती है. रिस्पॉन्स में कुछ पैरामीटर
पठनीयता के लिए छोड़ा गया.
इकाइयों की रिपोर्ट के लिए, JSON रिस्पॉन्स का उदाहरण
{
"kind": "reports#usageReports",
"nextPageToken": "NjQ1OTgwODk0MzkxNDAwNjQ0OA",
"usageReports": [
{
"kind": "admin#reports#usageReport",
"date": "2017-12-11",
"entity": {
"type": "OBJECT",
"customerId": "C03az79cb",
"objectType": "GPLUS_COMMUNITY",
"objectId": "1234",
},
"parameters": [
{
"name": "gplus:community_name",
"stringValue": "My Community"
},
{
"name": "gplus:num_total_members",
"intValue": 37
},
{
"name": "gplus:num_7day_active_members",
"intValue": 12
},
{
"name": "gplus:num_30day_active_members",
"intValue": 17
},
]
}
]
}
चेतावनियों के साथ इकाइयों की रिपोर्ट के लिए, JSON रिस्पॉन्स का उदाहरण
अगर अनुरोध पूरा नहीं किया जाता है, तो हो सकता है कि जवाब के तौर पर एक या उससे ज़्यादा चेतावनियां दिखें. इसमें
उदाहरण के लिए, अनुरोध किए जाते समय रिपोर्ट उपलब्ध नहीं होती.
{
"kind": "reports#usageReports",
"warnings": [
{
"code": "PARTIAL_DATA_AVAILABLE"
"message": "Data for date 2017-12-11 for application gplus is not available right now, please try again after a few hours."
"data": [
{
"key": "date"
"value": "2017-12-11"
}
]
}
],
"usageReports": [],
}
warnings
कलेक्शन में मौजूद हर एंट्री में ये पैरामीटर होते हैं:
code
: मशीन से पढ़ा जा सकने वाला चेतावनी कोड
message
: चेतावनी वाला मैसेज, जिसे कोई भी व्यक्ति आसानी से पढ़ सकता है
data
: की-वैल्यू पेयर की सूची, जो चेतावनी की पूरी जानकारी देती है
जब तक कुछ अलग से न बताया जाए, तब तक इस पेज की सामग्री को Creative Commons Attribution 4.0 License के तहत और कोड के नमूनों को Apache 2.0 License के तहत लाइसेंस मिला है. ज़्यादा जानकारी के लिए, Google Developers साइट नीतियां देखें. Oracle और/या इससे जुड़ी हुई कंपनियों का, Java एक रजिस्टर किया हुआ ट्रेडमार्क है.
आखिरी बार 2025-08-29 (UTC) को अपडेट किया गया.
[null,null,["आखिरी बार 2025-08-29 (UTC) को अपडेट किया गया."],[],[],null,["# Reports API: Entities Usage Report\n\nThe entities usage report returns Google Workspace service activities related to entities\nused by your account's users. These reports can be customized and filtered for specific usage\ninformation. Data is available for the past 30 days.\n\nThe entities usage report may be used only for lawful purposes in\naccordance with your Customer Agreement. These reports also apply to\nGoogle Workspace and Education.\n\nRetrieve all entities usage activities\n--------------------------------------\n\nCurrently, the only entity type supported by this API is Google+ communities. To retrieve a\nreport of all activities related to app entities in your account, use the following\n`GET` HTTP request and include the authorization token described in the\n[authorization documentation](/workspace/admin/reports/v1/guides/authorizing). For\nreadability, the following example is formatted with line returns: \n\n```\nGET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/date\n?parameters=applicationParameters\n&filters=parameterFilters\n&maxResults=maxResults\n```\n\nThe \u003cvar translate=\"no\"\u003edate\u003c/var\u003e value is the date the usage occurred and the timestamp is in the\n[ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601), yyyy-mm-dd. We recommend you\nuse your account's time zone for this. For more information about the query string parameters and\nresponse properties, see the [API\nReference](/workspace/admin/reports/v1/reference/entityUsageReports/get). For information about the entities usage report parameters, see the\n[Entities Usage Parameters\nreference](/workspace/admin/reports/v1/reference/usage-ref-appendix-a/entities).\n\n\u003cvar translate=\"no\"\u003eapplicationParameters\u003c/var\u003e is a comma-separated list of parameters you wish to retrieve.\nEach parameter is formatted as `application:parameter_name`, for example,\n`gplus:community_name`. The available parameters are documented in the\n[Entities Usage Parameters\nreference](/workspace/admin/reports/v1/reference/usage-ref-appendix-a/entities). If no parameters are specified, all are returned.\n\n\u003cvar translate=\"no\"\u003eparameterFilters\u003c/var\u003e is a comma-separated list of filters to apply to the results. Each\nfilter is formatted as\n`application:parameter_name[relational_operator]parameter_value`. For example, the\nfilter `gplus:num_total_members\u003e100` filters the results to contain only results\nwhere the `gplus:num_total_members` parameter has a value greater than 100.\n\n\u003cvar translate=\"no\"\u003emaxResults\u003c/var\u003e is the maximum number of results to return in a single fetch. If the total\nnumber of results is greater than this, the response will be truncated and a\n`nextPageToken` will be included (see the\n[JSON response example](#example_response) below).\n\n### Examples\n\nThe following example gets a report containing all parameters\nfor all `gplus_communities` entities. \n\n```\nGET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all\n/dates/2017-12-11\n```\n\nThe following example gets a report containing the `community_name` parameter\nfor all `gplus_communities` entities. \n\n```\nGET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all\n/dates/2017-12-11?parameters=gplus:community_name\n```\n\nThe following example gets a report of `community_name` and\n`num_total_members` for each `gplus_communities` entity, filtered by\ncommunities with more than 100 members. For an example of an API response, see the\n[JSON response example](#example_response). \n\n```\nGET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-11\n?parameters=gplus:community_name,gplus:num_total_members&filters=gplus:num_total_members\u003e100\n```\n\nRetrieve a report for a specific entity\n---------------------------------------\n\nTo retrieve a report for a specific entity, use the following `GET` HTTP request and\ninclude the authorization token described in the\n[authorization documentation](/workspace/admin/reports/v1/guides/authorizing). For\nreadability, the following example is formatted with line returns. \n\n```\nGET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date\n?parameters=applicationParameters\n&filters=parameterFilters\n&maxResults=maxResults\n```\n\nThe \u003cvar translate=\"no\"\u003eentityKey\u003c/var\u003e is an entity identifier which is specific to the application where the\nentity lives. See the [API\nReference](/workspace/admin/reports/v1/reference/userUsageReport/get) for details on how to obtain the \u003cvar translate=\"no\"\u003eentityKey\u003c/var\u003e for the particular entity you\nare interested in. The other parameters are documented above under\n[Retrieve all entities usage activities](#get_all_entities_usage).\n\nFor more information about the query string parameters and response properties, see the [API Reference](/workspace/admin/reports/v1/reference/userUsageReport/get). For information\nabout the entities usage report parameters, see the\n[Entities Usage Parameters\nreference](/workspace/admin/reports/v1/reference/usage-ref-appendix-a/users).\n\n### Examples\n\nThe following example gets the entity report for a `gplus_community` entity with the\n\u003cvar translate=\"no\"\u003eentityKey\u003c/var\u003e \"1234\". \n\n```\nhttps://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11\n```\n\nUsage report example JSON response\n----------------------------------\n\nA successful response returns an [HTTP 200 status code](http://wikipedia.org/wiki/List_of_HTTP_status_codes). Along with\nthe status code, the response returns a report. Some of the parameters in the response have been\nomitted for readability.\n\n#### Example JSON response for entities report\n\n```carbon\n{\n \"kind\": \"reports#usageReports\",\n \"nextPageToken\": \"NjQ1OTgwODk0MzkxNDAwNjQ0OA\",\n \"usageReports\": [\n {\n \"kind\": \"admin#reports#usageReport\",\n \"date\": \"2017-12-11\",\n \"entity\": {\n \"type\": \"OBJECT\",\n \"customerId\": \"C03az79cb\",\n \"objectType\": \"GPLUS_COMMUNITY\",\n \"objectId\": \"1234\",\n },\n \"parameters\": [\n {\n \"name\": \"gplus:community_name\",\n \"stringValue\": \"My Community\"\n },\n {\n \"name\": \"gplus:num_total_members\",\n \"intValue\": 37\n },\n {\n \"name\": \"gplus:num_7day_active_members\",\n \"intValue\": 12\n },\n {\n \"name\": \"gplus:num_30day_active_members\",\n \"intValue\": 17\n },\n ]\n }\n ]\n}\n```\n\n#### Example JSON response for entities report with warnings\n\nOne or more warnings may be returned in the response if the request cannot be fulfilled. In this example, the report is not available at the time the request is made. \n\n```scdoc\n{\n \"kind\": \"reports#usageReports\",\n \"warnings\": [\n {\n \"code\": \"PARTIAL_DATA_AVAILABLE\"\n \"message\": \"Data for date 2017-12-11 for application gplus is not available right now, please try again after a few hours.\"\n \"data\": [\n {\n \"key\": \"date\"\n \"value\": \"2017-12-11\"\n }\n ]\n }\n ],\n \"usageReports\": [],\n}\n```\nEach entry in the `warnings` array has the following parameters:\n\n- `code`: machine-readable warning code\n- `message`: human-readable warning message\n- `data`: list of key-value pairs which give detailed warning information"]]