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

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

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

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

ผู้ชม

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

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

เริ่มกระบวนการ

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

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

เกี่ยวกับประเภทฟีด Admin Settings API

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

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

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

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

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

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

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

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

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

ตัวอย่างคำขอและการตอบกลับ XML ของ Admin Settings API

เอกสารนี้มีตัวอย่างโค้ดของคำขอและการตอบกลับ API การตั้งค่าผู้ดูแลระบบขั้นพื้นฐานโดยใช้ 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 จะแสดงคู่คีย์-ค่าคู่เดียวที่มีข้อมูลเกี่ยวกับพร็อพเพอร์ตี้ที่คุณต้องการเรียกหรืออัปเดต ยกเว้นพร็อพเพอร์ตี้และค่าที่เจาะจงสำหรับการดำเนินการ กระบวนการเหล่านี้เป็นเรื่องปกติในเนื้อความของคำขอ 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
ssoWhitelist คือที่อยู่ 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 ของฟีดคีย์การลงชื่อเพียงครั้งเดียวของ SSO และรวมส่วนหัว 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 ฟีดคีย์การลงชื่อ SSO ตรวจสอบว่าค่า <id> อยู่ในรายการที่อัปเดตแล้วตรงกับ <id> ของรายการที่มีอยู่ทุกประการ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับคีย์การลงชื่อเพียงครั้งเดียวที่ใช้ SAML ที่หัวข้อการสร้างคีย์และใบรับรองสำหรับบริการการลงชื่อเพียงครั้งเดียวของ Google Workspace

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

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 Hostname) ในเซิร์ฟเวอร์อีเมลปลายทาง ซึ่งจะคล้ายกับการตั้งค่า "เปลี่ยนเอนเวโลป 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