סקירה כללית על Admin Settings API

Admin Settings API מאפשר לאדמינים של דומיינים ב-Google Workspace לאחזר ולשנות את ההגדרות של הדומיינים שלהם בצורת פידים של Google Data API.

הגדרות הדומיין האלה כוללות תכונות רבות שזמינות במסוף Admin של Google Workspace. דוגמאות לשימוש ב-API הזה כוללות יצירת לוח בקרה מותאם אישית או שילוב של דומיינים של Google Workspace בסביבה קיימת מדור קודם.

ב-Admin Settings API מוטמע פרוטוקול Google Data API. Google Data API תואם למודל העריכה והפרסום של Atom Publishing Protocol‏ (AtomPub). בקשות ה-HTTP של AtomPub משתמשות בגישה של העברת קבוצת ייצוג (RESTful) לתכנון שירותי אינטרנט. מידע נוסף זמין במדריך למפתחים של Google Data.

קהל

המסמך הזה מיועד למפתחים שרוצים לכתוב אפליקציות לקוח שיכולות לשנות ולשלוף מידע על דומיינים של Google Workspace. הוא מספק דוגמאות לאינטראקציות הבסיסיות של Admin Settings API באמצעות XML ו-HTTP גולמיים.

במסמך הזה אנו מניחים שאתם מבינים את הרעיונות הכלליים שמאחורי פרוטוקול Google Data API, ושאתם מכירים את מסוף Admin של Google Workspace. מידע נוסף על מסוף Admin זמין במאמר שימוש במסוף Admin.

תחילת העבודה

יצירת חשבון

ה-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 לא שונתה במהלך ההעברה ברשת.

לסיכום קצר של השימוש בהגדרות ה-SSO ב-API ספציפי, צריך לקבל את האישור של המפתח הציבורי מספק הזהויות, לרשום את המפתח הציבורי ב-Google ולהגדיר את הגדרות השאילתות של ה-SSO שמבוססות על SAML. הודעות שגיאה מפורטות במאמר פתרון בעיות ב-SSO:

  • יצירת המפתחות – באמצעות ספק הזהויות, יוצרים קבוצה של מפתחות ציבוריים ופרטיים באמצעות אלגוריתמי DSA או RSA. המפתח הציבורי נמצא באישור בפורמט X.509. מידע נוסף על מפתחות חתימה של כניסה יחידה (SSO) המבוססת על SAML זמין במאמר יצירת מפתחות ואישורים לשירות הכניסה היחידה של Google Workspace.
  • רישום ב-Google – משתמשים בהגדרות של התחברות יחידה (SSO) ב-Admin Settings API כדי לרשום את האישור של המפתח הציבורי ב-Google.
  • מגדירים את הגדרות ה-SSO – משתמשים בהגדרות של 'כניסה יחידה' ב-Admin Settings API כדי להגדיר את ההגדרות שבהן נעשה שימוש בתקשורת עם שרתי ספק הזהויות של הדומיין.

הגדרות של שער וניתוב

הפיד הזה מאפשר למנהלי הדומיינים לשלוט בניתוב האימיילים של הדומיינים שלהם.

פעולות ניתוב האימייל מאפשרות לאדמינים לציין את הגדרות ניתוב האימייל ברמת הדומיין. האפשרות הזו דומה לפונקציית הניתוב של אימיילים בהגדרות Gmail במסוף Admin. מידע נוסף זמין במאמרים ניתוב אימיילים והגדרת שליחה כפולה של תכונת ניתוב האימיילים.

דוגמה לבקשה ולתגובה בפורמט 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)

התכונה 'כניסה יחידה' (SSO) ב-Google Workspace מאפשרת למשתמשים להתחבר לכמה שירותים בלי שתצטרכו להזין שם משתמש וסיסמה יותר מפעם אחת. הסיסמה הזו מאוחסנת על ידי ספק הזהויות של הדומיין, ולא על ידי Google Workspace. מידע נוסף זמין בדף SSO במרכז העזרה. בקטעים הבאים מוצג פורמט ה-XML שמשמש להגדרות של כניסה יחידה (SSO).

אחזור ההגדרות של כניסה יחידה

כדי לאחזר את הגדרות הכניסה היחידה, שולחים 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, אבל היא שימושית בחברות גדולות שמשתמשות בספק זהויות יחיד כדי לאמת ארגון שלם עם כמה תת-דומיינים. הצגת המנפיק הספציפי של הדומיין קובעת איזה תת-דומיין ישותף עם הבקשה. מידע נוסף זמין במאמר איך פועל הרכיב 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.

אסור לבצע שינויים בהגדרות של כניסה יחידה אם לקוח היעד הפעיל את האפשרות קבלת אישור ממספר משתמשים עבור פעולות רגישות. הבקשות נכשלות עם errorCode="1811" ו-reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval".

אחזור מפתח החתימה של כניסה יחידה

כדי לאחזר את מפתח החתימה של כניסה יחידה, שולחים 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> ברשומה הקיימת. מידע נוסף על מפתחות חתימה של כניסה יחידה (SSO) המבוססת על 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>

אסור לבצע שינויים בהגדרות של כניסה יחידה אם לקוח היעד הפעיל את האפשרות קבלת אישור ממספר משתמשים עבור פעולות רגישות. הבקשות נכשלות עם errorCode="1811" ו-reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval".

ניהול שער האימייל והניתוב

בקטע 'שער אימייל יוצא' מוסבר איך Admin Settings 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
אם הערך הוא true, השדה to: של מעטפת ה-SMTP של ההודעה ישתנה לשם המארח של היעד (שם המארח של user@destination), וההודעה תימסר לכתובת המשתמש הזו בשרת הדואר של היעד. אם הערך הוא false, האימייל יימסר לכתובת האימייל to: של ההודעה המקורית (user@original hostname) בשרת האימייל של היעד. ההגדרה הזו דומה להגדרה 'שינוי מעטפת ה-SMTP' במסוף Admin. מידע נוסף זמין במאמר הגדרות דומיין לניתוב אימייל.
routeEnabled
אם true, הפונקציונליות של ניתוב האימיילים מופעלת. אם הערך הוא false, הפונקציונליות מושבתת.
bounceNotifications
אם הערך הוא true, מערכת Google Workspace תוכל לשלוח התראות על הודעות שהוחמצו לשולח במקרה של כשל בשליחה.
accountHandling

ההגדרה הזו קובעת איך סוגים שונים של משתמשים בדומיין מושפעים מהניתוב של האימיילים:

  • allAccounts – העברת כל האימיילים ליעד הזה.
  • provisionedAccounts – העברת אימייל ליעד הזה אם המשתמש קיים ב-Google Workspace.
  • unknownAccounts – שליחת אימייל ליעד הזה אם המשתמש לא קיים ב-Google Workspace. ההגדרה הזו דומה להגדרה 'אימייל למשלוח' במסוף Admin. מידע נוסף על התנאים המוקדמים ועל השימוש בניתוב אימיילים זמין במאמר הגדרות דומיין לניתוב אימיילים. ~ כדי לפרסם את הבקשה הזו, שולחים HTTP POST לכתובת ה-URL של פיד הניתוב של האימייל, וכוללים כותרת Authorization כפי שמתואר בקטע אימות לשירות 'הגדרות אדמין':

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

בתגובה מוצלחת מוחזר קוד סטטוס HTTP‏ 200 OK, יחד עם פיד AtomPub עם פרטי הארכיון.

אם הבקשה נכשלת מסיבה כלשהי, יוחזר קוד סטטוס אחר. מידע נוסף על קודי הסטטוס של Google Data API זמין במאמר קודי סטטוס HTTP.

הסגירה של Endpoints ב-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