กําหนดค่า OAuth

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

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

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

  • ขอบเขตที่เพิ่มลงในหน้าจอความยินยอมของ OAuth จะใช้สำหรับการยืนยัน OAuth
  • ขอบเขตที่เพิ่มลงใน Google Workspace Marketplace SDK จะใช้สำหรับการติดตั้งทั่วทั้งโดเมนและการติดตั้งแต่ละรายการเพื่อให้สิทธิ์แอปของคุณเมื่อติดตั้งจาก 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 สำหรับ API ของ Google
    • ตรวจสอบขอบเขตที่ระบุไว้ในแต่ละส่วนทั้ง 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 รวมถึงฟังก์ชันและความสามารถในการใช้งานของแอป ดูข้อมูลเพิ่มเติมเกี่ยวกับเกณฑ์ การตรวจสอบแอปได้ที่ เกี่ยวกับการตรวจสอบแอป