অ্যাডমিন সেটিংস API ওভারভিউ

অ্যাডমিন সেটিংস API Google Workspace ডোমেনের অ্যাডমিনিস্ট্রেটরদের Google Data API ফিডের আকারে তাদের ডোমেনের সেটিংস পুনরুদ্ধার করতে এবং পরিবর্তন করতে দেয়।

এই ডোমেন সেটিংসে Google Workspace অ্যাডমিন কনসোলে উপলব্ধ অনেক বৈশিষ্ট্য অন্তর্ভুক্ত রয়েছে। এই API-এর উদাহরণগুলির মধ্যে রয়েছে একটি কাস্টম কন্ট্রোল প্যানেল তৈরি করা বা Google Workspace ডোমেনগুলিকে বিদ্যমান লিগ্যাসি পরিবেশে একীভূত করা।

অ্যাডমিন সেটিংস API Google ডেটা API প্রোটোকল প্রয়োগ করে। Google Data API এটম পাবলিশিং প্রোটোকল (AtomPub) প্রকাশনা এবং সম্পাদনা মডেলের সাথে সঙ্গতিপূর্ণ। AtomPub HTTP অনুরোধগুলি ওয়েব পরিষেবাগুলিতে প্রতিনিধিত্বমূলক সেট ট্রান্সফার (RESTful) ডিজাইন পদ্ধতি ব্যবহার করে। আরও তথ্যের জন্য, Google ডেটা বিকাশকারীর নির্দেশিকা দেখুন।

শ্রোতা

এই ডকুমেন্টটি এমন ডেভেলপারদের জন্য তৈরি করা হয়েছে যারা ক্লায়েন্ট অ্যাপ্লিকেশন লিখতে চান যা Google Workspace ডোমেন সম্পর্কে তথ্য পরিবর্তন এবং পুনরুদ্ধার করতে পারে। এটি কাঁচা XML এবং HTTP ব্যবহার করে মৌলিক অ্যাডমিন সেটিংস API ইন্টারঅ্যাকশনের উদাহরণ প্রদান করে।

এই ডকুমেন্টটি অনুমান করে যে আপনি Google Data API প্রোটোকলের পিছনের সাধারণ ধারণাগুলি বোঝেন এবং আপনি Google Workspace অ্যাডমিন কনসোলের সাথে পরিচিত। অ্যাডমিন কনসোল সম্পর্কে আরও তথ্যের জন্য, আপনার অ্যাডমিন কনসোল ব্যবহার করুন দেখুন।

শুরু করা

একটি অ্যাকাউন্ট তৈরি করা হচ্ছে

অ্যাডমিন সেটিংস API Google Workspace অ্যাকাউন্টের জন্য চালু করা আছে। পরীক্ষার উদ্দেশ্যে একটি Google Workspace অ্যাকাউন্টে সাইন আপ করুন। অ্যাডমিন সেটিংস পরিষেবা Google অ্যাকাউন্ট ব্যবহার করে, তাই আপনার যদি আগে থেকেই Google Workspace ডোমেনে একটি অ্যাকাউন্ট থাকে তাহলে আপনি প্রস্তুত।

অ্যাডমিন সেটিংস এপিআই ফিড প্রকার সম্পর্কে

অ্যাডমিন সেটিংস API আপনাকে ডোমেন সেটিংসের এই বিভাগগুলি পরিচালনা করতে দেয়:

একক সাইন-অন সেটিংস

SAML-ভিত্তিক একক সাইন-অন (SSO) ব্যবহারকারীদের Google Workspace হোস্ট করা পরিষেবার পাশাপাশি আপনার প্রতিষ্ঠানের মধ্যে হোস্ট করা অন্যান্য পরিষেবার জন্য একই লগইন এবং পাসওয়ার্ড ব্যবহার করতে দেয়। বিশেষত SSO ব্যবহার করার সময়, হোস্ট করা ওয়েব অ্যাপ্লিকেশন, যেমন Google Workspace, ব্যবহারকারীরা লগ ইন করার সময় তাদের প্রমাণীকরণ করতে আপনার প্রতিষ্ঠানের পরিচয় প্রদানকারীর কাছে রিডাইরেক্ট করে। বিস্তারিত তথ্যের জন্য, Google Workspace-এর জন্য SAML-ভিত্তিক SSO বোঝা দেখুন।

SSO কনফিগার করার ক্ষেত্রে Google Workspace পরিষেবার জন্য প্রয়োজনীয় তথ্য প্রবেশ করানো হয় যাতে আপনার ব্যবহারকারীর লগইন তথ্য সংরক্ষণ করা হয় এমন পরিচয় প্রদানকারীর সাথে যোগাযোগ করা যায়, সেইসাথে ব্যবহারকারীদের লগ ইন, লগ আউট এবং পাসওয়ার্ড পরিবর্তন করার জন্য যে লিঙ্কগুলিতে পাঠানো উচিত সেগুলি সেট-আপ করা। . অ্যাডমিন সেটিংস API আপনাকে প্রোগ্রামগতভাবে এই সেটিংস আপডেট করতে এবং পুনরুদ্ধার করতে দেয়৷ Google আপনার তৈরি করা সর্বজনীন কী ব্যবহার করে আপনার পরিচয় প্রদানকারীর সাথে এই SSO অনুরোধটি যাচাই করতে এবং নেটওয়ার্ক ট্রান্সমিশনের সময় ব্যক্তিগত কী SAML প্রতিক্রিয়া পরিবর্তন করা হয়নি।

SSO সেটিংস ব্যবহার করার একটি সংক্ষিপ্ত API নির্দিষ্ট সারাংশের জন্য, আপনার পরিচয় প্রদানকারীর থেকে আপনার সর্বজনীন কী শংসাপত্র পান, Google-এর সাথে সর্বজনীন কী নিবন্ধন করুন এবং আপনার SAML-ভিত্তিক SSO ক্যোয়ারী সেটিংস সেট আপ করুন৷ ত্রুটি বার্তার জন্য, SSO সমস্যা সমাধান দেখুন:

  • আপনার কী জেনারেট করুন -- আপনার পরিচয় প্রদানকারীর সাথে, DSA বা RSA অ্যালগরিদম ব্যবহার করে পাবলিক এবং প্রাইভেট কীগুলির একটি সেট তৈরি করুন। সর্বজনীন কী একটি X.509 বিন্যাসিত শংসাপত্রে রয়েছে। SAML-ভিত্তিক একক সাইন-অন সাইনিং কী সম্পর্কে আরও তথ্যের জন্য, Google Workspace সিঙ্গল সাইন-অন পরিষেবার জন্য কী এবং সার্টিফিকেট তৈরি করা দেখুন।
  • Google-এর সাথে নিবন্ধন করুন -- Google-এর সাথে আপনার সর্বজনীন কী শংসাপত্র নিবন্ধন করতে অ্যাডমিন সেটিংস API-এর একক সাইন-অন সেটিংস ব্যবহার করুন৷
  • আপনার SSO সেটিংস সেট আপ করুন -- ডোমেনের পরিচয় প্রদানকারীর সার্ভারের সাথে যোগাযোগের জন্য ব্যবহৃত সেটিংস কনফিগার করতে অ্যাডমিন সেটিংস API-এর একক সাইন-অন সেটিংস ব্যবহার করুন৷

গেটওয়ে এবং রাউটিং সেটিংস

এই ফিডটি ডোমেন প্রশাসকদের তাদের ডোমেনের জন্য ইমেলের রাউটিং নিয়ন্ত্রণ করতে দেয়।

ইমেল রাউটিং অপারেশনগুলি প্রশাসকদের ডোমেন-স্তরের ইমেল রাউটিং সেটিংস নির্দিষ্ট করার অনুমতি দেয়। এটি অ্যাডমিন কনসোলের Gmail সেটিংসের ইমেল রাউটিং কার্যকারিতার মতো। আরও তথ্যের জন্য, ইমেল রাউটিং এবং ইমেল রাউটিং বৈশিষ্ট্যের দ্বৈত বিতরণ কনফিগারেশন দেখুন।

একটি অ্যাডমিন সেটিংস API XML অনুরোধ এবং প্রতিক্রিয়ার নমুনা৷

এই নথিটি কাঁচা XML এবং HTTP ব্যবহার করে মৌলিক অ্যাডমিন সেটিংস API অনুরোধ এবং প্রতিক্রিয়াগুলির কোড উদাহরণ প্রদান করে৷ এই ডোমেন ডিফল্ট ভাষার উদাহরণটি একটি অনুরোধ এবং প্রতিক্রিয়া এন্ট্রির মূল অংশের জন্য সম্পূর্ণ XML এবং HTTP সিনট্যাক্স দেখায় যা প্রতিটি অপারেশনের জন্য সাধারণ:

ডোমেনের আউটবাউন্ড ইমেল গেটওয়ে সেটিং পরিবর্তন করতে, গেটওয়ে ফিড URL-এ একটি HTTP PUT পাঠান:

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 সিনট্যাক্স সব অ্যাডমিন সেটিংস 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>

একক সাইন-অন সেটিংস পরিচালনা করা

Google Workspace সিঙ্গেল সাইন-অন ফিচার (SSO) ব্যবহারকারীদের একাধিক পরিষেবায় লগ-ইন করতে দেয় যখন শুধুমাত্র একবার লগইন এবং পাসওয়ার্ড দিতে হয়। এই পাসওয়ার্ডটি ডোমেনের পরিচয় প্রদানকারীর দ্বারা সংরক্ষণ করা হয়, Google Workspace দ্বারা নয়। আরও তথ্যের জন্য, সহায়তা কেন্দ্রের SSO পৃষ্ঠাটি দেখুন। নিম্নলিখিত বিভাগগুলি একক সাইন-অন সেটিংসের জন্য ব্যবহৃত XML বিন্যাস প্রদর্শন করে৷

একক সাইন-অন সেটিংস পুনরুদ্ধার করা হচ্ছে

একক সাইন-অন সেটিংস পুনরুদ্ধার করতে, SSO সাধারণ ফিড URL-এ একটি HTTP GET পাঠান এবং অ্যাডমিন সেটিংস পরিষেবায় প্রমাণীকরণে বর্ণিত একটি Authorization শিরোনাম অন্তর্ভুক্ত করুন। এবং, ত্রুটি বার্তার জন্য, SSO সমস্যা সমাধান দেখুন:

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

এই অপারেশনের অনুরোধের অংশে কোনো পরামিতি নেই।

একটি সফল প্রতিক্রিয়া ডোমেনের SSO সেটিংস সহ একটি AtomPub ফিড সহ একটি HTTP 200 OK স্ট্যাটাস কোড প্রদান করে৷

GET প্রতিক্রিয়া XML ফেরত দেয় 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 পাসওয়ার্ড পরিবর্তন করতে চান তখন যে ঠিকানায় পাঠানো হবে৷
এসএসও সক্ষম করুন
এই ডোমেনের জন্য SAML-ভিত্তিক SSO সক্ষম করে৷ আপনি যদি পূর্বে SSO সেটিংস কনফিগার করে থাকেন, এবং আপনি পরবর্তীতে enableSSO কে enableSSO=false সেট করে থাকেন, তাহলে আপনি পূর্বে প্রবেশ করা সেটিংস এখনও সংরক্ষিত থাকবে।
ssoহোয়াইটলিস্ট
একটি ssoWhitelist হল ক্লাসলেস ইন্টার-ডোমেন রাউটিং (CIDR) ফর্ম্যাটে একটি নেটওয়ার্ক মাস্ক IP ঠিকানা। ssoWhitelist নির্ধারণ করে যে কোন ব্যবহারকারী SSO ব্যবহার করে লগ ইন করবেন এবং কোন ব্যবহারকারীরা Google Workspace অ্যাকাউন্ট প্রমাণীকরণ পৃষ্ঠা ব্যবহার করে লগ ইন করবেন। যদি কোনো মুখোশ নির্দিষ্ট না থাকে, তাহলে সকল ব্যবহারকারী SSO ব্যবহার করে লগ ইন করবে। আরও তথ্যের জন্য, দেখুন কিভাবে নেটওয়ার্ক মাস্ক কাজ করে ।
DomainSpecific Issuer ব্যবহার করুন
পরিচয় প্রদানকারীর কাছে SAML অনুরোধে একটি ডোমেন নির্দিষ্ট ইস্যুকারী ব্যবহার করা যেতে পারে। যদিও বেশিরভাগ SSO স্থাপনার জন্য প্রয়োজনীয় নয়, এই বৈশিষ্ট্যটি একটি একক পরিচয় প্রদানকারী ব্যবহার করে একাধিক সাবডোমেন সহ একটি সম্পূর্ণ সংস্থাকে প্রমাণীকরণ করার জন্য বড় কোম্পানিগুলিতে উপযোগী। নির্দিষ্ট ডোমেন ইস্যুকারীকে প্রদান করা অনুরোধের সাথে কোন সাবডোমেন যুক্ত করা হবে তা নির্ধারণ করে। আরও তথ্যের জন্য, দেখুন SAML অনুরোধে ইস্যুকারী উপাদান কীভাবে কাজ করে?

আপনার অনুরোধ কোনো কারণে ব্যর্থ হলে, একটি ভিন্ন স্ট্যাটাস কোড ফেরত দেওয়া হয়। Google Data API স্ট্যাটাস কোড সম্পর্কে আরও তথ্যের জন্য, HTTP স্ট্যাটাস কোড দেখুন।

একক সাইন-অন সেটিংস আপডেট করা হচ্ছে

একটি ডোমেনের SSO সেটিংস আপডেট করতে, প্রথমে একক সাইন-অন সেটিংস অপারেশন পুনরুদ্ধার ব্যবহার করে SSO সেটিংস পুনরুদ্ধার করুন, এটি সংশোধন করুন এবং তারপর SSO ফিড URL-এ একটি PUT অনুরোধ পাঠান৷ নিশ্চিত করুন যে আপনার আপডেট করা এন্ট্রিতে <id> মানটি বিদ্যমান এন্ট্রির <id> সাথে হুবহু মেলে। অ্যাডমিন সেটিংস API পরিষেবার প্রমাণীকরণে বর্ণিত হিসাবে একটি Authorization শিরোনাম অন্তর্ভুক্ত করুন৷ এবং, ত্রুটি বার্তার জন্য, SSO সমস্যা সমাধান দেখুন।

একক সাইন-অন সেটিংস আপডেট করার সময়, SSO সাধারণ ফিড URL-এ একটি HTTP PUT পাঠান:

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

PUT অনুরোধের XML বডি হল:

<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 ফিড সহ একটি HTTP 200 OK স্ট্যাটাস কোড প্রদান করে৷

PUT প্রতিক্রিয়া XML হল:

<?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 স্ট্যাটাস কোড দেখুন।

যখন টার্গেট গ্রাহক সংবেদনশীল ক্রিয়াকলাপের জন্য বহু-দলীয় অনুমোদন সক্ষম করে তখন একক সাইন-অন সেটিংসে পরিবর্তনগুলি অনুমোদিত নয়৷ errorCode="1811" এবং reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval" এর সাথে অনুরোধগুলি ব্যর্থ হবে।

একক সাইন-অন সাইনিং কী পুনরুদ্ধার করা হচ্ছে

সিঙ্গেল সাইন-অন সাইনিং কী পুনরুদ্ধার করতে, SSO সাইনিং কী ফিড URL-এ একটি HTTP GET পাঠান এবং অ্যাডমিন সেটিংস পরিষেবায় প্রমাণীকরণে বর্ণিত একটি Authorization শিরোনাম অন্তর্ভুক্ত করুন। এবং, ত্রুটি বার্তার জন্য, SSO সমস্যা সমাধান দেখুন:

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

এই অপারেশনের অনুরোধের অংশে কোনো পরামিতি নেই।

একটি সফল প্রতিক্রিয়া সাইনিং কী সহ একটি AtomPub ফিড সহ একটি HTTP 200 OK স্ট্যাটাস কোড প্রদান করে৷

GET প্রতিক্রিয়া XML 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 সাইনিং কী ফিড ইউআরএলে একটি PUT অনুরোধ পাঠান। নিশ্চিত করুন যে আপনার আপডেট করা এন্ট্রিতে <id> মানটি বিদ্যমান এন্ট্রির <id> সাথে হুবহু মেলে। SAML-ভিত্তিক একক সাইন-অন সাইনিং কী সম্পর্কে আরও তথ্যের জন্য, Google Workspace সিঙ্গল সাইন-অন পরিষেবার জন্য কী এবং সার্টিফিকেট তৈরি করা দেখুন।

সিঙ্গেল সাইন-অন সাইনিং কী আপডেট করার সময়, SSO সাইনিং কী ফিড URL-এ একটি HTTP PUT পাঠান:

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

PUT অনুরোধ XML হল:

<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>

যখন টার্গেট গ্রাহক সংবেদনশীল ক্রিয়াকলাপের জন্য বহু-দলীয় অনুমোদন সক্ষম করে তখন একক সাইন-অন সেটিংসে পরিবর্তনগুলি অনুমোদিত নয়৷ errorCode="1811" এবং reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval" এর সাথে অনুরোধগুলি ব্যর্থ হবে।

ইমেল গেটওয়ে এবং রাউটিং পরিচালনা করা

আউটবাউন্ড ইমেল গেটওয়ে বিভাগটি দেখায় কিভাবে অ্যাডমিন সেটিংস API আপনার ডোমেনের ব্যবহারকারীদের থেকে মেলের আউটবাউন্ড রাউটিং সমর্থন করে৷ ইমেল রাউটিং বিভাগটি দেখায় কিভাবে বার্তাগুলিকে অন্য মেল সার্ভারে রুট করতে হয়।

আউটবাউন্ড ইমেল গেটওয়ে সেটিংস পুনরুদ্ধার করা হচ্ছে

আউটবাউন্ড ইমেল গেটওয়ে সেটিংস পুনরুদ্ধার করতে, গেটওয়ে ফিড URL-এ একটি HTTP GET পাঠান এবং অ্যাডমিন সেটিংস পরিষেবায় প্রমাণীকরণে বর্ণিত একটি Authorization শিরোনাম অন্তর্ভুক্ত করুন:

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

এই অপারেশনের অনুরোধের অংশে কোনো পরামিতি নেই।

একটি সফল প্রতিক্রিয়া ইমেল গেটওয়ে স্ট্যাটাস তথ্য সহ একটি AtomPub ফিড সহ একটি HTTP 200 ওকে স্ট্যাটাস কোড প্রদান করে।

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 স্ট্যাটাস কোড দেখুন।

আউটবাউন্ড ইমেল গেটওয়ে সেটিংস আপডেট করা হচ্ছে

একটি ডোমেনের আউটবাউন্ড ইমেল গেটওয়ে সেটিং আপডেট করতে, গেটওয়ে ফিড URL-এ একটি HTTP PUT অনুরোধ পাঠান:

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

PUT অনুরোধ 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>

অনুরোধের বৈশিষ্ট্যগুলি হল:

স্মার্টহোস্ট
হয় IP ঠিকানা বা আপনার SMTP সার্ভারের হোস্টনাম। Google Workspace এই সার্ভারে আউটগোয়িং মেল রুট করে।
smtpMode
ডিফল্ট মান হল SMTP। আরেকটি মান, SMTP_TLS, বার্তা প্রদান করার সময় TLS-এর সাথে একটি সংযোগ সুরক্ষিত করে।

একটি সফল প্রতিক্রিয়া ইমেল গেটওয়ে সেটিংস স্ট্যাটাস সহ AtomPub ফিড সহ একটি HTTP 200 OK স্ট্যাটাস কোড প্রদান করে।

আপনার অনুরোধ কোনো কারণে ব্যর্থ হলে, একটি ভিন্ন স্ট্যাটাস কোড ফেরত দেওয়া হয়। 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>

অনুরোধের বৈশিষ্ট্যগুলি হল:

রুট গন্তব্য
এই গন্তব্য হল SMTP-ইন মেল সার্ভারের হোস্টনাম বা IP ঠিকানা যেখানে ইমেলটি রাউট করা হচ্ছে। হোস্টনাম বা আইপি ঠিকানা অবশ্যই Google এর জন্য সমাধান করতে হবে। মেল হোস্টের নামগুলি সমাধান করার বিষয়ে আরও বিশদ বিবরণের জন্য, ইমেল রাউটিং সহ পাইলট Google Workspace দেখুন।
routeRewriteTo
সত্য হলে, বার্তাটির SMTP খামের to: ক্ষেত্রটি গন্তব্য হোস্টনামে (user@destination এর হোস্টনাম) পরিবর্তিত হয় এবং বার্তাটি গন্তব্য মেল সার্ভারে এই ব্যবহারকারীর ঠিকানায় বিতরণ করা হয়। false হলে, ইমেলটি মূল বার্তার to: গন্তব্য মেল সার্ভারে ইমেল ঠিকানা (user@original hostname)। এটি অ্যাডমিন কনসোলের 'চেঞ্জ SMTP খাম' সেটিং-এর মতো। আরও তথ্যের জন্য, ইমেল রাউটিং এর জন্য ডোমেন সেটিংস দেখুন।
রুট সক্ষম
true হলে, ইমেল রাউটিং কার্যকারিতা সক্রিয় করা হয়। false হলে, কার্যকারিতা অক্ষম করা হয়।
বাউন্স বিজ্ঞপ্তি
true হলে, ডেলিভারি ব্যর্থ হলে প্রেরকের কাছে বাউন্স বিজ্ঞপ্তি পাঠাতে Google Workspace চালু থাকে।
অ্যাকাউন্ট হ্যান্ডলিং

এই সেটিং নির্ধারণ করে কিভাবে ডোমেনের বিভিন্ন ধরনের ব্যবহারকারী ইমেল রাউটিং দ্বারা প্রভাবিত হয়:

  • allAccounts -- এই গন্তব্যে সমস্ত ইমেল বিতরণ করুন।
  • provisionedAccounts -- ব্যবহারকারী Google Workspace-এ থাকলে এই গন্তব্যে মেল ডেলিভার করুন।
  • unknownAccounts -- ব্যবহারকারী Google Workspace-এ না থাকলে এই গন্তব্যে মেল ডেলিভার করুন। এটি অ্যাডমিন কনসোলের 'ডেলিভারি ইমেল ফর' সেটিং এর মতো। পূর্বশর্ত এবং মেল রাউটিং কীভাবে ব্যবহার করবেন সে সম্পর্কে আরও তথ্যের জন্য, ইমেল রাউটিং এর জন্য ডোমেন সেটিংস দেখুন। ~ এই অনুরোধটি প্রকাশ করার জন্য, ইমেল রাউটিং ফিড URL-এ একটি HTTP POST পাঠান এবং অ্যাডমিন সেটিংস পরিষেবায় প্রমাণীকরণে বর্ণিত একটি Authorization শিরোনাম অন্তর্ভুক্ত করুন:

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

একটি সফল প্রতিক্রিয়া সংরক্ষণাগার তথ্য সহ একটি AtomPub ফিড সহ একটি HTTP 200 OK স্ট্যাটাস কোড প্রদান করে৷

আপনার অনুরোধ কোনো কারণে ব্যর্থ হলে, একটি ভিন্ন স্ট্যাটাস কোড ফেরত দেওয়া হয়। 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