Method: accounts.locations.verify

فرآیند تأیید یک مکان را شروع می کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
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 مراجعه کنید.

ورودی ایمیل

ورودی برای تأیید EMAIL.

نمایندگی JSON 
{
  "emailAddress": string
}
فیلدها
emailAddress

string

آدرس ایمیلی که پین ​​باید به آن ارسال شود.

آدرس ایمیل فقط در صورتی پذیرفته می شود که یکی از آدرس های ارائه شده توسط locations.fetchVerificationOptions باشد. اگر EmailVerificationData isUserNameEditable را روی true تنظیم کرده باشد، سرویس گیرنده ممکن است نام کاربری دیگری (قسمت محلی) تعیین کند اما باید با نام دامنه مطابقت داشته باشد.

آدرس ورودی

ورودی برای تأیید ADDRESS.

نمایندگی JSON 
{
  "mailerContactName": string
}
فیلدها
mailerContactName

string

نام تماسی که نامه باید به آن ارسال شود.

ورودی تلفن

ورودی برای تأیید PHONE_CALL/SMS.

نمایندگی JSON 
{
  "phoneNumber": string
}
فیلدها
phoneNumber

string

شماره تلفنی که باید تماس گرفته شود یا به آن پیامک ارسال شود. باید یکی از شماره تلفن های موجود در گزینه های واجد شرایط باشد.