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

กลุ่มเป้าหมาย

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

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

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

หากต้องการเริ่มใช้ Admin Settings API ให้ตั้งค่าบัญชีก่อน

สร้างบัญชี

Admin Settings API เปิดใช้สำหรับบัญชี Google Workspace ลงชื่อสมัครใช้ บัญชี Google Workspace เพื่อวัตถุประสงค์ในการทดสอบ บริการ Admin Settings ใช้ Google Accounts ดังนั้นหากคุณมีบัญชีใน โดเมน 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 ดูข้อมูลเพิ่มเติมเกี่ยวกับคีย์การลงชื่อเพียงครั้งเดียว (SSO) แบบ SAML ได้ที่ หัวข้อการสร้างคีย์และใบรับรองสำหรับ บริการการลงชื่อเพียงครั้งเดียว (SSO) ของ Google Workspace
  • ลงทะเบียนกับ Google -- ใช้การตั้งค่าการลงชื่อเพียงครั้งเดียว (SSO) ของ Admin Settings API เพื่อลงทะเบียนใบรับรองคีย์สาธารณะกับ Google
  • ตั้งค่า SSO -- ใช้การตั้งค่าการลงชื่อเพียงครั้งเดียว (SSO) ของ Admin Settings API เพื่อกำหนดค่าการตั้งค่าที่ใช้ในการสื่อสารกับเซิร์ฟเวอร์ของผู้ให้บริการข้อมูลประจำตัวของโดเมน

การตั้งค่าเกตเวย์

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

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

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

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

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

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

XML entry ของ AtomPub สำหรับคำขอ 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>

ยกเว้นพร็อพเพอร์ตี้และค่าเฉพาะของการดำเนินการ องค์ประกอบ 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 ตามที่อธิบายไว้ใน การตรวจสอบสิทธิ์เพื่อเข้าถึงบริการ Admin Settings และหากต้องการดู ข้อความแสดงข้อผิดพลาด โปรดดูหัวข้อการแก้ปัญหา 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 ส่วนใหญ่จะไม่จำเป็น แต่ฟีเจอร์นี้มีประโยชน์ในบริษัทขนาดใหญ่ที่ใช้ผู้ให้บริการข้อมูลประจำตัวรายเดียวเพื่อตรวจสอบสิทธิ์ทั้งองค์กรที่มีโดเมนย่อยหลายโดเมน การระบุผู้ให้บริการเฉพาะของโดเมนจะกำหนดโดเมนย่อยที่จะเชื่อมโยงกับคำขอ ดูข้อมูลเพิ่มเติมได้ที่หัวข้อ องค์ประกอบ Issuer ในคำขอ SAML ทำงานอย่างไร

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

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

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

เมื่ออัปเดตการตั้งค่าการลงชื่อเพียงครั้งเดียว (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

ระบบจะไม่อนุญาตให้เปลี่ยนแปลงการตั้งค่าการลงชื่อเพียงครั้งเดียว (SSO) เมื่อลูกค้าเป้าหมายได้ เปิดใช้ การอนุมัติจากผู้ที่มีสิทธิ์สำหรับการดำเนินการที่มีความละเอียดอ่อน คำขอจะล้มเหลวโดยมี errorCode="1811" และ reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval"

ดึงข้อมูลคีย์การลงชื่อเพียงครั้งเดียว (SSO)

หากต้องการดึงข้อมูลคีย์การลงชื่อเพียงครั้งเดียว (SSO) ให้ส่ง HTTP GET ไปยัง URL ฟีดคีย์การลงชื่อ เพียงครั้งเดียว (SSO) และใส่ส่วนหัว Authorization ตามที่อธิบายไว้ใน หัวข้อการตรวจสอบสิทธิ์เพื่อเข้าถึงบริการ Admin Settings และหากต้องการดูข้อความแสดงข้อผิดพลาด โปรดดูหัวข้อ การแก้ปัญหา 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)

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

เมื่ออัปเดตคีย์การลงชื่อเพียงครั้งเดียว (SSO) ให้ส่ง PUT HTTP ไปยัง 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>

ระบบจะไม่อนุญาตให้เปลี่ยนแปลงการตั้งค่าการลงชื่อเพียงครั้งเดียว (SSO) เมื่อลูกค้าเป้าหมายได้ เปิดใช้ การอนุมัติจากผู้ที่มีสิทธิ์สำหรับการดำเนินการที่มีความละเอียดอ่อน คำขอจะล้มเหลวโดยมี errorCode="1811" และ reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval"

จัดการเกตเวย์อีเมล

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

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

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

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

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

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

จุดสิ้นสุดการให้บริการในวันที่ 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