GOgoogle
drives

GET /drives/{driveId}

Changed on

Gets a shared drive's metadata by ID. For more information, see Manage shared drives.

Request

  • Base URL
    https://www.googleapis.com/drive/v3
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive.readonly
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive.readonly

Path parameters

driveIdstring required

The ID of the shared drive.

Query parameters

useDomainAdminAccessboolean

Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.

Response

Successful response

backgroundImageLinkstring

Output only. A short-lived link to this shared drive's background image.

colorRgbstring

The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId.

createdTimestring date-time

The time at which the shared drive was created (RFC 3339 date-time).

hiddenboolean

Whether the shared drive is hidden from default view.

idstring

Output only. The ID of this shared drive which is also the ID of the top level folder of this shared drive.

kindstring

Output only. Identifies what kind of resource this is. Value: the fixed string "drive#drive".

namestring

The name of this shared drive.

orgUnitIdstring

Output only. The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true.

themeIdstring

The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.

Changes

  • d1fe7d8d02c7Revision changes
    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/drive.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive.readonly was removed from the endpoint's security scheme Oauth2c

  • 3257eb8f178cRevision changes
    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/drive.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive.readonly was removed from the endpoint's security scheme Oauth2c