Method: labels.list

Enumera etiquetas. Para obtener más información, consulta Cómo buscar etiquetas.

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 devuelven las revisiones de etiquetas publicadas actuales. Se incluyen las etiquetas inhabilitadas. Los nombres de recursos de etiquetas devueltos hacen referencia a la revisión publicada (labels/{id}/{revisionId}).
  • Cuando es false, se devuelven las revisiones de etiquetas actuales, que podrían no estar publicadas. Los nombres de recursos de etiquetas que se devuelven no hacen referencia a una revisión específica (labels/{id}).
customer

string

Es el cliente para el que se limita el alcance de esta solicitud de lista. Por ejemplo: customers/abcd1234. Si no se configura, se devolverán todas las etiquetas del cliente actual.

languageCode

string

Es el código de idioma BCP-47 que se usará para evaluar las etiquetas de campo localizadas. Cuando no se especifica, se usan los valores del idioma configurado predeterminado.

pageSize

integer

Es la cantidad máxima de etiquetas que se devolverán por página. El valor predeterminado es 50. Máx.: 200

pageToken

string

Es el token de la página que se devolverá.

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

Se debe establecer en true para usar las credenciales de administrador del usuario. Se devolverán todas las etiquetas del cliente.

minimumRole

enum (LabelRole)

Especifica el nivel de acceso que debe tener el usuario en las etiquetas devueltas. Es el rol mínimo que debe tener un usuario en un sello discográfico. La configuración predeterminada es READER.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es la respuesta para enumerar 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

Es el token de la página siguiente en la respuesta.

Permisos 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.