bucket STRING Required

Name of the bucket in which to look for objects

delimiter STRING

Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted

includeTrailingDelimiter BOOLEAN

If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes

maxResults INTEGER

Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller

pageToken STRING

A previously-returned page token representing part of the larger set of results to view

prefix STRING

Filter results to objects whose names begin with this prefix

projection ENUMERATION

Set of properties to return. Defaults to noAcl

provisionalUserProject STRING

The project to be billed for this request if the target bucket is requester-pays bucket

userProject STRING

The project to be billed for this request. Required for Requester Pays buckets

versions BOOLEAN

If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning

items[] OBJECT

An object

items[].acl[] OBJECT

An access-control entry

items[].acl[].bucket STRING

The name of the bucket

items[].acl[].domain STRING

The domain associated with the entity, if any

items[].acl[].email STRING

The email address associated with the entity, if any

items[].acl[].entity STRING

The entity holding the permission, in one of the following forms:

• user-userId
• user-email
• group-groupId
• group-email
• domain-domain
• project-team-projectId
• allUsers
• allAuthenticatedUsers Examples:
• The user [email protected] would be [email protected].
• The group [email protected] would be [email protected].
• To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

items[].acl[].entityId STRING

The ID for the entity, if any

items[].acl[].etag STRING

HTTP 1.1 Entity tag for the access-control entry

items[].acl[].generation INTEGER

The content generation of the object, if applied to an object

items[].acl[].id STRING

The ID of the access-control entry

items[].acl[].kind STRING

The kind of item this is. For object access control entries, this is always storage#objectAccessControl

items[].acl[].object STRING

The name of the object, if applied to an object

items[].acl[].projectTeam OBJECT

The project team associated with the entity, if any

items[].acl[].projectTeam.projectNumber STRING

The project number

items[].acl[].projectTeam.team STRING

The team

items[].acl[].role STRING

The access permission for the entity

items[].acl[].selfLink STRING

The link to this access-control entry

items[].bucket STRING

The name of the bucket containing this object

items[].cacheControl STRING

Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600

items[].componentCount INTEGER

Number of underlying components that make up this object. Components are accumulated by compose operations

items[].contentDisposition STRING

Content-Disposition of the object data

items[].contentEncoding STRING

Content-Encoding of the object data

items[].contentLanguage STRING

Content-Language of the object data

items[].contentType STRING

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream

items[].crc32c STRING

CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices

items[].customerEncryption OBJECT

Metadata of customer-supplied encryption key, if the object is encrypted by such a key

items[].customerEncryption.encryptionAlgorithm STRING

The encryption algorithm

items[].customerEncryption.keySha256 STRING

SHA256 hash value of the encryption key

items[].etag STRING

HTTP 1.1 Entity tag for the object

items[].eventBasedHold BOOLEAN

Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false

items[].generation INTEGER

The content generation of this object. Used for object versioning

items[].id STRING

The ID of the object, including the bucket name, object name, and generation number

items[].kind STRING

The kind of item this is. For objects, this is always storage#object

items[].kmsKeyName STRING

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key

items[].md5Hash STRING

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices

items[].mediaLink STRING

Media download link

items[].metadata OBJECT

User-provided metadata, in key/value pairs

items[].metadata.customKey.value STRING

User-provided metadata, in key/value pairs

items[].metageneration INTEGER

The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object

items[].name STRING

The name of the object. Required if not specified by URL parameter

items[].owner OBJECT

The owner of the object. This will always be the uploader of the object

items[].owner.entity STRING

The entity, in the form user-userId

items[].owner.entityId STRING

The ID for the entity

items[].retentionExpirationTime DATE_TIME

A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold)

items[].selfLink STRING

The link to this object

items[].size INTEGER

Content-Length of the data in bytes

items[].storageClass STRING

Storage class of the object

items[].temporaryHold BOOLEAN

Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object

items[].timeCreated DATE_TIME

The creation time of the object in RFC 3339 format

items[].timeDeleted DATE_TIME

The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted

items[].timeStorageClassUpdated DATE_TIME

The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated

items[].updated DATE_TIME

The modification time of the object metadata in RFC 3339 format

kind STRING

The kind of item this is. For lists of objects, this is always storage#objects

nextPageToken STRING

The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results

prefixes[] STRING