Package google.mybusiness.verifications.v1

فهرست مطالب

تاییدیه ها

این API اجازه می دهد تا تأییدیه های موقعیت مکانی را در Google مدیریت کنید. این به شما امکان می دهد منابع [Verification] [google.mybusiness.v1.Verification] را مدیریت کنید.

هر [Location] [google.mybusiness.businessinformation.locations.v1.Location] مجموعه‌ای از منابع [Verification] [google.mybusiness.verifications] با نام locations/*/verifications/* دارد.

تأیید کامل

rpc CompleteVerification( CompleteVerificationRequest ) returns ( CompleteVerificationResponse )

یک تأیید PENDING را تکمیل می کند.

فقط برای روش های تأیید غیر AUTO لازم است. درخواست تأیید AUTO بلافاصله پس از ایجاد VERIFIED می شود.

محدوده مجوز

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

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

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

FetchVerificationOptions

rpc FetchVerificationOptions( FetchVerificationOptionsRequest ) returns ( FetchVerificationOptionsResponse )

همه گزینه های تأیید واجد شرایط را برای یک مکان به زبان خاصی گزارش می دهد.

محدوده مجوز

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

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

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

ListVerifications

rpc ListVerifications( ListVerificationsRequest ) returns ( ListVerificationsResponse )

تأییدیه‌های یک مکان را که بر اساس زمان ایجاد مرتب شده‌اند فهرست کنید.

محدوده مجوز

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

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

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

VerifyLocation

rpc VerifyLocation( VerifyLocationRequest ) returns ( VerifyLocationResponse )

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

محدوده مجوز

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

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

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

صدای بازرگان

این سرویس به کاربران 3P اجازه می دهد تا جزئیات مربوط به صدای دولت تجاری را درخواست کنند.

GetVoiceOfMerchantState

rpc GetVoiceOfMerchantState( GetVoiceOfMerchantStateRequest ) returns ( VoiceOfMerchantState )

حالت VoiceOfMerchant را دریافت می کند.

محدوده مجوز

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

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

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

CompleteVerification Request

درخواست پیام برای Verifications.CompleteVerificationAction.

زمینه های
name

string

ضروری. نام منبع تأیید برای تکمیل.

pin

string

ضروری. کد پین توسط تاجر برای تکمیل تأیید دریافت شده است.

CompleteVerificationResponse

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

زمینه های
verification

Verification

تایید تکمیل شده

مطابق با دستورالعمل ها

نشان می دهد که مکان با دستورالعمل های ما مطابقت ندارد.

زمینه های
recommendation_reason

RecommendationReason

دلیل اینکه چرا مکان برای مطابقت با دستورالعمل ها توصیه می شود.

توصیه دلیل

نشان می دهد که چرا مکان به ComplyWithGuidelines توصیه شده است.

Enums
RECOMMENDATION_REASON_UNSPECIFIED مشخص نشده است.
BUSINESS_LOCATION_SUSPENDED مکان کسب و کار به حالت تعلیق درآمده است. برای رفع این مشکل، به مقاله مرکز راهنمایی مراجعه کنید.
BUSINESS_LOCATION_DISABLED مکان کسب و کار غیرفعال است. برای رفع این مشکل، به مقاله مرکز راهنمایی مراجعه کنید.

FetchVerificationOptionsRequest

درخواست پیام برای Verifications.FetchVerificationOptions.

زمینه های
location

string

ضروری. مکانی برای تأیید.

language_code

string

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

context

ServiceBusinessContext

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

FetchVerificationOptionsResponse

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

زمینه های
options[]

VerificationOption

گزینه های تأیید صحت موجود

GetVoiceOfMerchantStateRequest

درخواست پیام برای VoiceOfMerchant.GetVoiceOfMerchantState.

زمینه های
name

string

ضروری. نام منبع مکان

ListVerificationsRequest

درخواست پیام برای Verifications.ListVerifications.

زمینه های
parent

string

ضروری. نام منبع مکانی که درخواست های تأیید به آن تعلق دارد.

page_size

int32

در هر صفحه چه تعداد تأییدیه باید لحاظ شود. حداقل 1 و اندازه پیش فرض و حداکثر صفحه 100 است.

page_token

string

اگر مشخص شده باشد، صفحه بعدی تأیید را برمی‌گرداند.

ListVerificationsResponse

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

زمینه های
verifications[]

Verification

لیست تاییدیه ها

next_page_token

string

اگر تعداد تأییدها از اندازه صفحه درخواستی بیشتر شود، این فیلد با یک نشانه پر می شود تا در تماس بعدی صفحه بعدی تأیید را واکشی کند. اگر هیچ ویژگی دیگری وجود نداشته باشد، این فیلد در پاسخ وجود نخواهد داشت.

ResolveOwnership Conflict

این نوع هیچ فیلدی ندارد.

نشان می دهد که مکان مکان دیگری را کپی می کند که در وضعیت خوبی قرار دارد.

ServiceBusinessContext

داده های اضافی برای تأیید کسب و کار خدمات.

زمینه های
address

PostalAddress

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

تایید

تأیید یک تلاش برای تأیید در یک مکان است.

زمینه های
name

string

نام منبع تأیید.

method

VerificationMethod

روش تایید.

state

State

وضعیت تأیید.

create_time

Timestamp

مهر زمانی که تأیید درخواست می شود.

announcement

string

اختیاری. اعلام پاسخ فقط در صورتی تنظیم می‌شود که روش VETTED_PARTNER باشد.

حالت

همه حالت های تایید ممکن

Enums
STATE_UNSPECIFIED مقدار پیش فرض، منجر به خطا می شود.
PENDING تأیید در انتظار است.
COMPLETED تایید تکمیل شد.
FAILED راستی‌آزمایی انجام نشد.

روش تأیید

فرآیندهای مورد استفاده توسط Google را برای تأیید یک مکان مشخص می کند.

Enums
VERIFICATION_METHOD_UNSPECIFIED مقدار پیش فرض، منجر به خطا می شود.
ADDRESS یک کارت پستال با یک پین تأیید به یک آدرس پستی خاص ارسال کنید. پین برای تکمیل تأیید با Google استفاده می شود.
EMAIL یک ایمیل با یک پین تأیید به یک آدرس ایمیل خاص ارسال کنید. پین برای تکمیل تأیید با Google استفاده می شود.
PHONE_CALL با یک پین تأیید به یک شماره تلفن خاص تماس تلفنی برقرار کنید. پین برای تکمیل تأیید با Google استفاده می شود.
SMS یک پیامک با یک پین تأیید به یک شماره تلفن خاص ارسال کنید. پین برای تکمیل تأیید با Google استفاده می شود.
AUTO بدون اقدام کاربر اضافی، مکان را تأیید کنید. این گزینه ممکن است برای همه مکان ها در دسترس نباشد.
VETTED_PARTNER این گزینه ممکن است برای همه مکان ها در دسترس نباشد.

VerificationOption

گزینه تأیید نحوه تأیید مکان (که با روش تأیید نشان داده شده است) و تأیید به کجا ارسال می شود (با داده های نمایش نشان داده شده است) را نشان می دهد.

زمینه های
verification_method

VerificationMethod

روش تأیید مکان

فیلد اتحادیه DisplayData . یکی از داده های نمایشگر داده ها باید با روش مطابقت داشته باشند. اگر روش مربوطه هیچ داده نمایشی ندارد، خالی شود. DisplayData تنها می تواند یکی از موارد زیر باشد:
phone_number

string

فقط در صورتی تنظیم کنید که روش PHONE_CALL یا پیامک باشد. شماره تلفنی که پین ​​به آن ارسال خواهد شد.

address_data

AddressVerificationData

فقط در صورتی تنظیم کنید که روش MAIL باشد.

email_data

EmailVerificationData

تنها در صورتی تنظیم کنید که روش EMAIL باشد.

announcement

string

فقط در صورتی تنظیم کنید که روش VETTED_PARTNER باشد.

AddressVerificationData

نمایش داده ها برای تأیید از طریق کارت پستال.

زمینه های
business

string

نام تجاری تاجر.

address

PostalAddress

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

expected_delivery_days_region

int32

تعداد روزهای پیش بینی شده برای تحویل کارت پستال به منطقه آدرس طول می کشد.

EmailVerificationData

نمایش داده ها برای تأیید از طریق ایمیل.

زمینه های
domain

string

نام دامنه در آدرس ایمیل. به عنوان مثال "gmail.com" در foo@gmail.com

user

string

نام کاربری در آدرس ایمیل به عنوان مثال "foo" در foo@gmail.com

is_user_name_editable

bool

آیا مشتری مجاز به ارائه نام کاربری متفاوت است یا خیر.

VerificationToken

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

زمینه های
token_string

string

رشته توکن.

تأیید کنید

نشان می دهد که مکان به تأیید نیاز دارد. حاوی اطلاعاتی درباره اقدامات تأیید فعلی انجام شده در مکان است.

زمینه های
has_pending_verification

bool

نشان می دهد که آیا فرآیند تأیید قبلاً شروع شده است یا خیر، و می تواند توسط مکان تکمیل شود.

VerifyLocationRequest

درخواست پیام برای Verifications.VerifyLocation.

زمینه های
name

string

ضروری. نام منبع مکان برای تأیید.

method

VerificationMethod

ضروری. روش تایید.

language_code

string

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

context

ServiceBusinessContext

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

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

string

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

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

mailer_contact

string

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

phone_number

string

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

token

VerificationToken

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

VerifyLocationResponse

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

زمینه های
verification

Verification

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

VoiceOfMerchantState

پیام پاسخ برای VoiceOfMerchant.GetVoiceOfMerchantState.

زمینه های
has_voice_of_merchant

bool

نشان می دهد که آیا مکان در وضعیت خوبی است و بر کسب و کار در Google کنترل دارد یا خیر. هر گونه ویرایشی که در مکان انجام شود پس از گذراندن مرحله بازبینی در Maps منتشر می شود.

has_business_authority

bool

نشان می دهد که آیا مکان دارای اختیار (مالکیت) بر کسب و کار در Google است یا خیر. اگر درست باشد، مکان دیگری نمی‌تواند تسلط یابد و به فهرست غالب در Maps تبدیل شود. با این حال، ویرایش‌ها زنده نمی‌شوند مگر اینکه Voice of Merchant به دست بیاید (یعنی has_voice_of_merchant درست است).

فیلد اتحادیه gain_voice_of_merchant_action . اقدامی برای به دست آوردن کنترل بر کسب و کار در Google به مکان توصیه شده است. gain_voice_of_merchant_action تنها می تواند یکی از موارد زیر باشد:
wait_for_voice_of_merchant

WaitForVoiceOfMerchant

برای به دست آوردن Voice of Merchant منتظر بمانید. مکان برای اهداف کیفی در دست بررسی است.

verify

Verify

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

resolve_ownership_conflict

ResolveOwnershipConflict

این مکان مکان دیگری را کپی می کند که در وضعیت خوبی قرار دارد. اگر به موقعیت مکانی مناسب دسترسی دارید، از شناسه آن مکان برای انجام عملیات استفاده کنید. در غیر این صورت، از مالک فعلی درخواست دسترسی کنید.

comply_with_guidelines

ComplyWithGuidelines

مکان با دستورالعمل‌های ما مطابقت ندارد و به مراحل دیگری برای بازگرداندن نیاز دارد. برای رفع این مشکل، به مقاله مرکز راهنمایی مراجعه کنید.

WaitForVoiceOfMerchant

این نوع هیچ فیلدی ندارد.

نشان می دهد که مکان پس از گذراندن بررسی، صدای تاجر را به دست می آورد.