Method: locations.verify

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

درخواست HTTP

POST https://mybusinessverifications.googleapis.com/v1/{name=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:
  "emailAddress": string,
  "mailerContact": string,
  "phoneNumber": string,
  "token": {
    object (VerificationToken)
  }
  // End of list of possible types for union field RequestData.
}
فیلدها
method

enum ( VerificationMethod )

مورد نیاز. روش تایید.

languageCode

string

اختیاری. کد زبان BCP 47 نشان دهنده زبانی است که قرار است برای فرآیند تأیید استفاده شود.

context

object ( ServiceBusinessContext )

اختیاری. اطلاعات زمینه اضافی برای تأیید مشاغل خدماتی. فقط برای مکان‌هایی که نوع کسب و کارشان CUSTOMER_LOCATION_ONLY است لازم است. برای تأیید ADDRESS، از آدرس برای ارسال کارت پستال استفاده خواهد شد. برای روش های دیگر، باید همان روشی باشد که به GetVerificationOptions ارسال می شود. اگر INVALID_ARGUMENT برای سایر انواع مکان‌های تجاری تنظیم شود، پرتاب می‌شود.

فیلد اتحادیه RequestData . داده های ورودی کاربر برای روش خاص علاوه بر داده های نمایش داده می شود. داده ها باید با روش درخواستی مطابقت داشته باشند. اگر به داده ای نیاز نیست آن را خالی بگذارید. RequestData می تواند تنها یکی از موارد زیر باشد:
emailAddress

string

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

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

mailerContact

string

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

phoneNumber

string

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

token

object ( VerificationToken )

اختیاری. ورودی روش VETTED_PARTNER برای شرکای انتخابی موجود است. ورودی برای حساب تایید شده مورد نیاز نیست. رمزی که به مکان مرتبط است. رمزی که به مکان مرتبط است.

بدن پاسخگو

پیام پاسخ برای Verifications.VerifyLocation.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "verification": {
    object (Verification)
  }
}
فیلدها
verification

object ( Verification )

درخواست تأیید ایجاد شده

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/business.manage

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

VerificationToken

توکن تولید شده توسط شریک تایید شده

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

string

رشته توکن.