Drive API . properties

close()

Close httplib2 connections.

delete(fileId, propertyKey, visibility=None)

Deletes a property.

Args:
  fileId: string, The ID of the file. (required)
  propertyKey: string, The key of the property. (required)
  visibility: string, The visibility of the property.

get(fileId, propertyKey, visibility=None)

Gets a property by its key.

Args:
  fileId: string, The ID of the file. (required)
  propertyKey: string, The key of the property. (required)
  visibility: string, The visibility of the property.

Returns:
  An object of the form:

    { # 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.
  "etag": "A String", # ETag of the property.
  "key": "A String", # The key of this property.
  "kind": "drive#property", # This is always drive#property.
  "selfLink": "A String", # The link back to this property.
  "value": "A String", # The value of this property.
  "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). 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.
}

insert(fileId, body=None)

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

Args:
  fileId: string, The ID of the file. (required)
  body: object, The request body.
    The object takes the form of:

{ # 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.
  "etag": "A String", # ETag of the property.
  "key": "A String", # The key of this property.
  "kind": "drive#property", # This is always drive#property.
  "selfLink": "A String", # The link back to this property.
  "value": "A String", # The value of this property.
  "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). 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.
}


Returns:
  An object of the form:

    { # 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.
  "etag": "A String", # ETag of the property.
  "key": "A String", # The key of this property.
  "kind": "drive#property", # This is always drive#property.
  "selfLink": "A String", # The link back to this property.
  "value": "A String", # The value of this property.
  "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). 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.
}

list(fileId)

Lists a file's properties.

Args:
  fileId: string, The ID of the file. (required)

Returns:
  An object of the form:

    { # A collection of properties, key-value pairs that are either public or private to an application.
  "etag": "A String", # The ETag of the list.
  "items": [ # The list of properties.
    { # 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.
      "etag": "A String", # ETag of the property.
      "key": "A String", # The key of this property.
      "kind": "drive#property", # This is always drive#property.
      "selfLink": "A String", # The link back to this property.
      "value": "A String", # The value of this property.
      "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). 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": "drive#propertyList", # This is always drive#propertyList.
  "selfLink": "A String", # The link back to this list.
}

patch(fileId, propertyKey, body=None, visibility=None)

Updates a property.

Args:
  fileId: string, The ID of the file. (required)
  propertyKey: string, The key of the property. (required)
  body: object, The request body.
    The object takes the form of:

{ # 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.
  "etag": "A String", # ETag of the property.
  "key": "A String", # The key of this property.
  "kind": "drive#property", # This is always drive#property.
  "selfLink": "A String", # The link back to this property.
  "value": "A String", # The value of this property.
  "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). 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.
}

  visibility: string, The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

Returns:
  An object of the form:

    { # 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.
  "etag": "A String", # ETag of the property.
  "key": "A String", # The key of this property.
  "kind": "drive#property", # This is always drive#property.
  "selfLink": "A String", # The link back to this property.
  "value": "A String", # The value of this property.
  "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). 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.
}

update(fileId, propertyKey, body=None, visibility=None)

Updates a property.

Args:
  fileId: string, The ID of the file. (required)
  propertyKey: string, The key of the property. (required)
  body: object, The request body.
    The object takes the form of:

{ # 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.
  "etag": "A String", # ETag of the property.
  "key": "A String", # The key of this property.
  "kind": "drive#property", # This is always drive#property.
  "selfLink": "A String", # The link back to this property.
  "value": "A String", # The value of this property.
  "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). 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.
}

  visibility: string, The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

Returns:
  An object of the form:

    { # 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.
  "etag": "A String", # ETag of the property.
  "key": "A String", # The key of this property.
  "kind": "drive#property", # This is always drive#property.
  "selfLink": "A String", # The link back to this property.
  "value": "A String", # The value of this property.
  "visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE). 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.
}