Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

ファイルデータをアップロードする

Google Drive API を使用すると、 File の作成時または更新時にファイルデータをアップロードできます。フォルダなどのメタデータのみのファイルを作成する方法については、メタデータのみのファイルを作成するをご覧ください。

実行できるアップロードには、次の 3 種類があります。

単純なアップロード（uploadType=media）: このアップロードタイプは、メタデータを提供せずに小さなメディアファイル（5 MB 以下）を転送する場合に使用します。単純なアップロードを実行するには、単純なアップロードを実行するをご覧ください。
マルチパートアップロード（uploadType=multipart）: このアップロードタイプは、ファイルを表すメタデータとともに小さなファイル（5 MB 以下）を単一のリクエストで転送する場合に使用します。マルチパートアップロードを実行するには、マルチパートアップロードを実行するをご覧ください。
再開可能なアップロード（uploadType=resumable）: このアップロードタイプは、大容量ファイル（5 MB 超）の場合や、モバイルアプリからファイルを作成する場合など、ネットワークが中断する可能性が高い場合に使用します。再開可能なアップロードは、アップロードごとに 1 つの HTTP リクエストを送信するだけで、サイズの小さなファイルでも利用できるため、ほとんどのアプリケーションに適しています。再開可能なアップロードを実行するには、再開可能なアップロードをご覧ください。

Google API クライアントライブラリは、これらのアップロードタイプのうち少なくとも 1 つを実装しています。各タイプの使用方法の詳細については、クライアントライブラリドキュメントをご覧ください。

`PATCH` と `PUT` の使い分け

復習として、HTTP 動詞 PATCH はファイルリソースの部分的な更新をサポートしますが、HTTP 動詞 PUT はリソースの完全な置き換えをサポートします。PUT を使用すると、既存のリソースに新しいフィールドを追加するときに、互換性を損なう変更が発生する可能性があります。

ファイルリソースをアップロードする場合は、次のガイドラインに従ってください。

再開可能なアップロードの最初のリクエスト、または単純なアップロードまたはマルチパートアップロードの唯一のリクエストには、API リファレンスに記載されている HTTP 動詞を使用します。
リクエストが開始されたら、再開可能なアップロードの後続のリクエストにはすべて PUT を使用します。これらのリクエストは、呼び出されるメソッドに関係なく、コンテンツをアップロードします。

単純なアップロードを実行する

単純なアップロードを実行するには、create メソッドをfiles リソースで uploadType=media使用します。

以下に、単純なアップロードを実行する方法を示します。

HTTP

クエリパラメータ uploadType=media を指定して、メソッドの /upload URI に POST リクエストを作成します。

POST https://www.googleapis.com/upload/drive/v3/files?uploadType=media
ファイルのデータをリクエストの本文に追加します。
次の HTTP ヘッダーを追加します。
- Content-Type: アップロードするオブジェクトの MIME メディアタイプに設定します。
- Content-Length: アップロードするバイト数を設定します。チャンク形式転送エンコードを使用する場合、このヘッダーは不要です。
リクエストを送信します。リクエストが成功すると、サーバーは HTTP 200 OK ステータスコードとファイルのメタデータを返します。{HTTP}

単純なアップロードを実行すると、基本的なメタデータが作成され、MIME タイプや modifiedTime など、一部の属性がファイルから推測されます。単純なアップロードは、ファイルが小さく、ファイルメタデータが重要でない場合に使用できます。

マルチパートアップロードを実行する

マルチパートアップロードリクエストを使用すると、メタデータとデータを同じリクエストでアップロードできます。送信するデータが小さく、接続が失敗したときに全体を再アップロードできる場合は、このオプションを使用します。

マルチパートアップロードを実行するには、 create メソッドを files リソースで uploadType=multipart とともに使用します。

以下に、マルチパートアップロードを実行する方法を示します。

Java

drive/snippets/drive_v3/src/main/java/UploadBasic.java

GitHub で表示

import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.FileContent;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.drive.Drive;
import com.google.api.services.drive.DriveScopes;
import com.google.api.services.drive.model.File;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.util.Arrays;

/* Class to demonstrate use of Drive insert file API */
public class UploadBasic {

  /**
   * Upload new file.
   *
   * @return Inserted file metadata if successful, {@code null} otherwise.
   * @throws IOException if service account credentials file not found.
   */
  public static String uploadBasic() throws IOException {
    // Load pre-authorized user credentials from the environment.
    // TODO(developer) - See https://developers.google.com/identity for
    // guides on implementing OAuth2 for your application.
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(Arrays.asList(DriveScopes.DRIVE_FILE));
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Build a new authorized API client service.
    Drive service = new Drive.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Drive samples")
        .build();
    // Upload file photo.jpg on drive.
    File fileMetadata = new File();
    fileMetadata.setName("photo.jpg");
    // File's content.
    java.io.File filePath = new java.io.File("files/photo.jpg");
    // Specify media type and file-path for file.
    FileContent mediaContent = new FileContent("image/jpeg", filePath);
    try {
      File file = service.files().create(fileMetadata, mediaContent)
          .setFields("id")
          .execute();
      System.out.println("File ID: " + file.getId());
      return file.getId();
    } catch (GoogleJsonResponseException e) {
      // TODO(developer) - handle error appropriately
      System.err.println("Unable to upload file: " + e.getDetails());
      throw e;
    }
  }
}

Python

drive/snippets/drive-v3/file_snippet/upload_basic.py

GitHub で表示

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from googleapiclient.http import MediaFileUpload


def upload_basic():
  """Insert new file.
  Returns : Id's of the file uploaded

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()

  try:
    # create drive api client
    service = build("drive", "v3", credentials=creds)

    file_metadata = {"name": "download.jpeg"}
    media = MediaFileUpload("download.jpeg", mimetype="image/jpeg")
    # pylint: disable=maybe-no-member
    file = (
        service.files()
        .create(body=file_metadata, media_body=media, fields="id")
        .execute()
    )
    print(f'File ID: {file.get("id")}')

  except HttpError as error:
    print(f"An error occurred: {error}")
    file = None

  return file.get("id")


if __name__ == "__main__":
  upload_basic()

Node.js

drive/snippets/drive_v3/file_snippets/upload_basic.js

GitHub で表示

import fs from 'node:fs';
import {GoogleAuth} from 'google-auth-library';
import {google} from 'googleapis';

/**
 * Uploads a file to Google Drive.
 * @return {Promise<string|null|undefined>} The ID of the uploaded file.
 */
async function uploadBasic() {
  // Authenticate with Google and get an authorized client.
  // TODO (developer): Use an appropriate auth mechanism for your app.
  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/drive',
  });

  // Create a new Drive API client (v3).
  const service = google.drive({version: 'v3', auth});

  // The request body for the file to be uploaded.
  const requestBody = {
    name: 'photo.jpg',
    fields: 'id',
  };

  // The media content to be uploaded.
  const media = {
    mimeType: 'image/jpeg',
    body: fs.createReadStream('files/photo.jpg'),
  };

  // Upload the file.
  const file = await service.files.create({
    requestBody,
    media,
  });

  // Print the ID of the uploaded file.
  console.log('File Id:', file.data.id);
  return file.data.id;
}

PHP

drive/snippets/drive_v3/src/DriveUploadBasic.php

GitHub で表示

<?php
use Google\Client;
use Google\Service\Drive;
# TODO - PHP client currently chokes on fetching start page token
function uploadBasic()
{
    try {
        $client = new Client();
        $client->useApplicationDefaultCredentials();
        $client->addScope(Drive::DRIVE);
        $driveService = new Drive($client);
        $fileMetadata = new Drive\DriveFile(array(
        'name' => 'photo.jpg'));
        $content = file_get_contents('../files/photo.jpg');
        $file = $driveService->files->create($fileMetadata, array(
            'data' => $content,
            'mimeType' => 'image/jpeg',
            'uploadType' => 'multipart',
            'fields' => 'id'));
        printf("File ID: %s\n", $file->id);
        return $file->id;
    } catch(Exception $e) {
        echo "Error Message: ".$e;
    } 

}

.NET

drive/snippets/drive_v3/DriveV3Snippets/UploadBasic.cs

GitHub で表示

using Google.Apis.Auth.OAuth2;
using Google.Apis.Drive.v3;
using Google.Apis.Services;

namespace DriveV3Snippets
{
    // Class to demonstrate use of Drive insert file API
    public class UploadBasic
    {
        /// <summary>
        /// Upload new file.
        /// </summary>
        /// <param name="filePath">Image path to upload.</param>
        /// <returns>Inserted file metadata if successful, null otherwise.</returns>
        public static string DriveUploadBasic(string filePath)
        {
            try
            {
                /* Load pre-authorized user credentials from the environment.
                 TODO(developer) - See https://developers.google.com/identity for
                 guides on implementing OAuth2 for your application. */
                GoogleCredential credential = GoogleCredential.GetApplicationDefault()
                    .CreateScoped(DriveService.Scope.Drive);

                // Create Drive API service.
                var service = new DriveService(new BaseClientService.Initializer
                {
                    HttpClientInitializer = credential,
                    ApplicationName = "Drive API Snippets"
                });

                // Upload file photo.jpg on drive.
                var fileMetadata = new Google.Apis.Drive.v3.Data.File()
                {
                    Name = "photo.jpg"
                };
                FilesResource.CreateMediaUpload request;
                // Create a new file on drive.
                using (var stream = new FileStream(filePath,
                           FileMode.Open))
                {
                    // Create a new file, with metadata and stream.
                    request = service.Files.Create(
                        fileMetadata, stream, "image/jpeg");
                    request.Fields = "id";
                    request.Upload();
                }

                var file = request.ResponseBody;
                // Prints the uploaded file id.
                Console.WriteLine("File ID: " + file.Id);
                return file.Id;
            }
            catch (Exception e)
            {
                // TODO(developer) - handle error appropriately
                if (e is AggregateException)
                {
                    Console.WriteLine("Credential Not found");
                }
                else if (e is FileNotFoundException)
                {
                    Console.WriteLine("File not found");
                }
                else
                {
                    throw;
                }
            }
            return null;
        }
    }
}

HTTP

クエリパラメータ uploadType=multipart を指定して、メソッドの /upload URI に POST リクエストを作成します。

POST https://www.googleapis.com/upload/drive/v3/files?uploadType=multipart
リクエストの本文を作成します。本文は、 multipart/related コンテンツタイプ RFC 2387 に従ってフォーマットします。これには次の 2 つの部分が含まれます。
- メタデータ。メタデータは最初に指定する必要があり、Content-Type ヘッダーを application/json; charset=UTF-8 に設定する必要があります。ファイルのメタデータを JSON 形式で追加します。
- メディア。メディアは 2 番目に指定する必要があり、Content-Type ヘッダーは任意の MIME タイプにする必要があります。ファイルのデータをメディア要素に追加します。
最初の境界文字列の前に 2 個のハイフンを付けて、各部分を区別します。さらに、最後の境界文字列の後に 2 個のハイフンを追加します。
次の最上位の HTTP ヘッダーを追加します。
- Content-Type: multipart/related に設定し、リクエストの各部分の識別に使用する境界文字列を含めます。例: Content-Type: multipart/related; boundary=foo_bar_baz
- Content-Length: リクエスト本文の総バイト数に設定します。
リクエストを送信します。

関連付けられたデータなしでメタデータ部分のみを作成または更新するには、標準リソースエンドポイント https://www.googleapis.com/drive/v3/files に POST リクエストまたは PATCH リクエストを送信します。リクエストが成功すると、サーバーは HTTP 200 OK ステータスコードとファイルのメタデータを返します。

ファイルを作成するときは、ファイルの name フィールドにファイル拡張子を指定する必要があります。たとえば、写真の JPEG ファイルを作成する場合は、メタデータに何かのように "name": "photo.jpg"指定します。get メソッドを呼び出すと、name フィールドに指定された拡張子を含む読み取り専用の fileExtension プロパティが返されます。

再開可能なアップロードを実行する

再開可能なアップロードを使用すると、通信障害でデータフローが中断した後にアップロード操作を再開できます。再開可能なアップロードでは、ネットワーク障害が発生した場合に大容量のファイルのアップロードを最初からやり直す必要がないため、使用する帯域幅を削減できます。

再開可能なアップロードは、ファイルサイズが大きく異なる場合や、リクエストに固定の時間制限がある場合（モバイル OS のバックグラウンドタスクや特定の App Engine リクエストなど）に便利です。アップロードの進行状況バーを表示する場合にも、再開可能なアップロードを使用できます。

再開可能なアップロードは、次のような手順で構成されます。

最初のリクエストを送信して、再開可能なセッション URI を取得します。
データをアップロードし、アップロードの状態をモニタリングします。
（省略可）アップロードが中断された場合は、アップロードを再開します。

最初のリクエストを送信する

再開可能なアップロードを開始するには、 create メソッドを files リソースで uploadType=resumable とともに使用します。

HTTP

クエリパラメータ uploadType=resumable を指定して、メソッドの /upload URI に POST リクエストを作成します。

POST https://www.googleapis.com/upload/drive/v3/files?uploadType=resumable

開始リクエストが成功すると、レスポンスには 200 OK HTTP ステータスコードが含まれます。また、再開可能なセッション URI を指定した Location ヘッダーも含まれます。
```
HTTP/1.1 200 OK
Location: https://www.googleapis.com/upload/drive/v3/files?uploadType=resumable&upload_id=xa298sd_sdlkj2
Content-Length: 0
```
再開可能なセッション URI を保存して、ファイルデータをアップロードし、アップロードステータスを確認できるようにします。再開可能なセッションの URI は 1 週間後に期限切れになります。

注: 既存のファイルを更新するには、PATCH を使用します。
ファイルにメタデータがある場合には、リクエストの本文に JSON 形式でメタデータを追加します。それ以外の場合には、リクエストの本文は空にしておきます。
次の HTTP ヘッダーを追加します。
- X-Upload-Content-Type。省略できます。ファイルデータの MIME タイプに設定します。これは、後続のリクエストで転送されます。データの MIME タイプがメタデータまたはこのヘッダーで指定されていない場合、オブジェクトは application/octet-stream. として提供されます。
- X-Upload-Content-Length。省略できます。後続のリクエストで転送されるファイルデータのバイト数を設定します。
- Content-Type。ファイルにメタデータがある場合には必須です。application/json; charset=UTF-8 に設定します。
- Content-Length。チャンク形式転送エンコードを使用しない場合は、必須です。この開始リクエスト本文のバイト数を設定します。
リクエストを送信します。セッション開始リクエストが成功すると、レスポンスには 200 OK HTTP ステータスコードが返されます。また、レスポンスには、再開可能なセッション URI を指定した Location ヘッダーが含まれます。再開可能なセッション URI を使用してファイルデータをアップロードし、アップロードステータスを確認します。再開可能なセッションの URI は 1 週間後に期限切れになります。
再開可能なセッションの URL をコピーして保存します。
コンテンツのアップロードに進みます。

コンテンツをアップロードする

再開可能なセッションでファイルをアップロードするには、2 つの方法があります。

単一のリクエストでコンテンツをアップロードする: 1 つのリクエストでファイルをアップロードできる場合、単一のリクエストに固定の時間制限がない場合、アップロードの進行状況インジケーターを表示する必要がない場合は、この方法を使用します。この方法は、リクエストの数が少なく、パフォーマンスが向上するため、最適です。
複数のチャンクでコンテンツをアップロードする: 単一のリクエストで転送されるデータ量を減らす必要がある場合は、この方法を使用します。個々のリクエストに固定の時間制限がある場合（App Engine リクエストの一部のクラスなど）は、転送されるデータを減らす必要がある場合があります。この方法は、アップロードの進行状況を示すカスタムインジケーターを提供する必要がある場合にも便利です。

HTTP - 単一のリクエスト

再開可能なセッションの URI に PUT リクエストを作成します。
ファイルのデータをリクエストの本文に追加します。
Content-Length HTTP ヘッダーを追加し、ファイルのバイト数に設定します。
リクエストを送信します。アップロードリクエストが中断するか、 5xx レスポンスを受信したら、中断されたアップロードを再開するの手順を行います。

HTTP - 複数のリクエスト

再開可能なセッションの URI に PUT リクエストを作成します。
リクエストの本文にチャンクのデータを追加します。サイズが 256 KB（256 x 1,024 バイト）の倍数になるようにチャンクを作成します（アップロードを完了する最後のチャックは除く）。アップロードを効率的に行うため、チャンクサイズはできるだけ大きくしてください。
次の HTTP ヘッダーを追加します。
- Content-Length: 現在のチャンクのバイト数を設定します。
- Content-Range: アップロードするファイルのバイト数を示すように設定します。たとえば、Content-Range: bytes 0-524287/2000000 は、2,000,000 バイトのファイルの最初の 524,288 バイト（256 x 1024 x 2）をアップロードすることを示します。
リクエストを送信してレスポンスを処理します。アップロードリクエストが中断するか、5xx レスポンスを受信したら、中断されたアップロードを再開するの手順を行います。
ファイルに残っているチャンクごとに、手順 1 ～ 4 を繰り返します。レスポンスの Range ヘッダーを使用して、次のチャンクを開始する位置を決定します。サーバーが前のリクエストで送信されたすべてのバイトを受信したと想定しないでください。

ファイル全体のアップロードが完了すると、200 OK または 201 Created レスポンスと、リソースに関連付けられたメタデータを受け取ります。

中断されたアップロードを再開する

レスポンスを受信する前にアップロードリクエストが終了した場合や、503 Service Unavailable レスポンスが返された場合は、中断されたアップロードを再開する必要があります。

HTTP

アップロードのステータスを取得するため、再開可能なセッションの URI に空の PUT リクエストを作成します。
ファイル内の現在の位置が不明であることを示す Content-Range ヘッダーを追加します。たとえば、ファイルの合計サイズが 2,000,000 バイトの場合は、Content-Range を */2000000 に設定します。ファイル全体のサイズがわからない場合は、Content-Range を */* に設定します。
リクエストを送信します。
レスポンスを処理します。
- 200 OK または 201 Created が返された場合、アップロードは完了しています。これ以上の操作は必要ありません。
- 308 Resume Incomplete が返された場合、ファイルのアップロードを続行する必要があります。
- 404 Not Found が返された場合、アップロードセッションが期限切れになったため、アップロードを最初からやり直す必要があります。
308 Resume Incomplete レスポンスを受け取った場合は、レスポンスの Range ヘッダーを処理して、サーバーが受信したバイト数を特定します。レスポンスに Range ヘッダーがない場合、バイトは受信されていません。たとえば、Range ヘッダーが bytes=0-42 の場合、ファイルの最初の 43 バイトが受信され、次にアップロードするチャンクはバイト 44 から始まることを示します。
これで、アップロードを再開する場所が確認できました。次のバイトからファイルのアップロードを続行します。送信するファイルの部分を示す Content-Range ヘッダーを含めます。たとえば、Content-Range: bytes 43-1999999 は、バイト 44 から 2,000,000 までを送信することを示します。

メディアアップロード時のエラーを処理する

メディアをアップロードするときは、次のベストプラクティスに従ってエラーを処理します。

5xx エラーの場合は、接続の中断が原因で失敗したアップロードを再開または再試行します。5xx エラーの処理の詳細については、 500、502、503、504 エラーをご覧ください。
403 rate limit エラーの場合は、アップロードを再試行します。403 rate limit エラーの処理の詳細については、403 エラー: rateLimitExceeded をご覧ください。
再開可能なアップロード中に 4xx エラー（403 を含む）が発生した場合は、アップロードを再開します。これらのエラーは、アップロードセッションが期限切れになったことを示します。新しいセッション URI をリクエストして、アップロードを再開する必要があります。アップロードセッションは、1 週間操作が行われないと期限切れになります。

Google ドキュメントのタイプにインポートする

Drive でファイルを作成するときに、Google ドキュメントや Google スプレッドシートなどの Google Workspace ファイル形式に変換することがあります。たとえば、お気に入りのワープロ文書を Google ドキュメントに変換して、その機能を利用したい場合などです。

ファイルを特定の Google Workspace ファイル形式に変換するには、ファイルを作成するときに Google Workspace mimeType を指定します。

以下に、CSV ファイルを Google Workspace スプレッドシートに変換する方法を示します。

Java

drive/snippets/drive_v3/src/main/java/UploadWithConversion.java

GitHub で表示

import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.FileContent;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.drive.Drive;
import com.google.api.services.drive.DriveScopes;
import com.google.api.services.drive.model.File;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.util.Arrays;

/* Class to demonstrate Drive's upload with conversion use-case. */
public class UploadWithConversion {

  /**
   * Upload file with conversion.
   *
   * @return Inserted file id if successful, {@code null} otherwise.
   * @throws IOException if service account credentials file not found.
   */
  public static String uploadWithConversion() throws IOException {
    // Load pre-authorized user credentials from the environment.
    // TODO(developer) - See https://developers.google.com/identity for
    // guides on implementing OAuth2 for your application.
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(Arrays.asList(DriveScopes.DRIVE_FILE));
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Build a new authorized API client service.
    Drive service = new Drive.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Drive samples")
        .build();

    // File's metadata.
    File fileMetadata = new File();
    fileMetadata.setName("My Report");
    fileMetadata.setMimeType("application/vnd.google-apps.spreadsheet");

    java.io.File filePath = new java.io.File("files/report.csv");
    FileContent mediaContent = new FileContent("text/csv", filePath);
    try {
      File file = service.files().create(fileMetadata, mediaContent)
          .setFields("id")
          .execute();
      System.out.println("File ID: " + file.getId());
      return file.getId();
    } catch (GoogleJsonResponseException e) {
      // TODO(developer) - handle error appropriately
      System.err.println("Unable to move file: " + e.getDetails());
      throw e;
    }
  }
}

Python

drive/snippets/drive-v3/file_snippet/upload_with_conversion.py

GitHub で表示

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from googleapiclient.http import MediaFileUpload


def upload_with_conversion():
  """Upload file with conversion
  Returns: ID of the file uploaded

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()

  try:
    # create drive api client
    service = build("drive", "v3", credentials=creds)

    file_metadata = {
        "name": "My Report",
        "mimeType": "application/vnd.google-apps.spreadsheet",
    }
    media = MediaFileUpload("report.csv", mimetype="text/csv", resumable=True)
    # pylint: disable=maybe-no-member
    file = (
        service.files()
        .create(body=file_metadata, media_body=media, fields="id")
        .execute()
    )
    print(f'File with ID: "{file.get("id")}" has been uploaded.')

  except HttpError as error:
    print(f"An error occurred: {error}")
    file = None

  return file.get("id")


if __name__ == "__main__":
  upload_with_conversion()

Node.js

drive/snippets/drive_v3/file_snippets/upload_with_conversion.js

GitHub で表示

import fs from 'node:fs';
import {GoogleAuth} from 'google-auth-library';
import {google} from 'googleapis';

/**
 * Uploads a file to Google Drive and converts it to a Google Sheet.
 * @return {Promise<string|null|undefined>} The ID of the uploaded file.
 */
async function uploadWithConversion() {
  // Authenticate with Google and get an authorized client.
  // TODO (developer): Use an appropriate auth mechanism for your app.
  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/drive',
  });

  // Create a new Drive API client (v3).
  const service = google.drive({version: 'v3', auth});

  // The metadata for the file to be uploaded and converted.
  const fileMetadata = {
    name: 'My Report',
    // The MIME type to convert the file to.
    mimeType: 'application/vnd.google-apps.spreadsheet',
  };

  // The media content to be uploaded.
  const media = {
    mimeType: 'text/csv',
    body: fs.createReadStream('files/report.csv'),
  };

  // Upload the file with conversion.
  const file = await service.files.create({
    requestBody: fileMetadata,
    media,
    fields: 'id',
  });

  // Print the ID of the uploaded file.
  console.log('File Id:', file.data.id);
  return file.data.id;
}

PHP

drive/snippets/drive_v3/src/DriveUploadWithConversion.php

GitHub で表示

<?php
use Google\Client;
use Google\Service\Drive;
function uploadWithConversion()
{
    try {
        $client = new Client();
        $client->useApplicationDefaultCredentials();
        $client->addScope(Drive::DRIVE);
        $driveService = new Drive($client);
        $fileMetadata = new Drive\DriveFile(array(
            'name' => 'My Report',
            'mimeType' => 'application/vnd.google-apps.spreadsheet'));
        $content = file_get_contents('../files/report.csv');
        $file = $driveService->files->create($fileMetadata, array(
            'data' => $content,
            'mimeType' => 'text/csv',
            'uploadType' => 'multipart',
            'fields' => 'id'));
        printf("File ID: %s\n", $file->id);
        return $file->id;
    } catch(Exception $e) {
        echo "Error Message: ".$e;
    }

}

.NET

drive/snippets/drive_v3/DriveV3Snippets/UploadWithConversion.cs

GitHub で表示

using Google.Apis.Auth.OAuth2;
using Google.Apis.Drive.v3;
using Google.Apis.Services;

namespace DriveV3Snippets
{
    // Class to demonstrate Drive's upload with conversion use-case.
    public class UploadWithConversion
    {
        /// <summary>
        /// Upload file with conversion.
        /// </summary>
        /// <param name="filePath">Id of the spreadsheet file.</param>
        /// <returns>Inserted file id if successful, null otherwise.</returns>
        public static string DriveUploadWithConversion(string filePath)
        {
            try
            {
                /* Load pre-authorized user credentials from the environment.
                 TODO(developer) - See https://developers.google.com/identity for
                 guides on implementing OAuth2 for your application. */
                GoogleCredential credential = GoogleCredential.GetApplicationDefault()
                    .CreateScoped(DriveService.Scope.Drive);

                // Create Drive API service.
                var service = new DriveService(new BaseClientService.Initializer
                {
                    HttpClientInitializer = credential,
                    ApplicationName = "Drive API Snippets"
                });

                // Upload file My Report on drive.
                var fileMetadata = new Google.Apis.Drive.v3.Data.File()
                {
                    Name = "My Report",
                    MimeType = "application/vnd.google-apps.spreadsheet"
                };
                FilesResource.CreateMediaUpload request;
                // Create a new drive.
                using (var stream = new FileStream(filePath,
                           FileMode.Open))
                {
                    // Create a new file, with metadata and stream.
                    request = service.Files.Create(
                        fileMetadata, stream, "text/csv");
                    request.Fields = "id";
                    request.Upload();
                }

                var file = request.ResponseBody;
                // Prints the uploaded file id.
                Console.WriteLine("File ID: " + file.Id);
                return file.Id;
            }
            catch (Exception e)
            {
                // TODO(developer) - handle error appropriately
                if (e is AggregateException)
                {
                    Console.WriteLine("Credential Not found");
                }
                else if (e is FileNotFoundException)
                {
                    Console.WriteLine("File not found");
                }
                else
                {
                    throw;
                }
            }
            return null;
        }
    }
}

変換が可能かどうかを確認するには、ファイルを作成する前に importFormats リソースの about フィールドを確認します。サポートされている変換は、この配列で動的に利用できます。一般的なインポート形式は次のとおりです。

差出人	宛先
Microsoft Word、OpenDocument Text、HTML、RTF、プレーンテキスト	Google ドキュメント
Microsoft Excel、OpenDocument Spreadsheet、CSV、TSV、プレーンテキスト	Google スプレッドシート
Microsoft PowerPoint、OpenDocument Presentation	Google スライド
JPEG、PNG、GIF、BMP、PDF	Google ドキュメント（ドキュメントに画像を埋め込む）
プレーンテキスト（特別な MIME タイプ）、JSON	Google Apps Script

ドキュメント、スプレッドシート、スライドのファイルに対する update リクエストでメディアをアップロードして変換すると、ドキュメントのコンテンツ全体が置き換えられます。

画像を Google ドキュメントに変換すると、Drive は光学式文字認識（OCR）を使用して画像をテキストに変換します。OCR アルゴリズムの品質を向上させるには、該当する BCP 47 言語コードを ocrLanguage パラメータに指定します。抽出されたテキストは、埋め込まれた画像とともにドキュメントに表示されます。

事前生成された ID を使用してファイルをアップロードする

Drive API を使用すると、リソースの作成、コピー、アップロードに使用できる事前生成されたファイル ID のリストを取得できます。詳細については、ファイルで使用する ID を生成するをご覧ください。

事前生成された ID を使用すると、サーバーエラーやタイムアウトが発生した場合でも、アップロードを安全に再試行できます。ファイル操作が成功した場合、後続の再試行では 409 Conflict HTTP ステータスコードレスポンスが返され、重複するファイルは作成されません。

事前生成された ID は、 Google Workspace ファイルの作成ではサポートされていません。ただし、application/vnd.google-apps.drive-sdk と application/vnd.google-apps.folder MIME タイプは例外です。同様に、Google Workspace ファイル形式への変換を参照するアップロードはサポートされていません。

不明なファイル形式のインデックス可能なテキストを定義する

ユーザーは Drive UI を使用してドキュメントコンテンツを検索できます。また、 list リソースの files メソッドと fullText フィールドを使用して、アプリからコンテンツを検索することもできます。詳細については、ファイルとフォルダを検索するをご覧ください。

Drive は、テキストドキュメント、PDF、テキストを含む画像など、ファイル形式を認識すると、検索用にドキュメントを自動的にインデックス登録します。アプリが他の種類のファイル（図面、動画、ショートカットなど）を保存する場合は、ファイルの contentHints.indexableText フィールドにインデックス可能なテキストを指定することで、検出可能性を高めることができます。

インデックス可能なテキストの詳細については、ファイルメタデータを管理するをご覧ください。

ファイル データをアップロードする コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

PATCH と PUT の使い分け

単純なアップロードを実行する

HTTP

マルチパート アップロードを実行する

Java

Python

Node.js

PHP

.NET

HTTP

再開可能なアップロードを実行する

最初のリクエストを送信する

HTTP

コンテンツをアップロードする

HTTP - 単一のリクエスト

HTTP - 複数のリクエスト

中断されたアップロードを再開する

HTTP

メディア アップロード時のエラーを処理する

Google ドキュメントのタイプにインポートする

Java

Python

Node.js

PHP

.NET

事前生成された ID を使用してファイルをアップロードする

不明なファイル形式のインデックス可能なテキストを定義する

ファイルデータをアップロードする

`PATCH` と `PUT` の使い分け

マルチパートアップロードを実行する

メディアアップロード時のエラーを処理する