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, הכתובת תשמש לשליחת גלויה. עבור שיטות אחרות, היא צריכה להיות זהה לזו שהועברה אל GetVerifyOptions. הפונקציה INVALID_ARGUMENT לא תיבחר אם היא מוגדרת לסוגים אחרים של מיקומי עסקים.
שדה איחוד RequestData. נתוני קלט של משתמשים לשיטה ספציפית, בנוסף לנתוני התצוגה. הנתונים חייבים להתאים לשיטה המבוקשת. אם אין צורך בנתונים, אפשר להשאיר אותה ריקה. RequestData יכול להיות רק אחת מהאפשרויות הבאות:
emailAddress

string

זה שינוי אופציונלי. הקלט למתודה EMAIL. כתובת האימייל שאליה צריך לשלוח את קוד האימות.

כתובת אימייל תאושר רק אם היא אחת מהכתובות שסופקו על ידי locations.fetchVerifyOptions. אם האימות של [Email VerificationData] [google.mybusiness-verifications.v1.authenticationOption.Email VerificationData] מוגדר כ-True, הלקוח יכול לציין שם משתמש אחר (local-part), אבל חייב להתאים לשם הדומיין.
mailerContact

string

זה שינוי אופציונלי. הקלט לשיטה ADDRESS. שם איש הקשר שאליו יש לשלוח את האימייל.
phoneNumber

string

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

object (VerificationToken)

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

גוף התשובה

הודעת תגובה ל-Authentications.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

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