Method: accounts.locations.verify

Startet den Bestätigungsprozess für einen Standort.

HTTP-Anfrage

POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:verify

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Ressourcenname des zu bestätigenden Standorts.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "method": enum (VerificationMethod),
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  },

  // Union field RequestData can be only one of the following:
  "emailInput": {
    object (EmailInput)
  },
  "addressInput": {
    object (AddressInput)
  },
  "phoneInput": {
    object (PhoneInput)
  }
  // End of list of possible types for union field RequestData.
}
Felder
method

enum (VerificationMethod)

Bestätigungsmethode.

languageCode

string

Der BCP-47-Sprachcode, der die Sprache angibt, die für den Bestätigungsprozess verwendet werden soll.

context

object (ServiceBusinessContext)

Zusätzliche Kontextinformationen für die Überprüfung von Dienstleistungsunternehmen Erforderlich für Standorte mit dem Unternehmenstyp CUSTOMER_LOCATION_ONLY. Bei der Bestätigung der ADRESSE wird die Adresse verwendet, um eine Postkarte zu senden. Bei anderen Methoden sollte sie mit der übereinstimmen, die an „locations.fetchVerificationOptions“ übergeben wird. Andernfalls wird die Fehlermeldung INVALID_ARGUMENT ausgegeben.

Union-Feld RequestData. Zusätzlich zu den Anzeigedaten werden Daten zur Nutzereingabe für eine bestimmte Methode erfasst. Die Daten müssen mit der angeforderten Methode übereinstimmen. Lassen Sie das Feld leer, wenn keine Daten benötigt werden. Für RequestData ist nur einer der folgenden Werte zulässig:
emailInput

object (EmailInput)

Die Eingabe für die EMAIL-Methode.

addressInput

object (AddressInput)

Die Eingabe für die ADDRESS-Methode.

phoneInput

object (PhoneInput)

Eingabe für die PHONE_CALL-/SMS-Methode

Antworttext

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Antwortnachricht für Verifications.VerifyLocation

JSON-Darstellung
{
  "verification": {
    object (Verification)
  }
}
Felder
verification

object (Verification)

Die erstellte Bestätigungsanfrage.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der OAuth 2.0-Übersicht.

EmailInput

Eingabe für die E-MAIL-Bestätigung.

JSON-Darstellung
{
  "emailAddress": string
}
Felder
emailAddress

string

E-Mail-Adresse, an die die PIN gesendet werden soll.

Eine E-Mail-Adresse wird nur akzeptiert, wenn sie eine der Adressen ist, die von locations.fetchVerificationOptions angegeben werden. Wenn für die EmailVerificationData die Eigenschaft „isUserNameEditable“ auf „true“ gesetzt ist, kann der Client einen anderen Nutzernamen (local-part) angeben. Dieser muss jedoch mit dem Domainnamen übereinstimmen.

AddressInput

Eingabe für die Bestätigung von ADDRESS.

JSON-Darstellung
{
  "mailerContactName": string
}
Felder
mailerContactName

string

Name des Kontakts, an den die E-Mail gesendet werden soll.

PhoneInput

Eingabe für Bestätigung per PHONE_CALL/SMS.

JSON-Darstellung
{
  "phoneNumber": string
}
Felder
phoneNumber

string

Die Telefonnummer, die angerufen oder an die eine SMS gesendet werden soll. Es muss eine der Telefonnummern in den zulässigen Optionen sein.