Package google.mybusiness.accountmanagement.v1

Index

AccessControl

Mit diesem Dienst können Sie die Nutzer verwalten, die Zugriff auf Konten und Standorte haben.

AcceptInvitation

rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty)

Nimmt die angegebene Einladung an.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
CreateAccountAdmin

rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin)

Lädt den angegebenen Nutzer ein, Administrator für das angegebene Konto zu werden. Die eingeladene Person muss die Einladung annehmen, um Zugriff auf das Konto zu erhalten. Unter [AcceptInvitation] [google.mybusiness.accountmanagement.v1.AcceptInvitation] können Sie eine Einladung programmatisch annehmen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
CreateLocationAdmin

rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin)

Lädt den angegebenen Nutzer ein, Administrator für den angegebenen Standort zu werden. Der Eingeladene muss die Einladung annehmen, um Zugriff auf den Standort zu erhalten. Unter [AcceptInvitation] [google.mybusiness.accountmangement.v1.AcceptInvitation] können Sie eine Einladung programmatisch annehmen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
DeclineInvitation

rpc DeclineInvitation(DeclineInvitationRequest) returns (Empty)

Lehnt die angegebene Einladung ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
DeleteAccountAdmin

rpc DeleteAccountAdmin(DeleteAccountAdminRequest) returns (Empty)

Der angegebene Administrator wird aus dem angegebenen Konto entfernt.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
DeleteLocationAdmin

rpc DeleteLocationAdmin(DeleteLocationAdminRequest) returns (Empty)

Der angegebene Administrator wird für den angegebenen Standort als Administrator entfernt.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
ListAccountAdmins

rpc ListAccountAdmins(ListAccountAdminsRequest) returns (ListAccountAdminsResponse)

Listet die Administratoren für das angegebene Konto auf.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
ListInvitations

rpc ListInvitations(ListInvitationsRequest) returns (ListInvitationsResponse)

Hier werden ausstehende Einladungen für das angegebene Konto aufgelistet.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
ListLocationAdmins

rpc ListLocationAdmins(ListLocationAdminsRequest) returns (ListLocationAdminsResponse)

Listet alle Administratoren für den angegebenen Standort auf.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
TransferLocation

rpc TransferLocation(TransferLocationRequest) returns (Empty)

Verschiebt einen Standort von einem Konto, dessen Inhaber der Nutzer ist, in ein anderes Konto, das derselbe Nutzer verwaltet. Der Nutzer muss Inhaber des Kontos sein, mit dem der Standort derzeit verknüpft ist, und mindestens Administrator des Zielkontos sein.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
UpdateAccountAdmin

rpc UpdateAccountAdmin(UpdateAccountAdminRequest) returns (Admin)

Aktualisiert den Administrator für den angegebenen Kontoadministrator.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
UpdateLocationAdmin

rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (Admin)

Aktualisiert den Administrator für den angegebenen Standort. Nur die AdminRole des Administrators kann aktualisiert werden.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.

Konten

Diese API ermöglicht die Verwaltung von Unternehmenskonten auf Google. Er definiert folgendes Ressourcenmodell:

  • Die API enthält eine Sammlung von Kontoressourcen mit dem Namen accounts/*.

  • Der Einfachheit halber können Sie für das private Konto des authentifizierten Anrufers das Synonym "ich" anstelle der Konto-ID verwenden. Beispiele: GET /v1/accounts/me GET /v1/accounts/me/locations

CreateAccount

rpc CreateAccount(CreateAccountRequest) returns (Account)

Erstellt ein Konto mit dem angegebenen Namen und Typ unter dem angegebenen übergeordneten Element.

  • Private Konten und Organisationen können nicht erstellt werden.
  • User-Gruppen können nicht mit einem privaten Konto als primärer Eigentümer erstellt werden.
  • Standortgruppen können nicht mit dem primären Inhaber eines privaten Kontos erstellt werden, wenn sich das private Konto zu einer Organisation befindet.
  • Standortgruppen können nicht Inhaber von Standortgruppen sein.
Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Ruft das angegebene Konto ab. Gibt NOT_FOUND zurück, wenn das Konto nicht existiert oder der Aufrufer keine Zugriffsrechte dafür hat.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

Listet alle Konten für den authentifizierten Nutzer auf. Dazu gehören alle Konten, die dem Nutzer gehören, sowie alle Konten, für die der Nutzer Verwaltungsrechte hat.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

Aktualisiert das angegebene Unternehmenskonto. Private Konten können mit dieser Methode nicht aktualisiert werden.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.

AcceptInvitationRequest

Anfragenachricht für AccessControl.AcceptInvitation

Felder
name

string

Erforderlich. Name der angenommenen Einladungaccounts/{account_id}/invitations/{invitation_id}

Konto

Ein Konto ist ein Container für Ihren Standort. Wenn Sie der einzige Nutzer sind, der Standorte für Ihr Unternehmen verwaltet, können Sie Ihr privates Google-Konto verwenden. Wenn Sie Standorte mit mehreren Nutzern verwalten möchten, erstellen Sie ein Unternehmenskonto.

Felder
name

string

Nicht veränderbar. Der Ressourcenname im Format accounts/{account_id}.
account_name

string

Erforderlich. Der Name des Kontos. Bei einem Konto vom Typ PERSONAL ist dies der Vor- und Nachname des Nutzerkontos.
primary_owner

string

Erforderlich. Nur Eingabe. Der Ressourcenname des Kontos, das der primäre Inhaber des zu erstellenden Kontos ist. Sie sollte das Format accounts/{account_id} haben.
type

AccountType

Erforderlich. Enthält den Kontotyp. Konten vom Typ PERSONAL und ORGANISATION können nicht mit dieser API erstellt werden.
role

AccountRole

Nur Ausgabe Gibt die AccountRole dieses Kontos an.
verification_state

VerificationState

Nur Ausgabe Nach der Bestätigung werden neu erstellte Standorte automatisch mit Google Maps verknüpft und es werden automatisch Google+ Seiten erstellt, ohne dass eine Moderation erforderlich ist.
vetted_state

VettedState

Nur Ausgabe Gibt an, ob das Konto von Google geprüft wurde. Mit einem überprüften Konto können Standorte über die VETTED_PARTNER-Methode bestätigt werden.
account_number

string

Nur Ausgabe Referenznummer des Kontos, falls bereitgestellt.
permission_level

PermissionLevel

Nur Ausgabe Gibt die Berechtigungsstufe an, die der Nutzer für dieses Konto hat.
organization_info

OrganizationInfo

Nur Ausgabe Zusätzliche Informationen für eine Organisation. Dieses Feld wird nur für ein Organisationskonto ausgefüllt.

AccountRole

Gibt die Zugriffsebene an, die der authentifizierte Nutzer für dieses Konto hat. Weitere Informationen

Enums
ACCOUNT_ROLE_UNSPECIFIED Nicht angegeben.
PRIMARY_OWNER Der Nutzer ist der primäre Inhaber dieses Kontos.
OWNER Der Inhaber des Kontos.
MANAGER Der Nutzer kann dieses Konto verwalten.
SITE_MANAGER Der Nutzer kann eine begrenzte Anzahl von Funktionen für das Konto verwalten.

AccountType

Gibt an, um welche Art von Konto es sich handelt: entweder ein privates Konto/Nutzerkonto oder ein Geschäftskonto.

Enums
ACCOUNT_TYPE_UNSPECIFIED Nicht angegeben.
PERSONAL Ein Endnutzerkonto.
LOCATION_GROUP Eine Gruppe von Standorten. Weitere Informationen
USER_GROUP Eine User-Gruppe, mit der Mitarbeiter einer Organisation in Gruppen eingeteilt werden können. Weitere Informationen
ORGANIZATION Eine Organisation, die ein Unternehmen vertritt. Weitere Informationen

OrganizationInfo

Zusätzliche für eine Organisation gespeicherte Informationen.

Felder
registered_domain

string

Nur Ausgabe Die registrierte Domain für das Konto.
address

PostalAddress

Nur Ausgabe Die Postanschrift des Kontos.
phone_number

string

Nur Ausgabe Kontaktnummer der Organisation

PermissionLevel

Gibt die Zugriffsebene an, die der authentifizierte Nutzer für dieses Konto hat.

Enums
PERMISSION_LEVEL_UNSPECIFIED Nicht angegeben.
OWNER_LEVEL Der Nutzer hat eine Berechtigung auf Inhaberebene.
MEMBER_LEVEL Der Nutzer hat eine Berechtigung auf Mitgliederebene.

VerificationState

Gibt den Bestätigungsstatus des Kontos an.

Enums
VERIFICATION_STATE_UNSPECIFIED Nicht angegeben.
VERIFIED Bestätigtes Konto.
UNVERIFIED Das Konto ist nicht bestätigt und es wurde keine Bestätigung beantragt.
VERIFICATION_REQUESTED Das Konto ist nicht bestätigt, aber eine Bestätigung wurde angefordert.

VettedState

Gibt den überprüften Status eines Kontos an.

Enums
VETTED_STATE_UNSPECIFIED Nicht angegeben
NOT_VETTED Das Konto wurde nicht von Google überprüft.
VETTED Das Konto wurde von Google geprüft und hat einen gültigen Status. Ein Konto wird automatisch überprüft, wenn es direkten Zugriff auf ein überprüftes Gruppenkonto hat.
INVALID Das Konto wurde überprüft, hat jedoch einen ungültigen Status. Das Konto verhält sich wie ein nicht überprüftes Konto.

Administrator

Administrator eines Kontos oder Standorts

Felder
name

string

Nicht veränderbar. Der Ressourcenname Für Kontoadministratoren hat das folgende Format: accounts/{account_id}/admins/{admin_id}

Für Standortadministratoren hat sie das folgende Format: locations/{location_id}/admins/{admin_id}

Dieses Feld wird ignoriert, wenn es beim Erstellen des Administrators festgelegt wird.
admin

string

Optional. Der Name des Administrators. Bei der ersten Einladung ist dies die E-Mail-Adresse der eingeladenen Person. Bei GET-Aufrufen wird die E-Mail-Adresse des Nutzers zurückgegeben, wenn die Einladung noch aussteht. Andernfalls enthält er den Vor- und Nachnamen des Nutzers.

Dieses Feld muss nur beim Erstellen durch den Administrator festgelegt werden.
account

string

Nicht veränderbar. Der Name der Kontoressource, auf die dieser Administrator verweist. Wird beim Aufrufen von „locations.admins.create“ verwendet, um eine Standortgruppe als Administrator einzuladen.

Wenn sowohl dieses Feld als auch admin in CREATE-Anfragen festgelegt sind, hat dieses Feld Vorrang und die E-Mail-Adresse in admin wird ignoriert.

Format: accounts/{account}
role

AdminRole

Erforderlich. Gibt die Rolle an, die dieser Administrator mit dem angegebenen Konto oder Standort verwendet.
pending_invitation

bool

Nur Ausgabe Gibt an, ob dieser Administrator eine ausstehende Einladung für die angegebene Ressource hat.

AdminRole

Gibt die Zugriffsebene eines Administrators an. Weitere Informationen

Enums
ADMIN_ROLE_UNSPECIFIED Nicht angegeben.
PRIMARY_OWNER Der Administrator hat Zugriff auf Inhaberebene und ist der primäre Inhaber. (wird in der Benutzeroberfläche als „Primärer Inhaber“ angezeigt).
OWNER Der Administrator hat Zugriff auf Inhaberebene. (wird in der Benutzeroberfläche als „Eigentümer“ angezeigt).
MANAGER Der Administrator hat Verwaltungszugriff.
SITE_MANAGER Der Administrator kann Seiten sozialer Netzwerke (Google+) verwalten. Auf der Benutzeroberfläche wird „Site Manager“ angezeigt. Mit dieser API kann kein Kontoadministrator mit der Rolle SITE_MANAGER erstellt werden.

CreateAccountAdminRequest

Anfragenachricht für AccessControl.CreateAccountAdmin.

Felder
parent

string

Erforderlich. Der Ressourcenname des Kontos, für das dieser Administrator erstellt wurde. accounts/{account_id}.
admin

Admin

Erforderlich. Der zu erstellende Administrator. Die Rolle darf nicht SITE_MANAGER sein.

CreateAccountRequest

Anfragenachricht für Accounts.CreateAccount.

Felder
account

Account

Erforderlich. Kontoinformationen für das Konto, das erstellt werden soll. Die einzigen zulässigen Felder sind „account“ (Konto) und „type“ (Typ).

CreateLocationAdminRequest

Anfragenachricht für AccessControl.CreateLocationAdmin.

Felder
parent

string

Erforderlich. Der Ressourcenname des Standorts, für den dieser Administrator erstellt wurde. locations/{location_id}/admins.
admin

Admin

Erforderlich. Der Administrator, der erstellt werden soll.

DeclineInvitationRequest

Anfragenachricht für AccessControl.RejectInvitation

Felder
name

string

Erforderlich. Der Name der Kontoeinladung, die abgelehnt wird. accounts/{account_id}/invitations/{invitation_id}

DeleteAccountAdminRequest

Anfragenachricht für AccessControl.DeleteAccountAdmin.

Felder
name

string

Erforderlich. Der Ressourcenname des Administrators, der aus dem Konto entfernt werden soll. accounts/{account_id}/admins/{admin_id}.

DeleteLocationAdminRequest

Anfragenachricht für AccessControl.DeleteLocationAdmin

Felder
name

string

Erforderlich. Der Ressourcenname des Administrators, der aus dem Standort entfernt werden soll.

GetAccountRequest

Anfragenachricht für Accounts.GetAccount.

Felder
name

string

Erforderlich. Der Name des abzurufenden Kontos.

Einladung

Stellt eine ausstehende Einladung dar.

Felder
name

string

Erforderlich. Der Ressourcenname für die Einladung. accounts/{account_id}/invitations/{invitation_id}.
role

AdminRole

Nur Ausgabe Die eingeladene Rolle im Konto.
target_type

TargetType

Nur Ausgabe Gibt an, welche Zieltypen in der Antwort enthalten sein sollen.
Union-Feld target. Gibt das Ziel an, für das diese Einladung bestimmt ist. Für target ist nur einer der folgenden Werte zulässig:
target_account

Account

Das Konto mit wenigen Daten, für das diese Einladung bestimmt ist.
target_location

TargetLocation

Die Zielregion, für die diese Einladung bestimmt ist.

TargetLocation

Eine Zielregion für eine ausstehende Einladung.

Felder
location_name

string

Der Name des Standorts, zu dem der Nutzer eingeladen wurde.
address

string

Die Adresse des Standorts, zu dem der Nutzer eingeladen wird.

TargetType

Die Art des Ziels, für das eine Einladung bestimmt ist.

Enums
TARGET_TYPE_UNSPECIFIED Wird festgelegt, wenn kein Zieltyp angegeben ist.
ACCOUNTS_ONLY Einladungen werden nur für Ziele vom Typ „Konto“ aufgelistet.
LOCATIONS_ONLY Einladungen nur für Ziele vom Typ „Standort“ auflisten.

ListAccountAdminsRequest

Anfragenachricht für AccessControl.ListAccountAdmins.

Felder
parent

string

Erforderlich. Der Name des Kontos, von dem eine Liste der Administratoren abgerufen werden soll. accounts/{account_id}/admins.

ListAccountAdminsResponse

Antwortnachricht für AccessControl.ListAccountAdmins.

Felder
account_admins[]

Admin

Eine Sammlung von Administratorinstanzen.

ListAccountsRequest

Anfragenachricht für Accounts.ListAccounts

Felder
parent_account

string

Optional. Der Ressourcenname des Kontos, für das die Liste der direkt zugänglichen Konten abgerufen werden soll. Dies ist nur für Organisationen und Nutzergruppen sinnvoll. Wenn leer, wird ListAccounts für den authentifizierten Nutzer zurückgegeben. accounts/{account_id}.
page_size

int32

Optional. Die Anzahl der Konten, die pro Seite abgerufen werden sollen. Die Standard- und der Höchstwert sind 20.
page_token

string

Optional. Wenn angegeben, wird die nächste Seite mit Konten abgerufen. pageToken wird zurückgegeben, wenn bei einem Aufruf von accounts.list mehr Ergebnisse zurückgegeben werden, als in die angeforderte Seitengröße passen.
filter

string

Optional. Ein Filter, der die Rückgabe der Konten einschränkt. Die Antwort enthält nur Einträge, die dem Filter entsprechen. Wenn filter leer ist, werden keine Einschränkungen angewendet und alle Konten (paginiert) werden für das angeforderte Konto abgerufen.

Eine Anfrage mit dem Filter type=USER_GROUP gibt beispielsweise nur Nutzergruppen zurück.

Das Feld type ist der einzige unterstützte Filter.

ListAccountsResponse

Antwortnachricht für Accounts.ListAccounts

Felder
accounts[]

Account

Eine Sammlung von Konten, auf die der Nutzer Zugriff hat. Das private Konto des Nutzers, der die Abfrage durchführt, ist immer das erste Element des Ergebnisses, sofern es nicht herausgefiltert wird.
next_page_token

string

Wenn die Anzahl der Konten die angeforderte Seitengröße überschreitet, wird dieses Feld mit einem Token gefüllt, um bei einem nachfolgenden Aufruf von accounts.list die nächste Seite mit Konten abzurufen. Wenn keine weiteren Konten vorhanden sind, ist dieses Feld nicht in der Antwort vorhanden.

ListInvitationsRequest

Anfragenachricht für AccessControl.ListInvitations

Felder
parent

string

Erforderlich. Der Name des Kontos, über das die Liste der Einladungen abgerufen wird. accounts/{account_id}/invitations
filter

string

Optional. Die Antwort kann über das Feld „Invitation.target_type“ gefiltert werden.

ListInvitationsResponse

Antwortnachricht für AccessControl.ListInvitations

Felder
invitations[]

Invitation

Eine Sammlung von ausstehenden Einladungen für das Konto Die Anzahl der hier aufgeführten Einladungen darf 1.000 nicht überschreiten.

ListLocationAdminsRequest

Anfragenachricht für AccessControl.ListLocationAdmins

Felder
parent

string

Erforderlich. Der Name des Standorts, für den Administratoren aufgelistet werden sollen locations/{location_id}/admins.

ListLocationAdminsResponse

Antwortnachricht für AccessControl.ListLocationAdmins.

Felder
admins[]

Admin

Eine Sammlung von Administratoren.

TransferLocationRequest

Anfragenachricht für AccessControl.TransferLocation.

Felder
name

string

Erforderlich. Der Name des zu übertragenden Standorts. locations/{location_id}.
destination_account

string

Erforderlich. Name der Kontoressource, auf die der Standort übertragen werden soll (z. B. „accounts/{account}“).

UpdateAccountAdminRequest

Anfragenachricht für AccessControl.UpdateAccountAdmin.

Felder
account_admin

Admin

Erforderlich. Die aktualisierte Version der Admin-Konsole.
update_mask

FieldMask

Erforderlich. Die Felder, die aktualisiert werden sollen. Das einzige bearbeitbare Feld ist die Rolle.

UpdateAccountRequest

Anfragenachricht für Accounts.UpdateAccount

Felder
account

Account

Erforderlich. Das aktualisierte Konto.
update_mask

FieldMask

Erforderlich. Die Felder, die aktualisiert werden sollen. Das einzige bearbeitbare Feld ist accountName.
validate_only

bool

Optional. Bei „true“ wird die Anfrage validiert, ohne dass das Konto tatsächlich aktualisiert wird.

UpdateLocationAdminRequest

Anfragenachricht für AccessControl.UpdateLocationAdmin

Felder
location_admin

Admin

Erforderlich. Die aktualisierte Version der Admin-Konsole.
update_mask

FieldMask

Erforderlich. Die Felder, die aktualisiert werden sollen. Das einzige bearbeitbare Feld ist die Rolle.