Method: locations.verify

فرایند درستی‌سنجی را برای مکان شروع می‌کند.

درخواست HTTP

POST https://mybusinessverifications.googleapis.com/v1/{name=locations/*}:verify

این نشانی وب از نحو تراتبدیل gRPC استفاده می‌کند.

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

پارامترها
name

string

الزامی. نام منبع مکان برای درستی‌سنجی.

متن درخواست

بدنه درخواست حاوی داده‌هایی با ساختار زیر است:

نمایش JSON
{
  "method": enum (VerificationMethod),
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "emailAddress": string,
  "mailerContact": string,
  "phoneNumber": string,
  "token": {
    object (VerificationToken)
  },
  "trustedPartnerToken": string
  // End of mutually exclusive fields.
}
فیلدها
method

enum (VerificationMethod)

الزامی. روش درستی‌سنجی.

languageCode

string

اختیاری. کد زبان BCP 47 که نشان‌دهنده زبانی است که باید برای فرایند درستی‌سنجی استفاده شود.

context

object (ServiceBusinessContext)

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

داده‌های ورودی کاربر برای روش خاص علاوه‌بر داده‌های نمایش. داده‌ها باید با روش درخواستی مطابقت داشته باشد. اگر به داده‌ای نیاز نیست، آن را خالی بگذارید. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
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 برای انتخاب شرکا دردسترس است. برای حساب بررسی‌شده، به ورودی نیازی نیست. نشان مرتبط با مکان. نشان مرتبط با مکان.

trustedPartnerToken

string

ورودی برای روش TRUSTED_PARTNER (شریک معتمد) توکن درستی‌سنجی که با مکان مرتبط است.

پایان فیلدهای متقابلاً انحصاری.

بدنه پاسخ

Response message for Verifications.VerifyLocation.

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

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

object (Verification)

درخواست درستی‌سنجی ایجادشده.

دامنه‌های مجوز

به گستره OAuth زیر نیاز دارد:

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

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

VerificationToken

رمز تولیدشده توسط شریک تأییدشده.

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

string

رشته کد.