Method: limits.getLabel

Get the constraints on the structure of a Label; such as, the maximum number of Fields allowed and maximum length of the label title.

HTTP request

GET https://drivelabels.googleapis.com/v2/limits/label

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
name

string

Required. Label revision resource name Must be: "limits/label"

Request body

The request body must be empty.

Response body

Label constraints governing the structure of a Label; such as, the maximum number of Fields allowed and maximum length of the label title.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "name": string,
  "maxTitleLength": integer,
  "maxDescriptionLength": integer,
  "maxFields": integer,
  "maxDeletedFields": integer,
  "maxDraftRevisions": integer,
  "fieldLimits": {
    object (FieldLimits)
  }
}
Fields
name

string

Resource name.
maxTitleLength

integer

The maximum number of characters allowed for the title.
maxDescriptionLength

integer

The maximum number of characters allowed for the description.
maxFields

integer

The maximum number of Fields allowed within the label.
maxDeletedFields

integer

The maximum number of published Fields that can be deleted.
maxDraftRevisions

integer

The maximum number of draft revisions that will be kept before deleting old drafts.
fieldLimits

object (FieldLimits)

The limits for Fields.

Authorization scopes

Requires one of the following OAuth scopes:

  • 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

For more information, see the Authorization guide.

FieldLimits

Field constants governing the structure of a Field; such as, the maximum title length, minimum and maximum field values or length, etc.

JSON representation 
{
  "maxIdLength": integer,
  "maxDisplayNameLength": integer,
  "maxDescriptionLength": integer,
  "textLimits": {
    object (TextLimits)
  },
  "longTextLimits": {
    object (LongTextLimits)
  },
  "integerLimits": {
    object (IntegerLimits)
  },
  "dateLimits": {
    object (DateLimits)
  },
  "userLimits": {
    object (UserLimits)
  },
  "selectionLimits": {
    object (SelectionLimits)
  }
}
Fields
maxIdLength

integer

Max length for the id.
maxDisplayNameLength

integer

Limits for Field title.
maxDescriptionLength

integer

Limits for Field description, also called help text.
textLimits

object (TextLimits)

The relevant limits for the specified Field.Type. Text Field limits.
longTextLimits

object (LongTextLimits)

Long text Field limits.
integerLimits

object (IntegerLimits)

Integer Field limits.
dateLimits

object (DateLimits)

Date Field limits.
userLimits

object (UserLimits)

User Field limits.
selectionLimits

object (SelectionLimits)

Selection Field limits.

TextLimits

Limits for text Field type.

JSON representation 
{
  "minLength": integer,
  "maxLength": integer
}
Fields
minLength

integer

Minimum length allowed for a text Field type.
maxLength

integer

Maximum length allowed for a text Field type.

LongTextLimits

Limits for long text Field type.

JSON representation 
{
  "minLength": integer,
  "maxLength": integer
}
Fields
minLength

integer

Minimum length allowed for a long text Field type.
maxLength

integer

Maximum length allowed for a long text Field type.

IntegerLimits

Limits for integer Field type.

JSON representation 
{
  "minValue": string,
  "maxValue": string
}
Fields
minValue

string (int64 format)

Minimum value for an integer Field type.
maxValue

string (int64 format)

Maximum value for an integer Field type.

DateLimits

Limits for date Field type.

JSON representation 
{
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}
Fields
minValue

object (Date)

Minimum value for the date Field type.
maxValue

object (Date)

Maximum value for the date Field type.

UserLimits

Limits for Field.Type.USER.

JSON representation 
{
  "listLimits": {
    object (ListLimits)
  }
}
Fields
listLimits

object (ListLimits)

Limits for list-variant of a Field type.

ListLimits

Limits for list-variant of a Field type.

JSON representation 
{
  "maxEntries": integer
}
Fields
maxEntries

integer

Maximum number of values allowed for the Field type.

SelectionLimits

Limits for selection Field type.

JSON representation 
{
  "listLimits": {
    object (ListLimits)
  },
  "maxIdLength": integer,
  "maxDisplayNameLength": integer,
  "maxChoices": integer,
  "maxDeletedChoices": integer
}
Fields
listLimits

object (ListLimits)

Limits for list-variant of a Field type.
maxIdLength

integer

Maximum ID length for a selection options.
maxDisplayNameLength

integer

Maximum length for display name.
maxChoices

integer

The max number of choices.
maxDeletedChoices

integer

Maximum number of deleted choices.