Drive Labels API (drivelabels:v2)

Additions

Methods


• ▼ ▲ drivelabels.labels.list

  Flat Path: v2/labels

  Parameters:

  pageToken

  Location: query

  Type: string

  Description: The token of the page to return.

  languageCode

  Type: string

  Location: query

  Description: The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language will be used.

  pageSize

  Format: int32

  Type: integer

  Location: query

  Description: Maximum number of Labels to return per page. Default: 50. Max: 200.

  publishedOnly

  Type: boolean

  Description: Whether to include only published labels in the results. * When `true`, only the current published label revisions will be returned. Disabled labels will be included. Returned Label resource names will reference the published revision (`labels/{id}/{revision_id}`). * When `false`, the current label revisions will be returned, which may not by published. Returned Label resource names will not reference a specific revision (`labels/{id}`).

  Location: query

  view

  Location: query

  Enum:

  • LABEL_VIEW_BASIC
  • LABEL_VIEW_FULL

  Type: string

  Description: When specified, only certain fields belonging to the indicated view will be returned.

  Enum Descriptions:

  • Implies the field mask: `name,id,revision_id,label_type,properties.*`
  • All possible fields.

  minimumRole

  Type: string

  Location: query

  Enum:

  • LABEL_ROLE_UNSPECIFIED
  • READER
  • APPLIER
  • ORGANIZER
  • EDITOR

  Enum Descriptions:

  • Unknown role.
  • A reader can read the Label and associated metadata applied to Drive items.
  • An applier can write associated metadata on Drive items in which they also have write access to. Implies `READER`.
  • An organizer is allowed to pin this label in shared drives they manage and add new appliers to the label.
  • Editors may make any updates including deleting the Label which will also delete associated Drive item metadata. Implies `APPLIER`.

  Description: Specifies the level of access the user must have on the returned Labels. The minimum role a user must have on a label. Defaults to `READER`.

  useAdminAccess

  Location: query

  Type: boolean

  Description: Set to `true` in order to use the user's admin credentials. This will return all Labels within the customer.

  Description: ## Label APIs --------------------------------------------------------------- List Labels.

  HTTP Method: GET

  Path: v2/labels

• ▼ ▲ drivelabels.labels.get

  Path: v2/{+name}

  HTTP Method: GET

  Parameter Order: name

  Description: Get a Label by its resource name. Resource name may be any of: * `labels/{id}` - See to `labels/{id}@latest` * `labels/{id}@latest` - Gets the latest revision of the Label. * `labels/{id}@published` - Gets the current published revision of the Label. * `labels/{id}@{revision_id}` - Gets the Label at the specified revision ID.

  Parameters:

  name

  Required: Yes

  Description: Required. Label resource name. May be any of: * `labels/{id}` (equivalent to labels/{id}@latest) * `labels/{id}@latest` * `labels/{id}@published` * `labels/{id}@{revision_id}`

  Location: path

  Type: string

  Pattern: ^labels/[^/]+$

  languageCode

  Location: query

  Description: The BCP-47 language code to use for evaluating localized Field labels. When not specified, values in the default configured language will be used.

  Type: string

  view

  Enum:

  • LABEL_VIEW_BASIC
  • LABEL_VIEW_FULL

  Description: When specified, only certain Fields belonging to the indicated view will be returned.

  Type: string

  Enum Descriptions:

  • Implies the field mask: `name,id,revision_id,label_type,properties.*`
  • All possible fields.

  Location: query

  useAdminAccess

  Type: boolean

  Description: Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the Label before allowing access.

  Location: query

  Flat Path: v2/labels/{labelsId}