Google: Retrieves an access proposal by ID For more information, see Manage pending access proposals (https: developers google com workspace drive api guides pending-access)

Google driveAccessproposals.driveAccessproposalsGet: arguments, response, policy and SDK examples.

← Drive accessproposals operations · Get started

Operation google.drive_accessproposals_get

Provider route: GET /drive/v3/files/{fileId}/accessproposals/{proposalId}. 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["driveAccessproposals"]["driveAccessproposalsGet"]>[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.driveAccessproposals.driveAccessproposalsGet(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_accessproposals.drive_accessproposals_get(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 item the request is on.
`path.proposalId`	string	Required within parent	Required. The ID of the access proposal to resolve.
`query`	object	Optional	Additional keys: not allowed
`query.fields`	string	Optional	Selector specifying which fields to include in a partial response.
`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.

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 Retrieves an access proposal by ID For more information, see Manage pending access proposals (https: developers google com workspace drive api guides pending-access) — response body

Referenced models: Retrieves an access proposal by ID For more information, see Manage pending access proposals (https: developers google com workspace drive api guides pending-access) — response body

Schemas

Retrieves an access proposal by ID For more information, see Manage pending access proposals (https: developers google com workspace drive api guides pending-access) — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Manage outstanding access proposals on a file.
`createTime`	string	Optional	The creation time. Format: google-datetime
`fileId`	string	Optional	The file ID that the proposal for access is on.
`proposalId`	string	Optional	The ID of the access proposal.
`recipientEmailAddress`	string	Optional	The email address of the user that will receive permissions, if accepted.
`requestMessage`	string	Optional	The message that the requester added to the proposal.
`requesterEmailAddress`	string	Optional	The email address of the requesting user.
`rolesAndViews`	array	Optional	A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
`rolesAndViews[]`	Model	Each item	Expand Retrieves an access proposal by ID For more information, see Manage pending access proposals (https: developers google com workspace drive api guides pending-access) — response body — roles And Views item

Retrieves an access proposal by ID For more information, see Manage pending access proposals (https: developers google com workspace drive api guides pending-access) — response body — roles And Views item

Field	Type	Presence	Description and constraints
`$`	object	Root	A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
`role`	string	Optional	The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader`
`view`	string	Optional	Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported.

Policy, approvals and errors

SDK function policy ID: google.drive_accessproposals_get. Catalog operation: drive.accessproposals.get. 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.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