התחלת תהליך האימות של מיקום.
בקשת HTTP
POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:verify
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
name |
שם המשאב של המיקום שצריך לאמת. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON | |
---|---|
{ "method": enum ( |
שדות | ||
---|---|---|
method |
שיטת האימות. |
|
languageCode |
קוד השפה BCP 47 שמייצג את השפה שצריך להשתמש בה בתהליך האימות. |
|
context |
מידע נוסף על ההקשר של אימות עסקים שמספקים שירותים. נדרש עבור המיקומים שסוג העסק שלהם הוא CUSTOMER_LOCATION_ONLY. לאימות ADDRESS, הכתובת תשמש לשליחת גלויה. בשיטות אחרות, המדיניות צריכה להיות זהה לזו שמועברת אל locations.fetchVerifyOptions. הערך INVALID_ARGUMENT יופעל אם הוא מוגדר עבור סוגים אחרים של מיקומי עסקים. |
|
שדה איחוד RequestData . נתוני קלט של משתמשים לשיטה ספציפית בנוסף לנתוני התצוגה. הנתונים חייבים להתאים לשיטה המבוקשת. אם אין צורך בנתונים, משאירים אותו ריק. הערך של RequestData יכול להיות רק אחת מהאפשרויות הבאות: |
||
emailInput |
הקלט לשיטת EMAIL. |
|
addressInput |
הקלט עבור שיטת ADDRESS. |
|
phoneInput |
הקלט לשיטת PHONE_CALL/SMS |
גוף התגובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
הודעת תגובה עבור verifications.VerifyLocation.
ייצוג JSON | |
---|---|
{
"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 |
כתובת האימייל שאליה יש לשלוח את מספר ה-PIN. ניתן להשתמש בכתובת אימייל רק אם היא אחת מהכתובות שסופקו על ידי locations.fetchAuthenticationOptions. אם ה- |
AddressInput
קלט לאימות ADDRESS.
ייצוג JSON | |
---|---|
{ "mailerContactName": string } |
שדות | |
---|---|
mailerContactName |
שם איש הקשר שאליו יש לשלוח את הדואר. |
PhoneInput
קלט לאימות PHONE_CALL/SMS.
ייצוג JSON | |
---|---|
{ "phoneNumber": string } |
שדות | |
---|---|
phoneNumber |
מספר הטלפון שאליו יש להתקשר או לשלוח אליו SMS. הוא צריך להיות אחד ממספרי הטלפון שמופיעים באפשרויות המתאימות. |