Method: labels.list

Etiquetas de lista.

Solicitud HTTP

GET https://drivelabels.googleapis.com/v2/labels

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
publishedOnly

boolean

Indica si se deben incluir solo las etiquetas publicadas en los resultados.

  • Cuando es true, solo se muestran las revisiones de etiquetas publicadas actuales. Se incluyen las etiquetas inhabilitadas. Los nombres de recursos de etiqueta que se muestran hacen referencia a la revisión publicada (labels/{id}/{revisionId}).
  • Cuando es false, se muestran las revisiones de etiquetas actuales, que podrían no publicarse. Los nombres de recursos de etiquetas que se muestran no hacen referencia a una revisión específica (labels/{id}).
customer

string

El cliente al que se determinará el alcance de esta solicitud de lista. Por ejemplo: "clientes/abcd1234". Si no la estableces, se mostrarán todas las etiquetas del cliente actual.
languageCode

string

El código de idioma BCP-47 que se usará para evaluar las etiquetas de los campos localizados. Si no se especifica, se usarán los valores en el idioma configurado de forma predeterminada.
pageSize

integer

Cantidad máxima de etiquetas que se muestran por página. Valor predeterminado: 50. Máx.: 200.
pageToken

string

El token de la página que se mostrará.
view

enum (LabelView)

Cuando se especifica, solo se muestran ciertos campos que pertenecen a la vista indicada.

Parámetro de unión access.

access puede ser una de las siguientes opciones:
useAdminAccess

boolean

Configúralo en true para usar las credenciales de administrador del usuario. Se mostrarán todas las etiquetas del cliente.
minimumRole

enum (LabelRole)

Especifica el nivel de acceso que debe tener el usuario en las etiquetas que se muestran. Es la función mínima que debe tener un usuario en una etiqueta. La configuración predeterminada es READER.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Respuesta para enumerar las etiquetas.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "labels": [
    {
      object (Label)
    }
  ],
  "nextPageToken": string
}
Campos
labels[]

object (Label)

etiquetas
nextPageToken

string

El token de la página siguiente en la respuesta.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.labels.readonly
  • https://www.googleapis.com/auth/drive.admin.labels
  • https://www.googleapis.com/auth/drive.admin.labels.readonly

Para obtener más información, consulta la Guía de autorización.