Method: locations.fetchVerificationOptions

מדווח על כל אפשרויות האימות המתאימות למיקום בשפה מסוימת.

בקשת HTTP

POST https://mybusinessverifications.googleapis.com/v1/{location=locations/*}:fetchVerificationOptions

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

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

פרמטרים
location

string

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

גוף הבקשה

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

ייצוג JSON 
{
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  }
}
שדות
languageCode

string

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

object (ServiceBusinessContext)

אפשרות. מידע נוסף על ההקשר של אימות עסקים שמספקים שירותים. ניתן להחיל רק על מיקומים שסוג העסק שלהם הוא CUSTOMER_LOCATION_ONLY. ציון כתובת מדויקת עשוי להפעיל אפשרויות נוספות. הערך INVALID_ARGUMENT יוסר אם הוא מוגדר עבור סוגי מיקומים אחרים של עסקים.

גוף התגובה

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

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

ייצוג JSON 
{
  "options": [
    {
      object (VerificationOption)
    }
  ]
}
שדות
options[]

object (VerificationOption)

אפשרויות האימות הזמינות.

היקפי הרשאות

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

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

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

VerificationOption

אפשרות האימות מייצגת את האופן שבו מאמתים את המיקום (יש לציין את שיטת האימות) ואל המקום שאליו יישלח האימות (לפי נתוני התצוגה).

ייצוג JSON 
{
  "verificationMethod": enum (VerificationMethod),

  // Union field DisplayData can be only one of the following:
  "phoneNumber": string,
  "addressData": {
    object (AddressVerificationData)
  },
  "emailData": {
    object (EmailVerificationData)
  },
  "announcement": string
  // End of list of possible types for union field DisplayData.
}
שדות
verificationMethod

enum (VerificationMethod)

שיטה לאימות המיקום.
שדה איחוד DisplayData. אחד מנתוני התצוגה. הנתונים חייבים להתאים לשיטה. ריק אם לשיטה המתאימה אין נתוני תצוגה. הערך של DisplayData יכול להיות רק אחת מהאפשרויות הבאות:
phoneNumber

string

הגדר רק אם השיטה היא PHONE_CALL או SMS. מספר הטלפון שאליו יישלח קוד האימות.
addressData

object (AddressVerificationData)

יש להגדיר רק אם השיטה היא MAIL.
emailData

object (EmailVerificationData)

יש להגדיר רק אם השיטה היא EMAIL.
announcement

string

יש להגדיר רק אם השיטה היא VETTED_PARTNER.

AddressVerificationData

הצגת נתונים לאימות באמצעות גלויה.

ייצוג JSON 
{
  "business": string,
  "address": {
    object (PostalAddress)
  },
  "expectedDeliveryDaysRegion": integer
}
שדות
business

string

שם העסק של המוכר.
address

object (PostalAddress)

כתובת שאליה ניתן לשלוח גלויה.
expectedDeliveryDaysRegion

integer

מספר הימים הנדרשים למשלוח גלויה לאזור הכתובת.

EmailVerificationData

הצגת נתונים לאימות באימייל.

ייצוג JSON 
{
  "domain": string,
  "user": string,
  "isUserNameEditable": boolean
}
שדות
domain

string

שם הדומיין בכתובת האימייל. למשל "gmail.com" ב-foo@gmail.com
user

string

שם המשתמש בכתובת האימייל. למשל "foo" בכתובת foo@gmail.com
isUserNameEditable

boolean

האם ללקוח מותר לספק שם משתמש אחר.