กําหนดค่า OAuth

เมื่อเผยแพร่แอป คุณต้องทำ 4 งานหลักเพื่อการตรวจสอบสิทธิ์และการให้สิทธิ์

  1. กรอกข้อมูลในหน้าจอขอความยินยอม OAuth
  2. สร้างข้อมูลเข้าสู่ระบบ OAuth 2.0
  3. กำหนดค่าขอบเขตทั้งหมดที่แอปต้องใช้ในการทำงานใน SDK ของ Google Workspace Marketplace
  4. ส่งแอปเพื่อขอรับการยืนยัน OAuth

ขอบเขตที่คุณเพิ่มในแต่ละสถานที่ต้องตรงกันและจะใช้ในลักษณะต่อไปนี้

  • ขอบเขตที่เพิ่มลงในหน้าจอขอความยินยอม OAuth จะใช้สำหรับการยืนยัน OAuth
  • ขอบเขตที่เพิ่มลงใน SDK ของ Google Workspace Marketplace จะใช้สําหรับการติดตั้งทั่วทั้งโดเมนและการติดตั้งทีละรายการเพื่อให้สิทธิ์แอปเมื่อติดตั้งจาก Google Workspace Marketplace
  • ขอบเขตที่เพิ่มลงในไฟล์ Manifest เป็นสิ่งจําเป็นเพื่อให้แอปทํางานได้อย่างถูกต้อง

ตัวอย่างเช่น หากคุณเผยแพร่แอปที่มีส่วนเสริม Google ชีตและส่วนเสริม Google เอกสาร ไฟล์ Manifest ของ Apps Script ของส่วนเสริมแต่ละรายการจะมีเฉพาะขอบเขตที่เจาะจงสำหรับส่วนเสริมนั้นๆ ในโปรเจ็กต์ Google Cloud หน้าจอขอความยินยอม OAuth และ SDK ของ Google Workspace Marketplace จะมีขอบเขตสำหรับทั้ง 2 ส่วนเสริม

ข้อกำหนดเบื้องต้น

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

  1. ในคอนโซล Google Cloud ให้ไปที่เมนู > API และบริการ > หน้าจอขอความยินยอม OAuth

    ไปที่หน้าจอขอความยินยอม OAuth

  2. เลือกประเภทผู้ใช้สำหรับแอป แล้วคลิกสร้าง
  3. กรอกแบบฟอร์มการลงทะเบียนแอปให้สมบูรณ์ แล้วคลิกบันทึกและดำเนินการต่อ

  4. หากคุณกำลังสร้างแอปเพื่อใช้งานนอกองค์กร Google Workspace ให้คลิกเพิ่มหรือนำขอบเขตออก เราขอแนะนําแนวทางปฏิบัติแนะนำต่อไปนี้เมื่อเลือกขอบเขต

    • เลือกขอบเขตที่ให้สิทธิ์เข้าถึงระดับต่ำสุดที่แอปของคุณจําเป็นต้องใช้ ดูรายการขอบเขตที่ใช้ได้ได้ที่ขอบเขต OAuth 2.0 สําหรับ Google API
    • ตรวจสอบขอบเขตที่แสดงในแต่ละส่วน 3 ส่วน ได้แก่ ขอบเขตที่ไม่มีความละเอียดอ่อน ขอบเขตที่มีความละเอียดอ่อน และขอบเขตที่จํากัด สำหรับขอบเขตที่แสดงอยู่ในส่วน "ขอบเขตที่มีความละเอียดอ่อน" หรือ "ขอบเขตที่ถูกจํากัด" ให้ลองระบุขอบเขตอื่นที่ไม่มีความละเอียดอ่อนเพื่อหลีกเลี่ยงการตรวจสอบเพิ่มเติมที่ไม่จําเป็น
    • ขอบเขตบางอย่างต้องได้รับการตรวจสอบเพิ่มเติมจาก Google สําหรับแอปที่องค์กร Google Workspace ใช้ภายในเท่านั้น ขอบเขตจะไม่แสดงในหน้าจอขอความยินยอม และการใช้ขอบเขตที่จํากัดหรือมีความละเอียดอ่อนไม่จําเป็นต้องได้รับการตรวจสอบเพิ่มเติมจาก Google ดูข้อมูลเพิ่มเติมได้ที่หมวดหมู่ขอบเขต
  5. หลังจากเลือกขอบเขตที่จําเป็นสําหรับแอปแล้ว ให้คลิกบันทึกและดําเนินการต่อ
  6. หากคุณเลือกภายนอกสำหรับประเภทผู้ใช้ ให้เพิ่มผู้ใช้ทดสอบโดยทำดังนี้
    1. ในส่วนผู้ใช้ทดสอบ ให้คลิกเพิ่มผู้ใช้
    2. ป้อนอีเมลของคุณและผู้ใช้ทดสอบที่ได้รับอนุญาตคนอื่นๆ แล้วคลิกบันทึกและต่อไป
  7. ตรวจสอบข้อมูลสรุปการลงทะเบียนแอป หากต้องการเปลี่ยนแปลง ให้คลิกแก้ไข หากการลงทะเบียนแอปดูเรียบร้อยดี ให้คลิกกลับไปที่แดชบอร์ด

2. สร้างข้อมูลเข้าสู่ระบบ OAuth 2.0

การสร้างข้อมูลเข้าสู่ระบบ OAuth 2.0 ทำได้ 2 วิธี โดยขึ้นอยู่กับวิธีที่คุณสร้างแอป

หากคุณสร้างแอปใน Apps Script

เปลี่ยนโปรเจ็กต์ Apps Script จากโปรเจ็กต์ Google Cloud เริ่มต้นเป็นโปรเจ็กต์มาตรฐานใหม่ ดูหัวข้อการเปลี่ยนไปใช้โปรเจ็กต์มาตรฐานอื่น

หลังจากเชื่อมโยงโปรเจ็กต์ Apps Script กับโปรเจ็กต์ Google Cloud แล้ว ระบบจะสร้างข้อมูลเข้าสู่ระบบ OAuth 2.0 โดยอัตโนมัติ

หากคุณไม่ได้ใช้ Apps Script เพื่อสร้างแอป

หากต้องการสร้างข้อมูลเข้าสู่ระบบ OAuth 2.0 โปรดดูหัวข้อข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth

3. กำหนดขอบเขต

ระบุรายการขอบเขต OAuth ที่ครบถ้วนซึ่งแอปของคุณต้องใช้ ใช้ขอบเขตที่แคบที่สุดเสมอ

หากต้องการกำหนดระดับการเข้าถึงที่อนุญาตแก่แอป คุณต้องระบุและประกาศขอบเขตการให้สิทธิ์ ขอบเขตการให้สิทธิ์คือสตริง URI ของ OAuth 2.0 ซึ่งมีชื่อแอป Google Workspace, ประเภทข้อมูลที่แอปเข้าถึง และระดับการเข้าถึง ขอบเขตคือคําขอของแอปในการจัดการข้อมูล Google Workspace ซึ่งรวมถึงข้อมูลบัญชี Google ของผู้ใช้

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

4. ส่งเพื่อรับการยืนยัน OAuth (แอปสาธารณะเท่านั้น)

หากแอปสาธารณะใช้ขอบเขตที่มีความละเอียดอ่อนหรือจำกัด แอปจะต้องผ่านกระบวนการตรวจสอบการยืนยัน OAuth

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

หากต้องการส่งข้อมูลเพื่อรับการยืนยัน ให้ทำตามขั้นตอนต่อไปนี้

  1. ในคอนโซล Google Cloud ให้ไปที่เมนู > API และบริการ > หน้าจอขอความยินยอม OAuth

    ไปที่หน้าจอขอความยินยอม OAuth

  2. คลิกเครื่องมือเลือกโปรเจ็กต์ แล้วเลือกโปรเจ็กต์
  3. คลิกแก้ไขแอป
  4. ป้อนข้อมูลที่จําเป็น แล้วคลิกส่งเพื่อยืนยัน
  5. ในกล่องโต้ตอบต้องทำการยืนยัน ให้ป้อนเหตุผลที่เหมาะสม แล้วคลิกส่งเพื่อเริ่มกระบวนการยืนยัน

หากคุณอัปเดตแอปให้ใช้ขอบเขตอื่นที่ละเอียดอ่อนหรือจํากัด คุณต้องส่งแอปเพื่อรับการยืนยัน OAuth อีกครั้ง คุณไม่จำเป็นต้องส่งแอปเข้ารับการตรวจสอบอีกครั้ง

ความแตกต่างระหว่างการยืนยัน OAuth กับการตรวจสอบแอป

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

การตรวจสอบแอปจะมุ่งเน้นที่ข้อมูลที่คุณให้ไว้ใน Google Workspace Marketplace API รวมถึงฟังก์ชันการทำงานและความสามารถในการใช้งานของแอป ดูข้อมูลเพิ่มเติมเกี่ยวกับเกณฑ์การตรวจสอบแอปได้ที่หัวข้อเกี่ยวกับการตรวจสอบแอป