Method: locations.fetchVerificationOptions

รายงานตัวเลือกการยืนยันที่มีสิทธิ์ทั้งหมดสำหรับสถานที่ตั้งในภาษาที่เฉพาะเจาะจง

คำขอ HTTP

POST https://mybusinessverifications.googleapis.com/v1/{location=locations/*}:fetchVerificationOptions

URL ใช้ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
location

string

ต้องระบุ สถานที่ตั้งที่จะยืนยัน

เนื้อความของคำขอ

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON
{
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  }
}
ช่อง
languageCode

string

ต้องระบุ รหัสภาษา BCP 47 ที่แสดงถึงภาษาที่จะใช้สำหรับกระบวนการยืนยันตัวตน ตัวเลือกที่ใช้ได้จะแตกต่างกันไปตามภาษา

context

object (ServiceBusinessContext)

ไม่บังคับ ข้อมูลบริบทเพิ่มเติมสำหรับการยืนยันธุรกิจบริการ ใช้ได้กับสถานที่ตั้งที่มีประเภทธุรกิจเป็น CUSTOMER_LOCATION_ONLY เท่านั้น การระบุที่อยู่ที่ถูกต้องอาจช่วยให้มีตัวเลือกมากขึ้น ระบบจะแสดง INVALID_ARGUMENT หากตั้งค่าไว้สำหรับสถานที่ตั้งของธุรกิจประเภทอื่นๆ

เนื้อหาการตอบกลับ

ข้อความตอบกลับสำหรับ Verifications.FetchVerificationOptions

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON
{
  "options": [
    {
      object (VerificationOption)
    }
  ]
}
ช่อง
options[]

object (VerificationOption)

ตัวเลือกการยืนยันที่ใช้ได้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่ OAuth 2.0 Overview

VerificationOption

ตัวเลือกการยืนยันแสดงวิธีที่จะยืนยันสถานที่ตั้ง (ระบุโดยวิธีการยืนยัน) และสถานที่ที่จะส่งการยืนยันไป (ระบุโดยข้อมูลที่แสดง)

การแสดง JSON
{
  "verificationMethod": enum (VerificationMethod),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "phoneNumber": string,
  "addressData": {
    object (AddressVerificationData)
  },
  "emailData": {
    object (EmailVerificationData)
  },
  "announcement": string
  // End of mutually exclusive fields.
}
ช่อง
verificationMethod

enum (VerificationMethod)

วิธีการยืนยันสถานที่ตั้ง

ข้อมูลที่แสดงอย่างใดอย่างหนึ่ง ข้อมูลต้องตรงกับวิธีการ เว้นว่างไว้หากวิธีการที่เกี่ยวข้องไม่มีข้อมูลที่แสดง รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
phoneNumber

string

ตั้งค่าเฉพาะในกรณีที่วิธีการคือ PHONE_CALL หรือ SMS หมายเลขโทรศัพท์ที่จะใช้รับ PIN

addressData

object (AddressVerificationData)

ตั้งค่าเฉพาะในกรณีที่วิธีการคือ MAIL

emailData

object (EmailVerificationData)

ตั้งค่าเฉพาะในกรณีที่วิธีการคือ EMAIL

announcement

string

ตั้งค่าเฉพาะในกรณีที่เมธอดเป็น VETTED_PARTNER

สิ้นสุดฟิลด์ที่แยกกัน

AddressVerificationData

แสดงข้อมูลสำหรับการยืนยันผ่านไปรษณียบัตร

การแสดง JSON
{
  "business": string,
  "address": {
    object (PostalAddress)
  },
  "expectedDeliveryDaysRegion": integer
}
ช่อง
business

string

ชื่อธุรกิจของผู้ขาย

address

object (PostalAddress)

ที่อยู่ที่สามารถส่งไปรษณียบัตรได้

expectedDeliveryDaysRegion

integer

จำนวนวันที่คาดว่าจะใช้ในการส่งไปรษณียบัตรไปยังภูมิภาคของที่อยู่

EmailVerificationData

แสดงข้อมูลสำหรับการยืนยันทางอีเมล

การแสดง JSON
{
  "domain": string,
  "user": string,
  "isUserNameEditable": boolean
}
ช่อง
domain

string

ชื่อโดเมนในอีเมล เช่น "gmail.com" ใน foo@gmail.com

user

string

ชื่อผู้ใช้ในอีเมล เช่น "foo" ใน foo@gmail.com

isUserNameEditable

boolean

อนุญาตให้ไคลเอ็นต์ระบุชื่อผู้ใช้อื่นหรือไม่