Package google.mybusiness.verifications.v1

Chỉ mục

Giấy tờ xác minh

API này giúp bạn quản lý quy trình Xác minh vị trí trên Google. Tính năng này cho phép bạn quản lý các tài nguyên [Verify] của [google.mybusiness.v1.verify].

Mỗi [Vị trí] [google.mybusiness.businessinformation.locations.v1.Location] đều có một bộ sưu tập tài nguyên [Xác minh] [google.mybusiness.verifications] có tên là locations/*/verifications/*.

CompleteVerification

rpc CompleteVerification(CompleteVerificationRequest) returns (CompleteVerificationResponse)

Hoàn tất quy trình xác minh PENDING.

Điều này chỉ cần thiết cho các phương thức xác minh không phải là AUTO. Yêu cầu xác minh đối với AUTO sẽ có hiệu lực ngay lập tức khi tạo thành VERIFIED.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.
FetchVerificationOptions

rpc FetchVerificationOptions(FetchVerificationOptionsRequest) returns (FetchVerificationOptionsResponse)

Báo cáo tất cả các phương thức xác minh đủ điều kiện cho một vị trí bằng một ngôn ngữ cụ thể.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.
ListVerifications

rpc ListVerifications(ListVerificationsRequest) returns (ListVerificationsResponse)

Liệt kê các yêu cầu xác minh của một vị trí, được sắp xếp theo thời gian tạo.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.
VerifyLocation

rpc VerifyLocation(VerifyLocationRequest) returns (VerifyLocationResponse)

Bắt đầu quá trình xác minh cho một vị trí.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

VoiceOfMerchant

Dịch vụ này cho phép người dùng bên thứ ba yêu cầu thông tin chi tiết qua giọng nói của trạng thái của người bán.

GetVoiceOfMerchantState

rpc GetVoiceOfMerchantState(GetVoiceOfMerchantStateRequest) returns (VoiceOfMerchantState)

Lấy trạng thái VoiceOfMerchant.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

CompleteVerificationRequest

Yêu cầu thông báo cho Verifys.CompleteverifyAction.

Các trường
name

string

Bắt buộc. Tên tài nguyên của quy trình xác minh cần hoàn tất.
pin

string

Bắt buộc. Mã PIN mà người bán nhận được để hoàn tất quy trình xác minh.

CompleteVerificationResponse

Tin nhắn phản hồi cho Verifys.CompleteConfirmAction.

Các trường
verification

Verification

Quy trình xác minh đã hoàn tất.

ComplyWithGuidelines

Cho biết vị trí đó không tuân thủ nguyên tắc của chúng tôi.

Các trường
recommendation_reason

RecommendationReason

Lý do đề xuất vị trí đó để tuân thủ các nguyên tắc.

RecommendationReason

Cho biết lý do vị trí đó được đề xuất theo NetzDGWithGuidelines.

Enum
RECOMMENDATION_REASON_UNSPECIFIED Chưa xác định.
BUSINESS_LOCATION_SUSPENDED Địa điểm của doanh nghiệp đã bị tạm ngưng. Để khắc phục vấn đề này, hãy tham khảo bài viết này trên Trung tâm trợ giúp.
BUSINESS_LOCATION_DISABLED Địa điểm của doanh nghiệp đã bị tắt. Để khắc phục vấn đề này, hãy tham khảo bài viết này trên Trung tâm trợ giúp.

FetchVerificationOptionsRequest

Gửi tin nhắn yêu cầu cho Verifys.FetchConfirmOptions.

Các trường
location

string

Bắt buộc. Vị trí cần xác minh.
language_code

string

Bắt buộc. Mã ngôn ngữ BCP 47 đại diện cho ngôn ngữ sẽ được dùng trong quy trình xác minh. Các lựa chọn có sẵn sẽ khác nhau tuỳ theo ngôn ngữ.
context

ServiceBusinessContext

Không bắt buộc. Thông tin bổ sung về bối cảnh để xác minh doanh nghiệp cung cấp dịch vụ. Chỉ có thể áp dụng cho các vị trí có loại hình doanh nghiệp là CUSTOMER_LOCATION_ONLY. Việc chỉ định địa chỉ chính xác có thể cho phép nhiều tuỳ chọn hơn. INVALID_ACCOUNT sẽ được gửi nếu địa điểm đó được đặt cho các loại địa điểm doanh nghiệp khác.

FetchVerificationOptionsResponse

Thông báo phản hồi cho Verifys.FetchverifyOptions.

Các trường
options[]

VerificationOption

Các phương thức xác minh hiện có.

GetVoiceOfMerchantStateRequest

Yêu cầu gửi thông báo cho VoiceOfMerchant.GetVoiceOfMerchantState.

Các trường
name

string

Bắt buộc. Tên tài nguyên của vị trí.

ListVerificationsRequest

Yêu cầu tin nhắn cho Verifys.ListVerifys.

Các trường
parent

string

Bắt buộc. Tên tài nguyên của vị trí chứa yêu cầu xác minh.
page_size

int32

Số lượng yêu cầu xác minh cần đưa vào trên mỗi trang. Tối thiểu là 1, kích thước trang mặc định và tối đa là 100.
page_token

string

Nếu được chỉ định, trả về trang xác minh tiếp theo.

ListVerificationsResponse

Thông báo phản hồi cho Verifys.ListVerifys.

Các trường
verifications[]

Verification

Danh sách yêu cầu xác minh.
next_page_token

string

Nếu số lượt xác minh vượt quá kích thước trang được yêu cầu, trường này sẽ được điền sẵn một mã thông báo để tìm nạp trang xác minh tiếp theo trong lệnh gọi tiếp theo. Nếu không có thêm thuộc tính nào khác, trường này sẽ không xuất hiện trong phản hồi.

ResolveOwnershipConflict

Loại này không có trường.

Cho biết vị trí đó trùng lặp với một vị trí khác đang có trạng thái tốt.

ServiceBusinessContext

Dữ liệu bổ sung cho quy trình xác minh doanh nghiệp dịch vụ.

Các trường
address

PostalAddress

Địa chỉ xác minh của vị trí. Địa chỉ này được dùng để bật thêm các tuỳ chọn xác minh hoặc gửi bưu thiếp.

Xác minh

Lượt xác minh đại diện cho một lượt xác minh một vị trí.

Các trường
name

string

Tên tài nguyên của quy trình xác minh.
method

VerificationMethod

Phương thức xác minh.
state

State

Trạng thái xác minh.
create_time

Timestamp

Dấu thời gian khi bạn yêu cầu xác minh.
announcement

string

Không bắt buộc. Thông báo phản hồi chỉ được đặt nếu phương thức là VETTED_PARTNER.

Tiểu bang

Tất cả các trạng thái xác minh có thể có.

Enum
STATE_UNSPECIFIED Giá trị mặc định sẽ dẫn đến lỗi.
PENDING Quy trình xác minh đang chờ xử lý.
COMPLETED Quá trình xác minh đã hoàn tất.
FAILED Không xác minh được.

VerificationMethod

Chỉ định những quy trình mà Google sử dụng để xác minh một vị trí.

Enum
VERIFICATION_METHOD_UNSPECIFIED Giá trị mặc định sẽ dẫn đến lỗi.
ADDRESS Gửi bưu thiếp có mã PIN xác minh đến một địa chỉ gửi thư cụ thể. Mã PIN được dùng để hoàn tất quy trình xác minh với Google.
EMAIL Gửi email có mã PIN xác minh đến một địa chỉ email cụ thể. Mã PIN được dùng để hoàn tất quy trình xác minh với Google.
PHONE_CALL Gọi điện thoại bằng mã PIN xác minh đến một số điện thoại cụ thể. Mã PIN được dùng để hoàn tất quy trình xác minh với Google.
SMS Gửi tin nhắn SMS có mã PIN xác minh đến một số điện thoại cụ thể. Mã PIN được dùng để hoàn tất quy trình xác minh với Google.
AUTO Xác minh vị trí mà không cần người dùng thực hiện thêm hành động nào. Lựa chọn này có thể không được cung cấp cho một số vị trí.
VETTED_PARTNER Lựa chọn này có thể không được cung cấp cho một số vị trí.

VerificationOption

Tuỳ chọn xác minh thể hiện cách xác minh vị trí (được biểu thị bằng phương pháp xác minh) và nơi gửi thông tin xác minh đến (được chỉ rõ bằng dữ liệu hiển thị).

Các trường
verification_method

VerificationMethod

Phương thức để xác minh vị trí.
Trường nhóm DisplayData. Một trong các dữ liệu hiển thị. Dữ liệu phải khớp với phương thức. Để trống nếu phương thức tương ứng không có dữ liệu hiển thị nào. DisplayData chỉ có thể là một trong những trạng thái sau đây:
phone_number

string

Chỉ đặt nếu phương thức là PHONE_CALL hoặc SMS. Số điện thoại sẽ nhận mã PIN.
address_data

AddressVerificationData

Chỉ thiết lập nếu phương thức là THƯ.
email_data

EmailVerificationData

Chỉ thiết lập nếu phương thức là EMAIL.
announcement

string

Chỉ thiết lập nếu phương thức là VETTED_PARTNER.

AddressVerificationData

Hiển thị dữ liệu về các yêu cầu xác minh thông qua bưu thiếp.

Các trường
business

string

Tên doanh nghiệp của người bán.
address

PostalAddress

Địa chỉ có thể gửi bưu thiếp đến.
expected_delivery_days_region

int32

Số ngày dự kiến cần để gửi bưu thiếp đến khu vực của địa chỉ.

EmailVerificationData

Hiển thị dữ liệu cho các yêu cầu xác minh qua email.

Các trường
domain

string

Tên miền trong địa chỉ email. Ví dụ: "gmail.com" thì trong foo@gmail.com
user

string

Tên người dùng trong địa chỉ email. Ví dụ: "foo" trong foo@gmail.com
is_user_name_editable

bool

Liệu khách hàng có được phép cung cấp tên người dùng khác hay không.

VerificationToken

Mã thông báo do đối tác được xét duyệt xét duyệt tạo ra.

Các trường
token_string

string

Chuỗi mã thông báo.

Xác minh

Cho biết rằng vị trí đó yêu cầu xác minh. Chứa thông tin về những biện pháp xác minh hiện tại được thực hiện tại địa điểm đó.

Các trường
has_pending_verification

bool

Cho biết liệu quy trình xác minh đã bắt đầu hay chưa và vị trí đó có thể hoàn tất quy trình xác minh hay không.

VerifyLocationRequest

Thông báo yêu cầu cho phương thức Verifys.VerifyLocation.

Các trường
name

string

Bắt buộc. Tên tài nguyên của vị trí cần xác minh.
method

VerificationMethod

Bắt buộc. Phương thức xác minh.
language_code

string

Không bắt buộc. Mã ngôn ngữ BCP 47 đại diện cho ngôn ngữ sẽ được dùng trong quy trình xác minh.
context

ServiceBusinessContext

Không bắt buộc. Thông tin bổ sung về bối cảnh để xác minh doanh nghiệp cung cấp dịch vụ. Mã số này chỉ bắt buộc cho các địa điểm có loại hình doanh nghiệp là CUSTOMER_LOCATION_ONLY. Để xác minh ADDRESS, địa chỉ này sẽ được sử dụng để gửi bưu thiếp. Đối với các phương thức khác, phương thức này phải giống với phương thức được chuyển đến GetVerifyOptions. INVALID_{8} sẽ được gửi nếu thông số này được đặt cho các loại địa điểm doanh nghiệp khác.
Trường nhóm RequestData. Dữ liệu đầu vào của người dùng cho phương thức cụ thể ngoài dữ liệu hiển thị. Dữ liệu phải khớp với phương thức được yêu cầu. Để trống nếu không cần dữ liệu. RequestData chỉ có thể là một trong những trạng thái sau đây:
email_address

string

Không bắt buộc. Phương thức nhập cho phương thức EMAIL. Địa chỉ email sẽ nhận mã PIN.

Địa chỉ email chỉ được chấp nhận nếu địa chỉ đó là một trong những địa chỉ do FetchConfirmOptions cung cấp. Nếu giá trị [EmailConfirmData] [google.mybusiness-verifications.v1.VerifyOption.EmailVerifyData] được đặt thành true, ứng dụng có thể chỉ định một tên người dùng khác (local-part) nhưng phải khớp với tên miền.
mailer_contact

string

Không bắt buộc. Giá trị nhập cho phương thức ADDRESS. Tên liên hệ nhận thư.
phone_number

string

Không bắt buộc. Số điện thoại cần được gọi hoặc gửi SMS đến. Số điện thoại này phải là một trong các số điện thoại ở các tuỳ chọn đủ điều kiện.
token

VerificationToken

Không bắt buộc. Thông tin đầu vào cho phương thức VETTED_PARTNER được cung cấp cho một số partners.. Tài khoản đã được xét duyệt không cần thông tin nhập vào. Mã thông báo liên kết với vị trí. Mã thông báo liên kết với vị trí.

VerifyLocationResponse

Thông báo phản hồi cho Verifys.VerifyLocation.

Các trường
verification

Verification

Yêu cầu xác minh đã tạo.

VoiceOfMerchantState

Thông báo phản hồi cho VoiceOfMerchant.GetVoiceOfMerchantState.

Các trường
has_voice_of_merchant

bool

Cho biết liệu vị trí đó có ở trạng thái tốt và có quyền kiểm soát doanh nghiệp trên Google hay không. Mọi nội dung chỉnh sửa đối với vị trí sẽ được áp dụng trên Maps sau khi vượt qua giai đoạn đánh giá.
has_business_authority

bool

Cho biết liệu địa điểm có quyền (quyền sở hữu) đối với doanh nghiệp trên Google hay không. Nếu đúng thì một vị trí khác sẽ không thể chiếm dụng và trở thành trang thông tin nổi bật trên Maps. Tuy nhiên, nội dung chỉnh sửa sẽ không xuất hiện công khai trừ phi có được Voice of Merchant (Tiếng nói của người bán), ví dụ: has_voice_of_merchant là true).
Trường nhóm gain_voice_of_merchant_action. Hành động được đề xuất cho địa điểm đó để kiểm soát doanh nghiệp trên Google. gain_voice_of_merchant_action chỉ có thể là một trong những trạng thái sau đây:
wait_for_voice_of_merchant

WaitForVoiceOfMerchant

Hãy chờ để có tiếng nói của người bán. Địa điểm này đang được xem xét để nâng cao chất lượng.
verify

Verify

Bắt đầu hoặc tiếp tục quá trình xác minh.
resolve_ownership_conflict

ResolveOwnershipConflict

Vị trí này trùng lặp với một vị trí khác có trạng thái tốt. Nếu bạn có quyền truy cập vào vị trí ở trạng thái tốt, hãy sử dụng id của vị trí đó để thực hiện thao tác. Nếu không, hãy yêu cầu chủ sở hữu hiện tại cấp quyền truy cập.
comply_with_guidelines

ComplyWithGuidelines

Vị trí đó không tuân thủ nguyên tắc của chúng tôi nên sẽ cần thực hiện thêm một số bước để khôi phục. Để khắc phục vấn đề này, vui lòng tham khảo Bài viết trên Trung tâm trợ giúp.

WaitForVoiceOfMerchant

Loại này không có trường.

Cho biết vị trí sẽ nhận được giọng nói của người bán sau khi vượt qua quy trình xem xét.