Skip to content

Commit

Permalink
feat(admin): update the api
Browse files Browse the repository at this point in the history
#### admin:reports_v1

The following keys were added:
- resources.activities.methods.watch.parameters.orgUnitID.deprecated (Total Keys: 1)
  • Loading branch information
yoshi-automation committed Feb 27, 2024
1 parent 7d769dd commit 3fc86c6
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/dyn/admin_directory_v1.customer.devices.chromeos.html
Expand Up @@ -151,7 +151,7 @@ <h3>Method Details</h3>

{ # A request for issuing a command.
&quot;commandType&quot;: &quot;A String&quot;, # The type of command.
&quot;payload&quot;: &quot;A String&quot;, # The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { &quot;volume&quot;: 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { &quot;ackedUserPresence&quot;: true }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`.
&quot;payload&quot;: &quot;A String&quot;, # The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { &quot;volume&quot;: 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { &quot;ackedUserPresence&quot;: true }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`. * `REBOOT`: Payload is a stringified JSON object in the form: { &quot;user_session_delay_seconds&quot;: 300 }. The delay has to be in the range [0, 300].
}

x__xgafv: string, V1 error format.
Expand Down
2 changes: 1 addition & 1 deletion docs/dyn/admin_reports_v1.activities.html
Expand Up @@ -295,7 +295,7 @@ <h3>Method Details</h3>
filters: string, The `filters` query string is a comma-separated list composed of event parameters manipulated by relational operators. Event parameters are in the form `{parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...` These event parameters are associated with a specific `eventName`. An empty report is returned if the request&#x27;s parameter doesn&#x27;t belong to the `eventName`. For more information about the available `eventName` fields for each application and their associated parameters, go to the [ApplicationName](#applicationname) table, then click through to the Activity Events page in the Appendix for the application you want. In the following Drive activity examples, the returned list consists of all `edit` events where the `doc_id` parameter value matches the conditions defined by the relational operator. In the first example, the request returns all edited documents with a `doc_id` value equal to `12345`. In the second example, the report returns any edited documents where the `doc_id` value is not equal to `98765`. The `&lt;&gt;` operator is URL-encoded in the request&#x27;s query string (`%3C%3E`): ``` GET...&amp;eventName=edit&amp;filters=doc_id==12345 GET...&amp;eventName=edit&amp;filters=doc_id%3C%3E98765 ``` A `filters` query supports these relational operators: * `==`—&#x27;equal to&#x27;. * `&lt;&gt;`—&#x27;not equal to&#x27;. Must be URL-encoded (%3C%3E). * `&lt;`—&#x27;less than&#x27;. Must be URL-encoded (%3C). * `&lt;=`—&#x27;less than or equal to&#x27;. Must be URL-encoded (%3C=). * `&gt;`—&#x27;greater than&#x27;. Must be URL-encoded (%3E). * `&gt;=`—&#x27;greater than or equal to&#x27;. Must be URL-encoded (%3E=). **Note:** The API doesn&#x27;t accept multiple values of the same parameter. If a parameter is supplied more than once in the API request, the API only accepts the last value of that parameter. In addition, if an invalid parameter is supplied in the API request, the API ignores that parameter and returns the response corresponding to the remaining valid parameters. If no parameters are requested, all parameters are returned.
groupIdFilter: string, Comma separated group ids (obfuscated) on which user activities are filtered, i.e. the response will contain activities for only those users that are a part of at least one of the group ids mentioned here. Format: &quot;id:abc123,id:xyz456&quot;
maxResults: integer, Determines how many activity records are shown on each response page. For example, if the request sets `maxResults=1` and the report has two activities, the report has two pages. The response&#x27;s `nextPageToken` property has the token to the second page. The `maxResults` query string is optional in the request. The default value is 1000.
orgUnitID: string, ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn&#x27;t appear in the filtered results.
orgUnitID: string, `Deprecated`. This field is deprecated and is no longer supported. ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn&#x27;t appear in the filtered results.
pageToken: string, The token to specify next page. A report with multiple pages has a `nextPageToken` property in the response. In your follow-on request getting the next page of the report, enter the `nextPageToken` value in the `pageToken` query string.
startTime: string, Sets the beginning of the range of time shown in the report. The date is in the RFC 3339 format, for example 2010-10-28T10:26:35.000Z. The report returns all activities from `startTime` until `endTime`. The `startTime` must be before the `endTime` (if specified) and the current time when the request is made, or the API returns an error.
x__xgafv: string, V1 error format.
Expand Down
Expand Up @@ -272,7 +272,7 @@
}
}
},
"revision": "20240206",
"revision": "20240220",
"rootUrl": "https://admin.googleapis.com/",
"schemas": {
"Application": {
Expand Down
Expand Up @@ -4671,7 +4671,7 @@
}
}
},
"revision": "20240206",
"revision": "20240220",
"rootUrl": "https://admin.googleapis.com/",
"schemas": {
"Alias": {
Expand Down Expand Up @@ -6165,7 +6165,7 @@ false
"type": "string"
},
"payload": {
"description": "The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { \"volume\": 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { \"ackedUserPresence\": true }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`.",
"description": "The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { \"volume\": 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { \"ackedUserPresence\": true }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`. * `REBOOT`: Payload is a stringified JSON object in the form: { \"user_session_delay_seconds\": 300 }. The delay has to be in the range [0, 300].",
"type": "string"
}
},
Expand Down
Expand Up @@ -360,7 +360,8 @@
},
"orgUnitID": {
"default": "",
"description": "ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
"deprecated": true,
"description": "`Deprecated`. This field is deprecated and is no longer supported. ID of the organizational unit to report on. Activity records will be shown only for users who belong to the specified organizational unit. Data before Dec 17, 2018 doesn't appear in the filtered results.",
"location": "query",
"pattern": "(id:[a-z0-9]+)",
"type": "string"
Expand Down Expand Up @@ -625,7 +626,7 @@
}
}
},
"revision": "20240206",
"revision": "20240220",
"rootUrl": "https://admin.googleapis.com/",
"schemas": {
"Activities": {
Expand Down

0 comments on commit 3fc86c6

Please sign in to comment.