- درخواست اچتیتیپی
- پارامترهای مسیر
- بدنه درخواست
- متن پاسخ
- دامنههای مجوز
- VerificationOption
- AddressVerificationData
- EmailVerificationData
همه گزینههای درستیسنجی واجدشرایط را برای مکانی به زبانی خاص گزارش میکند.
درخواست HTTP
POST https://mybusinessverifications.googleapis.com/v1/{location=locations/*}:fetchVerificationOptions
این نشانی وب از نحو تراتبدیل gRPC استفاده میکند.
پارامترهای مسیر
| پارامترها | |
|---|---|
location |
الزامی. مکان موردنظر برای درستیسنجی. |
متن درخواست
بدنه درخواست حاوی دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{
"languageCode": string,
"context": {
object ( |
| فیلدها | |
|---|---|
languageCode |
الزامی. کد زبان BCP 47 که نشاندهنده زبانی است که باید برای فرایند درستیسنجی استفاده شود. گزینههای دردسترس بسته به زبان متفاوت است. |
context |
اختیاری. اطلاعات زمینهای بیشتر برای درستیسنجی کسبوکارهای خدماتی. فقط میتواند برای مکانهایی اعمال شود که نوع کسبوکارشان CUSTOMER_LOCATION_ONLY است. مشخص کردن نشانی دقیق میتواند گزینههای بیشتری را فعال کند. اگر برای انواع دیگر مکانهای کسبوکار تنظیم شود، INVALID_ARGUMENT (آرگومان نامعتبر) نشان داده خواهد شد. |
بدنه پاسخ
Response message for Verifications.FetchVerificationOptions.
اگر موفقیتآمیز باشد، بدنه پاسخ حاوی دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{
"options": [
{
object ( |
| فیلدها | |
|---|---|
options[] |
گزینههای درستیسنجی دردسترس. |
دامنههای مجوز
به گستره OAuth زیر نیاز دارد:
https://www.googleapis.com/auth/business.manage
برای اطلاعات بیشتر، به OAuth 2.0 Overview مراجعه کنید.
VerificationOption
گزینه درستیسنجی نشاندهنده نحوه درستیسنجی مکان (که با روش درستیسنجی مشخص میشود) و جایی است که درستیسنجی به آن ارسال میشود (که با دادههای نمایشی مشخص میشود).
| نمایش JSON |
|---|
{ "verificationMethod": enum ( |
| فیلدها | |
|---|---|
verificationMethod |
روش درستیسنجی مکان. |
| یکی از دادههای نمایش. دادهها باید با روش مطابقت داشته باشد. اگر روش مربوطه هیچ داده نمایشی نداشته باشد، خالی است. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد: | |
phoneNumber |
فقط درصورتی تنظیم میشود که روش PHONE_CALL یا SMS باشد. شماره تلفنی که پین به آن ارسال خواهد شد. |
addressData |
فقط درصورتی تنظیم میشود که روش MAIL باشد. |
emailData |
فقط درصورتی تنظیم میشود که روش EMAIL باشد. |
announcement |
فقط درصورتی تنظیم میشود که روش VETTED_PARTNER باشد. |
| پایان فیلدهای متقابلاً انحصاری. | |
AddressVerificationData
نمایش دادههای مربوط به درستیسنجی ازطریق کارتپستال.
| نمایش JSON |
|---|
{
"business": string,
"address": {
object ( |
| فیلدها | |
|---|---|
business |
نام کسبوکار فروشنده. |
address |
نشانیای که کارتپستال میتواند به آن ارسال شود. |
expectedDeliveryDaysRegion |
تعداد روزهای موردانتظار برای تحویل کارتپستال به منطقه نشانی. |
EmailVerificationData
نمایش دادهها برای درستیسنجی ازطریق ایمیل.
| نمایش JSON |
|---|
{ "domain": string, "user": string, "isUserNameEditable": boolean } |
| فیلدها | |
|---|---|
domain |
نام دامنه در نشانی ایمیل. برای مثال، «gmail.com» در foo@gmail.com |
user |
نام کاربری در نشانی ایمیل. برای مثال، «foo» در foo@gmail.com |
isUserNameEditable |
آیا مشتری مجاز است نام کاربری دیگری ارائه دهد. |