หน้านี้ได้รับการแปลโดย Cloud Translation API

ภาพรวม 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 ใช้แนวทางการออกแบบ Setational Set Transfer (RESTful) กับบริการเว็บ ดูข้อมูลเพิ่มเติมได้ที่คู่มือสําหรับนักพัฒนาซอฟต์แวร์ Google

ผู้ชม

เอกสารนี้มีไว้สําหรับนักพัฒนาซอฟต์แวร์ที่ต้องการเขียนแอปพลิเคชันไคลเอ็นต์ซึ่งแก้ไขและเรียกข้อมูลเกี่ยวกับโดเมน Google Workspace ได้ โดยจะแสดงตัวอย่างการโต้ตอบ 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 เพื่อสื่อสารกับผู้ให้บริการข้อมูลประจําตัวที่เก็บข้อมูลการเข้าสู่ระบบของผู้ใช้ รวมถึงการตั้งค่าลิงก์ที่ผู้ใช้จะใช้เพื่อเข้าสู่ระบบ ออกจากระบบ และเปลี่ยนรหัสผ่าน Admin Settings 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

เอกสารนี้แสดงตัวอย่างโค้ดของคําขอและการตอบกลับเกี่ยวกับ Admin Settings 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: ที่อยู่ที่ผู้ใช้จะส่งเมื่อออกจากระบบเว็บแอปพลิเคชัน
เปลี่ยนรหัสผ่านรหัสผ่าน: ที่อยู่ที่จะส่งผู้ใช้เมื่อต้องการเปลี่ยนรหัสผ่าน SSO สําหรับเว็บแอปพลิเคชัน
เปิดใช้ SSO: เปิดใช้งาน SSO แบบ SAML สําหรับโดเมนนี้ หากคุณเคยกําหนดการตั้งค่า SSO ไว้แล้ว และตั้งค่า enableSSO เป็น enableSSO=false ในภายหลัง การตั้งค่าที่คุณป้อนไว้ก่อนหน้านี้จะยังคงได้รับการบันทึกอยู่
รายการที่อนุญาตพิเศษ: ssossous คือที่อยู่ IP ของมาสก์เครือข่ายในรูปแบบ Classless Inter-Domain Routing (CIDR) ssosso จะกําหนดผู้ใช้ที่ลงชื่อเข้าสู่ระบบด้วย SSO และผู้ใช้ลงชื่อเข้าสู่ระบบโดยใช้หน้าการตรวจสอบสิทธิ์ของบัญชี Google Workspace หากไม่ได้ระบุหน้ากากไว้ ผู้ใช้ทุกคนจะลงชื่อเข้าสู่ระบบโดยใช้ SSO ดูข้อมูลเพิ่มเติมได้ที่วิธีการทํางานของมาสก์เครือข่าย
ใช้ผู้ออกชื่อโดเมนที่เฉพาะเจาะจง: ผู้ให้บริการเฉพาะโดเมนสามารถใช้ในคําขอ 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>

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

หากต้องการเรียกดูคีย์การลงชื่อเพียงครั้งเดียว ให้ส่ง 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>

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

หากต้องการอัปเดตคีย์การลงนาม SSO ของโดเมน ให้เรียกดูคีย์ Signing โดยใช้การดําเนินการเรียกดูคีย์การลงชื่อเพียงครั้งเดียว แก้ไขคีย์ จากนั้นส่งคําขอ PUT ไปยัง URL ของฟีดคีย์การลงนาม SSO ตรวจสอบว่าค่า <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>

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

หากต้องการอัปเดตการตั้งค่าเกตเวย์อีเมลขาออกของโดเมน ให้ส่งคําขอ 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>

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

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

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

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

ก่อนอื่น ให้สร้างคําขอ 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>

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

จุดหมาย

ปลายทางนี้คือชื่อโฮสต์หรือที่อยู่ IP ของเซิร์ฟเวอร์อีเมล SMTP ที่มีการกําหนดเส้นทางอีเมล ชื่อโฮสต์หรือที่อยู่ IP ต้องได้รับการแก้ไขสําหรับ Google โปรดดูรายละเอียดเพิ่มเติมเกี่ยวกับการแก้ไขชื่อโฮสต์อีเมลที่หัวข้อนําร่อง Google Workspace ด้วยการกําหนดเส้นทางอีเมล

เขียนเส้นทางใหม่

หากเป็น "จริง" ช่อง to: ของเอนเวโลป SMTP ของข้อความจะเปลี่ยนเป็นชื่อโฮสต์ปลายทาง (ชื่อโฮสต์ของ user@destination) และข้อความจะส่งถึงผู้ใช้นี้ในเซิร์ฟเวอร์อีเมลปลายทาง หาก false ระบบจะส่งอีเมลไปยังอีเมล to: ของข้อความต้นฉบับ (ชื่อโฮสต์ user@original) ในเซิร์ฟเวอร์อีเมลปลายทาง การตั้งค่านี้คล้ายกับการตั้งค่า "เปลี่ยนเอนเวโลป SMTP" ของคอนโซลผู้ดูแลระบบ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อการตั้งค่าโดเมนสําหรับการกําหนดเส้นทางอีเมล

เปิดใช้การกําหนดเส้นทางแล้ว

หากเป็น true ระบบจะเปิดใช้ฟังก์ชันการกําหนดเส้นทางอีเมล หากfalse ระบบจะปิดใช้ฟังก์ชันดังกล่าว

การแจ้งเตือนการตีกลับ

หาก true ระบบจะเปิดใช้ Google Workspace ให้ส่งการแจ้งเตือนการตีกลับไปยังผู้ส่งเมื่อการจัดส่งไม่สําเร็จ

การใช้งานบัญชี

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

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 ที่มีข้อมูลที่เก็บถาวร

ปลายทางจะเลิกใช้งานในวันที่ 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