एडमिन सेटिंग एपीआई की खास जानकारी

Admin Settings API की मदद से Google Workspace डोमेन के एडमिन, अपने डोमेन की सेटिंग को वापस पा सकते हैं और उनमें बदलाव कर सकते हैं. इस सेटिंग को Google Data API फ़ीड के रूप में इस्तेमाल किया जा सकता है.

इन डोमेन सेटिंग में, Google Workspace Admin console में उपलब्ध कई सुविधाएं शामिल हैं. यह एपीआई, कस्टम कंट्रोल पैनल बनाने या Google Workspace डोमेन को किसी मौजूदा लेगसी एनवायरमेंट में इंटिग्रेट करने जैसे काम करता है.

Admin Settings API, Google Data API प्रोटोकॉल लागू करता है. Google Data API, ऐटम पब्लिशिंग प्रोटोकॉल (ऐटमPub) के पब्लिशिंग और एडिटिंग मॉडल के हिसाब से काम करता है. AtomPub एचटीटीपी अनुरोध, वेब सेवाओं के लिए रिप्रज़ेंटेशनल सेट ट्रांसफ़र (RESTful) डिज़ाइन अप्रोच का इस्तेमाल करते हैं. ज़्यादा जानकारी के लिए, Google डेटा डेवलपर की गाइड देखें.

दर्शक

यह दस्तावेज़ उन डेवलपर के लिए है जो ऐसे क्लाइंट ऐप्लिकेशन लिखना चाहते हैं जो Google Workspace डोमेन की जानकारी में बदलाव कर सकें और उसे फिर से हासिल कर सकें. इसमें, रॉ एक्सएमएल और एचटीटीपी का इस्तेमाल करके, बेसिक एडमिन सेटिंग एपीआई इंटरैक्शन के उदाहरण दिए गए हैं.

इस दस्तावेज़ में यह माना गया है कि आपको Google Data API प्रोटोकॉल के सामान्य आइडिया और Google Workspace Admin console के बारे में पता है. Admin console के बारे में ज़्यादा जानकारी के लिए, अपने Admin console का इस्तेमाल करना देखें.

YouTube पर शुरुआत करना

खाता बनाना

Google Workspace खातों के लिए, Admin Settings API को चालू किया गया है. जांच के लिए, Google Workspace खाते में साइन अप करें. Admin Settings सेवा Google खाते का इस्तेमाल करती है. इसलिए, अगर आपके पास पहले से ही Google Workspace डोमेन पर खाता है, तो आपको इसका इस्तेमाल करने की सुविधा मिल गई है.

Admin Settings API फ़ीड टाइप के बारे में जानकारी

एडमिन सेटिंग एपीआई से आपको डोमेन सेटिंग की इन कैटगरी को मैनेज करने की सुविधा मिलती है:

सिंगल साइन-ऑन की सेटिंग

एसएएमएल पर आधारित सिंगल साइन-ऑन (एसएसओ) सेवा की मदद से उपयोगकर्ता, Google Workspace की होस्ट की जाने वाली सेवाओं के साथ-साथ अपने संगठन में होस्ट की जा रही अन्य सेवाओं के लिए, एक ही लॉगिन और पासवर्ड का इस्तेमाल कर सकते हैं. खास तौर पर, जब Google Workspace जैसे होस्ट किए गए वेब ऐप्लिकेशन एसएसओ (SSO) का इस्तेमाल किया जाता है, तब उपयोगकर्ताओं को आपके संगठन के आइडेंटिटी प्रोवाइडर पर रीडायरेक्ट किया जाता है. ऐसा करने पर, उपयोगकर्ताओं के लॉग इन करने पर उनकी पुष्टि की जाती है. ज़्यादा जानकारी के लिए, Google Workspace के लिए एसएएमएल-आधारित एसएसओ (SSO) को समझना पढ़ें.

एसएसओ को कॉन्फ़िगर करने में, Google Workspace सेवा के लिए ज़रूरी जानकारी डालनी होती है. ऐसा, आपके उपयोगकर्ताओं की लॉगिन जानकारी सेव करने वाली आइडेंटिटी प्रोवाइडर से संपर्क करने के लिए किया जाता है. साथ ही, इसमें ऐसे लिंक सेट अप किए जाते हैं जिन पर उपयोगकर्ताओं को लॉगिन करने, लॉग आउट करने, और पासवर्ड बदलने के लिए भेजा जाता है. Admin Settings API से, आपको प्रोग्राम के हिसाब से इन सेटिंग को अपडेट करने और वापस लाने की सुविधा मिलती है. Google आपके जनरेट किए गए सार्वजनिक पासकोड का इस्तेमाल, आपके आइडेंटिटी प्रोवाइडर के साथ इस एसएसओ (SSO) अनुरोध की पुष्टि करने और यह तय करने के लिए करता है कि नेटवर्क ट्रांसमिशन के दौरान, निजी पासकोड के एसएएमएल रिस्पॉन्स में बदलाव नहीं हुआ है.

एपीआई की मदद से, एसएसओ (SSO) सेटिंग के इस्तेमाल से जुड़ी खास जानकारी के लिए, अपने आइडेंटिटी प्रोवाइडर से सार्वजनिक पासकोड को रजिस्टर करें, सार्वजनिक पासकोड को Google पर रजिस्टर करें, और एसएएमएल पर आधारित एसएसओ (SSO) क्वेरी की सेटिंग सेट अप करें. गड़बड़ी के मैसेज के लिए, एसएसओ (SSO) से जुड़ी समस्या हल करना देखें:

  • अपनी कुंजियां जनरेट करें -- अपने आइडेंटिटी प्रोवाइडर की मदद से, डीएसए या आरएसए एल्गोरिदम का इस्तेमाल करके, सार्वजनिक और निजी कुंजियों का सेट जनरेट करें. सार्वजनिक कुंजी, X.509 फ़ॉर्मैट वाले सर्टिफ़िकेट में होती है. एसएएमएल पर आधारित सिंगल साइन-ऑन कुंजी के बारे में ज़्यादा जानकारी के लिए, Google Workspace सिंगल साइन-ऑन सेवा के लिए पासकोड और सर्टिफ़िकेट जनरेट करना लेख पढ़ें.
  • Google के साथ पंजीकृत करें -- अपने सार्वजनिक कुंजी प्रमाणपत्र को Google के साथ पंजीकृत करने के लिए, Admin Settings API की एकल साइन-ऑन सेटिंग का उपयोग करें.
  • अपनी एसएसओ (SSO) सेटिंग सेट करें -- डोमेन के पहचान देने वाली कंपनी के सर्वर से कम्यूनिकेट करने के लिए इस्तेमाल की जाने वाली सेटिंग कॉन्फ़िगर करने के लिए, एडमिन सेटिंग एपीआई की सिंगल साइन-ऑन सेटिंग का इस्तेमाल करें.

गेटवे और रूटिंग सेटिंग

यह फ़ीड डोमेन एडमिन को उनके डोमेन के लिए ईमेल की रूटिंग को नियंत्रित करने देती है.

ईमेल रूटिंग कार्रवाइयां एडमिन को डोमेन-लेवल ईमेल रूटिंग सेटिंग तय करने की अनुमति देती हैं. यह Admin console के Gmail सेटिंग की ईमेल रूटिंग फ़ंक्शन जैसा है. ज़्यादा जानकारी के लिए, ईमेल रूटिंग और ईमेल रूटिंग सुविधा का ड्यूअल डिलीवरी कॉन्फ़िगरेशन देखें.

Admin Settings API एक्सएमएल अनुरोध और रिस्पॉन्स का सैंपल

यह दस्तावेज़ रॉ एक्सएमएल और एचटीटीपी का इस्तेमाल करके, बेसिक एडमिन सेटिंग एपीआई अनुरोधों और रिस्पॉन्स के कोड के उदाहरण देता है. डोमेन की डिफ़ॉल्ट भाषा के इस उदाहरण में, अनुरोध और रिस्पॉन्स एंट्री के पूरे एक्सएमएल और एचटीटीपी सिंटैक्स को दिखाया गया है. यह सिंटैक्स हर कार्रवाई के लिए एक आम बात है:

डोमेन की आउटबाउंड ईमेल गेटवे सेटिंग बदलने के लिए, गेटवे फ़ीड यूआरएल पर एक एचटीटीपी PUT भेजें:

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

डोमेन के लिए, AtomPub entry एक्सएमएल के अनुरोध की डिफ़ॉल्ट भाषा 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 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>

सिंगल साइन-ऑन सेटिंग मैनेज करना

Google Workspace सिंगल साइन-ऑन सुविधा (SSO) की मदद से, उपयोगकर्ता कई सेवाओं पर लॉग इन कर सकते हैं. इसके लिए, उन्हें सिर्फ़ एक बार लॉगिन और पासवर्ड डालना होगा. इस पासवर्ड को डोमेन का आइडेंटिटी प्रोवाइडर सेव करता है, न कि Google Workspace. ज़्यादा जानकारी के लिए, सहायता केंद्र का एसएसओ पेज देखें. नीचे दिए गए सेक्शन, सिंगल साइन-ऑन सेटिंग के लिए इस्तेमाल किए जाने वाले एक्सएमएल फ़ॉर्मैट के बारे में बताते हैं.

सिंगल साइन-ऑन सेटिंग फ़ेच की जा रही हैं

सिंगल साइन-ऑन सेटिंग को फिर से पाने के लिए, एसएसओ (SSO) सामान्य फ़ीड के यूआरएल पर एक एचटीटीपी GET भेजें और एडमिन सेटिंग सेवा के लिए पुष्टि करना में बताए गए तरीके से एक Authorization हेडर शामिल करें. और गड़बड़ी के मैसेज के लिए, एसएसओ (SSO) से जुड़ी समस्या हल करना देखें:

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

इस कार्रवाई के लिए अनुरोध के मुख्य हिस्से में कोई पैरामीटर नहीं है.

सही जवाब देने पर, डोमेन की एसएसओ (SSO) सेटिंग के साथ AtomPub फ़ीड के साथ एचटीटीपी 200 OK स्टेटस कोड मिलता है.

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
पहचान देने वाली सेवा का वह यूआरएल जहां Google Workspace, उपयोगकर्ता की पुष्टि करने के लिए एसएएमएल अनुरोध भेजता है.
samlLogoutUri
वह पता जिस पर उपयोगकर्ताओं को, वेब ऐप्लिकेशन से लॉग आउट करने पर भेजा जाएगा.
changePasswordUri
वह पता जिस पर उपयोगकर्ताओं को तब भेजा जाएगा, जब वे वेब ऐप्लिकेशन के लिए अपना एसएसओ पासवर्ड बदलना चाहेंगे.
enableSSO
इस डोमेन के लिए एसएएमएल-आधारित एसएसओ (SSO) को चालू करता है. अगर आपने एसएसओ (SSO) सेटिंग पहले कॉन्फ़िगर की हैं और आपने enableSSO को बाद में enableSSO=false पर सेट कर दिया है, तो पहले डाली गई सेटिंग अब भी सेव की जाएंगी.
ssoWhitelist
ssoवाइट, क्लासलेस इंटर-डोमेन रूटिंग (सीआईडीआर) फ़ॉर्मैट में एक नेटवर्क मास्क आईपी पता है. ssoवाइट से यह तय किया जाता है कि कौनसे उपयोगकर्ता एसएसओ (SSO) का इस्तेमाल करके लॉग इन करते हैं और कौनसे उपयोगकर्ता Google Workspace खाते की पुष्टि करने वाले पेज का इस्तेमाल करके लॉग इन करते हैं. अगर कोई मास्क नहीं चुना गया है, तो सभी उपयोगकर्ता एसएसओ (SSO) का इस्तेमाल करके लॉग इन करेंगे. ज़्यादा जानकारी के लिए, नेटवर्क मास्क कैसे काम करते हैं देखें.
useDomainSpecificIssuer
डोमेन के हिसाब से जारी करने वाले का इस्तेमाल, पहचान देने वाली सेवा को एसएएमएल अनुरोध के लिए किया जा सकता है. हालांकि, ज़्यादातर एसएसओ (SSO) डिप्लॉयमेंट के लिए यह सुविधा ज़रूरी नहीं है, लेकिन यह सुविधा एक आइडेंटिटी प्रोवाइडर का इस्तेमाल करने वाली बड़ी कंपनियों के लिए काम की है. इसकी मदद से, पूरे संगठन की कई सबडोमेन से पुष्टि करने के लिए इसका इस्तेमाल किया जाता है. डोमेन जारी करने वाले की जानकारी देने से, यह तय होता है कि अनुरोध के साथ किस सबडोमेन को जोड़ना है. ज़्यादा जानकारी के लिए, एसएएमएल अनुरोध में शामिल करने वाला एलिमेंट कैसे काम करता है? लेख पढ़ें

अगर किसी वजह से आपका अनुरोध पूरा नहीं हो पाता है, तो एक दूसरा स्टेटस कोड दिखता है. Google Data API के स्टेटस कोड के बारे में ज़्यादा जानकारी के लिए, एचटीटीपी स्टेटस कोड देखें.

सिंगल साइन-ऑन सेटिंग अपडेट की जा रही हैं

डोमेन की एसएसओ (SSO) सेटिंग अपडेट करने के लिए, सबसे पहले सिंगल साइन-ऑन वापस पाना कार्रवाई का इस्तेमाल करके एसएसओ (SSO) सेटिंग वापस पाएं. इसके बाद, उनमें बदलाव करें और फिर एसएसओ (SSO) फ़ीड के यूआरएल पर PUT अनुरोध भेजें. पक्का करें कि आपकी अपडेट की गई एंट्री में <id> की वैल्यू, मौजूदा एंट्री के <id> से पूरी तरह मैच करती हो. एडमिन सेटिंग एपीआई सेवा के लिए पुष्टि करने में बताए गए तरीके से एक Authorization हेडर शामिल करें. और गड़बड़ी के मैसेज के लिए, एसएसओ से जुड़ी समस्या का हल देखें.

एकल साइन-ऑन सेटिंग अपडेट करते समय, एसएसओ (SSO) सामान्य फ़ीड के यूआरएल पर एक एचटीटीपी PUT भेजें:

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

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>

सही जवाब देने पर, एसएसओ (SSO) सेटिंग के साथ एक AtomPub फ़ीड और एचटीटीपी 200 OK स्टेटस कोड मिलता है.

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 के स्टेटस कोड के बारे में ज़्यादा जानकारी के लिए, एचटीटीपी स्टेटस कोड देखें.

सिंगल साइन-ऑन साइनिंग पासकोड वापस पाना

सिंगल साइन-ऑन साइनिंग कुंजी को वापस पाने के लिए, एसएसओ (SSO) साइनिंग पासकोड के फ़ीड के यूआरएल पर एक एचटीटीपी GET भेजें. साथ ही, एडमिन सेटिंग सेवा के लिए पुष्टि करने में बताए गए तरीके से एक Authorization हेडर शामिल करें. और गड़बड़ी के मैसेज के लिए, एसएसओ (SSO) से जुड़ी समस्या हल करना देखें:

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

इस कार्रवाई के लिए अनुरोध के मुख्य हिस्से में कोई पैरामीटर नहीं है.

सही जवाब देने पर, साइनिंग पासकोड के साथ AtomPub फ़ीड और एचटीटीपी 200 OK स्टेटस कोड मिलता है.

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 के स्टेटस कोड के बारे में ज़्यादा जानकारी के लिए, एचटीटीपी स्टेटस कोड देखें.

सिंगल साइन-ऑन साइनिंग पासकोड को अपडेट करना

डोमेन की एसएसओ (SSO) साइनिंग कुंजी को अपडेट करने के लिए, सबसे पहले सिंगल साइन-ऑन कुंजी को वापस पाने की कार्रवाई का इस्तेमाल करके, साइनिंग पासकोड को वापस पाएं. इसमें बदलाव करें. इसके बाद, एसएसओ (SSO) साइनिंग पासकोड के फ़ीड यूआरएल पर PUT अनुरोध भेजें. पक्का करें कि आपकी अपडेट की गई एंट्री में <id> की वैल्यू, मौजूदा एंट्री के <id> से पूरी तरह मैच करती हो. एसएएमएल पर आधारित सिंगल साइन-ऑन कुंजी के बारे में ज़्यादा जानकारी के लिए, Google Workspace सिंगल साइन-ऑन सेवा के लिए पासकोड और सर्टिफ़िकेट जनरेट करना लेख पढ़ें.

सिंगल साइन-ऑन साइनिंग पासकोड को अपडेट करते समय, एसएसओ (SSO) साइनिंग पासकोड के फ़ीड के यूआरएल पर एक एचटीटीपी PUT भेजें:

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

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>

ईमेल गेटवे और रूटिंग को मैनेज करना

आउटबाउंड ईमेल गेटवे सेक्शन दिखाता है कि एडमिन सेटिंग एपीआई, आपके डोमेन के उपयोगकर्ताओं के मेल की आउटबाउंड रूटिंग रूटिंग के साथ कैसे काम करता है. ईमेल रूटिंग सेक्शन, मैसेज को किसी दूसरे मेल सर्वर पर रूट करने का तरीका दिखाता है.

आउटबाउंड ईमेल गेटवे की सेटिंग फिर से हासिल की जा रही है

आउटबाउंड ईमेल गेटवे की सेटिंग वापस पाने के लिए, गेटवे फ़ीड के यूआरएल पर एचटीटीपी GET भेजें. साथ ही, एडमिन सेटिंग सेवा के लिए पुष्टि करना में बताए गए तरीके से Authorization हेडर शामिल करें:

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

इस कार्रवाई के लिए अनुरोध के मुख्य हिस्से में कोई पैरामीटर नहीं है.

सही जवाब देने पर, एचटीटीपी 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 के स्टेटस कोड के बारे में ज़्यादा जानकारी के लिए, एचटीटीपी स्टेटस कोड देखें.

आउटबाउंड ईमेल गेटवे की सेटिंग अपडेट की जा रही हैं

किसी डोमेन की आउटबाउंड ईमेल गेटवे की सेटिंग अपडेट करने के लिए, गेटवे फ़ीड के यूआरएल पर एचटीटीपी PUT अनुरोध भेजें:

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

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
आपके एसएमटीपी सर्वर का आईपी पता या होस्टनेम. Google Workspace, आउटगोइंग मेल को इस सर्वर पर रूट करता है.
smtpMode
डिफ़ॉल्ट मान एसएमटीपी है. एक अन्य वैल्यू एसएमटीपी_TLS, मैसेज डिलीवर करते समय TLS के साथ कनेक्शन को सुरक्षित करती है.

सही जवाब देने पर, ईमेल गेटवे सेटिंग की स्थिति के साथ AtomPub फ़ीड और एचटीटीपी 200 OK स्टेटस कोड मिलता है.

अगर किसी वजह से आपका अनुरोध पूरा नहीं हो पाता है, तो एक दूसरा स्टेटस कोड दिखता है. Google Data API के स्टेटस कोड के बारे में ज़्यादा जानकारी के लिए, एचटीटीपी स्टेटस कोड देखें.

ईमेल रूटिंग सेटिंग मैनेज करना

सबसे पहले, एक्सएमएल अनुरोध करें:

<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
यह डेस्टिनेशन, एसएमटीपी-इन मेल सर्वर का होस्टनेम या आईपी पता है, जहां ईमेल को रूट किया जा रहा है. Google के लिए, होस्टनेम या आईपी पते का समाधान करना ज़रूरी है. मेल होस्ट नेम से जुड़ी समस्याओं को हल करने के बारे में ज़्यादा जानकारी के लिए, ईमेल रूटिंग की सुविधा के साथ Google Workspace को टेस्ट करना देखें.
routeRewriteTo
अगर सही है, तो मैसेज के एसएमटीपी लिफ़ाफ़े का to: फ़ील्ड, डेस्टिनेशन के होस्टनेम (user@destination का होस्टनेम) में बदल जाता है और मैसेज को डेस्टिनेशन मेल सर्वर पर, उपयोगकर्ता के पते पर डिलीवर कर दिया जाता है. अगर false हो, तो ईमेल को डेस्टिनेशन मेल सर्वर पर मूल मैसेज के to: ईमेल पते (user@original होस्टनाम) पर डिलीवर किया जाता है. यह Admin console की 'एसएमटीपी लिफ़ाफ़ा बदलें' सेटिंग की तरह है. ज़्यादा जानकारी के लिए, ईमेल रूटिंग की डोमेन सेटिंग देखें.
routeEnabled
अगर true है, तो ईमेल रूटिंग की सुविधा चालू है. false होने पर, यह सुविधा बंद हो जाती है.
bounceNotifications
अगर true, Google Workspace के पास यह सुविधा है कि वह डिलीवरी न होने पर, भेजने वाले को बाउंस की सूचना भेज सके.
accountHandling

यह सेटिंग तय करती है कि डोमेन के अलग-अलग प्रकार के उपयोगकर्ता ईमेल रूटिंग से किस तरह प्रभावित होते हैं:

  • allAccounts -- सभी ईमेल इस मंज़िल पर डिलीवर करें.
  • provisionedAccounts -- अगर उपयोगकर्ता Google Workspace में मौजूद है, तो इस डेस्टिनेशन पर ईमेल डिलीवर करें.
  • unknownAccounts -- अगर उपयोगकर्ता Google Workspace में मौजूद नहीं है, तो इस डेस्टिनेशन पर ईमेल डिलीवर करें. यह Admin console की 'डिलीवरी के लिए ईमेल' सेटिंग जैसा ही है. पूर्वापेक्षाओं और मेल रूटिंग का उपयोग करने के बारे में अधिक जानकारी के लिए, ईमेल रूटिंग के लिए डोमेन सेटिंग देखें. ~ इस अनुरोध को पब्लिश करने के लिए, ईमेल रूटिंग फ़ीड के यूआरएल पर एक एचटीटीपी POST भेजें और एडमिन सेटिंग सेवा के लिए पुष्टि करना सेक्शन में बताए गए तरीके से Authorization हेडर शामिल करें:

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

जवाब देने पर, एक एचटीटीपी 200 OK स्टेटस कोड दिखता है. साथ ही, संग्रह की जानकारी के साथ AtomPub फ़ीड मिलता है.

अगर किसी वजह से आपका अनुरोध पूरा नहीं हो पाता है, तो एक दूसरा स्टेटस कोड दिखता है. Google Data API के स्टेटस कोड के बारे में ज़्यादा जानकारी के लिए, एचटीटीपी स्टेटस कोड देखें.

एंडपॉइंट डिवाइस 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