Method: accounts.locations.verify

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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.fetchVerificationOptions. הערך 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

מזינים את הפרטים לאימות באימייל.

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

string

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

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

AddressInput

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

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

string

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

PhoneInput

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

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

string

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