สร้างและจัดการสเปรดชีต

เอกสารนี้อธิบายวิธีสร้างและจัดการสเปรดชีตใน Google ชีตโดยใช้ Google Sheets API

สร้างสเปรดชีต

หากต้องการสร้างไฟล์ในชีต ให้ใช้ createเมธอดใน spreadsheetsแหล่งข้อมูล โดยไม่มีพารามิเตอร์

เมื่อคุณสร้างไฟล์ เมธอดจะแสดงผลแหล่งข้อมูล spreadsheets แหล่งข้อมูลที่แสดงผลจะมี spreadsheetId, properties, รายการ sheets และ spreadsheetUrl

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีสร้างสเปรดชีตเปล่าที่มีชื่อที่ระบุ

Apps Script

sheets/api/spreadsheet_snippets.gs
/**
 * 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
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
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
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
<?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
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
spreadsheet = {
  properties: {
    title: 'Sales Report'
  }
}
spreadsheet = service.create_spreadsheet(spreadsheet,
                                         fields: 'spreadsheetId')
puts "Spreadsheet ID: #{spreadsheet.spreadsheet_id}"

จัดระเบียบสเปรดชีตในโฟลเดอร์ Google ไดรฟ์

โดยค่าเริ่มต้น ระบบจะบันทึกสเปรดชีตที่สร้างขึ้นในโฟลเดอร์รากของผู้ใช้ใน Google ไดรฟ์

หากต้องการบันทึกสเปรดชีตลงในโฟลเดอร์ไดรฟ์ที่ระบุ ให้ใช้วิธีการต่อไปนี้

สำหรับตัวเลือกทั้ง 2 แบบ คุณจะต้องเพิ่มขอบเขต Drive API ที่เหมาะสมเพื่อให้สิทธิ์การเรียก

หากแอปของคุณใช้บัญชีบริการ บัญชีบริการจะเป็นเจ้าของสเปรดชีตที่สร้างขึ้น จากนั้นไฟล์นี้จะอยู่ในพื้นที่เก็บข้อมูล Google ไดรฟ์เฉพาะของบัญชีบริการ ไฟล์จะไม่ปรากฏในบัญชีพื้นที่เก็บข้อมูลไดรฟ์อื่นๆ เว้นแต่จะมีการแชร์อย่างชัดเจน ดูข้อมูลเพิ่มเติมได้ที่หัวข้อความเป็นเจ้าของไฟล์

หากต้องการย้ายหรือสร้างไฟล์ภายในโฟลเดอร์ไดรฟ์ที่แชร์ โปรดดูหัวข้อ ใช้ การรองรับไดรฟ์ที่แชร์

ดูข้อมูลเพิ่มเติมเกี่ยวกับขีดจำกัดของเซลล์และแถวใน Google ชีตได้ที่หัวข้อ ไฟล์ที่จัดเก็บใน Google ไดรฟ์

รับสเปรดชีต

หากต้องการรับสเปรดชีต ให้ใช้เมธอด get ในแหล่งข้อมูล spreadsheets พร้อมพารามิเตอร์เส้นทาง spreadsheetId

เมธอดจะแสดงผลไฟล์เป็นอินสแตนซ์ของแหล่งข้อมูล spreadsheets โดยค่าเริ่มต้น ระบบจะไม่แสดงผลข้อมูลภายในสเปรดชีต แหล่งข้อมูลที่แสดงผลจะมีโครงสร้างและข้อมูลเมตาของสเปรดชีต ซึ่งรวมถึงพร็อพเพอร์ตี้ของสเปรดชีต (เช่น ชื่อ ภาษา และเขตเวลา) และข้อมูลชีตโดยละเอียดบางอย่าง (เช่น การจัดรูปแบบและช่วงที่ป้องกัน)

หากต้องการรวมข้อมูลภายในแหล่งข้อมูล spreadsheets ให้ใช้ 2 วิธีต่อไปนี้

  • ระบุมาสก์ของฟิลด์ที่แสดงรายการ ฟิลด์ที่เลือกโดยตั้งค่าfields พารามิเตอร์ ระบบ

  • ตั้งค่าพารามิเตอร์การค้นหาบูลีน includeGridData เป็น true หากตั้งค่ามาสก์ของฟิลด์ไว้ ระบบจะละเว้นพารามิเตอร์ includeGridData

เมื่อทำงานกับสเปรดชีตขนาดใหญ่ เราขอแนะนำให้คุณค้นหาเฉพาะฟิลด์สเปรดชีตที่ต้องการ เมธอด get จะแสดงผลข้อมูลทั้งหมดที่เชื่อมโยงกับสเปรดชีต ดังนั้นการค้นหาสเปรดชีตขนาดใหญ่โดยทั่วไปอาจใช้เวลานาน ตัวอย่างเช่น หากต้องการอ่านตัวเลข 100 จากเซลล์ spreadsheets.get จะแสดงผลค่าเซลล์พร้อมข้อมูลเมตา (เช่น ชื่อแบบอักษร ขนาด ฯลฯ) ซึ่งส่งผลให้เพย์โหลด JSON มีขนาดใหญ่และแยกวิเคราะห์ได้ช้า ในทางตรงกันข้าม การเรียก values.get ที่คล้ายกันจะแสดงผลเฉพาะค่าเซลล์ที่เฉพาะเจาะจง ซึ่งส่งผลให้การตอบกลับมีขนาดเล็กลงและเร็วขึ้นมาก

ดูข้อมูลเพิ่มเติมเกี่ยวกับแหล่งข้อมูล spreadsheets.values ซึ่งรวมถึง spreadsheets.values.get และ spreadsheets.values.batchGet ได้ในเอกสารต่อไปนี้

แสดงรายการสเปรดชีต

Sheets API ไม่มีเมธอดสำหรับแสดงรายการสเปรดชีตสำหรับผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์

หากต้องการดึงข้อมูลรายการสเปรดชีต คุณสามารถใช้เมธอด list ของ Drive API ในแหล่งข้อมูล files โดยระบุ application/vnd.google-apps.spreadsheet เป็น mimeType ดังนี้

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 ที่จำกัด

ขั้นตอนถัดไปที่คุณอาจลองทำมีดังนี้