📄 Source: Files.php
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Drive\Resource;
use Google\Service\Drive\Channel;
use Google\Service\Drive\DriveFile;
use Google\Service\Drive\FileList;
use Google\Service\Drive\GenerateCseTokenResponse;
use Google\Service\Drive\GeneratedIds;
use Google\Service\Drive\LabelList;
use Google\Service\Drive\ModifyLabelsRequest;
use Google\Service\Drive\ModifyLabelsResponse;
use Google\Service\Drive\Operation;
/**
* The "files" collection of methods.
* Typical usage is:
* <code>
* $driveService = new Google\Service\Drive(...);
* $files = $driveService->files;
* </code>
*/
class Files extends \Google\Service\Resource
{
/**
* Creates a copy of a file and applies any requested updates with patch
* semantics. For more information, see [Create and manage
* files](https://developers.google.com/workspace/drive/api/guides/create-file).
* (files.copy)
*
* @param string $fileId The ID of the file.
* @param DriveFile $postBody
* @param array $optParams Optional parameters.
*
* @opt_param bool enforceSingleParent Deprecated: Copying files into multiple
* folders is no longer supported. Use shortcuts instead.
* @opt_param bool ignoreDefaultVisibility Whether to ignore the domain's
* default visibility settings for the created file. Domain administrators can
* choose to make all uploaded files visible to the domain by default; this
* parameter bypasses that behavior for the request. Permissions are still
* inherited from parent folders.
* @opt_param string includeLabels A comma-separated list of IDs of labels to
* include in the `labelInfo` part of the response.
* @opt_param string includePermissionsForView Specifies which additional view's
* permissions to include in the response. Only `published` is supported.
* @opt_param bool keepRevisionForever Whether to set the `keepForever` field in
* the new head revision. This is only applicable to files with binary content
* in Google Drive. Only 200 revisions for the file can be kept forever. If the
* limit is reached, try deleting pinned revisions.
* @opt_param string ocrLanguage A language hint for OCR processing during image
* import (ISO 639-1 code).
* @opt_param bool supportsAllDrives Whether the requesting application supports
* both My Drives and shared drives.
* @opt_param bool supportsTeamDrives Deprecated: Use `supportsAllDrives`
* instead.
* @return DriveFile
* @throws \Google\Service\Exception
*/
public function copy($fileId, DriveFile $postBody, $optParams = [])
{
$params = ['fileId' => $fileId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('copy', [$params], DriveFile::class);
}
/**
* Creates a file. For more information, see [Create and manage
* files](https://developers.google.com/workspace/drive/api/guides/create-file).
* This method supports an upload* URI and accepts uploaded media with the
* following characteristics: - *Maximum file size:* 5,120 GB - *Accepted Media
* MIME types:* `*` (Specify a valid MIME type, rather than the literal `*`
* value. The literal `*` is only used to indicate that any valid MIME type can
* be uploaded. For more information, see [Google Workspace and Google Drive
* supported MIME
* types](https://developers.google.com/workspace/drive/api/guides/mime-types).)
* For more information on uploading files, see [Upload file
* data](https://developers.google.com/workspace/drive/api/guides/manage-
* uploads). Apps creating shortcuts with the `create` method must specify the
* MIME type `application/vnd.google-apps.shortcut`. Apps should specify a file
* extension in the `name` property when inserting files with the API. For
* example, an operation to insert a JPEG file should specify something like
* `"name": "cat.jpg"` in the metadata. Subsequent `GET` requests include the
* read-only `fileExtension` property populated with the extension originally
* specified in the `name` property. When a Google Drive user requests to
* download a file, or when the file is downloaded through the sync client,
* Drive builds a full filename (with extension) based on the name. In cases
* where the extension is missing, Drive attempts to determine the extension
* based on the file's MIME type. (files.create)
*
* @param DriveFile $postBody
* @param array $optParams Optional parameters.
*
* @opt_param bool enforceSingleParent Deprecated: Creating files in multiple
* folders is no longer supported.
* @opt_param bool ignoreDefaultVisibility Whether to ignore the domain's
* default visibility settings for the created file. Domain administrators can
* choose to make all uploaded files visible to the domain by default; this
* parameter bypasses that behavior for the request. Permissions are still
* inherited from parent folders.
* @opt_param string includeLabels A comma-separated list of IDs of labels to
* include in the `labelInfo` part of the response.
* @opt_param string includePermissionsForView Specifies which additional view's
* permissions to include in the response. Only `published` is supported.
* @opt_param bool keepRevisionForever Whether to set the `keepForever` field in
* the new head revision. This is only applicable to files with binary content
* in Google Drive. Only 200 revisions for the file can be kept forever. If the
* limit is reached, try deleting pinned revisions.
* @opt_param string ocrLanguage A language hint for OCR processing during image
* import (ISO 639-1 code).
* @opt_param bool supportsAllDrives Whether the requesting application supports
* both My Drives and shared drives.
* @opt_param bool supportsTeamDrives Deprecated: Use `supportsAllDrives`
* instead.
* @opt_param bool useContentAsIndexableText Whether to use the uploaded content
* as indexable text.
* @return DriveFile
* @throws \Google\Service\Exception
*/
public function create(DriveFile $postBody, $optParams = [])
{
$params = ['postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], DriveFile::class);
}
/**
* Permanently deletes a file owned by the user without moving it to the trash.
* For more information, see [Trash or delete files and
* folders](https://developers.google.com/workspace/drive/api/guides/delete). If
* the file belongs to a shared drive, the user must be an `organizer` on the
* parent folder. If the target is a folder, all descendants owned by the user
* are also deleted. (files.delete)
*
* @param string $fileId The ID of the file.
* @param array $optParams Optional parameters.
*
* @opt_param bool enforceSingleParent Deprecated: If an item isn't in a shared
* drive and its last parent is deleted but the item itself isn't, the item will
* be placed under its owner's root.
* @opt_param bool supportsAllDrives Whether the requesting application supports
* both My Drives and shared drives.
* @opt_param bool supportsTeamDrives Deprecated: Use `supportsAllDrives`
* instead.
* @throws \Google\Service\Exception
*/
public function delete($fileId, $optParams = [])
{
$params = ['fileId' => $fileId];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Downloads the content of a file. For more information, see [Download and
* export
* files](https://developers.google.com/workspace/drive/api/guides/manage-
* downloads). Operations are valid for 24 hours from the time of creation.
* (files.download)
*
* @param string $fileId Required. The ID of the file to download.
* @param array $optParams Optional parameters.
*
* @opt_param string mimeType Optional. The MIME type the file should be
* downloaded as. This field can only be set when downloading Google Workspace
* documents. For a list of supported MIME types, see [Export MIME types for
* Google Workspace documents](/workspace/drive/api/guides/ref-export-formats).
* If not set, a Google Workspace document is downloaded with a default MIME
* type. The default MIME type might change in the future.
* @opt_param string revisionId Optional. The revision ID of the file to
* download. This field can only be set when downloading blob files, Google
* Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific
* revision on the file is unsupported.
* @return Operation
* @throws \Google\Service\Exception
*/
public function download($fileId, $optParams = [])
{
$params = ['fileId' => $fileId];
$params = array_merge($params, $optParams);
return $this->call('download', [$params], Operation::class);
}
/**
* Permanently deletes all of the user's trashed files. For more information,
* see [Trash or delete files and
* folders](https://developers.google.com/workspace/drive/api/guides/delete).
* (files.emptyTrash)
*
* @param array $optParams Optional parameters.
*
* @opt_param string driveId If set, empties the trash of the provided shared
* drive.
* @opt_param bool enforceSingleParent Deprecated: If an item isn't in a shared
* drive and its last parent is deleted but the item itself isn't, the item will
* be placed under its owner's root.
* @throws \Google\Service\Exception
*/
public function emptyTrash($optParams = [])
{
$params = [];
$params = array_merge($params, $optParams);
return $this->call('emptyTrash', [$params]);
}
/**
* Exports a Google Workspace document to the requested MIME type and returns
* exported byte content. For more information, see [Download and export
* files](https://developers.google.com/workspace/drive/api/guides/manage-
* downloads). Note that the exported content is limited to 10 MB.
* (files.export)
*
* @param string $fileId The ID of the file.
* @param string $mimeType Required. The MIME type of the format requested for
* this export. For a list of supported MIME types, see [Export MIME types for
* Google Workspace documents](/workspace/drive/api/guides/ref-export-formats).
* @param array $optParams Optional parameters.
* @throws \Google\Service\Exception
*/
public function export($fileId, $mimeType, $optParams = [])
{
$params = ['fileId' => $fileId, 'mimeType' => $mimeType];
$params = array_merge($params, $optParams);
return $this->call('export', [$params]);
}
/**
* Generates a CSE token which can be used to create or update CSE files.
* (files.generateCseToken)
*
* @param array $optParams Optional parameters.
*
* @opt_param string fileId The ID of the file for which the JWT should be
* generated. If not provided, an id will be generated.
* @opt_param string parent The ID of the expected parent of the file. Used when
* generating a JWT for a new CSE file. If specified, the parent will be
* fetched, and if the parent is a shared drive item, the shared drive's policy
* will be used to determine the KACLS that should be used. It is invalid to
* specify both file_id and parent in a single request.
* @return GenerateCseTokenResponse
* @throws \Google\Service\Exception
*/
public function generateCseToken($optParams = [])
{
$params = [];
$params = array_merge($params, $optParams);
return $this->call('generateCseToken', [$params], GenerateCseTokenResponse::class);
}
/**
* Generates a set of file IDs which can be provided in create or copy requests.
* For more information, see [Create and manage
* files](https://developers.google.com/workspace/drive/api/guides/create-file).
* (files.generateIds)
*
* @param array $optParams Optional parameters.
*
* @opt_param int count The number of IDs to return.
* @opt_param string space The space in which the IDs can be used to create
* files. Supported values are `drive` and `appDataFolder`. (Default: `drive`.)
* For more information, see [File
* organization](https://developers.google.com/workspace/drive/api/guides/about-
* files#file-organization).
* @opt_param string type The type of items which the IDs can be used for.
* Supported values are `files` and `shortcuts`. Note that `shortcuts` are only
* supported in the `drive` `space`. (Default: `files`.) For more information,
* see [File
* organization](https://developers.google.com/workspace/drive/api/guides/about-
* files#file-organization).
* @return GeneratedIds
* @throws \Google\Service\Exception
*/
public function generateIds($optParams = [])
{
$params = [];
$params = array_merge($params, $optParams);
return $this->call('generateIds', [$params], GeneratedIds::class);
}
/**
* Gets a file's metadata or content by ID. For more information, see [Search
* for files and
* folders](https://developers.google.com/workspace/drive/api/guides/search-
* files). If you provide the URL parameter `alt=media`, then the response
* includes the file contents in the response body. Downloading content with
* `alt=media` only works if the file is stored in Drive. To download Google
* Docs, Sheets, and Slides use [`files.export`](https://developers.google.com/w
* orkspace/drive/api/reference/rest/v3/files/export) instead. For more
* information, see [Download and export
* files](https://developers.google.com/workspace/drive/api/guides/manage-
* downloads). (files.get)
*
* @param string $fileId The ID of the file.
* @param array $optParams Optional parameters.
*
* @opt_param bool acknowledgeAbuse Whether the user is acknowledging the risk
* of downloading known malware or other abusive files. This is only applicable
* when the `alt` parameter is set to `media` and the user is the owner of the
* file or an organizer of the shared drive in which the file resides.
* @opt_param string includeLabels A comma-separated list of IDs of labels to
* include in the `labelInfo` part of the response.
* @opt_param string includePermissionsForView Specifies which additional view's
* permissions to include in the response. Only `published` is supported.
* @opt_param bool supportsAllDrives Whether the requesting application supports
* both My Drives and shared drives.
* @opt_param bool supportsTeamDrives Deprecated: Use `supportsAllDrives`
* instead.
* @return DriveFile
* @throws \Google\Service\Exception
*/
public function get($fileId, $optParams = [])
{
$params = ['fileId' => $fileId];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], DriveFile::class);
}
/**
* Lists the user's files. For more information, see [Search for files and
* folders](https://developers.google.com/workspace/drive/api/guides/search-
* files). This method accepts the `q` parameter, which is a search query
* combining one or more search terms. This method returns *all* files by
* default, including trashed files. If you don't want trashed files to appear
* in the list, use the `trashed=false` query parameter to remove trashed files
* from the results. (files.listFiles)
*
* @param array $optParams Optional parameters.
*
* @opt_param string corpora Specifies a collection of items (files or
* documents) to which the query applies. Supported items include: * `user` *
* `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for
* efficiency. By default, corpora is set to `user`. However, this can change
* depending on the filter set through the `q` parameter. For more information,
* see [File
* organization](https://developers.google.com/workspace/drive/api/guides/about-
* files#file-organization).
* @opt_param string corpus Deprecated: The source of files to list. Use
* `corpora` instead.
* @opt_param string driveId ID of the shared drive to search.
* @opt_param bool includeItemsFromAllDrives Whether both My Drive and shared
* drive items should be included in results.
* @opt_param string includeLabels A comma-separated list of IDs of labels to
* include in the `labelInfo` part of the response.
* @opt_param string includePermissionsForView Specifies which additional view's
* permissions to include in the response. Only `published` is supported.
* @opt_param bool includeTeamDriveItems Deprecated: Use
* `includeItemsFromAllDrives` instead.
* @opt_param string orderBy A comma-separated list of sort keys. Valid keys
* are: * `createdTime`: When the file was created. Avoid using this key for
* queries on large item collections as it might result in timeouts or other
* issues. For time-related sorting on large item collections, use
* `modifiedTime` instead. * `folder`: The folder ID. This field is sorted using
* alphabetical ordering. * `modifiedByMeTime`: The last time the file was
* modified by the user. * `modifiedTime`: The last time the file was modified
* by anyone. * `name`: The name of the file. This field is sorted using
* alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the
* file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. *
* `quotaBytesUsed`: The number of storage quota bytes used by the file. *
* `recency`: The most recent timestamp from the file's date-time fields. *
* `sharedWithMeTime`: When the file was shared with the user, if applicable. *
* `starred`: Whether the user has starred the file. * `viewedByMeTime`: The
* last time the file was viewed by the user. Each key sorts ascending by
* default, but can be reversed with the `desc` modifier. Example usage:
* `?orderBy=folder,modifiedTime desc,name`.
* @opt_param int pageSize The maximum number of files to return per page.
* Partial or empty result pages are possible even before the end of the files
* list has been reached.
* @opt_param string pageToken The token for continuing a previous list request
* on the next page. This should be set to the value of `nextPageToken` from the
* previous response.
* @opt_param string q A query for filtering the file results. For supported
* syntax, see [Search for files and
* folders](/workspace/drive/api/guides/search-files).
* @opt_param string spaces A comma-separated list of spaces to query within the
* corpora. Supported values are `drive` and `appDataFolder`. For more
* information, see [File
* organization](https://developers.google.com/workspace/drive/api/guides/about-
* files#file-organization).
* @opt_param bool supportsAllDrives Whether the requesting application supports
* both My Drives and shared drives.
* @opt_param bool supportsTeamDrives Deprecated: Use `supportsAllDrives`
* instead.
* @opt_param string teamDriveId Deprecated: Use `driveId` instead.
* @return FileList
* @throws \Google\Service\Exception
*/
public function listFiles($optParams = [])
{
$params = [];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], FileList::class);
}
/**
* Lists the labels on a file. For more information, see [List labels on a
* file](https://developers.google.com/workspace/drive/api/guides/list-labels).
* (files.listLabels)
*
* @param string $fileId The ID for the file.
* @param array $optParams Optional parameters.
*
* @opt_param int maxResults The maximum number of labels to return per page.
* When not set, defaults to 100.
* @opt_param string pageToken The token for continuing a previous list request
* on the next page. This should be set to the value of `nextPageToken` from the
* previous response.
* @return LabelList
* @throws \Google\Service\Exception
*/
public function listLabels($fileId, $optParams = [])
{
$params = ['fileId' => $fileId];
$params = array_merge($params, $optParams);
return $this->call('listLabels', [$params], LabelList::class);
}
/**
* Modifies the set of labels applied to a file. For more information, see [Set
* a label field on a
* file](https://developers.google.com/workspace/drive/api/guides/set-label).
* Returns a list of the labels that were added or modified.
* (files.modifyLabels)
*
* @param string $fileId The ID of the file to which the labels belong.
* @param ModifyLabelsRequest $postBody
* @param array $optParams Optional parameters.
* @return ModifyLabelsResponse
* @throws \Google\Service\Exception
*/
public function modifyLabels($fileId, ModifyLabelsRequest $postBody, $optParams = [])
{
$params = ['fileId' => $fileId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('modifyLabels', [$params], ModifyLabelsResponse::class);
}
/**
* Updates a file's metadata, content, or both. When calling this method, only
* populate fields in the request that you want to modify. When updating fields,
* some fields might be changed automatically, such as `modifiedDate`. This
* method supports patch semantics. This method supports an upload* URI and
* accepts uploaded media with the following characteristics: - *Maximum file
* size:* 5,120 GB - *Accepted Media MIME types:* `*` (Specify a valid MIME
* type, rather than the literal `*` value. The literal `*` is only used to
* indicate that any valid MIME type can be uploaded. For more information, see
* [Google Workspace and Google Drive supported MIME
* types](https://developers.google.com/workspace/drive/api/guides/mime-types).)
* For more information on uploading files, see [Upload file
* data](https://developers.google.com/workspace/drive/api/guides/manage-
* uploads). (files.update)
*
* @param string $fileId The ID of the file.
* @param DriveFile $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string addParents A comma-separated list of parent IDs to add.
* @opt_param bool enforceSingleParent Deprecated: Adding files to multiple
* folders is no longer supported. Use shortcuts instead.
* @opt_param string includeLabels A comma-separated list of IDs of labels to
* include in the `labelInfo` part of the response.
* @opt_param string includePermissionsForView Specifies which additional view's
* permissions to include in the response. Only `published` is supported.
* @opt_param bool keepRevisionForever Whether to set the `keepForever` field in
* the new head revision. This is only applicable to files with binary content
* in Google Drive. Only 200 revisions for the file can be kept forever. If the
* limit is reached, try deleting pinned revisions.
* @opt_param string ocrLanguage A language hint for OCR processing during image
* import (ISO 639-1 code).
* @opt_param string removeParents A comma-separated list of parent IDs to
* remove.
* @opt_param bool supportsAllDrives Whether the requesting application supports
* both My Drives and shared drives.
* @opt_param bool supportsTeamDrives Deprecated: Use `supportsAllDrives`
* instead.
* @opt_param bool useContentAsIndexableText Whether to use the uploaded content
* as indexable text.
* @return DriveFile
* @throws \Google\Service\Exception
*/
public function update($fileId, DriveFile $postBody, $optParams = [])
{
$params = ['fileId' => $fileId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('update', [$params], DriveFile::class);
}
/**
* Subscribes to changes to a file. For more information, see [Notifications for
* resource
* changes](https://developers.google.com/workspace/drive/api/guides/push).
* (files.watch)
*
* @param string $fileId The ID of the file.
* @param Channel $postBody
* @param array $optParams Optional parameters.
*
* @opt_param bool acknowledgeAbuse Whether the user is acknowledging the risk
* of downloading known malware or other abusive files. This is only applicable
* when the `alt` parameter is set to `media` and the user is the owner of the
* file or an organizer of the shared drive in which the file resides.
* @opt_param string includeLabels A comma-separated list of IDs of labels to
* include in the `labelInfo` part of the response.
* @opt_param string includePermissionsForView Specifies which additional view's
* permissions to include in the response. Only `published` is supported.
* @opt_param bool supportsAllDrives Whether the requesting application supports
* both My Drives and shared drives.
* @opt_param bool supportsTeamDrives Deprecated: Use `supportsAllDrives`
* instead.
* @return Channel
* @throws \Google\Service\Exception
*/
public function watch($fileId, Channel $postBody, $optParams = [])
{
$params = ['fileId' => $fileId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('watch', [$params], Channel::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Files::class, 'Google_Service_Drive_Resource_Files');
← Back