Package google.mybusiness.verifications.v1

Index

Bestätigungen

Diese API ermöglicht die Verwaltung von Standortbestätigungen auf Google. Sie können damit Ressourcen zum Thema [Überprüfung] [google.mybusiness.v1.Verification] verwalten.

Für jeden [Location] [google.mybusiness.businessinformation.locations.v1.Location] gibt es eine Sammlung von [Verification]-[google.mybusiness.verifications]-Ressourcen namens locations/*/verifications/*.

CompleteVerification

rpc CompleteVerification(CompleteVerificationRequest) returns (CompleteVerificationResponse)

Schließt die Bestätigung von PENDING ab.

Sie ist nur für andere Bestätigungsmethoden als AUTO erforderlich. AUTO Bestätigungsanfrage wird sofort VERIFIED nach der Erstellung angezeigt.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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

rpc FetchVerificationOptions(FetchVerificationOptionsRequest) returns (FetchVerificationOptionsResponse)

Meldet alle zulässigen Bestätigungsoptionen für einen Standort in einer bestimmten Sprache.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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

rpc ListVerifications(ListVerificationsRequest) returns (ListVerificationsResponse)

Bestätigungen eines Standorts nach Erstellungszeit geordnet auflisten.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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

rpc VerifyLocation(VerifyLocationRequest) returns (VerifyLocationResponse)

Startet den Bestätigungsprozess für einen Standort.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

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

VoiceOfMerchant

Mit diesem Dienst können Drittanbieternutzer Details zur Stimme des Händlerstatus anfordern.

GetVoiceOfMerchantState

rpc GetVoiceOfMerchantState(GetVoiceOfMerchantStateRequest) returns (VoiceOfMerchantState)

Ruft den Status "VoiceOfMerchant" 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.

CompleteVerificationRequest

Anfragenachricht für Verifications.CompleteVerificationAction.

Felder
name

string

Erforderlich. Ressourcenname der durchzuführenden Überprüfung.
pin

string

Erforderlich. PIN-Code, den der Händler erhalten hat, um die Bestätigung abzuschließen.

CompleteVerificationResponse

Antwortnachricht für Verifications.CompleteVerificationAction.

Felder
verification

Verification

Die Bestätigung ist abgeschlossen.

ComplyWithGuidelines

Gibt an, dass der Standort nicht unseren Richtlinien entspricht.

Felder
recommendation_reason

RecommendationReason

Der Grund, warum der Standort gemäß den Richtlinien empfohlen wird.

RecommendationReason

Gibt an, warum der Standort zur Einhaltung von Richtlinien empfohlen wurde.

Enums
RECOMMENDATION_REASON_UNSPECIFIED Nicht angegeben.
BUSINESS_LOCATION_SUSPENDED Der Unternehmensstandort ist gesperrt. Informationen zur Behebung dieses Problems finden Sie in diesem Hilfeartikel.
BUSINESS_LOCATION_DISABLED Der Unternehmensstandort ist deaktiviert. Informationen zur Behebung dieses Problems finden Sie in diesem Hilfeartikel.

FetchVerificationOptionsRequest

Anfragenachricht für Verifications.FetchVerificationOptions.

Felder
location

string

Erforderlich. Der zu bestätigende Standort.
language_code

string

Erforderlich. Der BCP 47-Sprachcode für die Sprache, die für den Bestätigungsprozess verwendet wird. Die verfügbaren Optionen variieren je nach Sprache.
context

ServiceBusinessContext

Optional. Zusätzliche Kontextinformationen für die Bestätigung von Dienstleistungsunternehmen. Kann nur auf Standorte angewendet werden, deren Unternehmenstyp CUSTOMER_LOCATION_ONLY ist. Durch Angabe einer genauen Adresse könnten weitere Optionen aktiviert werden. Wenn für andere Unternehmenstypen von Standorten festgelegt ist, wird INVALID_ARGUMENT ausgegeben.

FetchVerificationOptionsResponse

Antwortnachricht für Verifications.FetchVerificationOptions.

Felder
options[]

VerificationOption

Die verfügbaren Bestätigungsoptionen.

GetVoiceOfMerchantStateRequest

Anfragenachricht für VoiceOfMerchant.GetVoiceOfMerchantState.

Felder
name

string

Erforderlich. Ressourcenname des Standorts.

ListVerificationsRequest

Anfragenachricht für Verifications.ListVerifications.

Felder
parent

string

Erforderlich. Ressourcenname des Standorts, zu dem Bestätigungsanfragen gehören.
page_size

int32

Anzahl der Bestätigungen pro Seite. Der Mindestwert ist 1, die Standard- und maximale Seitengröße 100.
page_token

string

Falls angegeben, wird die nächste Seite mit Bestätigungen zurückgegeben.

ListVerificationsResponse

Antwortnachricht für Verifications.ListVerifications.

Felder
verifications[]

Verification

Liste der Bestätigungen.
next_page_token

string

Wenn die Anzahl der Bestätigungen die angeforderte Seitengröße überschreitet, wird dieses Feld mit einem Token gefüllt, um bei einem nachfolgenden Aufruf die nächste Bestätigungsseite abzurufen. Wenn keine weiteren Attribute vorhanden sind, ist dieses Feld nicht in der Antwort enthalten.

ResolveOwnershipConflict

Dieser Typ hat keine Felder.

Gibt an, dass der Standort einen anderen Standort mit einwandfreiem Status dupliziert.

ServiceBusinessContext

Zusätzliche Daten für die Bestätigung des Dienstleistungsunternehmens.

Felder
address

PostalAddress

Die Bestätigungsadresse des Standorts. Sie wird verwendet, um entweder weitere Bestätigungsoptionen zu aktivieren oder eine Postkarte zu versenden.

Überprüfung

Eine Bestätigung ist ein Bestätigungsversuch für einen Standort.

Felder
name

string

Ressourcenname der Überprüfung.
method

VerificationMethod

Die Bestätigungsmethode.
state

State

Der Status der Überprüfung.
create_time

Timestamp

Der Zeitstempel, zu dem die Bestätigung angefordert wird.
announcement

string

Optional. Antwortankündigung wird nur festgelegt, wenn die Methode VETTED_PARTNER ist.

Status

Alle möglichen Bestätigungsstatus.

Enums
STATE_UNSPECIFIED Standardwert, führt zu Fehlern.
PENDING Die Überprüfung steht noch aus.
COMPLETED Die Überprüfung ist abgeschlossen.
FAILED Die Bestätigung ist fehlgeschlagen.

VerificationMethod

Gibt die Prozesse an, die von Google zur Bestätigung eines Standorts verwendet werden.

Enums
VERIFICATION_METHOD_UNSPECIFIED Standardwert, führt zu Fehlern.
ADDRESS Senden Sie eine Postkarte mit einer Bestätigungs-PIN an eine bestimmte Postanschrift. Die PIN wird verwendet, um die Bestätigung bei Google abzuschließen.
EMAIL Senden Sie eine E-Mail mit einer Bestätigungs-PIN an eine bestimmte E-Mail-Adresse. Die PIN wird verwendet, um die Bestätigung bei Google abzuschließen.
PHONE_CALL Sie rufen mit einer Bestätigungs-PIN eine bestimmte Telefonnummer an. Die PIN wird verwendet, um die Bestätigung bei Google abzuschließen.
SMS SMS mit Bestätigungs-PIN an eine bestimmte Telefonnummer senden Die PIN wird verwendet, um die Bestätigung bei Google abzuschließen.
AUTO Bestätigen Sie den Standort ohne weitere Nutzeraktion. Diese Option ist möglicherweise nicht für alle Standorte verfügbar.
VETTED_PARTNER Diese Option ist möglicherweise nicht für alle Standorte verfügbar.

VerificationOption

Die Bestätigungsoption legt fest, wie der Standort bestätigt werden soll (durch die Bestätigungsmethode angegeben) und wohin die Bestätigung gesendet wird (dargestellt durch angezeigte Daten).

Felder
verification_method

VerificationMethod

Methode zur Bestätigung des Standorts.
Union-Feld DisplayData. Einer der Anzeigedaten. Die Daten müssen der Methode entsprechen. Leer, wenn die entsprechende Methode keine Anzeigedaten hat. Für DisplayData ist nur einer der folgenden Werte zulässig:
phone_number

string

Wird nur festgelegt, wenn die Methode PHONE_CALL oder SMS ist. Telefonnummer, an die die PIN gesendet wird
address_data

AddressVerificationData

Wird nur festgelegt, wenn die Methode MAIL lautet.
email_data

EmailVerificationData

Wird nur festgelegt, wenn die Methode EMAIL ist.
announcement

string

Wird nur festgelegt, wenn die Methode VETTED_PARTNER ist.

AddressVerificationData

Anzeigedaten für Bestätigungen per Postkarte.

Felder
business

string

Der Name des Händlers.
address

PostalAddress

Adresse, an die eine Postkarte gesendet werden kann
expected_delivery_days_region

int32

Voraussichtliche Anzahl von Tagen, bis eine Postkarte in der Region der Adresse zugestellt wird

EmailVerificationData

Daten für Bestätigungen per E-Mail anzeigen.

Felder
domain

string

Domainname in der E-Mail-Adresse, z. B. "gmail.com" in foo@gmail.com
user

string

Nutzername in der E-Mail-Adresse, z. B. „foo“ in foo@gmail.com
is_user_name_editable

bool

Gibt an, ob der Client einen anderen Nutzernamen angeben darf.

VerificationToken

Token, das von einem geprüften Partner generiert wurde.

Felder
token_string

string

Der Tokenstring.

Bestätigen

Gibt an, dass der Standort bestätigt werden muss. Enthält Informationen zu den aktuellen Bestätigungsaktionen, die für den Standort durchgeführt wurden.

Felder
has_pending_verification

bool

Gibt an, ob der Bestätigungsprozess bereits begonnen hat und je nach Standort abgeschlossen werden kann.

VerifyLocationRequest

Anfragenachricht für Verifications.VerifyLocation

Felder
name

string

Erforderlich. Ressourcenname des zu überprüfenden Standorts.
method

VerificationMethod

Erforderlich. Bestätigungsmethode.
language_code

string

Optional. Der BCP 47-Sprachcode für die Sprache, die für den Bestätigungsprozess verwendet wird.
context

ServiceBusinessContext

Optional. Zusätzliche Kontextinformationen für die Bestätigung von Dienstleistungsunternehmen. Es ist nur für Standorte erforderlich, deren Unternehmenstyp CUSTOMER_LOCATION_ONLY ist. Zur Bestätigung von ADDRESS wird die Adresse zum Versand der Postkarte verwendet. Bei anderen Methoden sollte sie mit der übereinstimmen, die an GetVerificationOptions übergeben wird. Für andere Arten von Unternehmensstandorten wird INVALID_ARGUMENT ausgegeben.
Union-Feld RequestData. Nutzereingabedaten für eine bestimmte Methode zusätzlich zu den Anzeigedaten. 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:
email_address

string

Optional. Die Eingabe für die EMAIL-Methode. E-Mail-Adresse, an die die PIN gesendet werden soll

Eine E-Mail-Adresse wird nur akzeptiert, wenn sie eine der von FetchVerificationOptions bereitgestellten Adressen ist. Wenn für [EmailVerificationData] [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] is_user_name_editable "true" festgelegt ist, kann der Client einen anderen Nutzernamen (lokaler Teil) angeben, muss aber mit dem Domainnamen übereinstimmen.
mailer_contact

string

Optional. Die Eingabe für die Methode ADDRESS. Name der Kontaktperson, an die die E-Mail gesendet werden soll
phone_number

string

Optional. Eingabe für PHONE_CALL/SMS-Methode Die Telefonnummer, die angerufen oder an die eine SMS gesendet werden soll. Dabei muss es sich um eine der infrage kommenden Optionen handeln.
token

VerificationToken

Optional. Die Eingabe für die Methode VETTED_PARTNER zur Auswahl von partners.. Die Angaben sind für ein überprüftes Konto nicht erforderlich. Token, das mit dem Standort verknüpft ist. Token, das mit dem Standort verknüpft ist.

VerifyLocationResponse

Antwortnachricht für Verifications.VerifyLocation

Felder
verification

Verification

Die erstellte Bestätigungsanfrage.

VoiceOfMerchantState

Antwortnachricht für VoiceOfMerchant.GetVoiceOfMerchantState.

Felder
has_voice_of_merchant

bool

Gibt an, ob sich der Standort in einwandfreiem Zustand befindet und ob er die Kontrolle über das Unternehmen auf Google hat. Nach Abschluss der Überprüfungsphase werden alle am Standort vorgenommenen Änderungen in Google Maps übernommen.
has_business_authority

bool

Gibt an, ob der Standort die Autorität (Eigentumsrechte) für das Unternehmen auf Google hat. Bei „true“ kann kein anderer Standort den dominanten Eintrag in Google Maps übernehmen. Änderungen werden jedoch erst veröffentlicht, wenn Voice of Merchant gewonnen wurde (d.h. "has_voice_of_merchant" ist "true").
Union-Feld gain_voice_of_merchant_action. Für den Standort empfohlene Maßnahme, um Kontrolle über das Unternehmen auf Google zu erhalten. Für gain_voice_of_merchant_action ist nur einer der folgenden Werte zulässig:
wait_for_voice_of_merchant

WaitForVoiceOfMerchant

Warten Sie, bis Sie die Stimme des Händlers erhalten. Der Standort wird zur Qualitätssicherung überprüft.
verify

Verify

Starten oder fahren Sie mit dem Bestätigungsprozess fort.
resolve_ownership_conflict

ResolveOwnershipConflict

Dieser Standort ist identisch mit einem anderen Standort, der sich in einwandfreiem Zustand befindet. Wenn Sie Zugriff auf einen einwandfreien Standort haben, verwenden Sie die ID dieses Standorts, um Vorgänge auszuführen. Andernfalls fordern Sie Zugriff beim aktuellen Inhaber an.
comply_with_guidelines

ComplyWithGuidelines

Der Standort entspricht nicht unseren Richtlinien und es sind zusätzliche Schritte zur Reaktivierung erforderlich. Informationen zur Behebung dieses Problems finden Sie in diesem Hilfeartikel.

WaitForVoiceOfMerchant

Dieser Typ hat keine Felder.

Gibt an, dass der Standort die Zustimmung des Händlers erhält, nachdem die Überprüfung bestanden wurde.