REST-Ressource: accounts.customers

Ressource: Kunde

Entität, die den Kunden eines Resellers oder Händlers darstellt.

JSON-Darstellung 

{
  "name": string,
  "orgDisplayName": string,
  "orgPostalAddress": {
    object(PostalAddress)
  },
  "primaryContactInfo": {
    object(ContactInfo)
  },
  "alternateEmail": string,
  "domain": string,
  "createTime": string,
  "updateTime": string
}
Felder
name

string

Ressourcenname des Kunden im Format "accounts/{account_id}/customers/{customer_id}". Schreibgeschützt.

orgDisplayName

string

Name der Organisation, die die Kundenentität darstellt.

orgPostalAddress

object(PostalAddress)

Adresse der Organisation der Kundenentität. Regionscodes und Postleitzahlen sind für die Einhaltung der US-amerikanischen Gesetze und Embargos erforderlich.

primaryContactInfo

object(ContactInfo)

Primäre Kontaktdaten.

alternateEmail

string

Sekundäre Kontakt-E-Mail-Adresse (erforderlich). Die alternative E-Mail-Adresse und die primäre Kontakt-E-Mail-Adresse müssen unterschiedliche Domains haben.

domain

string

Die vom Kunden verwendete primäre Domain (erforderlich). Die Domain der primären Kontakt-E-Mail-Adresse muss der angegebenen Domain entsprechen.

createTime

string (Timestamp format)

Schreibgeschützt. Der Zeitpunkt, zu dem der Kunde erstellt wird.

Ein Zeitstempel im Format "RFC3339 UTC 'Zulu'" in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Der Zeitpunkt, zu dem der Kunde aktualisiert wird.

Ein Zeitstempel im Format "RFC3339 UTC 'Zulu'" in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".

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 internationalisierungsbereites Adress-Widget wie https://github.com/google/libaddressinput. Nutzer sollten in Ländern, in denen ein Feld nicht verwendet wird, nicht mit UI-Elementen für die Eingabe oder Bearbeitung solcher Felder konfrontiert werden.

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

JSON-Darstellung 

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

number

Die Schemaüberarbeitung 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. Ausführliche Informationen finden Sie unter http://cldr.unicode.org/ und http://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 in der Adresse.

ContactInfo

Stellt die Kontaktdaten für ein Kundenkonto dar.

JSON-Darstellung 

{
  "firstName": string,
  "lastName": string,
  "displayName": string,
  "email": string,
  "title": string,
  "phone": string
}
Felder
firstName

string

Vorname des Kontakts im Kundenkonto (erforderlich).

lastName

string

Nachname des Kontakts im Kundenkonto (erforderlich).

displayName

string

Anzeigename des Kontakts im Kundenkonto (optional). Wenn das Feld leer ist, wird der Anzeigename durch Kombination von Vor- und Nachname generiert.

email

string

E-Mail-Adresse des Kontakts im Kundenkonto (erforderlich).

title

string

Stellenbezeichnung des Kontakts im Kundenkonto.

phone

string

Telefonnummer des Kontakts im Kundenkonto.

Methoden

create

 Erstellt im Reseller- oder Händlerkonto eine neue Customer-Ressource.

get

 Gibt eine angeforderte Customer-Ressource zurück.

list

 Listet nachgelagerte Customer auf.

patch

 Aktualisiert eine vorhandene Customer-Ressource, die zum Reseller oder Händler gehört.