You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

843 lines
31 KiB

  1. {
  2. "auth": {
  3. "oauth2": {
  4. "scopes": {
  5. "https://www.googleapis.com/auth/admin.reports.audit.readonly": {
  6. "description": "View audit reports for your G Suite domain"
  7. },
  8. "https://www.googleapis.com/auth/admin.reports.usage.readonly": {
  9. "description": "View usage reports for your G Suite domain"
  10. }
  11. }
  12. }
  13. },
  14. "basePath": "/admin/reports/v1/",
  15. "baseUrl": "https://www.googleapis.com/admin/reports/v1/",
  16. "batchPath": "batch/admin/reports_v1",
  17. "canonicalName": "reports",
  18. "description": "Fetches reports for the administrators of G Suite customers about the usage, collaboration, security, and risk for their users.",
  19. "discoveryVersion": "v1",
  20. "documentationLink": "https://developers.google.com/admin-sdk/reports/",
  21. "etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/KxeH4adBmf7mUlvJEwydRVyJqZU\"",
  22. "icons": {
  23. "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
  24. "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
  25. },
  26. "id": "admin:reports_v1",
  27. "kind": "discovery#restDescription",
  28. "name": "admin",
  29. "ownerDomain": "google.com",
  30. "ownerName": "Google",
  31. "packagePath": "admin",
  32. "parameters": {
  33. "alt": {
  34. "default": "json",
  35. "description": "Data format for the response.",
  36. "enum": [
  37. "json"
  38. ],
  39. "enumDescriptions": [
  40. "Responses with Content-Type of application/json"
  41. ],
  42. "location": "query",
  43. "type": "string"
  44. },
  45. "fields": {
  46. "description": "Selector specifying which fields to include in a partial response.",
  47. "location": "query",
  48. "type": "string"
  49. },
  50. "key": {
  51. "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
  52. "location": "query",
  53. "type": "string"
  54. },
  55. "oauth_token": {
  56. "description": "OAuth 2.0 token for the current user.",
  57. "location": "query",
  58. "type": "string"
  59. },
  60. "prettyPrint": {
  61. "default": "true",
  62. "description": "Returns response with indentations and line breaks.",
  63. "location": "query",
  64. "type": "boolean"
  65. },
  66. "quotaUser": {
  67. "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
  68. "location": "query",
  69. "type": "string"
  70. },
  71. "userIp": {
  72. "description": "Deprecated. Please use quotaUser instead.",
  73. "location": "query",
  74. "type": "string"
  75. }
  76. },
  77. "protocol": "rest",
  78. "resources": {
  79. "activities": {
  80. "methods": {
  81. "list": {
  82. "description": "Retrieves a list of activities for a specific customer and application.",
  83. "httpMethod": "GET",
  84. "id": "reports.activities.list",
  85. "parameterOrder": [
  86. "userKey",
  87. "applicationName"
  88. ],
  89. "parameters": {
  90. "actorIpAddress": {
  91. "description": "IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.",
  92. "location": "query",
  93. "type": "string"
  94. },
  95. "applicationName": {
  96. "description": "Application name for which the events are to be retrieved.",
  97. "location": "path",
  98. "pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)|(jamboard)|(meet)|(user_accounts)|(access_transparency)",
  99. "required": true,
  100. "type": "string"
  101. },
  102. "customerId": {
  103. "description": "Represents the customer for which the data is to be fetched.",
  104. "location": "query",
  105. "pattern": "C.+",
  106. "type": "string"
  107. },
  108. "endTime": {
  109. "description": "Return events which occurred at or before this time.",
  110. "location": "query",
  111. "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
  112. "type": "string"
  113. },
  114. "eventName": {
  115. "description": "Name of the event being queried.",
  116. "location": "query",
  117. "type": "string"
  118. },
  119. "filters": {
  120. "description": "Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...",
  121. "location": "query",
  122. "pattern": "(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+,)*(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+)",
  123. "type": "string"
  124. },
  125. "maxResults": {
  126. "description": "Number of activity records to be shown in each page.",
  127. "format": "int32",
  128. "location": "query",
  129. "maximum": "1000",
  130. "minimum": "1",
  131. "type": "integer"
  132. },
  133. "orgUnitID": {
  134. "default": "",
  135. "description": "the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s)",
  136. "location": "query",
  137. "pattern": "(id:[a-z0-9]+)",
  138. "type": "string"
  139. },
  140. "pageToken": {
  141. "description": "Token to specify next page.",
  142. "location": "query",
  143. "type": "string"
  144. },
  145. "startTime": {
  146. "description": "Return events which occurred at or after this time.",
  147. "location": "query",
  148. "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
  149. "type": "string"
  150. },
  151. "userKey": {
  152. "description": "Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.",
  153. "location": "path",
  154. "required": true,
  155. "type": "string"
  156. }
  157. },
  158. "path": "activity/users/{userKey}/applications/{applicationName}",
  159. "response": {
  160. "$ref": "Activities"
  161. },
  162. "scopes": [
  163. "https://www.googleapis.com/auth/admin.reports.audit.readonly"
  164. ],
  165. "supportsSubscription": true
  166. },
  167. "watch": {
  168. "description": "Push changes to activities",
  169. "httpMethod": "POST",
  170. "id": "reports.activities.watch",
  171. "parameterOrder": [
  172. "userKey",
  173. "applicationName"
  174. ],
  175. "parameters": {
  176. "actorIpAddress": {
  177. "description": "IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.",
  178. "location": "query",
  179. "type": "string"
  180. },
  181. "applicationName": {
  182. "description": "Application name for which the events are to be retrieved.",
  183. "location": "path",
  184. "pattern": "(admin)|(calendar)|(drive)|(login)|(mobile)|(token)|(groups)|(saml)|(chat)|(gplus)|(rules)|(jamboard)|(meet)|(user_accounts)|(access_transparency)",
  185. "required": true,
  186. "type": "string"
  187. },
  188. "customerId": {
  189. "description": "Represents the customer for which the data is to be fetched.",
  190. "location": "query",
  191. "pattern": "C.+",
  192. "type": "string"
  193. },
  194. "endTime": {
  195. "description": "Return events which occurred at or before this time.",
  196. "location": "query",
  197. "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
  198. "type": "string"
  199. },
  200. "eventName": {
  201. "description": "Name of the event being queried.",
  202. "location": "query",
  203. "type": "string"
  204. },
  205. "filters": {
  206. "description": "Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...",
  207. "location": "query",
  208. "pattern": "(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+,)*(.+[\u003c,\u003c=,==,\u003e=,\u003e,\u003c\u003e].+)",
  209. "type": "string"
  210. },
  211. "maxResults": {
  212. "description": "Number of activity records to be shown in each page.",
  213. "format": "int32",
  214. "location": "query",
  215. "maximum": "1000",
  216. "minimum": "1",
  217. "type": "integer"
  218. },
  219. "orgUnitID": {
  220. "default": "",
  221. "description": "the organizational unit's(OU) ID to filter activities from users belonging to a specific OU or one of its sub-OU(s)",
  222. "location": "query",
  223. "pattern": "(id:[a-z0-9]+)",
  224. "type": "string"
  225. },
  226. "pageToken": {
  227. "description": "Token to specify next page.",
  228. "location": "query",
  229. "type": "string"
  230. },
  231. "startTime": {
  232. "description": "Return events which occurred at or after this time.",
  233. "location": "query",
  234. "pattern": "(\\d\\d\\d\\d)-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)(?:\\.(\\d+))?(?:(Z)|([-+])(\\d\\d):(\\d\\d))",
  235. "type": "string"
  236. },
  237. "userKey": {
  238. "description": "Represents the profile id or the user email for which the data should be filtered. When 'all' is specified as the userKey, it returns usageReports for all users.",
  239. "location": "path",
  240. "required": true,
  241. "type": "string"
  242. }
  243. },
  244. "path": "activity/users/{userKey}/applications/{applicationName}/watch",
  245. "request": {
  246. "$ref": "Channel",
  247. "parameterName": "resource"
  248. },
  249. "response": {
  250. "$ref": "Channel"
  251. },
  252. "scopes": [
  253. "https://www.googleapis.com/auth/admin.reports.audit.readonly"
  254. ],
  255. "supportsSubscription": true
  256. }
  257. }
  258. },
  259. "channels": {
  260. "methods": {
  261. "stop": {
  262. "description": "Stop watching resources through this channel",
  263. "httpMethod": "POST",
  264. "id": "admin.channels.stop",
  265. "path": "/admin/reports_v1/channels/stop",
  266. "request": {
  267. "$ref": "Channel",
  268. "parameterName": "resource"
  269. },
  270. "scopes": [
  271. "https://www.googleapis.com/auth/admin.reports.audit.readonly"
  272. ]
  273. }
  274. }
  275. },
  276. "customerUsageReports": {
  277. "methods": {
  278. "get": {
  279. "description": "Retrieves a report which is a collection of properties / statistics for a specific customer.",
  280. "httpMethod": "GET",
  281. "id": "reports.customerUsageReports.get",
  282. "parameterOrder": [
  283. "date"
  284. ],
  285. "parameters": {
  286. "customerId": {
  287. "description": "Represents the customer for which the data is to be fetched.",
  288. "location": "query",
  289. "pattern": "C.+",
  290. "type": "string"
  291. },
  292. "date": {
  293. "description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
  294. "location": "path",
  295. "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
  296. "required": true,
  297. "type": "string"
  298. },
  299. "pageToken": {
  300. "description": "Token to specify next page.",
  301. "location": "query",
  302. "type": "string"
  303. },
  304. "parameters": {
  305. "description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
  306. "location": "query",
  307. "pattern": "(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+,)*(((accounts)|(app_maker)|(apps_scripts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)|(meet)):[^,]+)",
  308. "type": "string"
  309. }
  310. },
  311. "path": "usage/dates/{date}",
  312. "response": {
  313. "$ref": "UsageReports"
  314. },
  315. "scopes": [
  316. "https://www.googleapis.com/auth/admin.reports.usage.readonly"
  317. ]
  318. }
  319. }
  320. },
  321. "entityUsageReports": {
  322. "methods": {
  323. "get": {
  324. "description": "Retrieves a report which is a collection of properties / statistics for a set of objects.",
  325. "httpMethod": "GET",
  326. "id": "reports.entityUsageReports.get",
  327. "parameterOrder": [
  328. "entityType",
  329. "entityKey",
  330. "date"
  331. ],
  332. "parameters": {
  333. "customerId": {
  334. "description": "Represents the customer for which the data is to be fetched.",
  335. "location": "query",
  336. "pattern": "C.+",
  337. "type": "string"
  338. },
  339. "date": {
  340. "description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
  341. "location": "path",
  342. "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
  343. "required": true,
  344. "type": "string"
  345. },
  346. "entityKey": {
  347. "description": "Represents the key of object for which the data should be filtered.",
  348. "location": "path",
  349. "required": true,
  350. "type": "string"
  351. },
  352. "entityType": {
  353. "description": "Type of object. Should be one of - gplus_communities.",
  354. "location": "path",
  355. "pattern": "(gplus_communities)",
  356. "required": true,
  357. "type": "string"
  358. },
  359. "filters": {
  360. "description": "Represents the set of filters including parameter operator value.",
  361. "location": "query",
  362. "pattern": "(((gplus)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+,)*(((gplus)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+)",
  363. "type": "string"
  364. },
  365. "maxResults": {
  366. "description": "Maximum number of results to return. Maximum allowed is 1000",
  367. "format": "uint32",
  368. "location": "query",
  369. "maximum": "1000",
  370. "type": "integer"
  371. },
  372. "pageToken": {
  373. "description": "Token to specify next page.",
  374. "location": "query",
  375. "type": "string"
  376. },
  377. "parameters": {
  378. "description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
  379. "location": "query",
  380. "pattern": "(((gplus)):[^,]+,)*(((gplus)):[^,]+)",
  381. "type": "string"
  382. }
  383. },
  384. "path": "usage/{entityType}/{entityKey}/dates/{date}",
  385. "response": {
  386. "$ref": "UsageReports"
  387. },
  388. "scopes": [
  389. "https://www.googleapis.com/auth/admin.reports.usage.readonly"
  390. ]
  391. }
  392. }
  393. },
  394. "userUsageReport": {
  395. "methods": {
  396. "get": {
  397. "description": "Retrieves a report which is a collection of properties / statistics for a set of users.",
  398. "httpMethod": "GET",
  399. "id": "reports.userUsageReport.get",
  400. "parameterOrder": [
  401. "userKey",
  402. "date"
  403. ],
  404. "parameters": {
  405. "customerId": {
  406. "description": "Represents the customer for which the data is to be fetched.",
  407. "location": "query",
  408. "pattern": "C.+",
  409. "type": "string"
  410. },
  411. "date": {
  412. "description": "Represents the date in yyyy-mm-dd format for which the data is to be fetched.",
  413. "location": "path",
  414. "pattern": "(\\d){4}-(\\d){2}-(\\d){2}",
  415. "required": true,
  416. "type": "string"
  417. },
  418. "filters": {
  419. "description": "Represents the set of filters including parameter operator value.",
  420. "location": "query",
  421. "pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[a-z0-9_]+[\u003c,\u003c=,==,\u003e=,\u003e,!=][^,]+)",
  422. "type": "string"
  423. },
  424. "maxResults": {
  425. "description": "Maximum number of results to return. Maximum allowed is 1000",
  426. "format": "uint32",
  427. "location": "query",
  428. "maximum": "1000",
  429. "type": "integer"
  430. },
  431. "orgUnitID": {
  432. "default": "",
  433. "description": "the organizational unit's ID to filter usage parameters from users belonging to a specific OU or one of its sub-OU(s).",
  434. "location": "query",
  435. "pattern": "(id:[a-z0-9]+)",
  436. "type": "string"
  437. },
  438. "pageToken": {
  439. "description": "Token to specify next page.",
  440. "location": "query",
  441. "type": "string"
  442. },
  443. "parameters": {
  444. "description": "Represents the application name, parameter name pairs to fetch in csv as app_name1:param_name1, app_name2:param_name2.",
  445. "location": "query",
  446. "pattern": "(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)",
  447. "type": "string"
  448. },
  449. "userKey": {
  450. "description": "Represents the profile id or the user email for which the data should be filtered.",
  451. "location": "path",
  452. "required": true,
  453. "type": "string"
  454. }
  455. },
  456. "path": "usage/users/{userKey}/dates/{date}",
  457. "response": {
  458. "$ref": "UsageReports"
  459. },
  460. "scopes": [
  461. "https://www.googleapis.com/auth/admin.reports.usage.readonly"
  462. ]
  463. }
  464. }
  465. }
  466. },
  467. "revision": "20190117",
  468. "rootUrl": "https://www.googleapis.com/",
  469. "schemas": {
  470. "Activities": {
  471. "description": "JSON template for a collection of activites.",
  472. "id": "Activities",
  473. "properties": {
  474. "etag": {
  475. "description": "ETag of the resource.",
  476. "type": "string"
  477. },
  478. "items": {
  479. "description": "Each record in read response.",
  480. "items": {
  481. "$ref": "Activity"
  482. },
  483. "type": "array"
  484. },
  485. "kind": {
  486. "default": "admin#reports#activities",
  487. "description": "Kind of list response this is.",
  488. "type": "string"
  489. },
  490. "nextPageToken": {
  491. "description": "Token for retrieving the next page",
  492. "type": "string"
  493. }
  494. },
  495. "type": "object"
  496. },
  497. "Activity": {
  498. "description": "JSON template for the activity resource.",
  499. "id": "Activity",
  500. "properties": {
  501. "actor": {
  502. "description": "User doing the action.",
  503. "properties": {
  504. "callerType": {
  505. "description": "User or OAuth 2LO request.",
  506. "type": "string"
  507. },
  508. "email": {
  509. "description": "Email address of the user.",
  510. "type": "string"
  511. },
  512. "key": {
  513. "description": "For OAuth 2LO API requests, consumer_key of the requestor.",
  514. "type": "string"
  515. },
  516. "profileId": {
  517. "description": "Obfuscated user id of the user.",
  518. "type": "string"
  519. }
  520. },
  521. "type": "object"
  522. },
  523. "etag": {
  524. "description": "ETag of the entry.",
  525. "type": "string"
  526. },
  527. "events": {
  528. "description": "Activity events.",
  529. "items": {
  530. "properties": {
  531. "name": {
  532. "description": "Name of event.",
  533. "type": "string"
  534. },
  535. "parameters": {
  536. "description": "Parameter value pairs for various applications.",
  537. "items": {
  538. "properties": {
  539. "boolValue": {
  540. "description": "Boolean value of the parameter.",
  541. "type": "boolean"
  542. },
  543. "intValue": {
  544. "description": "Integral value of the parameter.",
  545. "format": "int64",
  546. "type": "string"
  547. },
  548. "multiIntValue": {
  549. "description": "Multi-int value of the parameter.",
  550. "items": {
  551. "format": "int64",
  552. "type": "string"
  553. },
  554. "type": "array"
  555. },
  556. "multiValue": {
  557. "description": "Multi-string value of the parameter.",
  558. "items": {
  559. "type": "string"
  560. },
  561. "type": "array"
  562. },
  563. "name": {
  564. "description": "The name of the parameter.",
  565. "type": "string"
  566. },
  567. "value": {
  568. "description": "String value of the parameter.",
  569. "type": "string"
  570. }
  571. },
  572. "type": "object"
  573. },
  574. "type": "array"
  575. },
  576. "type": {
  577. "description": "Type of event.",
  578. "type": "string"
  579. }
  580. },
  581. "type": "object"
  582. },
  583. "type": "array"
  584. },
  585. "id": {
  586. "description": "Unique identifier for each activity record.",
  587. "properties": {
  588. "applicationName": {
  589. "description": "Application name to which the event belongs.",
  590. "type": "string"
  591. },
  592. "customerId": {
  593. "description": "Obfuscated customer ID of the source customer.",
  594. "type": "string"
  595. },
  596. "time": {
  597. "description": "Time of occurrence of the activity.",
  598. "format": "date-time",
  599. "type": "string"
  600. },
  601. "uniqueQualifier": {
  602. "description": "Unique qualifier if multiple events have the same time.",
  603. "format": "int64",
  604. "type": "string"
  605. }
  606. },
  607. "type": "object"
  608. },
  609. "ipAddress": {
  610. "description": "IP Address of the user doing the action.",
  611. "type": "string"
  612. },
  613. "kind": {
  614. "default": "admin#reports#activity",
  615. "description": "Kind of resource this is.",
  616. "type": "string"
  617. },
  618. "ownerDomain": {
  619. "description": "Domain of source customer.",
  620. "type": "string"
  621. }
  622. },
  623. "type": "object"
  624. },
  625. "Channel": {
  626. "description": "An notification channel used to watch for resource changes.",
  627. "id": "Channel",
  628. "properties": {
  629. "address": {
  630. "description": "The address where notifications are delivered for this channel.",
  631. "type": "string"
  632. },
  633. "expiration": {
  634. "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
  635. "format": "int64",
  636. "type": "string"
  637. },
  638. "id": {
  639. "description": "A UUID or similar unique string that identifies this channel.",
  640. "type": "string"
  641. },
  642. "kind": {
  643. "default": "api#channel",
  644. "description": "Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string \"api#channel\".",
  645. "type": "string"
  646. },
  647. "params": {
  648. "additionalProperties": {
  649. "description": "Declares a new parameter by name.",
  650. "type": "string"
  651. },
  652. "description": "Additional parameters controlling delivery channel behavior. Optional.",
  653. "type": "object"
  654. },
  655. "payload": {
  656. "description": "A Boolean value to indicate whether payload is wanted. Optional.",
  657. "type": "boolean"
  658. },
  659. "resourceId": {
  660. "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.",
  661. "type": "string"
  662. },
  663. "resourceUri": {
  664. "description": "A version-specific identifier for the watched resource.",
  665. "type": "string"
  666. },
  667. "token": {
  668. "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.",
  669. "type": "string"
  670. },
  671. "type": {
  672. "description": "The type of delivery mechanism used for this channel.",
  673. "type": "string"
  674. }
  675. },
  676. "type": "object"
  677. },
  678. "UsageReport": {
  679. "description": "JSON template for a usage report.",
  680. "id": "UsageReport",
  681. "properties": {
  682. "date": {
  683. "description": "The date to which the record belongs.",
  684. "readOnly": true,
  685. "type": "string"
  686. },
  687. "entity": {
  688. "description": "Information about the type of the item.",
  689. "properties": {
  690. "customerId": {
  691. "description": "Obfuscated customer id for the record.",
  692. "readOnly": true,
  693. "type": "string"
  694. },
  695. "entityId": {
  696. "description": "Object key. Only relevant if entity.type = \"OBJECT\" Note: external-facing name of report is \"Entities\" rather than \"Objects\".",
  697. "readOnly": true,
  698. "type": "string"
  699. },
  700. "profileId": {
  701. "description": "Obfuscated user id for the record.",
  702. "readOnly": true,
  703. "type": "string"
  704. },
  705. "type": {
  706. "description": "The type of item, can be customer, user, or entity (aka. object).",
  707. "readOnly": true,
  708. "type": "string"
  709. },
  710. "userEmail": {
  711. "description": "user's email. Only relevant if entity.type = \"USER\"",
  712. "readOnly": true,
  713. "type": "string"
  714. }
  715. },
  716. "readOnly": true,
  717. "type": "object"
  718. },
  719. "etag": {
  720. "description": "ETag of the resource.",
  721. "type": "string"
  722. },
  723. "kind": {
  724. "default": "admin#reports#usageReport",
  725. "description": "The kind of object.",
  726. "type": "string"
  727. },
  728. "parameters": {
  729. "description": "Parameter value pairs for various applications.",
  730. "items": {
  731. "properties": {
  732. "boolValue": {
  733. "description": "Boolean value of the parameter.",
  734. "readOnly": true,
  735. "type": "boolean"
  736. },
  737. "datetimeValue": {
  738. "description": "RFC 3339 formatted value of the parameter.",
  739. "format": "date-time",
  740. "readOnly": true,
  741. "type": "string"
  742. },
  743. "intValue": {
  744. "description": "Integral value of the parameter.",
  745. "format": "int64",
  746. "readOnly": true,
  747. "type": "string"
  748. },
  749. "msgValue": {
  750. "description": "Nested message value of the parameter.",
  751. "items": {
  752. "additionalProperties": {
  753. "type": "any"
  754. },
  755. "type": "object"
  756. },
  757. "readOnly": true,
  758. "type": "array"
  759. },
  760. "name": {
  761. "description": "The name of the parameter.",
  762. "type": "string"
  763. },
  764. "stringValue": {
  765. "description": "String value of the parameter.",
  766. "readOnly": true,
  767. "type": "string"
  768. }
  769. },
  770. "type": "object"
  771. },
  772. "readOnly": true,
  773. "type": "array"
  774. }
  775. },
  776. "type": "object"
  777. },
  778. "UsageReports": {
  779. "description": "JSON template for a collection of usage reports.",
  780. "id": "UsageReports",
  781. "properties": {
  782. "etag": {
  783. "description": "ETag of the resource.",
  784. "type": "string"
  785. },
  786. "kind": {
  787. "default": "admin#reports#usageReports",
  788. "description": "The kind of object.",
  789. "type": "string"
  790. },
  791. "nextPageToken": {
  792. "description": "Token for retrieving the next page",
  793. "type": "string"
  794. },
  795. "usageReports": {
  796. "description": "Various application parameter records.",
  797. "items": {
  798. "$ref": "UsageReport"
  799. },
  800. "type": "array"
  801. },
  802. "warnings": {
  803. "description": "Warnings if any.",
  804. "items": {
  805. "properties": {
  806. "code": {
  807. "description": "Machine readable code / warning type.",
  808. "type": "string"
  809. },
  810. "data": {
  811. "description": "Key-Value pairs to give detailed information on the warning.",
  812. "items": {
  813. "properties": {
  814. "key": {
  815. "description": "Key associated with a key-value pair to give detailed information on the warning.",
  816. "type": "string"
  817. },
  818. "value": {
  819. "description": "Value associated with a key-value pair to give detailed information on the warning.",
  820. "type": "string"
  821. }
  822. },
  823. "type": "object"
  824. },
  825. "type": "array"
  826. },
  827. "message": {
  828. "description": "Human readable message for the warning.",
  829. "type": "string"
  830. }
  831. },
  832. "type": "object"
  833. },
  834. "type": "array"
  835. }
  836. },
  837. "type": "object"
  838. }
  839. },
  840. "servicePath": "admin/reports/v1/",
  841. "title": "Admin Reports API",
  842. "version": "reports_v1"
  843. }