Google: 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)

Google driveApprovals.driveApprovalsList: arguments, response, policy and SDK examples.

← Drive approvals operations · Get started

Operation google.drive_approvals_list

Provider route: GET /drive/v3/files/{fileId}/approvals. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GoogleIntegration } from "@alter-ai/google";

async function execute(input: Parameters<GoogleIntegration["driveApprovals"]["driveApprovalsList"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.driveApprovals.driveApprovalsList(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_google import GoogleIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.drive_approvals.drive_approvals_list(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.fileId`	string	Required within parent	Required. The ID of the file that the approval is on.
`query`	object	Required within parent	Additional keys: not allowed
`query.fields`	string	Required within parent	Selector specifying which fields to include in a partial response. Minimum length: 1
`query.prettyPrint`	boolean	Optional	Returns response with indentations and line breaks. Default: true
`query.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.
`query.pageSize`	integer	Optional	The maximum number of approvals to return. When not set, at most 100 approvals are returned. Format: int32
`query.pageToken`	string	Optional	The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand 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

Referenced models: 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

Schemas

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

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

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Information about a Drive user.
`displayName`	string	Optional	Output only. A plain text displayable name for this user. Read only: true
`emailAddress`	string	Optional	Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. Read only: true
`kind`	string	Optional	Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`. Default: drive#user Read only: true
`me`	boolean	Optional	Output only. Whether this user is the requesting user. Read only: true
`permissionId`	string	Optional	Output only. The user's ID as visible in Permission resources. Read only: true
`photoLink`	string	Optional	Output only. A link to the user's profile photo, if available. Read only: true

Policy, approvals and errors

SDK function policy ID: google.drive_approvals_list. Catalog operation: drive.approvals.list. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/drive.metadata", "https://www.googleapis.com/auth/drive.metadata.readonly", "https://www.googleapis.com/auth/drive.readonly"]

Official provider source

Report an issue with this page