Method: accounts.locations.fetchVerificationOptions

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

בקשת HTTP

POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:fetchVerificationOptions

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

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

פרמטרים
name

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/plus.business.manage
  • 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:
  "phoneData": {
    object (PhoneVerificationData)
  },
  "addressData": {
    object (AddressVerificationData)
  },
  "emailData": {
    object (EmailVerificationData)
  }
  // End of list of possible types for union field DisplayData.
}
שדות
verificationMethod

enum (VerificationMethod)

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

object (PhoneVerificationData)

יש להגדיר רק אם השיטה היא PHONE_CALL או SMS.
addressData

object (AddressVerificationData)

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

object (EmailVerificationData)

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

PhoneVerificationData

הצגת נתונים לאימות באמצעות הטלפון, למשל: שיחת טלפון, sms.

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

string

מספר הטלפון שאליו יישלח קוד האימות.

AddressVerificationData

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

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

string

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

object (PostalAddress)

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

EmailVerificationData

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

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

string

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

string

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

boolean

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