- درخواست HTTP
- پارامترهای مسیر
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- VerificationOption
- Phone Verification Data
- AddressVerificationData
- EmailVerificationData
همه گزینه های تأیید واجد شرایط را برای یک مکان به زبان خاصی گزارش می دهد.
درخواست HTTP
POST https://mybusiness.googleapis.com/v4/{name=accounts/*/locations/*}:fetchVerificationOptions
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها | |
---|---|
name | نام منبع مکان برای تأیید. |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON | |
---|---|
{
"languageCode": string,
"context": {
object ( |
فیلدها | |
---|---|
languageCode | کد زبان BCP 47 نشان دهنده زبانی است که قرار است برای فرآیند تأیید استفاده شود. گزینه های موجود بر اساس زبان متفاوت است. |
context | اطلاعات زمینه اضافی برای تأیید مشاغل خدماتی. برای مکانهایی که نوع کسب و کار آنها CUSTOMER_LOCATION_ONLY است الزامی است. اگر INVALID_ARGUMENT برای مکانهای دیگر کسبوکار تنظیم شود، پرتاب میشود. |
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
پیام پاسخ برای Verifications.FetchVerificationOptions.
نمایندگی JSON | |
---|---|
{
"options": [
{
object ( |
فیلدها | |
---|---|
options[] | گزینه های تأیید صحت موجود |
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/plus.business.manage
-
https://www.googleapis.com/auth/business.manage
برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.
VerificationOption
گزینه تأیید نحوه تأیید مکان (که با روش تأیید نشان داده شده است) و تأیید به کجا ارسال می شود (با داده های نمایش نشان داده شده است) را نشان می دهد.
نمایندگی JSON | |
---|---|
{ "verificationMethod": enum ( |
فیلدها | ||
---|---|---|
verificationMethod | روش تأیید مکان | |
فیلد اتحادیه DisplayData . یکی از داده های نمایشگر داده ها باید با روش مطابقت داشته باشند. اگر روش مربوطه هیچ داده نمایشی ندارد، خالی شود. DisplayData تنها می تواند یکی از موارد زیر باشد: | ||
phoneData | فقط در صورتی تنظیم کنید که روش PHONE_CALL یا پیامک باشد. | |
addressData | فقط در صورتی تنظیم کنید که روش MAIL باشد. | |
emailData | تنها در صورتی تنظیم کنید که روش EMAIL باشد. |
Phone Verification Data
نمایش داده ها برای تأیید از طریق تلفن، به عنوان مثال تماس تلفنی، پیامک.
نمایندگی JSON | |
---|---|
{ "phoneNumber": string } |
فیلدها | |
---|---|
phoneNumber | شماره تلفنی که پین به آن ارسال خواهد شد. |
AddressVerificationData
نمایش داده ها برای تأیید از طریق کارت پستال.
نمایندگی JSON | |
---|---|
{
"businessName": string,
"address": {
object ( |
فیلدها | |
---|---|
businessName | نام تجاری تاجر. |
address | آدرسی که می توان به آن کارت پستال ارسال کرد. |
EmailVerificationData
نمایش داده ها برای تأیید از طریق ایمیل.
نمایندگی JSON | |
---|---|
{ "domainName": string, "userName": string, "isUserNameEditable": boolean } |
فیلدها | |
---|---|
domainName | نام دامنه در آدرس ایمیل. به عنوان مثال "gmail.com" در foo@gmail.com |
userName | نام کاربری در آدرس ایمیل به عنوان مثال "foo" در foo@gmail.com |
isUserNameEditable | آیا مشتری مجاز به ارائه نام کاربری متفاوت است یا خیر. |