Class DocumentApp

DocumentApp

บริการเอกสารจะสร้างและเปิด Documents ที่สามารถแก้ไขได้

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

// Create and open a document.
doc = DocumentApp.create('Document Name');

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้Typeคำอธิบาย
AttributeAttributeการแจกแจง Attribute
ElementTypeElementTypeการแจกแจง ElementType
FontFamilyFontFamilyการแจกแจง FontFamily
GlyphTypeGlyphTypeการแจกแจง GlyphType
HorizontalAlignmentHorizontalAlignmentการแจกแจง HorizontalAlignment
ParagraphHeadingParagraphHeadingการแจกแจง ParagraphHeading
PositionedLayoutPositionedLayoutการแจกแจง PositionedLayout
TextAlignmentTextAlignmentการแจกแจง TextAlignment
VerticalAlignmentVerticalAlignmentการแจกแจง VerticalAlignment

วิธีการ

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
create(name)Documentสร้างและแสดงผลเอกสารใหม่
getActiveDocument()Documentแสดงผลเอกสารที่สคริปต์เชื่อมโยงกับคอนเทนเนอร์
getUi()Uiแสดงผลอินสแตนซ์ของสภาพแวดล้อมอินเทอร์เฟซผู้ใช้ของเอกสาร ซึ่งช่วยให้สคริปต์สามารถเพิ่มฟีเจอร์ต่างๆ เช่น เมนู กล่องโต้ตอบ และแถบด้านข้าง
openById(id)Documentแสดงเอกสารที่มีรหัสตามที่ระบุ
openByUrl(url)Documentเปิดและส่งเอกสารที่มี URL ที่ระบุกลับมา

เอกสารประกอบโดยละเอียด

create(name)

สร้างและแสดงผลเอกสารใหม่

// Create and open a new document.
var doc = DocumentApp.create('Document Name');

พารามิเตอร์

ชื่อTypeคำอธิบาย
nameStringชื่อเอกสารใหม่

รีเทิร์น

Document — อินสแตนซ์เอกสารใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/documents

getActiveDocument()

แสดงผลเอกสารที่สคริปต์เชื่อมโยงกับคอนเทนเนอร์ หากต้องการโต้ตอบกับเอกสารที่สคริปต์ไม่ได้ผูกกับคอนเทนเนอร์ ให้ใช้ openById(id) หรือ openByUrl(url) แทน

// Get the document to which this script is bound.
var doc = DocumentApp.getActiveDocument();

รีเทิร์น

Document — อินสแตนซ์ของเอกสาร

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getUi()

แสดงผลอินสแตนซ์ของสภาพแวดล้อมอินเทอร์เฟซผู้ใช้ของเอกสาร ซึ่งช่วยให้สคริปต์สามารถเพิ่มฟีเจอร์ต่างๆ เช่น เมนู กล่องโต้ตอบ และแถบด้านข้าง สคริปต์จะโต้ตอบกับ UI สำหรับอินสแตนซ์ปัจจุบันของเอกสารที่เปิดอยู่เท่านั้น และเฉพาะในกรณีที่สคริปต์มีการเชื่อมโยงกับเอกสาร ดูข้อมูลเพิ่มเติมได้ที่คำแนะนำเกี่ยวกับเมนู รวมถึงกล่องโต้ตอบและแถบด้านข้าง

// Add a custom menu to the active document, including a separator and a sub-menu.
function onOpen(e) {
  DocumentApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(DocumentApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

รีเทิร์น

Ui — อินสแตนซ์ของสภาพแวดล้อมอินเทอร์เฟซผู้ใช้ของเอกสารนี้


openById(id)

แสดงเอกสารที่มีรหัสตามที่ระบุ หากสคริปต์เชื่อมโยงกับเอกสาร ให้ใช้ getActiveDocument() แทน

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

พารามิเตอร์

ชื่อTypeคำอธิบาย
idStringรหัสของเอกสารที่จะเปิด

รีเทิร์น

Document — อินสแตนซ์ของเอกสาร

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/documents

openByUrl(url)

เปิดและส่งเอกสารที่มี URL ที่ระบุกลับมา หากสคริปต์เชื่อมโยงกับเอกสารอยู่แล้ว ให้ใช้ getActiveDocument() แทน

// Open a document by URL.
var doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit');

พารามิเตอร์

ชื่อTypeคำอธิบาย
urlStringURL ของเอกสารที่จะเปิด

รีเทิร์น

Document — อินสแตนซ์ของเอกสาร

การให้สิทธิ์

สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • https://www.googleapis.com/auth/documents