Class ScriptApp

ScriptApp

เข้าถึงและจัดการการเผยแพร่และการทริกเกอร์สคริปต์ คลาสนี้ช่วยให้ผู้ใช้สร้างทริกเกอร์สคริปต์ และควบคุมการเผยแพร่สคริปต์เป็นบริการได้

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

พร็อพเพอร์ตี้ประเภทคำอธิบาย
AuthModeAuthModeการแจงนับที่ระบุหมวดหมู่ของบริการที่ได้รับอนุญาตซึ่ง Apps Script สามารถ เรียกใช้ผ่านฟังก์ชันที่ทริกเกอร์
AuthorizationStatusAuthorizationStatusการแจงนับที่ระบุสถานะการให้สิทธิ์ของสคริปต์
EventTypeEventTypeการแจงนับที่ระบุประเภทของเหตุการณ์ที่ทริกเกอร์
InstallationSourceInstallationSourceการแจงนับที่ระบุวิธีการติดตั้งสคริปต์ให้กับผู้ใช้เป็นส่วนเสริม
TriggerSourceTriggerSourceการแจงนับที่ระบุแหล่งที่มาของเหตุการณ์ที่ทําให้ทริกเกอร์ทํางาน
WeekDayWeekdayการแจงนับที่แสดงวันในสัปดาห์

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
deleteTrigger(trigger)voidนำทริกเกอร์ที่ระบุออกเพื่อไม่ให้ทำงานอีกต่อไป
getAuthorizationInfo(authMode)AuthorizationInfoรับออบเจ็กต์ที่ตรวจสอบว่าผู้ใช้ได้ให้สิทธิ์สำหรับข้อกำหนดของสคริปต์ทั้งหมดหรือไม่
getAuthorizationInfo(authMode, oAuthScopes)AuthorizationInfoรับออบเจ็กต์ที่ตรวจสอบว่าผู้ใช้ได้ให้สิทธิ์สำหรับขอบเขตที่ขอหรือไม่
getIdentityToken()Stringรับโทเค็นข้อมูลประจำตัว OpenID Connect สำหรับ ผู้ใช้ที่มีประสิทธิภาพ หากได้รับขอบเขต openid
getInstallationSource()InstallationSourceแสดงค่า Enum ที่ระบุวิธีติดตั้งสคริปต์เป็นส่วนเสริมสำหรับ ผู้ใช้ปัจจุบัน (เช่น ผู้ใช้ติดตั้งด้วยตนเองผ่าน Chrome เว็บสโตร์ หรือผู้ดูแลระบบโดเมนติดตั้งให้ผู้ใช้ทั้งหมด)
getOAuthToken()Stringรับโทเค็น การเข้าถึง OAuth 2.0 สำหรับผู้ใช้ที่มีผล
getProjectTriggers()Trigger[]รับทริกเกอร์ที่ติดตั้งได้ทั้งหมดที่เชื่อมโยงกับโปรเจ็กต์ปัจจุบันและผู้ใช้ปัจจุบัน
getScriptId()Stringรับรหัสที่ไม่ซ้ำกันของโปรเจ็กต์สคริปต์
getService()Serviceรับออบเจ็กต์ที่ใช้ควบคุมการเผยแพร่สคริปต์เป็นเว็บแอป
getUserTriggers(document)Trigger[]รับทริกเกอร์ที่ติดตั้งได้ทั้งหมดซึ่งผู้ใช้เป็นเจ้าของในเอกสารที่ระบุ สำหรับสคริปต์หรือส่วนเสริมนี้เท่านั้น
getUserTriggers(form)Trigger[]รับทริกเกอร์ที่ติดตั้งได้ทั้งหมดซึ่งผู้ใช้เป็นเจ้าของในแบบฟอร์มที่ระบุ สำหรับสคริปต์หรือส่วนเสริมนี้เท่านั้น
getUserTriggers(spreadsheet)Trigger[]รับทริกเกอร์ที่ติดตั้งได้ทั้งหมดซึ่งผู้ใช้เป็นเจ้าของในสเปรดชีตที่ระบุ สำหรับสคริปต์หรือส่วนเสริมนี้เท่านั้น
invalidateAuth()voidยกเลิกการให้สิทธิ์ที่ผู้ใช้ที่มีผลบังคับใช้มีในการเรียกใช้สคริปต์ปัจจุบัน
newStateToken()StateTokenBuilderสร้างเครื่องมือสร้างโทเค็นสถานะที่ใช้ใน API เรียกกลับได้ (เช่น โฟลว์ OAuth)
newTrigger(functionName)TriggerBuilderเริ่มกระบวนการสร้างทริกเกอร์ที่ติดตั้งได้ ซึ่งจะเรียกใช้ฟังก์ชันที่ระบุเมื่อทริกเกอร์ทำงาน
requireAllScopes(authMode)voidตรวจสอบว่าผู้ใช้ได้ให้ความยินยอมสำหรับขอบเขตทั้งหมดที่สคริปต์ร้องขอหรือไม่
requireScopes(authMode, oAuthScopes)voidตรวจสอบว่าผู้ใช้ให้ความยินยอมสำหรับขอบเขตที่ขอหรือไม่

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

deleteTrigger(trigger)

นำทริกเกอร์ที่ระบุออกเพื่อไม่ให้ทำงานอีกต่อไป 

// Deletes all triggers in the current project.
const triggers = ScriptApp.getProjectTriggers();
for (let i = 0; i < triggers.length; i++) {
  ScriptApp.deleteTrigger(triggers[i]);
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
triggerTriggerทริกเกอร์ที่จะลบ

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

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

  • https://www.googleapis.com/auth/script.scriptapp

getAuthorizationInfo(authMode)

รับออบเจ็กต์ที่ตรวจสอบว่าผู้ใช้ได้ให้สิทธิ์สำหรับข้อกำหนดของสคริปต์ทั้งหมดหรือไม่ ออบเจ็กต์ยังมี URL การให้สิทธิ์สำหรับผู้ใช้ในการให้สิทธิ์เหล่านั้นด้วย ในกรณีที่ข้อกำหนดของสคริปต์ไม่ได้รับอนุญาต

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

const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
const status = authInfo.getAuthorizationStatus();
const url = authInfo.getAuthorizationUrl();

พารามิเตอร์

ชื่อประเภทคำอธิบาย
authModeAuthModeโหมดการให้สิทธิ์ที่ขอข้อมูลการให้สิทธิ์ ในเกือบทุกกรณี ค่าสำหรับ authMode ควรเป็น ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL) เนื่องจากไม่มีโหมดการให้สิทธิ์อื่นที่กำหนดให้ผู้ใช้ต้องให้สิทธิ์

รีเทิร์น

AuthorizationInfo - ออบเจ็กต์ที่ให้ข้อมูลเกี่ยวกับสถานะการให้สิทธิ์ของผู้ใช้ได้

getAuthorizationInfo(authMode, oAuthScopes)

รับออบเจ็กต์ที่ตรวจสอบว่าผู้ใช้ได้ให้สิทธิ์สำหรับขอบเขตที่ขอหรือไม่ ออบเจ็กต์ ยังมี URL การให้สิทธิ์สำหรับผู้ใช้ในการให้สิทธิ์เหล่านั้นด้วย ในกรณีที่ขอบเขตที่ขอ ไม่ได้รับอนุญาต

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

const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL, [
  'https://www.googleapis.com/auth/documents',
  'https://www.googleapis.com/auth/presentations',
]);
const status = authInfo.getAuthorizationStatus();
const url = authInfo.getAuthorizationUrl();

พารามิเตอร์

ชื่อประเภทคำอธิบาย
authModeAuthModeโหมดการให้สิทธิ์ที่ขอข้อมูลการให้สิทธิ์ ในเกือบทุกกรณี ค่าสำหรับ authMode ควรเป็น ScriptApp.AuthMode.FULL เนื่องจากไม่มีโหมดการให้สิทธิ์อื่นใดที่กำหนดให้ผู้ใช้ต้องให้สิทธิ์
oAuthScopesString[]ขอบเขต OAuth ที่มีการขอข้อมูลการให้สิทธิ์

รีเทิร์น

AuthorizationInfo — ออบเจ็กต์ที่ให้ข้อมูลเกี่ยวกับสถานะการให้สิทธิ์ของผู้ใช้และ URL การให้สิทธิ์ในกรณีที่ไม่มีความยินยอมบางอย่าง

getIdentityToken()

รับโทเค็นข้อมูลประจำตัว OpenID Connect สำหรับ ผู้ใช้ที่มีประสิทธิภาพ หากได้รับขอบเขต openid โดยค่าเริ่มต้นแล้ว ขอบเขตนี้จะไม่รวมอยู่ด้วย และคุณต้องเพิ่มเป็นขอบเขตที่ชัดเจนในไฟล์ Manifest เพื่อขอ รวมขอบเขต https://www.googleapis.com/auth/userinfo.email หรือ https://www.googleapis.com/auth/userinfo.profile เพื่อแสดงข้อมูลผู้ใช้เพิ่มเติม ในโทเค็น

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

const idToken = ScriptApp.getIdentityToken();
const body = idToken.split('.')[1];
const decoded = Utilities
                    .newBlob(
                        Utilities.base64Decode(body),
                        )
                    .getDataAsString();
const payload = JSON.parse(decoded);

Logger.log(`Profile ID: ${payload.sub}`);
 ดูรายการฟิลด์ (การอ้างสิทธิ์) ทั้งหมดที่ระบบส่งคืนได้ในเอกสารประกอบของ OpenID Connect

รีเทิร์น

String - โทเค็นข้อมูลประจำตัว (หากมี) หรือ null

getInstallationSource()

แสดงค่า Enum ที่ระบุวิธีติดตั้งสคริปต์เป็นส่วนเสริมสำหรับ ผู้ใช้ปัจจุบัน (เช่น ผู้ใช้ติดตั้งด้วยตนเองผ่าน Chrome เว็บสโตร์ หรือผู้ดูแลระบบโดเมนติดตั้งให้ผู้ใช้ทั้งหมด)

รีเทิร์น

InstallationSource — แหล่งที่มาของการติดตั้ง

getOAuthToken()

รับโทเค็น การเข้าถึง OAuth 2.0 สำหรับผู้ใช้ที่มีผล หากขอบเขต OAuth ของสคริปต์เพียงพอที่จะให้สิทธิ์ Google API อื่นที่ปกติแล้วต้องมีโฟลว์ OAuth ของตัวเอง (เช่น Google Picker) สคริปต์จะข้ามข้อความแจ้งการให้สิทธิ์ครั้งที่ 2 ได้โดยส่งโทเค็นนี้แทน โทเค็นจะหมดอายุหลังจากผ่านไประยะหนึ่ง (อย่างน้อย 2-3 นาที) สคริปต์ควรจัดการความล้มเหลวในการให้สิทธิ์และเรียกใช้เมธอดนี้เพื่อรับโทเค็นใหม่เมื่อจำเป็น

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

รีเทิร์น

String — การแสดงโทเค็น OAuth 2.0 เป็นสตริง

getProjectTriggers()

รับทริกเกอร์ที่ติดตั้งได้ทั้งหมดที่เชื่อมโยงกับโปรเจ็กต์ปัจจุบันและผู้ใช้ปัจจุบัน 

Logger.log(
    `Current project has ${ScriptApp.getProjectTriggers().length} triggers.`,
);

รีเทิร์น

Trigger[] — อาร์เรย์ของทริกเกอร์ของผู้ใช้ปัจจุบันที่เชื่อมโยงกับโปรเจ็กต์นี้

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

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

  • https://www.googleapis.com/auth/script.scriptapp

getScriptId()

รับรหัสที่ไม่ซ้ำกันของโปรเจ็กต์สคริปต์ นี่เป็นวิธีที่แนะนำในการรับตัวระบุที่ไม่ซ้ำกัน สำหรับโปรเจ็กต์สคริปต์แทนgetProjectKey() คุณใช้รหัสนี้ได้ทุกที่ ที่เคยระบุคีย์โปรเจ็กต์ไว้

รีเทิร์น

String — รหัสของโปรเจ็กต์สคริปต์

getService()

รับออบเจ็กต์ที่ใช้ควบคุมการเผยแพร่สคริปต์เป็นเว็บแอป 

// Get the URL of the published web app.
const url = ScriptApp.getService().getUrl();

รีเทิร์น

Service - ออบเจ็กต์ที่ใช้เพื่อสังเกตและควบคุมการเผยแพร่สคริปต์เป็นเว็บแอป

getUserTriggers(document)

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

const doc = DocumentApp.getActiveDocument();
const triggers = ScriptApp.getUserTriggers(doc);
// Log the handler function for the first trigger in the array.
Logger.log(triggers[0].getHandlerFunction());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
documentDocumentไฟล์ Google เอกสารที่อาจมีทริกเกอร์ที่ติดตั้งได้

รีเทิร์น

Trigger[] — อาร์เรย์ของทริกเกอร์ที่ผู้ใช้เป็นเจ้าของในเอกสารที่ระบุ

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

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

  • https://www.googleapis.com/auth/script.scriptapp

getUserTriggers(form)

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

const form = FormApp.getActiveForm();
const triggers = ScriptApp.getUserTriggers(form);
// Log the trigger source for the first trigger in the array.
Logger.log(triggers[0].getTriggerSource());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
formFormไฟล์ Google ฟอร์มที่อาจมีทริกเกอร์ที่ติดตั้งได้

รีเทิร์น

Trigger[] - อาร์เรย์ของทริกเกอร์ที่ผู้ใช้เป็นเจ้าของในแบบฟอร์มที่ระบุ

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

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

  • https://www.googleapis.com/auth/script.scriptapp

getUserTriggers(spreadsheet)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const triggers = ScriptApp.getUserTriggers(ss);
// Log the event type for the first trigger in the array.
Logger.log(triggers[0].getEventType());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
spreadsheetSpreadsheetไฟล์ Google ชีตที่อาจมีทริกเกอร์ที่ติดตั้งได้

รีเทิร์น

Trigger[] — อาร์เรย์ของทริกเกอร์ที่ผู้ใช้เป็นเจ้าของในสเปรดชีตที่ระบุ

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

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

  • https://www.googleapis.com/auth/script.scriptapp

invalidateAuth()

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

ScriptApp.invalidateAuth();

การขว้าง

Error — เมื่อการทำให้ไม่มีผลไม่สำเร็จ

newStateToken()

สร้างเครื่องมือสร้างโทเค็นสถานะที่ใช้ใน API เรียกกลับได้ (เช่น โฟลว์ OAuth) 

// Generate a callback URL, given the name of a callback function. The script
// does not need to be published as a web app; the /usercallback URL suffix
// replaces /edit in any script's URL.
function getCallbackURL(callbackFunction) {
  // IMPORTANT: Replace string below with the URL from your script, minus the
  // /edit at the end.
  const scriptUrl =
      'https://script.google.com/macros/d/1234567890abcdefghijklmonpqrstuvwxyz';
  const urlSuffix = '/usercallback?state=';
  const stateToken = ScriptApp.newStateToken()
                         .withMethod(callbackFunction)
                         .withTimeout(120)
                         .createToken();
  return scriptUrl + urlSuffix + stateToken;
}

ในโฟลว์ OAuth2 ส่วนใหญ่ ระบบจะส่งโทเค็น state ไปยังปลายทางการให้สิทธิ์ โดยตรง (ไม่ใช่เป็นส่วนหนึ่งของ URL ติดต่อกลับ) จากนั้นปลายทางการให้สิทธิ์จะส่งโทเค็นดังกล่าวเป็น ส่วนหนึ่งของ URL ติดต่อกลับ

เช่น

  • สคริปต์จะเปลี่ยนเส้นทางผู้ใช้ไปยัง URL การให้สิทธิ์ OAuth2: https://accounts.google.com/o/oauth2/auth?state=token_generated_with_this_method&callback_uri=https://script.google.com/macros/d/1234567890abcdefghijklmonpqrstuvwxyz/usercallback&other_oauth2_parameters
  • ผู้ใช้คลิกให้สิทธิ์ และหน้าการให้สิทธิ์ OAuth2 จะเปลี่ยนเส้นทางผู้ใช้กลับไปที่ https://script.google.com/macros/d/1234567890abcdefghijklmonpqrstuvwxyz/usercallback?state=token_generated_with_this_method&other_params_that_include_tokens_or_grants
  • การเปลี่ยนเส้นทางข้างต้น (กลับไปที่ http://script.google.com/...) ทำให้คำขอของเบราว์เซอร์ ไปที่ /usercallback ซึ่งเรียกใช้เมธอดที่ระบุโดย StateTokenBuilder.withMethod(method)

รีเทิร์น

StateTokenBuilder — ออบเจ็กต์ที่ใช้เพื่อดำเนินการสร้างโทเค็นสถานะต่อ

newTrigger(functionName)

เริ่มกระบวนการสร้างทริกเกอร์ที่ติดตั้งได้ ซึ่งจะเรียกใช้ฟังก์ชันที่ระบุเมื่อทริกเกอร์ทำงาน 

// Creates an edit trigger for a spreadsheet identified by ID.
ScriptApp.newTrigger('myFunction')
    .forSpreadsheet('1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3')
    .onEdit()
    .create();

ก่อนสร้างทริกเกอร์ ให้ตรวจสอบว่าฟังก์ชันที่เชื่อมโยงมีสิทธิ์ OAuth ที่จำเป็นทั้งหมด

พารามิเตอร์

ชื่อประเภทคำอธิบาย
functionNameStringฟังก์ชันที่จะเรียกใช้เมื่อทริกเกอร์เริ่มทำงาน คุณใช้ฟังก์ชันจากไลบรารีที่รวมไว้ได้ เช่น Library.libFunction1

รีเทิร์น

TriggerBuilder — ออบเจ็กต์ที่ใช้เพื่อดำเนินการสร้างทริกเกอร์ต่อ

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

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

  • https://www.googleapis.com/auth/script.scriptapp

requireAllScopes(authMode)

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

วิธีนี้จะใช้ได้เฉพาะเมื่อผู้ใช้เรียกใช้สคริปต์จากแพลตฟอร์มที่รองรับความยินยอมแบบละเอียด เช่น จากภายใน IDE ของ Apps Script เมื่อเรียกใช้สคริปต์โดยไม่มีความยินยอมจากแพลตฟอร์มที่ไม่รองรับ เช่น ส่วนเสริมของ Google Workspace สคริปต์จะแสดงข้อความแจ้งการให้สิทธิ์ที่จุดเริ่มต้นของการดำเนินการเพื่อขอขอบเขตทั้งหมด 

ScriptApp.requireAllScopes(ScriptApp.AuthMode.FULL);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
authModeAuthModeโหมดการให้สิทธิ์ที่ต้องประเมินขอบเขตของสคริปต์ ในเกือบทุกกรณี ค่าสำหรับ authMode ควรเป็น ScriptApp.AuthMode.FULL เนื่องจากไม่มีโหมดการให้สิทธิ์อื่นใดที่กำหนดให้ผู้ใช้ให้สิทธิ์

requireScopes(authMode, oAuthScopes)

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

วิธีนี้จะใช้ได้เฉพาะเมื่อผู้ใช้เรียกใช้สคริปต์จากแพลตฟอร์มที่รองรับความยินยอมแบบละเอียด เช่น จากภายใน IDE ของ Apps Script เมื่อเรียกใช้สคริปต์โดยไม่มีความยินยอมจากแพลตฟอร์มที่ไม่รองรับ เช่น ส่วนเสริมของ Google Workspace สคริปต์จะแสดงข้อความแจ้งการให้สิทธิ์ที่จุดเริ่มต้นของการดำเนินการเพื่อขอขอบเขตทั้งหมด 

ScriptApp.requireScopes(ScriptApp.AuthMode.FULL, [
  'https://www.googleapis.com/auth/documents',
  'https://www.googleapis.com/auth/presentations',
]);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
authModeAuthModeโหมดการให้สิทธิ์ที่ต้องประเมินขอบเขตที่ขอ ในเกือบทุกกรณี ค่าสำหรับ authMode ควรเป็น ScriptApp.AuthMode.FULL เนื่องจากไม่มีโหมดการให้สิทธิ์อื่นใดที่กำหนดให้ผู้ใช้ให้สิทธิ์
oAuthScopesString[]ขอบเขต OAuth ที่จำเป็นต่อการดำเนินการตามโฟลว์การดำเนินการที่ระบุให้เสร็จสมบูรณ์

วิธีการที่เลิกใช้งานแล้ว