Method: locations.verify

เริ่มกระบวนการยืนยันสำหรับสถานที่

คำขอ HTTP

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

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

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

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

string

ต้องระบุ ชื่อทรัพยากรของสถานที่ที่ยืนยัน

เนื้อหาของคำขอ

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

การแสดง JSON
{
  "method": enum (VerificationMethod),
  "languageCode": string,
  "context": {
    object (ServiceBusinessContext)
  },

  // Union field RequestData can be only one of the following:
  "emailAddress": string,
  "mailerContact": string,
  "phoneNumber": string,
  "token": {
    object (VerificationToken)
  }
  // End of list of possible types for union field RequestData.
}
ช่อง
method

enum (VerificationMethod)

ต้องระบุ วิธีการยืนยัน

languageCode

string

ไม่บังคับ รหัสภาษา BCP 47 ซึ่งแสดงภาษาที่ใช้สำหรับกระบวนการยืนยัน

context

object (ServiceBusinessContext)

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

ช่องการรวม RequestData ข้อมูลอินพุตของผู้ใช้สำหรับวิธีที่เฉพาะเจาะจงนอกเหนือจากข้อมูลการแสดงผล ข้อมูลต้องตรงกับวิธีการที่ขอ โปรดปล่อยว่างไว้หากไม่จำเป็นต้องใช้ข้อมูล RequestData ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
emailAddress

string

ไม่บังคับ อินพุตสำหรับเมธอด EMAIL ที่อยู่อีเมลปลายทางสำหรับส่ง PIN

เราจะยอมรับอีเมลก็ต่อเมื่อเป็นหนึ่งในที่อยู่ที่ locations.fetch VerificationOptions แจ้งไว้ หาก [Email VerificationData] [google.mybusiness-verifications.v1.ConfirmOption.Email VerificationData] ตั้งค่า isUserNameEditable เป็น "จริง" ไคลเอ็นต์อาจระบุชื่ออื่น (local-part) แต่ต้องตรงกับชื่อโดเมน

mailerContact

string

ไม่บังคับ อินพุตสำหรับเมธอด ADDRESS ชื่อผู้ติดต่อที่อีเมลควรส่งถึง

phoneNumber

string

ไม่บังคับ อินพุตสำหรับวิธี PHONE_CALL/SMS หมายเลขโทรศัพท์ที่ควรโทรหาหรือส่ง SMS ถึง ต้องเป็นหมายเลขโทรศัพท์หนึ่งในตัวเลือกที่มีสิทธิ์

token

object (VerificationToken)

ไม่บังคับ อินพุตสำหรับเมธอด VETTED_PARTNER ที่ใช้ได้กับพาร์ทเนอร์บางราย บัญชีที่ผ่านการตรวจสอบแล้วไม่จําเป็นต้องป้อนข้อมูลนี้ โทเค็นที่เชื่อมโยงกับสถานที่ตั้ง โทเค็นที่เชื่อมโยงกับสถานที่ตั้ง

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

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

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

การแสดง JSON
{
  "verification": {
    object (Verification)
  }
}
ช่อง
verification

object (Verification)

คำขอการยืนยันที่สร้างขึ้น

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0

VerificationToken

โทเค็นที่สร้างโดยพาร์ทเนอร์ที่ผ่านการตรวจสอบ

การแสดง JSON
{
  "tokenString": string
}
ช่อง
tokenString

string

สตริงโทเค็น