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

גוף התשובה

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

הודעת תגובה ל-Authentications.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

קלט לאימות באימייל.

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

string

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

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

AddressInput

קלט לאימות ADDRESS.

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

string

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

PhoneInput

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

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

string

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