Method: accounts.locations.verify

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

בקשת HTTP

POST https://mybusiness.googleapis.com/v4/{name=accounts/*/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:
  "emailInput": {
    object (EmailInput)
  },
  "addressInput": {
    object (AddressInput)
  },
  "phoneInput": {
    object (PhoneInput)
  }
  // End of list of possible types for union field RequestData.
}
שדות
method

enum (VerificationMethod)

שיטת האימות.
languageCode

string

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

object (ServiceBusinessContext)

מידע נוסף על ההקשר של אימות עסקים שמספקים שירותים. נדרש עבור המיקומים שסוג העסק שלהם הוא CUSTOMER_LOCATION_ONLY. לאימות ADDRESS, הכתובת תשמש לשליחת גלויה. בשיטות אחרות, המדיניות צריכה להיות זהה לזו שמועברת אל locations.fetchVerifyOptions. הערך INVALID_ARGUMENT יופעל אם הוא מוגדר עבור סוגים אחרים של מיקומי עסקים.
שדה איחוד RequestData. נתוני קלט של משתמשים לשיטה ספציפית בנוסף לנתוני התצוגה. הנתונים חייבים להתאים לשיטה המבוקשת. אם אין צורך בנתונים, משאירים אותו ריק. הערך של RequestData יכול להיות רק אחת מהאפשרויות הבאות:
emailInput

object (EmailInput)

הקלט לשיטת EMAIL.
addressInput

object (AddressInput)

הקלט עבור שיטת ADDRESS.
phoneInput

object (PhoneInput)

הקלט לשיטת PHONE_CALL/SMS

גוף התגובה

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

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

ייצוג JSON 
{
  "verification": {
    object (Verification)
  }
}
שדות
verification

object (Verification)

בקשת האימות שנוצרה.

היקפי הרשאות

כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:

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

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

EmailInput

קלט לאימות EMAIL.

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

string

כתובת האימייל שאליה יש לשלוח את מספר ה-PIN.

ניתן להשתמש בכתובת אימייל רק אם היא אחת מהכתובות שסופקו על ידי locations.fetchAuthenticationOptions. אם ה-EmailVerificationData כולל את isUserNameEditable מוגדר כ-true, הלקוח יכול לציין שם משתמש אחר (local-part), אך חייב להתאים לשם הדומיין.

AddressInput

קלט לאימות ADDRESS.

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

string

שם איש הקשר שאליו יש לשלוח את הדואר.

PhoneInput

קלט לאימות PHONE_CALL/SMS.

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

string

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