Method: locations.verify

התחלת תהליך האימות של מיקום.

בקשת HTTP

POST https://mybusinessverifications.googleapis.com/v1/{name=locations/*}:verify

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של נתיב

פרמטרים
name

string

חובה. שם המשאב של המיקום שצריך לאמת.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "method": enum (VerificationMethod),
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  },

  // Union field RequestData can be only one of the following:
  "emailAddress": string,
  "mailerContact": string,
  "phoneNumber": string,
  "token": {
    object (VerificationToken)
  }
  // End of list of possible types for union field RequestData.
}
שדות
method

enum (VerificationMethod)

חובה. שיטת האימות.
languageCode

string

אפשרות. קוד השפה BCP 47 שמייצג את השפה שצריך להשתמש בה בתהליך האימות.
context

object (ServiceBusinessContext)

אפשרות. מידע נוסף על ההקשר של אימות עסקים שמספקים שירותים. הוא נדרש רק עבור המיקומים שסוג העסק שלהם הוא CUSTOMER_LOCATION_ONLY. לאימות ADDRESS, הכתובת תשמש לשליחת גלויה. בכל שיטה אחרת, השיטה הזו צריכה להיות זהה לזו שמועברת אל GetAuthenticationOptions. הערך INVALID_ARGUMENT יופעל אם הוא מוגדר עבור סוגים אחרים של מיקומי עסקים.
שדה איחוד RequestData. נתוני קלט של משתמשים לשיטה ספציפית בנוסף לנתוני התצוגה. הנתונים חייבים להתאים לשיטה המבוקשת. אם אין צורך בנתונים, משאירים אותו ריק. הערך של RequestData יכול להיות רק אחת מהאפשרויות הבאות:
emailAddress

string

אפשרות. הקלט לשיטת EMAIL. כתובת האימייל שאליה יש לשלוח את מספר ה-PIN.

ניתן להשתמש בכתובת אימייל רק אם היא אחת מהכתובות שסופקו על ידי locations.fetchAuthenticationOptions. אם הפרמטר isUserNameEditable מוגדר ל-[EmailAuthenticationData] [google.mybusiness-verifications.v1.AuthenticationOption.EmailAuthenticationData] כ-true, הלקוח יכול לציין שם משתמש אחר (local-part), אבל חייב להתאים לשם הדומיין.
mailerContact

string

אפשרות. הקלט עבור שיטת ADDRESS. שם איש הקשר שאליו יש לשלוח את הדואר.
phoneNumber

string

אפשרות. הקלט לשיטת PHONE_CALL/SMS מספר הטלפון שאליו יש להתקשר או לשלוח אליו SMS. הוא צריך להיות אחד ממספרי הטלפון שמופיעים באפשרויות המתאימות.
token

object (VerificationToken)

אפשרות. הקלט עבור שיטת VETTED_PARTNER זמין לpartners. נבחרים. הקלט לא נדרש לחשבון שנבדק. אסימון שמשויך למיקום. אסימון שמשויך למיקום.

גוף התגובה

הודעת תגובה עבור verifications.VerifyLocation.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON 
{
  "verification": {
    object (Verification)
  }
}
שדות
verification

object (Verification)

בקשת האימות שנוצרה.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.

VerificationToken

האסימון נוצר על ידי שותף נבדק.

ייצוג JSON 
{
  "tokenString": string
}
שדות
tokenString

string

מחרוזת האסימון.