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

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