ภาพรวมของ Admin Settings API

Admin Settings API ช่วยให้ผู้ดูแลระบบของโดเมน Google Workspace เรียกและเปลี่ยนการตั้งค่าโดเมนของตนเองในรูปแบบฟีด Google Data API ได้

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

Admin Settings API ใช้โปรโตคอล Google Data API Google Data API สอดคล้องกับโมเดลการเผยแพร่และแก้ไข Atom Publishing Protocol (AtomPub) คำขอ HTTP ของ AtomPub ใช้แนวทางการออกแบบ Redirectational Set Transfer (RESTful) สำหรับบริการเว็บ โปรดดูข้อมูลเพิ่มเติมในคู่มือข้อมูล Google สำหรับนักพัฒนาซอฟต์แวร์

ผู้ชม

เอกสารนี้มีไว้สำหรับนักพัฒนาซอฟต์แวร์ที่ต้องการเขียนแอปพลิเคชันไคลเอ็นต์ที่สามารถแก้ไขและเรียกดูข้อมูลเกี่ยวกับโดเมน Google Workspace ได้ โดยจะแสดงตัวอย่างของการโต้ตอบพื้นฐานของ Admin Settings API ที่ใช้ไฟล์ RAW XML และ HTTP

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

เริ่มต้นใช้งาน

การสร้างบัญชี

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

เกี่ยวกับประเภทฟีด API การตั้งค่าการดูแลระบบ

Admin Settings API ช่วยให้คุณจัดการหมวดหมู่ของการตั้งค่าโดเมนต่อไปนี้ได้

การตั้งค่าการลงชื่อเพียงครั้งเดียว

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

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

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

  • สร้างคีย์ -- สร้างชุดคีย์สาธารณะและคีย์ส่วนตัวด้วยผู้ให้บริการข้อมูลประจำตัวโดยใช้อัลกอริทึม DSA หรือ RSA คีย์สาธารณะอยู่ในใบรับรองที่มีการจัดรูปแบบ X.509 โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับคีย์การลงชื่อเพียงครั้งเดียวที่ใช้ SAML ที่หัวข้อการสร้างคีย์และใบรับรองสำหรับบริการลงชื่อเพียงครั้งเดียวของ Google Workspace
  • ลงทะเบียนกับ Google -- ใช้การตั้งค่าการลงชื่อเพียงครั้งเดียวของ API การตั้งค่าผู้ดูแลระบบเพื่อลงทะเบียนใบรับรองคีย์สาธารณะกับ Google
  • ตั้งค่า SSO ของคุณ -- ใช้การตั้งค่าการลงชื่อเพียงครั้งเดียวของ API การตั้งค่าผู้ดูแลระบบ เพื่อกำหนดค่าการตั้งค่าที่ใช้สื่อสารกับเซิร์ฟเวอร์ของผู้ให้บริการข้อมูลประจำตัวของโดเมน

การตั้งค่าเกตเวย์และการกำหนดเส้นทาง

ฟีดนี้ช่วยให้ผู้ดูแลระบบโดเมนควบคุมการกำหนดเส้นทางอีเมลสำหรับโดเมนได้

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

ตัวอย่างคำขอและการตอบกลับ XML สำหรับการตั้งค่าของผู้ดูแลระบบ

เอกสารนี้มีตัวอย่างโค้ดของคำขอและการตอบกลับพื้นฐานของ Admin Settings API ที่ใช้ไฟล์ RAW XML และ HTTP ตัวอย่างภาษาเริ่มต้นของโดเมนนี้แสดงไวยากรณ์ XML และ HTTP แบบเต็มสำหรับเนื้อหาของคำขอและรายการตอบกลับซึ่งเป็นรายการทั่วไปในการดำเนินงานแต่ละรายการ

หากต้องการเปลี่ยนการตั้งค่าเกตเวย์อีเมลขาออกของโดเมน ให้ส่ง HTTP PUT ไปยัง URL ของฟีดเกตเวย์ดังนี้

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

ภาษาเริ่มต้นของโดเมน PUT คำขอ AtomPub entry XML คือ:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
  xmlns:apps='http://schemas.google.com/apps/2006'>
  <apps:property name='smartHost' value='smtp.out.domain.com' />
  <apps:property name='smtpMode' value='SMTP' />
</atom:entry>

องค์ประกอบ atom:property แสดงคู่คีย์-ค่าเดียวที่มีข้อมูลเกี่ยวกับพร็อพเพอร์ตี้ที่คุณต้องการเรียกหรืออัปเดต ยกเว้นคุณสมบัติและค่าเฉพาะสำหรับการดำเนินการ การดำเนินการเหล่านี้เหมือนกันสำหรับเนื้อหาของคำขอ Admin Settings API ทั้งหมด

องค์ประกอบ entry การตอบสนองภาษาเริ่มต้นของโดเมนแสดงผลพร็อพเพอร์ตี้ smartHost และ smtpMode พร้อมไวยากรณ์ XML ทั่วไปสำหรับเนื้อหาการตอบกลับจาก Admin Settings API ทั้งหมด

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/domain/2.0/domainName/email/gateway</id>
<updated>2008-12-17T23:59:23.887Z</updated>
<link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</entry>

การจัดการการตั้งค่าการลงชื่อเพียงครั้งเดียว

ฟีเจอร์การลงชื่อเพียงครั้งเดียว (SSO) ของ Google Workspace ช่วยให้ผู้ใช้เข้าสู่ระบบบริการต่างๆ ได้โดยที่เพียงต้องป้อนข้อมูลเข้าสู่ระบบและรหัสผ่านเพียงครั้งเดียว ผู้ให้บริการข้อมูลประจำตัวของโดเมนจะเก็บรหัสผ่านนี้ ไม่ใช่ Google Workspace ดูข้อมูลเพิ่มเติมได้ที่หน้า SSO ของศูนย์ช่วยเหลือ ส่วนต่อไปนี้จะแสดงรูปแบบ XML ที่ใช้สำหรับการตั้งค่าการลงชื่อเพียงครั้งเดียว

การเรียกการตั้งค่าการลงชื่อเพียงครั้งเดียว

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

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

การดำเนินการนี้ไม่มีพารามิเตอร์ในเนื้อหาคำขอ

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 OK พร้อมกับฟีด AtomPub ที่มีการตั้งค่า SSO ของโดเมน

XML การตอบสนอง GET แสดงพร็อพเพอร์ตี้ samlSignonUri, samlLogoutUri, changePasswordUri, enableSSO, ssoWhitelist และ useDomainSpecificIssuer:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
...
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='true'/>
<apps:property name='ssoWhitelist' value='CIDR formatted IP address'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

โดยมีพร็อพเพอร์ตี้ดังนี้

samlSignonUri
URL ของผู้ให้บริการข้อมูลประจำตัวที่ Google Workspace ส่งคำขอ SAML สำหรับการตรวจสอบสิทธิ์ผู้ใช้
samlLogoutUri
ที่อยู่ที่ระบบจะส่งถึงคุณเมื่อออกจากระบบเว็บแอปพลิเคชัน
changePasswordUri
อีเมลที่ผู้ใช้จะไปถึงเมื่อต้องการเปลี่ยนรหัสผ่าน SSO สำหรับเว็บแอปพลิเคชัน
enableSSO
เปิดใช้ SSO ที่ใช้ SAML สำหรับโดเมนนี้ หากคุณเคยกําหนดการตั้งค่า SSO ไว้ก่อนหน้านี้ แล้วได้ตั้งค่า enableSSO เป็น enableSSO=false ในภายหลัง การตั้งค่าที่ป้อนไว้ก่อนหน้านี้จะยังคงได้รับการบันทึกไว้
ssoWhitelist
SSOรายการที่อนุญาต คือที่อยู่ IP ของเน็ตเวิร์กมาสก์ในรูปแบบ Classless Inter-Domain Routing (CIDR) ssoWhitelist จะกำหนดผู้ใช้ที่ลงชื่อเข้าสู่ระบบโดยใช้ SSO และผู้ใช้ที่มีสิทธิ์ลงชื่อเข้าสู่ระบบโดยใช้หน้าการตรวจสอบสิทธิ์บัญชีของ Google Workspace หากไม่ได้ระบุมาสก์ไว้ ผู้ใช้ทุกคนจะเข้าสู่ระบบโดยใช้ SSO ดูข้อมูลเพิ่มเติมได้ที่วิธีการทำงานของเน็ตเวิร์กมาสก์
useDomainSpecificIssuer
ผู้ให้บริการข้อมูลประจำตัวเฉพาะโดเมนสามารถใช้ในคำขอ SAML ที่ส่งไปยังผู้ให้บริการข้อมูลประจำตัว แม้ว่าไม่จำเป็นต้องใช้งาน SSO ส่วนใหญ่ แต่ฟีเจอร์นี้จะเป็นประโยชน์สำหรับบริษัทขนาดใหญ่ที่ใช้ผู้ให้บริการข้อมูลประจำตัวรายเดียวในการตรวจสอบสิทธิ์ทั้งองค์กรที่มีโดเมนย่อยหลายโดเมน การให้ผู้ออกใบรับรองที่เจาะจงจะเป็นตัวกำหนดโดเมนย่อยที่จะเชื่อมโยงกับคำขอ ดูข้อมูลเพิ่มเติมได้ที่องค์ประกอบผู้ออกในคำขอ SAML ทำงานอย่างไร

หากคำขอของคุณล้มเหลวด้วยเหตุผลบางอย่าง ระบบจะแสดงรหัสสถานะอื่น โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานะ Google Data API ที่รหัสสถานะ HTTP

การอัปเดตการตั้งค่าการลงชื่อเพียงครั้งเดียว

ในการอัปเดตการตั้งค่า SSO ของโดเมน ให้เรียกการตั้งค่า SSO โดยใช้การดำเนินการการเรียกการตั้งค่าการลงชื่อเพียงครั้งเดียว จากนั้นทำการแก้ไข จากนั้นส่งคำขอ PUT ไปยัง URL ของฟีด SSO ตรวจสอบว่าค่า <id> ในรายการที่อัปเดตตรงกับ <id> ของรายการที่มีอยู่ทุกประการ ใส่ส่วนหัว Authorization ตามที่อธิบายไว้ในการตรวจสอบสิทธิ์กับบริการ Admin Settings API และสำหรับข้อความแสดงข้อผิดพลาด โปรดดูหัวข้อการแก้ปัญหา SSO

เมื่ออัปเดตการตั้งค่าการลงชื่อเพียงครั้งเดียว ให้ส่ง HTTP PUT ไปยัง URL ฟีดทั่วไปของ SSO ดังนี้

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

เนื้อหา XML ของคำขอ PUT คือ

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='enableSSO' value='false' />
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon' />
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout' />
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword' />
<apps:property name='ssoWhitelist' value='127.0.0.1/32' />
<apps:property name='useDomainSpecificIssuer' value='false'/>
</atom:entry>

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 OK พร้อมกับฟีด AtomPub ที่มีการตั้งค่า SSO

XML ของการตอบกลับ PUT คือ

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='false'/>
<apps:property name='ssoWhitelist' value='127.0.0.1/32'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

หากคำขอของคุณล้มเหลวด้วยเหตุผลบางอย่าง ระบบจะแสดงรหัสสถานะอื่น โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานะ Google Data API ที่รหัสสถานะ HTTP

การเรียกคีย์การลงชื่อเพียงครั้งเดียว

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

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

การดำเนินการนี้ไม่มีพารามิเตอร์ในเนื้อหาคำขอ

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 OK พร้อมด้วยฟีด AtomPub ที่มีคีย์การลงนาม

XML การตอบกลับ GET แสดงพร็อพเพอร์ตี้ signingKey:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</entry>

หากคำขอของคุณล้มเหลวด้วยเหตุผลบางอย่าง ระบบจะแสดงรหัสสถานะอื่น โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานะ Google Data API ที่รหัสสถานะ HTTP

การอัปเดตคีย์การลงชื่อเพียงครั้งเดียว

หากต้องการอัปเดตคีย์การลงชื่อ SSO ของโดเมน ให้เรียกข้อมูลคีย์การลงชื่อโดยใช้การดำเนินการเรียกคีย์การลงชื่อเพียงครั้งเดียว แก้ไขคีย์ แล้วส่งคำขอ PUT ไปยัง URL ของฟีดคีย์การลงชื่อเพียงครั้งเดียว ตรวจสอบว่าค่า <id> ในรายการที่อัปเดตตรงกับ <id> ของรายการที่มีอยู่ทุกประการ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับคีย์การลงชื่อเพียงครั้งเดียวที่ใช้ SAML ที่หัวข้อการสร้างคีย์และใบรับรองสำหรับบริการลงชื่อเพียงครั้งเดียวของ Google Workspace

เมื่ออัปเดตคีย์การลงชื่อเพียงครั้งเดียว ให้ส่ง HTTP PUT ไปยัง URL ของฟีดคีย์การลงชื่อเพียงครั้งเดียวของ SSO

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

XML ของคำขอ PUT คือ

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</atom:entry>

การจัดการเกตเวย์อีเมลและการกำหนดเส้นทาง

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

กำลังเรียกการตั้งค่าเกตเวย์อีเมลขาออก

หากต้องการเรียกการตั้งค่าเกตเวย์อีเมลขาออก ให้ส่ง HTTP GET ไปยัง URL ฟีดของเกตเวย์ และใส่ส่วนหัว Authorization ตามที่อธิบายไว้ในการตรวจสอบสิทธิ์กับบริการการตั้งค่าของผู้ดูแลระบบ

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

การดำเนินการนี้ไม่มีพารามิเตอร์ในเนื้อหาคำขอ

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 OK พร้อมด้วยฟีด AtomPub ที่มีข้อมูลสถานะเกตเวย์อีเมล

การตอบกลับ GET แสดงผลพร็อพเพอร์ตี้ smartHost และ smtpMode สำหรับข้อมูลเพิ่มเติมเกี่ยวกับพร็อพเพอร์ตี้เหล่านี้ โปรดดูการอัปเดตการตั้งค่าเกตเวย์อีเมลขาออก

ตัวอย่างคําตอบที่เป็นไปได้มีดังนี้

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='smartHost' value='smtpout.domain.com'/>
<apps:property name='smtpMode' value='SMTP'/>
</entry>

หากคำขอของคุณล้มเหลวด้วยเหตุผลบางอย่าง ระบบจะแสดงรหัสสถานะอื่น โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานะ Google Data API ที่รหัสสถานะ HTTP

กำลังอัปเดตการตั้งค่าเกตเวย์อีเมลขาออก

หากต้องการอัปเดตการตั้งค่าเกตเวย์อีเมลขาออกของโดเมน ให้ส่งคำขอ HTTP PUT ไปยัง URL ของฟีดเกตเวย์:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

XML ของคำขอ PUT คือ

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</atom:entry>

พร็อพเพอร์ตี้ของคำขอมีดังนี้

smartHost
ที่อยู่ IP หรือชื่อโฮสต์ของเซิร์ฟเวอร์ SMTP Google Workspace จะกำหนดเส้นทางอีเมลขาออกไปยังเซิร์ฟเวอร์นี้
smtpMode
ค่าเริ่มต้นคือ SMTP อีกค่าหนึ่งคือ SMTP_TLS จะรักษาความปลอดภัยการเชื่อมต่อด้วย TLS เมื่อส่งข้อความ

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 OK พร้อมกับฟีด AtomPub ที่มีสถานะการตั้งค่าเกตเวย์อีเมล

หากคำขอของคุณล้มเหลวด้วยเหตุผลบางอย่าง ระบบจะแสดงรหัสสถานะอื่น โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานะ Google Data API ที่รหัสสถานะ HTTP

การจัดการการตั้งค่าการกำหนดเส้นทางอีเมล

ก่อนอื่นให้สร้างคำขอ XML ดังนี้

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='routeDestination' value='route-smtp.domain.com'/>
<apps:property name='routeRewriteTo' value='true'/>
<apps:property name='routeEnabled' value='true'/>
<apps:property name='bounceNotifications' value='true'/>
<apps:property name='accountHandling' value='can be either allAccounts | provisionedAccounts | unknownAccounts'/>
</atom:entry>

พร็อพเพอร์ตี้ของคำขอมีดังนี้

routeDestination
ปลายทางนี้คือชื่อโฮสต์หรือที่อยู่ IP ของเซิร์ฟเวอร์อีเมล SMTP-In ที่มีการกำหนดเส้นทางอีเมล ชื่อโฮสต์หรือที่อยู่ IP จะต้องระบุให้ถูกต้องสำหรับ Google โปรดดูรายละเอียดเพิ่มเติมเกี่ยวกับการแก้ไขชื่อโฮสต์ของอีเมลที่หัวข้อเวอร์ชันนำร่องของ Google Workspace กับการกำหนดเส้นทางอีเมล
routeRewriteTo
หากเป็น "จริง" ช่อง to: ของเอนเวโลป SMTP ของข้อความจะเปลี่ยนเป็นชื่อโฮสต์ปลายทาง (ชื่อโฮสต์ของ user@destination) และระบบจะส่งข้อความไปยังอีเมลของผู้ใช้นี้ในเซิร์ฟเวอร์อีเมลปลายทาง หากเป็น false ระบบจะส่งอีเมลไปยังอีเมล to: ของข้อความต้นฉบับ (user@original ชื่อโฮสต์) ในเซิร์ฟเวอร์อีเมลปลายทาง ซึ่งคล้ายกับการตั้งค่า "เปลี่ยนเอนเวโลป SMTP" ของคอนโซลผู้ดูแลระบบ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อการตั้งค่าโดเมนสำหรับการกำหนดเส้นทางอีเมล
routeEnabled
ถ้า true ฟังก์ชันการกำหนดเส้นทางอีเมลเปิดใช้งานอยู่ หากเป็น false ฟังก์ชันการทำงานจะถูกปิดใช้งาน
bounceNotifications
หากเป็น true จะมีการเปิดใช้ Google Workspace เพื่อส่งการแจ้งเตือนการตีกลับไปยังผู้ส่งเมื่อการนำส่งไม่สำเร็จ
accountHandling

การตั้งค่านี้จะกำหนดว่าการกำหนดเส้นทางอีเมลจะส่งผลต่อผู้ใช้ประเภทต่างๆ ในโดเมนอย่างไร ดังนี้

  • allAccounts -- ส่งอีเมลทั้งหมดไปยังปลายทางนี้
  • provisionedAccounts -- ส่งอีเมลไปยังปลายทางนี้หากมีผู้ใช้อยู่ใน Google Workspace
  • unknownAccounts -- ส่งอีเมลไปยังปลายทางนี้หากไม่มีผู้ใช้อยู่ใน Google Workspace ซึ่งคล้ายกับการตั้งค่า "อีเมลนำส่งสำหรับ" ของคอนโซลผู้ดูแลระบบ สำหรับข้อมูลเพิ่มเติมเกี่ยวกับข้อกำหนดเบื้องต้นและวิธีใช้การกำหนดเส้นทางอีเมล โปรดดูที่การตั้งค่าโดเมนสำหรับการกำหนดเส้นทางอีเมล ~ หากต้องการเผยแพร่คำขอนี้ ให้ส่ง HTTP POST ไปยัง URL ฟีดการกำหนดเส้นทางอีเมล และใส่ส่วนหัว Authorization ตามที่อธิบายในการตรวจสอบสิทธิ์กับบริการการตั้งค่าของผู้ดูแลระบบ

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/emailrouting

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 OK พร้อมกับฟีด AtomPub ที่มีข้อมูลที่เก็บถาวร

หากคำขอของคุณล้มเหลวด้วยเหตุผลบางอย่าง ระบบจะแสดงรหัสสถานะอื่น โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานะ Google Data API ที่รหัสสถานะ HTTP

ปลายทางจะยุติการให้บริการในวันที่ 31 ต.ค. 2018

เราได้เลิกใช้งานปลายทางต่อไปนี้ในประกาศนี้ มีการเลิกใช้งานเมื่อวันที่ 31 ตุลาคม 2018 และไม่พร้อมใช้งานอีกต่อไป

  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/defaultLanguage
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/organizationName
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/currentNumberOfUsers
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/maximumNumberOfUsers
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/supportPIN
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/customerPIN
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/adminSecondaryEmail
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/edition
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/creationTime
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/countryCode
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/appearance/customLogo
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/verification/mx