Google: Drive approvals schemas

← Drive approvals operations · All schemas

Approves an approval For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) This is used to update the Reviewer Response of the requesting user with a Response of `APPROVED` If this is the last required reviewer response, this also completes the approval and sets the approval Status to `APPROVED` — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request for approving an approval as a reviewer.
message	string	Optional	Optional. A message to accompany the reviewer response on the approval. This message is included in notifications for the action and in the approval activity log.

Cancels an approval For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) Updates the approval Status to `CANCELLED` This can be called by any user with the `writer` permission on the file while the approval Status is `IN PROGRESS` — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request for cancelling an approval as an initiator.
message	string	Optional	Optional. A message to accompany the cancellation of the approval. This message is included in notifications for the action and in the approval activity log.

Comments on an approval For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) This sends a notification to both the initiator and the reviewers Additionally, a message is also added to the approval activity log — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request for commenting on an approval.
message	string	Optional	Required. A message to comment on the approval. This message is included in notifications for the action and in the approval activity log.

Declines an approval For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) This is used to update the Reviewer Response of the requesting user with a Response of `DECLINED` This also completes the approval and sets the approval Status to `DECLINED` — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request for declining an approval as a reviewer.
message	string	Optional	Optional. A message to accompany the reviewer response on the approval. This message is included in notifications for the action and in the approval activity log.

Gets an approval by ID For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
fields	string	Required within parent	Selector specifying which fields to include in a partial response. Minimum length: 1
prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
quotaUser	string	Optional	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Gets an approval by ID For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) — response body

Field	Type	Presence	Description and constraints
$	object	Root	Metadata for an approval. An approval is a review or approve process for a Drive item.
approvalId	string	Optional	The approval ID.
completeTime	string	Optional	The time the approval was completed. Format: google-datetime
createTime	string	Optional	The time the approval was created. Format: google-datetime
dueTime	string	Optional	The time that the approval is due. Format: google-datetime
fileContentChangeBehavior	string	Optional	The behavior of the approval when the file content changes. Known values: FILE_CONTENT_CHANGE_BEHAVIOR_UNSPECIFIED, RESET_APPROVAL, NO_APPROVAL_ACTION
initiator	Model	Optional	Expand Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user The user that requested the approval.
kind	string	Optional	This is always drive#approval.
modifyTime	string	Optional	The most recent time the approval was modified. Format: google-datetime
reviewerResponses	array	Optional	The responses made on the approval by reviewers.
reviewerResponses[]	Model	Each item	Expand Gets an approval by ID For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) — response body — reviewer Responses item
status	string	Optional	The status of the approval at the time this resource was requested. Known values: STATUS_UNSPECIFIED, IN_PROGRESS, APPROVED, CANCELLED, DECLINED
targetFileId	string	Optional	Target file id of the approval.

Referenced models: Gets an approval by ID For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) — response body — reviewer Responses item, Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user

Gets an approval by ID For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) — response body — reviewer Responses item

Field	Type	Presence	Description and constraints
$	object	Root	A response on an approval made by a specific reviewer.
kind	string	Optional	This is always drive#reviewerResponse.
response	string	Optional	A reviewer’s response for the approval. Known values: RESPONSE_UNSPECIFIED, NO_RESPONSE, APPROVED, DECLINED
reviewer	Model	Optional	Expand Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user The user that's responsible for this response.

Referenced models: Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user

Lists the approvals on a file For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) By default, this method returns a minimal response that may not include the items array To retrieve approval details, you must explicitly specify the fields you want using the `fields` query parameter To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body

Field	Type	Presence	Description and constraints
$	object	Root	The response of an approvals list request.
items	array	Optional	The list of approvals. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched.
items[]	Model	Each item	Expand Gets an approval by ID For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) — response body
kind	string	Optional	This is always drive#approvalList
nextPageToken	string	Optional	The page token for the next page of approvals. This is absent if the end of the approvals list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.

Referenced models: Gets an approval by ID For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) — response body

Reassigns the reviewers on an approval For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) Adds or replaces reviewers in the Reviewer Response of the approval This can be called by any user with the `writer` permission on the file while the approval Status is `IN PROGRESS` and the Response for the reviewer being reassigned is `NO RESPONSE` A user with the `reader` permission can only reassign an approval that's assigned to themselves Removing a reviewer isn't allowed — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request for reassigning an approval. Reviewers can be added or replaced, but not removed.
addReviewers	array	Optional	Optional. The list of reviewers to add.
addReviewers[]	Model	Each item	Expand Reassigns the reviewers on an approval For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) Adds or replaces reviewers in the Reviewer Response of the approval This can be called by any user with the `writer` permission on the file while the approval Status is `IN PROGRESS` and the Response for the reviewer being reassigned is `NO RESPONSE` A user with the `reader` permission can only reassign an approval that's assigned to themselves Removing a reviewer isn't allowed — request body — body add Reviewers item
message	string	Optional	Optional. A message to send to the new reviewers. This message is included in notifications for the action and in the approval activity log.
replaceReviewers	array	Optional	Optional. The list of reviewer replacements.
replaceReviewers[]	Model	Each item	Expand Reassigns the reviewers on an approval For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) Adds or replaces reviewers in the Reviewer Response of the approval This can be called by any user with the `writer` permission on the file while the approval Status is `IN PROGRESS` and the Response for the reviewer being reassigned is `NO RESPONSE` A user with the `reader` permission can only reassign an approval that's assigned to themselves Removing a reviewer isn't allowed — request body — body replace Reviewers item

Referenced models: Reassigns the reviewers on an approval For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) Adds or replaces reviewers in the Reviewer Response of the approval This can be called by any user with the `writer` permission on the file while the approval Status is `IN PROGRESS` and the Response for the reviewer being reassigned is `NO RESPONSE` A user with the `reader` permission can only reassign an approval that's assigned to themselves Removing a reviewer isn't allowed — request body — body add Reviewers item, Reassigns the reviewers on an approval For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) Adds or replaces reviewers in the Reviewer Response of the approval This can be called by any user with the `writer` permission on the file while the approval Status is `IN PROGRESS` and the Response for the reviewer being reassigned is `NO RESPONSE` A user with the `reader` permission can only reassign an approval that's assigned to themselves Removing a reviewer isn't allowed — request body — body replace Reviewers item

Reassigns the reviewers on an approval For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) Adds or replaces reviewers in the Reviewer Response of the approval This can be called by any user with the `writer` permission on the file while the approval Status is `IN PROGRESS` and the Response for the reviewer being reassigned is `NO RESPONSE` A user with the `reader` permission can only reassign an approval that's assigned to themselves Removing a reviewer isn't allowed — request body — body add Reviewers item

Field	Type	Presence	Description and constraints
$	object	Root	Representation of a reviewer addition.
addedReviewerEmail	string	Optional	Required. The email of the reviewer to add.

Reassigns the reviewers on an approval For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) Adds or replaces reviewers in the Reviewer Response of the approval This can be called by any user with the `writer` permission on the file while the approval Status is `IN PROGRESS` and the Response for the reviewer being reassigned is `NO RESPONSE` A user with the `reader` permission can only reassign an approval that's assigned to themselves Removing a reviewer isn't allowed — request body — body replace Reviewers item

Field	Type	Presence	Description and constraints
$	object	Root	Representation of a reviewer replacement.
addedReviewerEmail	string	Optional	Required. The email of the reviewer to add.
removedReviewerEmail	string	Optional	Required. The email of the reviewer to remove.

Starts an approval on a file For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Allows creating an approval on a file.
dueTime	string	Optional	Optional. The time that the approval is due. Format: google-datetime
fileContentChangeBehavior	string	Optional	Optional. The behavior of the approval when the file content changes. One of: FILE_CONTENT_CHANGE_BEHAVIOR_UNSPECIFIED, RESET_APPROVAL, NO_APPROVAL_ACTION
lockFile	boolean	Optional	Optional. Whether to lock the file when starting the approval.
message	string	Optional	Optional. A message to send to reviewers when notifying them of the approval request.
reviewerEmails	array	Optional	Required. The emails of the users who are set to review the approval.
reviewerEmails[]	string	Each item