REST Resource: properties

Resource: Property

A key-value pair attached to a file that is either public or private to an application.

The following limits apply to file properties:

  • Maximum of 100 properties total per file
  • Maximum of 30 private properties per app
  • Maximum of 30 public properties
  • Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property

Some resource methods (such as properties.update) require a propertyKey. Use the properties.list method to retrieve the key for a property.

JSON representation
{
  "selfLink": string,
  "value": string,
  "visibility": string,
  "kind": string,
  "etag": string,
  "key": string
}
Fields
value

string

The value of this property.

visibility

string

The visibility of this property. Allowed values are PRIVATE (default) and PUBLIC. Private properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.

kind

string

Output only. This is always drive#property.

etag

string

Output only. ETag of the property.

key

string

The key of this property.

Methods

delete

Deletes a property.

get

Gets a property by its key.

insert

Adds a property to a file, or updates it if it already exists.

list

Lists a file's properties.

patch

Updates a property.

update

Updates a property.