スプレッドシートの作成と管理

このドキュメントでは、Google Sheets API を使用して Google スプレッドシートでスプレッドシートを作成して管理する方法について説明します。

スプレッドシートを作成する

スプレッドシートにファイルを作成するには、パラメータなしで spreadsheets リソースの create メソッドを使用します。

ファイルを作成すると、メソッドは spreadsheets リソースを返します。返されるリソースには、spreadsheetId、properties、sheets のリスト、spreadsheetUrl が含まれます。

次のコードサンプルは、指定したタイトルの空白のスプレッドシートを作成する方法を示しています。

Apps Script

sheets/api/spreadsheet_snippets.gs

GitHub で表示

/**
 * Creates a new sheet using the sheets advanced services
 * @param {string} title the name of the sheet to be created
 * @returns {string} the spreadsheet ID
 */
Snippets.prototype.create = (title) => {
  // This code uses the Sheets Advanced Service, but for most use cases
  // the built-in method SpreadsheetApp.create() is more appropriate.
  try {
    const sheet = Sheets.newSpreadsheet();
    sheet.properties = Sheets.newSpreadsheetProperties();
    sheet.properties.title = title;
    const spreadsheet = Sheets.Spreadsheets.create(sheet);

    return spreadsheet.spreadsheetId;
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log("Failed with error %s", err.message);
  }
};

Java

sheets/snippets/src/main/java/Create.java

GitHub で表示

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.sheets.v4.Sheets;
import com.google.api.services.sheets.v4.SheetsScopes;
import com.google.api.services.sheets.v4.model.Spreadsheet;
import com.google.api.services.sheets.v4.model.SpreadsheetProperties;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.util.Collections;

/* Class to demonstrate the use of Spreadsheet Create API */
public class Create {
  /**
   * Create a new spreadsheet.
   *
   * @param title - the name of the sheet to be created.
   * @return newly created spreadsheet id
   * @throws IOException - if credentials file not found.
   */
  public static String createSpreadsheet(String title) 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(Collections.singleton(SheetsScopes.SPREADSHEETS));
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Create the sheets API client
    Sheets service = new Sheets.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Sheets samples")
        .build();

    // Create new spreadsheet with a title
    Spreadsheet spreadsheet = new Spreadsheet()
        .setProperties(new SpreadsheetProperties()
            .setTitle(title));
    spreadsheet = service.spreadsheets().create(spreadsheet)
        .setFields("spreadsheetId")
        .execute();
    // Prints the new spreadsheet id
    System.out.println("Spreadsheet ID: " + spreadsheet.getSpreadsheetId());
    return spreadsheet.getSpreadsheetId();
  }
}

JavaScript

sheets/snippets/sheets_create.js

GitHub で表示

function create(title, callback) {
  try {
    gapi.client.sheets.spreadsheets.create({
      properties: {
        title: title,
      },
    }).then((response) => {
      if (callback) callback(response);
      console.log('Spreadsheet ID: ' + response.result.spreadsheetId);
    });
  } catch (err) {
    document.getElementById('content').innerText = err.message;
    return;
  }
}

Node.js

sheets/snippets/sheets_create.js

GitHub で表示

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

/**
 * Creates a new Google Spreadsheet.
 * @param {string} title The title of the new spreadsheet.
 * @return {string} The ID of the created spreadsheet.
 */
async function create(title) {
  // Authenticate with Google and get an authorized client.
  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/spreadsheets',
  });

  // Create a new Sheets API client.
  const service = google.sheets({version: 'v4', auth});

  // The resource body for creating a new spreadsheet.
  const resource = {
    properties: {
      title,
    },
  };

  // Create the new spreadsheet.
  const spreadsheet = await service.spreadsheets.create({
    resource,
    fields: 'spreadsheetId',
  });

  // Log the ID of the new spreadsheet.
  console.log(`Spreadsheet ID: ${spreadsheet.data.spreadsheetId}`);
  return spreadsheet.data.spreadsheetId;
}

PHP

sheets/snippets/src/SpreadsheetCreate.php

GitHub で表示

<?php
use Google\Client;
use Google\Service\Drive;
use Google\Service\Sheets\SpreadSheet;

/**
* create an empty spreadsheet
* 
*/

 function create($title)
    {   
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
        $client = new Google\Client();
        $client->useApplicationDefaultCredentials();
        $client->addScope(Google\Service\Drive::DRIVE);
        $service = new Google_Service_Sheets($client);
        try{

            $spreadsheet = new Google_Service_Sheets_Spreadsheet([
                'properties' => [
                    'title' => $title
                    ]
                ]);
                $spreadsheet = $service->spreadsheets->create($spreadsheet, [
                    'fields' => 'spreadsheetId'
                ]);
                printf("Spreadsheet ID: %s\n", $spreadsheet->spreadsheetId);
                return $spreadsheet->spreadsheetId;
        }
        catch(Exception $e) {
            // TODO(developer) - handle error appropriately
            echo 'Message: ' .$e->getMessage();
          }
    }

Python

sheets/snippets/sheets_create.py

GitHub で表示

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


def create(title):
  """
  Creates the Sheet the user has access to.
  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()
  # pylint: disable=maybe-no-member
  try:
    service = build("sheets", "v4", credentials=creds)
    spreadsheet = {"properties": {"title": title}}
    spreadsheet = (
        service.spreadsheets()
        .create(body=spreadsheet, fields="spreadsheetId")
        .execute()
    )
    print(f"Spreadsheet ID: {(spreadsheet.get('spreadsheetId'))}")
    return spreadsheet.get("spreadsheetId")
  except HttpError as error:
    print(f"An error occurred: {error}")
    return error


if __name__ == "__main__":
  # Pass: title
  create("mysheet1")

Ruby

sheets/snippets/lib/spreadsheet_snippets.rb

GitHub で表示

spreadsheet = {
  properties: {
    title: 'Sales Report'
  }
}
spreadsheet = service.create_spreadsheet(spreadsheet,
                                         fields: 'spreadsheetId')
puts "Spreadsheet ID: #{spreadsheet.spreadsheet_id}"

Google ドライブのフォルダでスプレッドシートを整理する

デフォルトでは、作成したスプレッドシートは Google ドライブのルートフォルダに保存されます。

スプレッドシートを指定したドライブフォルダに保存するには、次の方法を使用します。

スプレッドシートファイルを作成したら、Google Drive API の files リソースの update メソッドを使用して、特定フォルダに移動します。詳しくは、フォルダ間でファイルを移動するをご覧ください。
Drive API の files リソースで create メソッドを使用して、フォルダに空白のスプレッドシートを追加します。このとき、mimeType として application/vnd.google-apps.spreadsheet を指定します。ファイルの作成について詳しくは、特定のフォルダにファイルを作成するをご覧ください。MIME タイプの詳細については、Google Workspace と Google ドライブでサポートされている MIME タイプをご覧ください。

どちらの方法でも、呼び出しを承認するには、適切な Drive API スコープを追加する必要があります。

アプリがサービスアカウントを使用している場合、作成されたスプレッドシートはサービスアカウントが所有します。このファイルは、サービスアカウント専用のドライブストレージに保存されます。明示的に共有しない限り、ファイルは他のドライブストレージアカウントに表示されません。詳細については、ファイルの所有権をご覧ください。

共有ドライブフォルダ内でファイルを移動または作成するには、共有ドライブのサポートを実装するをご覧ください。

Google スプレッドシートのセル数と行数の上限について詳しくは、Google ドライブに保管可能なファイルをご覧ください。

スプレッドシートを取得する

スプレッドシートを取得するには、spreadsheetId パスパラメータを使用して spreadsheets リソースの get メソッドを使用します。

このメソッドは、ファイルを spreadsheets リソースのインスタンスとして返します。デフォルトでは、スプレッドシート内のデータは返されません。返されるリソースには、スプレッドシートの構造とメタデータが含まれます。これには、スプレッドシートのプロパティ（タイトル、ロケール、タイムゾーンなど）や、シートの詳細情報（書式設定や保護された範囲など）が含まれます。

spreadsheets リソース内にデータを含めるには、次の 2 つの方法を使用します。

fields システムパラメータを設定して、選択したフィールドを一覧表示するフィールドマスクを指定します。
ブール値の includeGridData クエリパラメータを true に設定します。フィールドマスクが設定されている場合、includeGridData パラメータは無視されます。

大きなスプレッドシートを扱う場合は、必要な特定のフィールドのみをクエリすることをおすすめします。get メソッドはスプレッドシートに関連付けられたすべてのデータを返すため、大きなスプレッドシートに対する一般的なクエリは遅くなる可能性があります。たとえば、セルから数値 100 を読み取る場合、spreadsheets.get はセル値とメタデータ（フォント名、サイズなど）を返します。これにより、解析に時間がかかる大きな JSON ペイロードが生成されます。これに対し、values.get への同様の呼び出しでは、特定のセル値のみが返されるため、レスポンスがはるかに軽量で高速になります。

spreadsheets.values リソース（spreadsheets.values.get や spreadsheets.values.batchGet など）の詳細については、次のドキュメントをご覧ください。

スプレッドシートの一覧表示

Sheets API には、認証済みユーザーのスプレッドシートを一覧表示するメソッドはありません。

スプレッドシートのリストを取得するには、files リソースで Drive API の list メソッドを使用し、mimeType として application/vnd.google-apps.spreadsheet を指定します。

HTTP

GET https://www.googleapis.com/drive/v3/files?q=mimeType='application/vnd.google-apps.spreadsheet'

cURL

curl -X GET "https://www.googleapis.com/drive/v3/files?q=mimeType='application/vnd.google-apps.spreadsheet'" \
 -H "Authorization: Bearer ACCESS_TOKEN" \
 -H "Accept: application/json"

ACCESS_TOKEN は、API へのアクセスを許可するアクセストークンに置き換えます。

files.list メソッドを使用してユーザーのスプレッドシートを一覧表示するには、制限付きの Drive API スコープが必要です。

次の手順をお試しください。

スプレッドシートを更新するには、スプレッドシートを更新するをご覧ください。
スマートチップを使用するには、スマートチップをご覧ください。
デベロッパーメタデータを操作するには、メタデータの読み取り、書き込み、検索をご覧ください。

スプレッドシートの作成と管理 コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

スプレッドシートを作成する

Apps Script

Java

JavaScript

Node.js

PHP

Python

Ruby

Google ドライブのフォルダでスプレッドシートを整理する

スプレッドシートを取得する

スプレッドシートの一覧表示

HTTP

cURL

関連トピック

スプレッドシートの作成と管理