LabelsListOptions

import type { LabelsListOptions } from "https://googleapis.deno.dev/v1/drivelabels:v2.ts";

Additional options for DriveLabels#labelsList.

interface LabelsListOptions {

customer?: string;

languageCode?: string;

minimumRole?:

| "LABEL_ROLE_UNSPECIFIED"

| "READER"

| "APPLIER"

| "ORGANIZER"

| "EDITOR";

pageSize?: number;

pageToken?: string;

publishedOnly?: boolean;

useAdminAccess?: boolean;

view?: "LABEL_VIEW_BASIC" | "LABEL_VIEW_FULL";

}

§Properties

customer?: string

[src]

The customer to scope this list request to. For example: "customers/abcd1234". If unset, will return all labels within the current customer.

languageCode?: string

[src]

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

minimumRole?: "LABEL_ROLE_UNSPECIFIED" | "READER" | "APPLIER" | "ORGANIZER" | "EDITOR"

[src]

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.

pageSize?: number

[src]

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

pageToken?: string

[src]

The token of the page to return.

publishedOnly?: boolean

[src]

Whether to include only published labels in the results. * When true, only the current published label revisions are returned. Disabled labels are included. Returned label resource names reference the published revision (labels/{id}/{revision_id}). * When false, the current label revisions are returned, which might not be published. Returned label resource names don't reference a specific revision (labels/{id}).

useAdminAccess?: boolean

[src]

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

view?: "LABEL_VIEW_BASIC" | "LABEL_VIEW_FULL"

[src]

When specified, only certain fields belonging to the indicated view are returned.