REST Resource: accounts

Ressource: 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.

JSON-Darstellung 
{
  "name": string,
  "accountName": string,
  "primaryOwner": string,
  "type": enum (AccountType),
  "role": enum (AccountRole),
  "verificationState": enum (VerificationState),
  "vettedState": enum (VettedState),
  "accountNumber": string,
  "permissionLevel": enum (PermissionLevel),
  "organizationInfo": {
    object (OrganizationInfo)
  }
}
Felder
name

string

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

string

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

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

enum (AccountType)

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

enum (AccountRole)

Nur Ausgabe Gibt die AccountRole dieses Kontos an.
verificationState

enum (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.
vettedState

enum (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.
accountNumber

string

Nur Ausgabe Referenznummer des Kontos, falls bereitgestellt.
permissionLevel

enum (PermissionLevel)

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

object (OrganizationInfo)

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

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

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.

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.

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.

OrganizationInfo

Zusätzliche für eine Organisation gespeicherte Informationen.

JSON-Darstellung 
{
  "registeredDomain": string,
  "address": {
    object (PostalAddress)
  },
  "phoneNumber": string
}
Felder
registeredDomain

string

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

object (PostalAddress)

Nur Ausgabe Die Postanschrift des Kontos.
phoneNumber

string

Nur Ausgabe Kontaktnummer der Organisation

PostalAddress

Stellt eine Postadresse dar, z. B. für Postzustellungs- oder Zahlungsadressen. Mit einer Postadresse kann ein Postdienst Artikel an eine Einrichtung, ein Postfach oder eine andere Adresse liefern. Sie stellt kein Modell eines geografischen Standorts (Straßen, Städte, Berge) dar.

Normalerweise wird eine Adresse je nach Prozesstyp durch eine Nutzereingabe oder den Import vorhandener Daten erstellt.

Hinweise zur Adresseingabe/-bearbeitung: Verwenden Sie ein zur Internationalisierung bereites Adress-Widget wie https://github.com/google/libaddressinput. Nutzer sollten außerhalb der Länder, in denen dieses Feld verwendet wird, keine UI-Elemente für die Eingabe oder Bearbeitung von Feldern sehen.

Weitere Informationen zur Verwendung dieses Schemas finden Sie unter https://support.google.com/business/answer/6397478.

JSON-Darstellung 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Felder
revision

integer

Die Schemaversion von PostalAddress. Die Einstellung muss 0 lauten, was der aktuellen Überarbeitung entspricht.

Alle neuen Überarbeitungen müssen abwärtskompatibel zu alten Überarbeitungen sein.
regionCode

string

Erforderlich. CLDR-Regionscode des Landes bzw. der Region der Adresse. Er wird nie abgeleitet. Der Nutzer muss sicherstellen, dass der Wert richtig ist. Weitere Informationen finden Sie unter https://cldr.unicode.org/ und https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Beispiel: "CH" für die Schweiz.
languageCode

string

Optional. BCP-47-Sprachencode des Inhalts dieser Adresse, falls bekannt. Dies ist oft die Sprache der UI des Eingabeformulars oder die Sprache, die mit einer der verwendeten Sprachen des Landes bzw. der Region mit der Adresse oder der entsprechenden Transliteration übereinstimmt. In bestimmten Ländern hat dies Auswirkungen auf die Formatierung. Es ist jedoch nicht entscheidend für die Richtigkeit der Daten und hat niemals Auswirkungen auf Validierungen oder andere nicht formatierungsbezogene Vorgänge.

Wenn dieser Wert nicht bekannt ist, sollte er weggelassen werden. Das ist besser, als einen möglicherweise falschen Wert anzugeben.

Beispiele: "zh-Hant", "ja", "ja-Latn", "en"
postalCode

string

Optional. Postleitzahl der Adresse. Postleitzahlen werden nicht in allen Ländern verwendet oder benötigt. Dort, wo sie verwendet werden, können sie weitere Validierungsvorgänge für andere Adressteile nach sich ziehen, z. B. die Validierung von Bundesstaat/Postleitzahl in den USA.
sortingCode

string

Optional. Zusätzlicher länderspezifischer Sortiercode. Dieser wird nur für wenige Regionen genutzt. Wenn er verwendet wird, ist der Wert entweder ein String wie "CEDEX", optional gefolgt von einer Ziffer (z. B. "CEDEX 7"), oder nur eine Ziffer für den Sektorcode (Jamaika), den Zustellbereichsindikator (Malawi) oder den Postamtindikator (z. B. Elfenbeinküste).
administrativeArea

string

Optional. Höchste administrative Untergliederung, die für Postadressen eines Landes oder einer Region verwendet wird. Dies kann beispielsweise ein Bundesland, eine Provinz, eine Oblast oder eine Präfektur sein. In Spanien ist dies beispielsweise die Provinz und nicht das autonome Gebiet, also z. B. "Barcelona" und nicht "Katalonien". In vielen Ländern werden in der Postadresse keine Verwaltungsgebiete verwendet. Für die Schweiz etwa sollte dieses Feld leer gelassen werden.
locality

string

Optional. Bezieht sich in der Regel auf die Stadt-/Ortsangabe der Adresse. Beispiele: Stadt in den USA, italienische Gemeinde, Post Town in Großbritannien. Lassen Sie in Regionen der Welt, in denen Lokalitäten nicht hinreichend definiert sind oder nicht dieser Struktur entsprechen, diese Angabe leer und verwenden Sie stattdessen "addressLines".
sublocality

string

Optional. Unterlokalität der Adresse. Dies können beispielsweise Stadtviertel, Stadtteile und Bezirke sein.
addressLines[]

string

Offene Adresszeilen, mit denen nachgeordnete Bereiche einer Adresse beschrieben werden können.

Da die Werte in "addressLines" keine Typinformationen beinhalten und manchmal mehrere Werte in einem einzigen Feld enthalten sind, z. B. "Austin, TX", muss die Zeilenreihenfolge deutlich erkennbar sein. Die Reihenfolge der Adresszeilen sollte der Adresse auf einem Briefumschlag für das Land bzw. die Region entsprechen. An Orten, an denen es keine einheitliche Reihenfolge gibt, z. B. in Japan, wird "address_language" verwendet, um dies klar zu machen (z. B. "ja" für die Reihenfolge groß zu klein und "ja-Latn" oder "en" für die Reihenfolge klein zu groß). Auf diese Weise kann die spezifischste Zeile einer Adresse sprachabhängig ausgewählt werden.

Die Mindestangabe für eine zulässige strukturierte Darstellung einer Adresse besteht aus einem "regionCode" und allen verbleibenden Informationen in "addressLines". Eine solche Adresse kann weitgehend angenähert ohne Geocodierung formatiert werden. Es wäre jedoch erst dann eine semantische Argumentation zu einer der Adresskomponenten möglich, wenn diese zumindest teilweise aufgelöst wird.

Es empfiehlt sich, für vollständig unstrukturierte Adressen eine Adresse mit einem "regionCode" und "adressLines" zu erstellen und danach eine Geocodierung dafür durchzuführen. So muss nicht geraten werden, welche Teile der Adresse Orte oder administrative Gebiete darstellen.
recipients[]

string

Optional. Der Empfänger an der Adresse. Dieses Feld kann in bestimmten Fällen mehrere Zeilen lange Informationen enthalten. Beispielsweise kann es Informationen der Art "wohnhaft bei" enthalten.
organization

string

Optional. Der Name der Organisation an der Adresse.

Methoden

create

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

get

 Ruft das angegebene Konto ab.

list

 Listet alle Konten für den authentifizierten Nutzer auf.

patch

 Aktualisiert das angegebene Unternehmenskonto.