Mit der Admin Settings API können Administratoren von Google Workspace-Domains die Einstellungen ihrer Domains in Form von Google Data API-Feeds abrufen und ändern.
Diese Domaineinstellungen umfassen viele der Funktionen, die in der Admin-Konsole von Google Workspace verfügbar sind. Beispiele für die Verwendung dieser API sind das Erstellen eines benutzerdefinierten Steuerfelds oder die Einbindung von Google Workspace-Domains in eine vorhandene Legacy-Umgebung.
Die Admin Settings API implementiert das Google Data API-Protokoll. Die Google Data API entspricht dem Veröffentlichungs- und Bearbeitungsmodell des Atom Publishing Protocol (AtomPub). Bei den AtomPub-HTTP-Anfragen wird der RESTful-Designansatz (Representational State Transfer) für Webdienste verwendet. Weitere Informationen finden Sie im Google Data Developer's Guide.
Zielgruppe
Dieses Dokument richtet sich an Entwickler, die Clientanwendungen schreiben möchten, mit denen Informationen zu Google Workspace-Domains geändert und abgerufen werden können. Es enthält Beispiele für die grundlegenden Interaktionen der Admin Settings API mithilfe von Roh-XML und HTTP.
In diesem Dokument wird davon ausgegangen, dass Sie mit den allgemeinen Konzepten des Google Data API-Protokolls vertraut sind und die Google Workspace Admin-Konsole kennen. Weitere Informationen zur Admin-Konsole finden Sie im Hilfeartikel Admin-Konsole nutzen.
Erste Schritte
Konto erstellen
Die Admin Settings API ist für Google Workspace-Konten aktiviert. Registrieren Sie sich zu Testzwecken für ein Google Workspace-Konto. Der Dienst „Verwaltungseinstellungen“ verwendet Google-Konten. Wenn Sie also bereits ein Konto in einer Google Workspace-Domain haben, können Sie sofort loslegen.
Admin API-Feedtypen
Mit der Admin Settings API können Sie die folgenden Kategorien von Domaineinstellungen verwalten:
- Einmalanmeldung (SSO)
Mit der SAML-basierten Einmalanmeldung (SSO) können Nutzer dieselbe Anmeldedaten für von Google Workspace gehostete Dienste sowie für andere Dienste verwenden, die Sie möglicherweise in Ihrer Organisation hosten. Insbesondere bei der Verwendung von SSO werden Nutzer von einer gehosteten Webanwendung wie Google Workspace an den Identitätsanbieter Ihrer Organisation weitergeleitet, um sich bei der Anmeldung zu authentifizieren. Weitere Informationen finden Sie unter SAML-basierter SSO für Google Workspace.
Bei der Konfiguration von SSO müssen Sie die erforderlichen Informationen eingeben, damit der Google Workspace-Dienst mit dem Identitätsanbieter kommunizieren kann, der die Anmeldedaten Ihrer Nutzer speichert. Außerdem müssen Sie die Links einrichten, zu denen Nutzer weitergeleitet werden sollen, um sich anzumelden, abzumelden und ihr Passwort zu ändern. Mit der Admin Settings API können Sie diese Einstellungen programmatisch aktualisieren und abrufen. Google verwendet Ihren generierten öffentlichen Schlüssel, um diese SSO-Anfrage bei Ihrem Identitätsanbieter zu überprüfen und sicherzustellen, dass die SAML-Antwort des privaten Schlüssels während der Netzwerkübertragung nicht geändert wurde.
Eine kurze API-spezifische Zusammenfassung zur Verwendung der SSO-Einstellungen: Holen Sie Ihr Public-Key-Zertifikat von Ihrem Identitätsanbieter ab, registrieren Sie den öffentlichen Schlüssel bei Google und richten Sie Ihre SAML-basierten SSO-Abfrageeinstellungen ein. Informationen zu Fehlermeldungen finden Sie unter Fehlerbehebung bei der SSO-Nutzung:- Schlüssel generieren: Erstellen Sie mit Ihrem Identitätsanbieter eine Reihe öffentlicher und privater Schlüssel mit dem DSA- oder RSA-Algorithmus. Der öffentliche Schlüssel befindet sich in einem X.509-formatierten Zertifikat. Weitere Informationen zu SAML-basierten Signaturschlüsseln für die Einmalanmeldung finden Sie unter Schlüssel und Zertifikate für den Google Workspace-Dienst zur Einmalanmeldung generieren.
- Bei Google registrieren: Verwenden Sie die Einstellungen für die einmalige Anmeldung der Admin Settings API, um Ihr öffentliches Schlüsselzertifikat bei Google zu registrieren.
- SSO-Einstellungen einrichten: Mit den SSO-Einstellungen der Admin Settings API können Sie die Einstellungen für die Kommunikation mit den Servern des Identitätsanbieters der Domain konfigurieren.
- Gateway- und Routingeinstellungen
Über diesen Feed können Domainadministratoren das Routing von E-Mails für ihre Domains steuern.
Mit den E-Mail-Weiterleitungsaktionen können Administratoren die E-Mail-Weiterleitungseinstellungen auf Domainebene festlegen. Das ähnelt der E-Mail-Weiterleitungsfunktion in den Gmail-Einstellungen der Admin-Konsole. Weitere Informationen finden Sie unter E-Mail-Routing und Konfiguration der zweifachen Zustellung der E-Mail-Weiterleitungsfunktion.
Beispiel für eine XML-Anfrage und -Antwort der Admin Settings API
In diesem Dokument finden Sie Codebeispiele für einfache Admin Settings API-Anfragen und ‑Antworten mit Roh-XML und HTTP. Dieses Beispiel für die Standardsprache der Domain zeigt die vollständige XML- und HTTP-Syntax für den Textkörper einer Anfrage und Antwort, der für jeden Vorgang gleich ist:
Wenn Sie die Einstellung für das ausgehende E-Mail-Gateway der Domain ändern möchten, senden Sie eine HTTP-PUT
an die Gateway-Feed-URL:
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway
Die Standardsprache der Domain PUT
für AtomPub-Anfragen entry
XML ist:
<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>
Mit Ausnahme der aktionsspezifischen Properties und Werte stellen die atom:property
-Elemente ein einzelnes Schlüssel/Wert-Paar dar, das Informationen zu einer Property enthält, die Sie abrufen oder aktualisieren möchten. Diese sind für alle API-Anfragekörper für die Einstellungen für Administratoren gleich.
Das Element entry
der Antwort zur Standardsprache der Domain gibt die Eigenschaften smartHost
und smtpMode
sowie die XML-Syntax zurück, die für alle Antworttexte der Admin Settings API üblich ist:
<?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>
Einstellungen für die Einmalanmeldung verwalten
Mit der Einmalanmeldung (SSO) von Google Workspace können sich Nutzer bei mehreren Diensten anmelden, ohne jedes Mal Anmeldedaten eingeben zu müssen. Dieses Passwort wird vom Identitätsanbieter der Domain und nicht von Google Workspace gespeichert. Weitere Informationen finden Sie auf der SSO-Seite in der Hilfe. In den folgenden Abschnitten wird das XML-Format für die Einstellungen für die Einmalanmeldung veranschaulicht.
Einstellungen für die Einmalanmeldung abrufen
Wenn Sie die Einstellungen für die Einmalanmeldung abrufen möchten, senden Sie eine HTTP-GET
an die allgemeine Feed-URL der SSO und fügen Sie einen Authorization
-Header hinzu, wie unter Authentifizierung beim Dienst „Verwaltungseinstellungen“ beschrieben. Informationen zu Fehlermeldungen finden Sie unter SSO-Fehler beheben:
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general
Dieser Vorgang hat keine Parameter im Anfragetext.
Bei einer erfolgreichen Antwort wird der Statuscode „HTTP 200 OK
“ zusammen mit einem AtomPub-Feed mit den SSO-Einstellungen der Domain zurückgegeben.
Die GET-Antwort-XML gibt die Eigenschaften samlSignonUri
, samlLogoutUri
, changePasswordUri
, enableSSO
, ssoWhitelist
und useDomainSpecificIssuer
zurück:
<?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>
Zu den Properties gehören:
- samlSignonUri
- Die URL des Identitätsanbieters, an die Google Workspace die SAML-Anfrage für die Nutzerauthentifizierung sendet.
- samlLogoutUri
- Die Adresse, an die Nutzer weitergeleitet werden, wenn sie sich von der Webanwendung abmelden.
- changePasswordUri
- Die Adresse, an die Nutzer weitergeleitet werden, wenn sie ihr SSO-Passwort für die Webanwendung ändern möchten.
- enableSSO
- Aktiviert die SAML-basierte SSO für diese Domain. Wenn Sie zuvor SSO-Einstellungen konfiguriert und anschließend
enableSSO
aufenableSSO=false
gesetzt haben, werden die zuvor eingegebenen Einstellungen weiterhin gespeichert. - ssoWhitelist
- Eine ssoWhitelist ist eine Netzwerkmaske im CIDR-Format (Classless Inter-Domain Routing). Mit der ssoWhitelist wird festgelegt, welche Nutzer sich über die Einmalanmeldung und welche Nutzer sich über die Authentifizierungsseite des Google Workspace-Kontos anmelden. Wenn keine Masken angegeben sind, melden sich alle Nutzer mit SSO an. Weitere Informationen finden Sie unter Funktionsweise von Netzwerkmasken.
- useDomainSpecificIssuer
- In der SAML-Anfrage an den Identitätsanbieter kann ein domainspezifischer Aussteller verwendet werden. Diese Funktion ist für die meisten SSO-Bereitstellungen zwar nicht erforderlich, aber nützlich für große Unternehmen, die einen einzelnen Identitätsanbieter verwenden, um eine gesamte Organisation mit mehreren Subdomains zu authentifizieren. Anhand des Domainausstellers wird festgelegt, welche Subdomain der Anfrage zugeordnet werden soll. Weitere Informationen finden Sie unter Wie funktioniert das Issuer-Element in der SAML-Anfrage?
Wenn Ihre Anfrage aus irgendeinem Grund fehlschlägt, wird ein anderer Statuscode zurückgegeben. Weitere Informationen zu den Statuscodes der Google Data API finden Sie unter HTTP-Statuscodes.
Einstellungen für die Einmalanmeldung aktualisieren
Wenn Sie die SSO-Einstellungen einer Domain aktualisieren möchten, rufen Sie die SSO-Einstellungen zuerst mit dem Vorgang SSO-Einstellungen abrufen ab, ändern Sie sie und senden Sie dann eine PUT
-Anfrage an die SSO-Feed-URL. Der Wert für <id>
in Ihrem aktualisierten Eintrag muss genau mit dem <id>
des vorhandenen Eintrags übereinstimmen. Fügen Sie einen Authorization
-Header hinzu, wie unter Authentifizierung beim Admin-Einstellungen API-Dienst beschrieben. Informationen zu Fehlermeldungen finden Sie unter Fehlerbehebung bei der SSO-Nutzung.
Senden Sie beim Aktualisieren der Einstellungen für die Einmalanmeldung eine HTTP-PUT-Anfrage an die allgemeine Feed-URL für die SSO:
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general
Der XML-Text der PUT
-Anfrage lautet:
<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>
Bei einer erfolgreichen Antwort wird der Statuscode „HTTP 200 OK
“ zusammen mit einem AtomPub-Feed mit den SSO-Einstellungen zurückgegeben.
Die PUT
-Antwort-XML lautet:
<?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>
Wenn Ihre Anfrage aus irgendeinem Grund fehlschlägt, wird ein anderer Statuscode zurückgegeben. Weitere Informationen zu den Statuscodes der Google Data API finden Sie unter HTTP-Statuscodes.
Änderungen an den Einstellungen für die Einmalanmeldung sind nicht zulässig, wenn der Zielkunde die Genehmigung durch mehrere Parteien für vertrauliche Aktionen aktiviert hat. Anfragen mit errorCode="1811"
und reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval"
schlagen fehl.
Signaturschlüssel für die Einmalanmeldung abrufen
Wenn Sie den Signaturschlüssel für die Einmalanmeldung abrufen möchten, senden Sie eine HTTP-GET
an die Feed-URL des Signaturschlüssels für die Einmalanmeldung und fügen Sie einen Authorization
-Header hinzu, wie unter Authentifizierung beim Dienst „Verwaltungseinstellungen“ beschrieben. Informationen zu Fehlermeldungen finden Sie unter SSO-Fehler beheben:
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey
Dieser Vorgang hat keine Parameter im Anfragetext.
Bei einer erfolgreichen Antwort wird der Statuscode „HTTP 200 OK
“ zusammen mit einem AtomPub-Feed mit dem Signaturschlüssel zurückgegeben.
Die GET
-Antwort-XML gibt das Attribut signingKey
zurück:
<?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>
Wenn Ihre Anfrage aus irgendeinem Grund fehlschlägt, wird ein anderer Statuscode zurückgegeben. Weitere Informationen zu den Statuscodes der Google Data API finden Sie unter HTTP-Statuscodes.
Signaturschlüssel für die Einmalanmeldung aktualisieren
Wenn Sie den SSO-Signaturschlüssel einer Domain aktualisieren möchten, rufen Sie den Signaturschlüssel zuerst mit dem Vorgang Abrufen des Signaturschlüssels für die Einmalanmeldung ab, ändern Sie ihn und senden Sie dann eine PUT
-Anfrage an die Feed-URL des SSO-Signaturschlüssels. Der Wert für <id>
in Ihrem aktualisierten Eintrag muss genau mit dem <id>
des vorhandenen Eintrags übereinstimmen. Weitere Informationen zu SAML-basierten Signaturschlüsseln für die Einmalanmeldung finden Sie unter Schlüssel und Zertifikate für den Google Workspace-Dienst zur Einmalanmeldung generieren.
Senden Sie beim Aktualisieren des Signaturschlüssels für die Einmalanmeldung eine HTTP-PUT
an die Feed-URL des Signaturschlüssels für die Einmalanmeldung:
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey
Die PUT
-Anfrage-XML lautet:
<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>
Änderungen an den Einstellungen für die Einmalanmeldung sind nicht zulässig, wenn der Zielkunde die Genehmigung durch mehrere Parteien für vertrauliche Aktionen aktiviert hat. Anfragen mit errorCode="1811"
und reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval"
schlagen fehl.
E-Mail-Gateway und -Routing verwalten
Im Abschnitt zum ausgehenden E-Mail-Gateway wird gezeigt, wie die Admin Settings API das ausgehende Routing von E-Mails von Nutzern in Ihrer Domain unterstützt. Im Abschnitt zum E-Mail-Weiterleiten wird beschrieben, wie Nachrichten an einen anderen Mailserver weitergeleitet werden.
Einstellungen für das Ausgangs-E-Mail-Gateway abrufen
Wenn Sie die Einstellungen für ausgehende E-Mail-Gateways abrufen möchten, senden Sie eine HTTP-GET
an die Gateway-Feed-URL und fügen Sie einen Authorization
-Header hinzu, wie unter Authentifizierung beim Dienst „Verwaltungseinstellungen“ beschrieben:
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway
Dieser Vorgang hat keine Parameter im Anfragetext.
Bei einer erfolgreichen Antwort wird der Statuscode „HTTP 200 OK“ zusammen mit einem AtomPub-Feed mit den Informationen zum Status des E-Mail-Gateways zurückgegeben.
Die GET
-Antwort gibt die Properties smartHost
und smtpMode
zurück. Weitere Informationen zu diesen Properties finden Sie unter Einstellungen für ausgehende E-Mail-Gateways aktualisieren.
Hier ist ein Beispiel für eine mögliche Antwort:
<?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>
Wenn Ihre Anfrage aus irgendeinem Grund fehlschlägt, wird ein anderer Statuscode zurückgegeben. Weitere Informationen zu den Statuscodes der Google Data API finden Sie unter HTTP-Statuscodes.
Einstellungen für das Ausgangs-E-Mail-Gateway aktualisieren
Wenn Sie die Einstellung für das ausgehende E-Mail-Gateway einer Domain aktualisieren möchten, senden Sie eine HTTP-PUT
-Anfrage an die Gateway-Feed-URL:
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway
Die PUT
-Anfrage-XML lautet:
<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>
Die Anfrageeigenschaften sind:
- smartHost
- Die IP-Adresse oder der Hostname Ihres SMTP-Servers. Google Workspace leitet ausgehende E-Mails an diesen Server weiter.
- smtpMode
- Der Standardwert ist „SMTP“. Mit dem Wert „SMTP_TLS“ wird beim Senden der Nachricht eine TLS-Verbindung gesichert.
Bei einer erfolgreichen Antwort wird der Statuscode „HTTP 200 OK
“ zusammen mit dem AtomPub-Feed mit dem Status der E-Mail-Gateway-Einstellungen zurückgegeben.
Wenn Ihre Anfrage aus irgendeinem Grund fehlschlägt, wird ein anderer Statuscode zurückgegeben. Weitere Informationen zu den Statuscodes der Google Data API finden Sie unter HTTP-Statuscodes.
Einstellungen für das E-Mail-Routing verwalten
Erstellen Sie zuerst eine XML-Anfrage:
<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>
Die Anfrageeigenschaften sind:
- routeDestination
- Dieses Ziel ist der Hostname oder die IP-Adresse des SMTP-In-Mailservers, an den die E-Mail weitergeleitet wird. Der Hostname oder die IP-Adresse muss für Google aufgelöst werden. Weitere Informationen zum Auflösen von E-Mail-Hostnamen finden Sie im Hilfeartikel Google Workspace mit E-Mail-Routing testen.
- routeRewriteTo
- Wenn „wahr“ festgelegt ist, wird das Feld
to:
des SMTP-Umschlags der Nachricht in den Ziel-Hostnamen (Hostname von „user@destination“) geändert und die Nachricht wird an diese Nutzeradresse auf dem Ziel-Mailserver zugestellt. Wennfalse
, wird die E-Mail an dieto:
-E-Mail-Adresse (Nutzer@ursprünglicher Hostname) der ursprünglichen Nachricht auf dem Ziel-E-Mail-Server zugestellt. Das entspricht der Einstellung „SMTP-Umschlag ändern“ in der Admin-Konsole. Weitere Informationen finden Sie unter Domaineinstellungen für das E-Mail-Routing. - routeEnabled
- Wenn
true
, ist die E-Mail-Weiterleitung aktiviert. Wennfalse
angezeigt wird, ist die Funktion deaktiviert. - bounceNotifications
- Wenn
true
festgelegt ist, kann Google Workspace dem Absender Benachrichtigungen über unzustellbare E-Mails senden, wenn die Zustellung fehlschlägt. - accountHandling
Mit dieser Einstellung wird festgelegt, wie verschiedene Nutzertypen in der Domain vom E-Mail-Routing betroffen sind:
allAccounts
– Alle E-Mails werden an dieses Ziel zugestellt.provisionedAccounts
– E-Mails an dieses Ziel senden, wenn der Nutzer in Google Workspace vorhanden ist.unknownAccounts
– E-Mails an dieses Ziel senden, wenn der Nutzer nicht in Google Workspace vorhanden ist. Das entspricht der Einstellung „E-Mail-Adresse für die Zustellung“ in der Admin-Konsole. Weitere Informationen zu den Voraussetzungen und zur Verwendung des E-Mail-Routings finden Sie unter Domaineinstellungen für das E-Mail-Routing. ~ Um diese Anfrage zu veröffentlichen, senden Sie eine HTTP-POST
an die URL des E-Mail-Routing-Feeds und fügen Sie einenAuthorization
-Header hinzu, wie unter Authentifizierung beim Dienst „Verwaltungseinstellungen“ beschrieben:
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/emailrouting
Bei einer erfolgreichen Antwort wird der Statuscode „HTTP 200 OK
“ zusammen mit einem AtomPub-Feed mit den Archivinformationen zurückgegeben.
Wenn Ihre Anfrage aus irgendeinem Grund fehlschlägt, wird ein anderer Statuscode zurückgegeben. Weitere Informationen zu den Statuscodes der Google Data API finden Sie unter HTTP-Statuscodes.
Einstellung der Endpunkte am 31. Oktober 2018
Die folgenden Endpunkte wurden in dieser Ankündigung eingestellt. Sie wurden am 31. Oktober 2018 eingestellt und sind nicht mehr verfügbar.
- 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