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

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