Package google.mybusiness.verifications.v1

索引

認證

這個 API 可讓您管理 Google 的地點驗證。可讓你管理 [驗證] [google.mybusiness.v1.Verification] 資源。

每個 [Location] [google.mybusiness.businessinformation.locations.v1.Location] 都有一系列的 [驗證] [google.mybusiness.verifications] 資源，名稱為「locations/*/verifications/*」。

CompleteVerification

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 總覽。

VoiceOfMerchant

這項服務可讓第三方使用者要求商家所在州的語音詳細資料。

GetVoiceOfMerchantState

rpc GetVoiceOfMerchantState(GetVoiceOfMerchantStateRequest) returns (VoiceOfMerchantState)

取得 VoiceOfMerchant 狀態。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。

CompleteVerificationRequest

Verifications.CompleteVerificationAction 要求訊息。

欄位
name

string

必要欄位。待驗證作業的資源名稱。
pin

string

必要欄位。商家收到的 PIN 碼，才能完成驗證。

CompleteVerificationResponse

Verifications.CompleteVerificationAction 的回應訊息。

欄位
verification

Verification

完成驗證。

ComplyWithGuidelines

指出該地區不符合我們的規範。

欄位
recommendation_reason

RecommendationReason

建議該地點遵循規範的原因。

RecommendationReason

指出建議地點遵循規範的原因。

列舉
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_COUNTRY。

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

如果驗證次數超過要求的頁面大小，系統會在這個欄位填入一個符記，以擷取後續呼叫的下一頁驗證。如果沒有其他屬性，回應中就不會顯示這個欄位。

ResolveOwnershipConflict

這個類型沒有任何欄位。

表示該地點與其他記錄良好的地點重複。

ServiceBusinessContext

服務商家驗證的其他資料。

欄位
address

PostalAddress

地點的驗證地址。這些資訊可用於啟用更多驗證選項或傳送明信片。

驗證

驗證是指某個地點的驗證嘗試。

欄位
name

string

驗證的資源名稱。
method

VerificationMethod

驗證方式。
state

State

驗證狀態，
create_time

Timestamp

要求驗證的時間戳記。
announcement

string

選用設定。只有在方法為 VETTED_PARTNER 時，才需要設定回應公告。

狀態

所有可能的驗證狀態。

列舉
STATE_UNSPECIFIED 預設值會產生錯誤。
PENDING 正在等待驗證，
COMPLETED 驗證完成。
FAILED 驗證失敗，

VerificationMethod

指定 Google 用來驗證位置資訊的程序。

列舉
VERIFICATION_METHOD_UNSPECIFIED 預設值會產生錯誤。
ADDRESS 將含有驗證 PIN 碼的明信片寄到特定郵寄地址。你可以使用 PIN 碼完成 Google 驗證程序。
EMAIL 將內含驗證 PIN 碼的電子郵件傳送至特定電子郵件地址。你可以使用 PIN 碼完成 Google 驗證程序。
PHONE_CALL 撥打特定電話號碼的驗證 PIN 碼。你可以使用 PIN 碼完成 Google 驗證程序。
SMS 傳送內含驗證 PIN 碼的簡訊到特定的電話號碼。你可以使用 PIN 碼完成 Google 驗證程序。
AUTO 在使用者不需執行其他操作的情況下驗證地點。部分地區可能無法使用這個選項。
VETTED_PARTNER 部分地區可能無法使用這個選項。

VerificationOption

驗證選項是指如何驗證位置 (以驗證方法表示)，以及驗證的目的地 (以多媒體廣告資料表示)。

欄位
verification_method

VerificationMethod

驗證地點的方法。
聯集欄位 DisplayData。其中一個顯示資料。資料必須與方法相符。如果對應的方法沒有任何顯示資料，則為空白。DisplayData 只能是下列其中一項：
phone_number

string

只有在方法為 PHONE_CALL 或 SMS 時才需要設定。要接收 PIN 碼的電話號碼。
address_data

AddressVerificationData

只有在方法為 導致 時，才需要設定。
email_data

EmailVerificationData

只有在方法為 EMAIL 時才會設定。
announcement

string

只有在方法為 VETTED_PARTNER 時才需要設定。

AddressVerificationData

透過明信片顯示驗證資料。

欄位
business

string

商家的商家名稱。
address

PostalAddress

明信片的收件地址。
expected_delivery_days_region

int32

寄送明信片到地址所在區域的預估天數。

EmailVerificationData

顯示透過電子郵件進行驗證的資料。

欄位
domain

string

電子郵件地址中的網域名稱，例如 foo@gmail.com 中的「gmail.com」
user

string

電子郵件地址中的使用者名稱，例如 foo@gmail.com 中的「foo」
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」的地點需要這項參數。如果是地址驗證，地址將用於寄送明信片。如果是其他方法，則應與傳遞至 GetVerificationOptions 的方法相同。如果為其他類型的商家所在地點設定 INVALID_VALUE，則系統會擲回該字串。
聯集欄位 RequestData。除了顯示資料以外，特定方法的使用者輸入資料。資料必須符合要求的方法。如果不需要資料，請留空。RequestData 只能是下列其中一項：
email_address

string

選用設定。EMAIL 方法的輸入內容。接收 PIN 碼的電子郵件地址。

系統只會接受 FetchVerificationOptions 所提供的其中一個地址電子郵件地址。如果 [EmailVerificationData] [google.mybusiness-verifications.v1.VerificationOption.EmailVerificationData] 設為 true，則用戶端可以指定不同的使用者名稱 (local-part)，但必須與網域名稱相符。
mailer_contact

string

選用設定。ADDRESS 方法的輸入內容。要接收郵件的聯絡人姓名。
phone_number

string

選用設定。PHONE_CALL/SMS 方法的輸入內容。應用於通話或傳送簡訊的電話號碼。且必須是適用選項中其中一個電話號碼。
token

VerificationToken

選用設定。可供特定partners.使用的 VETTED_PARTNER 方法輸入內容。無須為通過審查的帳戶輸入資料。與位置相關聯的權杖。與位置相關聯的權杖。

VerifyLocationResponse

Verifications.VerifyLocation 的回應訊息。

欄位
verification

Verification

已建立的驗證要求。

VoiceOfMerchantState

VoiceOfMerchant.GetVoiceOfMerchantState 的回應訊息。

欄位
has_voice_of_merchant

bool

指出該地點是否記錄良好，且可在 Google 上控管商家。審核階段結束後，您對地點所做的任何修改都會反映在 Google 地圖上。
has_business_authority

bool

指出營業地點是否針對 Google 上的商家取得權威 (擁有權)。如果為 true，則其他地點就無法獲得 Google 地圖上的主要商家資訊。不過，除非取得商家之 Voice (例如 has_voice_of_merchant)，否則編輯內容不會上線。
聯集欄位 gain_voice_of_merchant_action。建議對商家採取行動，以便取得 Google 上商家的控制權。gain_voice_of_merchant_action 只能是下列其中一項：
wait_for_voice_of_merchant

WaitForVoiceOfMerchant

等待取得商家之 Voice。我們正在審查該地點，以確保品質。
verify

Verify

開始或繼續驗證程序。
resolve_ownership_conflict

ResolveOwnershipConflict

這個地點與其他記錄良好的地點重複。如果可以存取地點記錄良好，請使用該位置的 ID 執行作業。或者，您也可以向目前的擁有者要求存取權。
comply_with_guidelines

ComplyWithGuidelines

該地點不符合我們的規範，且需要採取其他步驟才能恢復顯示。如要修正這個問題，請參閱說明中心文章。

WaitForVoiceOfMerchant

這個類型沒有任何欄位。

表示該地點在通過評論後將獲得商家身分。