Package google.mybusiness.placeactions.v1

ดัชนี

• PlaceActions (อินเทอร์เฟซ)
• CreatePlaceActionLinkRequest (ข้อความ)
• DeletePlaceActionLinkRequest (ข้อความ)
• ErrorCode (enum)
• GetPlaceActionLinkRequest (ข้อความ)
• ListPlaceActionLinksRequest (ข้อความ)
• ListPlaceActionLinksResponse (ข้อความ)
• ListPlaceActionTypeMetadataRequest (ข้อความ)
• ListPlaceActionTypeMetadataResponse (ข้อความ)
• PlaceActionLink (ข้อความ)
• PlaceActionLink.ProviderType (enum)
• PlaceActionType (enum)
• PlaceActionTypeMetadata (ข้อความ)
• UpdatePlaceActionLinkRequest (ข้อความ)

PlaceActions

API นี้ช่วยให้สามารถจัดการลิงก์ PlaceAction ของที่ตั้งธุรกิจ

CreatePlaceActionLink

rpc CreatePlaceActionLink(CreatePlaceActionLinkRequest) returns (PlaceActionLink) สร้างลิงก์การดำเนินการเกี่ยวกับสถานที่ที่เชื่อมโยงกับตำแหน่งที่ระบุ และส่งลิงก์กลับมา คำขอนี้จะถือว่าซ้ำหาก parent, place_action_link.uri และ place_action_link.place_action_type เหมือนกับคำขอก่อนหน้า ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/business.manage ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

DeletePlaceActionLink
rpc DeletePlaceActionLink(DeletePlaceActionLinkRequest) returns (Empty) ลบลิงก์การดำเนินการเกี่ยวกับสถานที่ออกจากตำแหน่งที่ระบุ ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/business.manage ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

GetPlaceActionLink
rpc GetPlaceActionLink(GetPlaceActionLinkRequest) returns (PlaceActionLink) รับลิงก์การดำเนินการเกี่ยวกับสถานที่ที่ระบุ ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/business.manage ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

ListPlaceActionLinks
rpc ListPlaceActionLinks(ListPlaceActionLinksRequest) returns (ListPlaceActionLinksResponse) แสดงลิงก์การดำเนินการเกี่ยวกับสถานที่สำหรับตำแหน่งที่ระบุ ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/business.manage ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

ListPlaceActionTypeMetadata
rpc ListPlaceActionTypeMetadata(ListPlaceActionTypeMetadataRequest) returns (ListPlaceActionTypeMetadataResponse) แสดงรายการประเภทการดำเนินการเกี่ยวกับสถานที่ที่ใช้ได้สําหรับสถานที่ตั้งหรือประเทศ ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/business.manage ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

UpdatePlaceActionLink
rpc UpdatePlaceActionLink(UpdatePlaceActionLinkRequest) returns (PlaceActionLink) อัปเดตลิงก์การดำเนินการเกี่ยวกับสถานที่ที่ระบุและส่งลิงก์กลับมา ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/business.manage ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0

CreatePlaceActionLinkRequest

ข้อความคำขอสำหรับ PlaceActions.CreatePlaceActionLink

ช่อง
parent	string ต้องระบุ ชื่อทรัพยากรของสถานที่ที่จะสร้างลิงก์การกระทำเกี่ยวกับสถานที่นี้ locations/{location_id}.
place_action_link	PlaceActionLink ต้องระบุ ลิงก์การดำเนินการเกี่ยวกับสถานที่ที่จะสร้างขึ้น

DeletePlaceActionLinkRequest

ข้อความคำขอสำหรับ PlaceActions.DeletePlaceActionLink

ช่อง
name	string ต้องระบุ ชื่อทรัพยากรของลิงก์การดำเนินการเกี่ยวกับสถานที่ที่จะนำออกจากตำแหน่ง

ErrorCode

รหัสข้อผิดพลาดสำหรับความล้มเหลวภายใน

Enum
ERROR_CODE_UNSPECIFIED	รหัสข้อผิดพลาดที่ไม่ได้ระบุ
UNVERIFIED_LOCATION	สถานที่ไม่ได้รับการยืนยัน
INVALID_LOCATION_CATEGORY	หมวดหมู่สถานที่ตั้งไม่มีสิทธิ์สำหรับประเภทการทำงานเกี่ยวกับสถานที่ ระบบจะแสดงประเภทการดำเนินการเกี่ยวกับสถานที่ที่ทำให้เกิดข้อผิดพลาดในข้อมูลเมตา โดยมีสตริง "place_action_type" เป็นคีย์และสตริงค่า enum PlaceActionType เป็นค่า
INVALID_URL	URL ผิดรูปแบบ/ไม่ถูกต้อง ระบบจะแสดงผล URL การดำเนินการของสถานที่ที่ไม่ถูกต้องในข้อมูลเมตา โดยมีสตริง "url" เป็นคีย์ และ url เป็นค่า
URL_PROVIDER_NOT_ALLOWED	URL มีผู้ให้บริการที่ไม่ได้รับอนุญาต ระบบจะแสดงผล URL การดำเนินการเกี่ยวกับสถานที่ที่ไม่ได้รับอนุญาตในข้อมูลเมตา โดยมีสตริง "url" เป็นคีย์และ url เป็นค่า
TOO_MANY_VALUES	มีการตั้งค่าสำหรับประเภทการดำเนินการเกี่ยวกับสถานที่มากเกินไป ระบบจะแสดงผลประเภทที่ถึงขีดจำกัดในข้อมูลเมตา โดยมีสตริง "place_action_type" เป็นคีย์และสตริงค่า enum PlaceActionType เป็นค่า
DELETED_LINK	ลิงก์การดำเนินการเกี่ยวกับสถานที่ที่ขอถูกลบแล้ว URL ที่เกี่ยวข้องจะแสดงในข้อมูลเมตา โดยมีสตริง "url" เป็นคีย์และ url เป็นค่า
LINK_ALREADY_EXISTS	ระบบกำลังร้องขอการอัปเดตเพื่อแปลงลิงก์การดำเนินการเกี่ยวกับสถานที่เป็นลิงก์ที่มีอยู่แล้ว โดยมี URI และประเภทเดียวกันในตำแหน่งที่ระบุ
SCALABLE_DEEP_LINK_INVALID_MULTIPLICITY	โดเมนที่มีลิงก์อยู่นั้นถูกใช้งานแล้ว และมีการจำกัดจำนวนลิงก์ 1 รายการต่อโดเมนสำหรับ PlaceActionType แต่ละประเภท
LINK_DOES_NOT_EXIST	มีการระบุลิงก์ที่ไม่พบในฐานข้อมูล

GetPlaceActionLinkRequest

ข้อความคำขอสำหรับ PlaceActions.GetPlaceActionLink

ช่อง
name	string ต้องระบุ ชื่อของลิงก์การดำเนินการเกี่ยวกับสถานที่ที่จะดึงข้อมูล

ListPlaceActionLinksRequest

ข้อความคำขอสำหรับ PlaceActions.ListPlaceActionLinks ตัวเลือกนี้จะแสดงลิงก์การดำเนินการเกี่ยวกับสถานที่สำหรับสถานที่ โดยไม่เรียงตามลำดับเฉพาะ ซึ่งอาจไม่แสดงลิงก์ที่สร้างขึ้นเมื่อเร็วๆ นี้ (ภายใน 24 ชั่วโมงที่ผ่านมา) ผ่านแพลตฟอร์มอื่นๆ เช่น เว็บไซต์ Google MyBusiness ลิงก์ใดก็ตามที่สร้างไว้แล้วนานกว่า 24 ชั่วโมงจะแสดงผ่าน API นี้

ช่อง
parent	string ต้องระบุ ชื่อของสถานที่ตั้งซึ่งลิงก์การดำเนินการเกี่ยวกับสถานที่จะแสดงอยู่ locations/{location_id}.
filter	string ไม่บังคับ ตัวกรองที่จํากัดลิงก์การดำเนินการเกี่ยวกับสถานที่ที่จะแสดง การตอบกลับมีรายการที่ตรงกับตัวกรอง เราสนับสนุนเฉพาะตัวกรองต่อไปนี้: 1.place_action_type=XYZ โดย XYZ เป็น PlaceActionType ที่ถูกต้อง
page_size	int32 ไม่บังคับ จำนวนลิงก์การดำเนินการเกี่ยวกับสถานที่ที่จะส่งคืนต่อหน้า ค่าเริ่มต้นคือ 10 ค่าต่ำสุดคือ 1
page_token	string ไม่บังคับ หากระบุไว้ ระบบจะแสดงหน้าถัดไปของลิงก์การดำเนินการเกี่ยวกับสถานที่

ListPlaceActionLinksResponse

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

ช่อง
place_action_links[]	PlaceActionLink รายการที่แสดงลิงก์การดำเนินการเกี่ยวกับสถานที่
next_page_token	string หากมีลิงก์การดำเนินการเกี่ยวกับสถานที่มากกว่าขนาดหน้าเว็บที่ขอ ระบบจะป้อนข้อมูลในช่องนี้ด้วยโทเค็นเพื่อดึงผลการค้นหาหน้าถัดไป

ListPlaceActionTypeMetadataRequest

ข้อความคำขอสำหรับ PlaceActions.ListPlaceActionTypeMetadata ผลลัพธ์จะไม่แสดงผลในลำดับที่เฉพาะเจาะจง

ช่อง
language_code	string ไม่บังคับ รหัสภาษา IETF BCP-47 สำหรับใช้แสดงชื่อที่แสดง หากยังไม่มีข้อมูลดังกล่าวจะเป็นภาษาอังกฤษ
page_size	int32 ไม่บังคับ จำนวนประเภทการทำงานที่จะรวมต่อหน้าเว็บ ค่าเริ่มต้นคือ 10 และต่ำสุดคือ 1
page_token	string ไม่บังคับ หากระบุไว้ ระบบจะเรียกข้อมูลเมตาของประเภทการทำงานเกี่ยวกับสถานที่ถัดไป ระบบจะแสดงผล pageToken เมื่อการเรียก placeActionTypeMetadata.list ให้ผลลัพธ์มากเกินกว่าจะพอดีกับขนาดหน้าเว็บที่ขอ
filter	string ไม่บังคับ ตัวกรองที่จํากัดประเภทการดําเนินการของสถานที่ที่จะแสดงข้อมูลเมตา การตอบกลับมีรายการที่ตรงกับตัวกรอง เรารองรับเฉพาะตัวกรองต่อไปนี้ 1. location=XYZ โดยที่ XYZ เป็นสตริงที่ระบุชื่อทรัพยากรของตำแหน่งในรูปแบบ locations/{location_id} 2.region_code=XYZ โดยที่ XYZ เป็นรหัสภูมิภาค CLDR แบบ Unicode เพื่อหาประเภทการทำงานที่ใช้ได้ หากไม่ใช้ตัวกรอง ระบบจะแสดงประเภทการดำเนินการเกี่ยวกับสถานที่ทั้งหมด

ListPlaceActionTypeMetadataResponse

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

ช่อง
place_action_type_metadata[]	PlaceActionTypeMetadata คอลเล็กชันของข้อมูลเมตาสำหรับประเภทการดำเนินการเกี่ยวกับสถานที่ที่ใช้ได้
next_page_token	string หากประเภทการดำเนินการมีจำนวนเกินขนาดหน้าเว็บที่ขอ ระบบจะป้อนข้อมูลในฟิลด์นี้พร้อมด้วยโทเค็นเพื่อดึงข้อมูลหน้าถัดไปในการเรียก placeActionTypeMetadata.list ในภายหลัง หากไม่มีผลลัพธ์เพิ่มเติม ระบบจะไม่แสดงช่องนี้ในการตอบกลับ

PlaceActionLink

แสดงลิงก์การดำเนินการเกี่ยวกับสถานที่และแอตทริบิวต์

ช่อง
name	string ไม่บังคับ ชื่อทรัพยากรในรูปแบบ locations/{location_id}/placeActionLinks/{place_action_link_id} ฟิลด์ชื่อจะได้รับการพิจารณาเฉพาะในคำขอ UpdatePlaceActionLink และ DeletePlaceActionLink สำหรับการอัปเดตและลบลิงก์ตามลำดับ แต่ระบบจะไม่นำมาพิจารณาในคำขอ CreatePlaceActionLink โดยที่เซิร์ฟเวอร์จะเป็นผู้กำหนด place_action_link_id เมื่อสร้างลิงก์ใหม่สำเร็จและจะแสดงเป็นส่วนหนึ่งของการตอบกลับ
provider_type	ProviderType เอาต์พุตเท่านั้น ระบุประเภทผู้ให้บริการ
is_editable	bool เอาต์พุตเท่านั้น ระบุว่าไคลเอ็นต์แก้ไขลิงก์นี้ได้หรือไม่
uri	string ต้องระบุ URI ลิงก์ URI เดียวกันจะนำมาใช้ซ้ำสำหรับประเภทการทำงานที่ต่างกันในสถานที่ต่างๆ ได้ อย่างไรก็ตาม อนุญาตให้มีลิงก์การดำเนินการเกี่ยวกับสถานที่เพียงลิงก์เดียวสําหรับชุดค่าผสมที่ไม่ซ้ำกันแต่ละชุดของ (uri, ประเภทการกระทําเกี่ยวกับสถานที่, สถานที่ตั้ง)
place_action_type	PlaceActionType ต้องระบุ ประเภทของการดำเนินการเกี่ยวกับสถานที่ที่สามารถทำได้โดยใช้ลิงก์นี้
is_preferred	bool ไม่บังคับ ผู้ขายต้องการลิงก์นี้หรือไม่ ทําเครื่องหมายลิงก์ที่ต้องการเป็นลิงก์ที่ต้องการได้เพียง 1 ลิงก์ต่อประเภทการทํางานเกี่ยวกับสถานที่ในสถานที่ตั้งหนึ่งๆ หากคำขอในอนาคตทำเครื่องหมายลิงก์อื่นว่าเป็นลิงก์ที่ต้องการสำหรับการดำเนินการประเภทสถานที่เดียวกัน ลิงก์ที่ต้องการในปัจจุบัน (หากมี) จะเสียค่ากำหนดนั้นไป
create_time	Timestamp เอาต์พุตเท่านั้น เวลาที่สร้างลิงก์การดำเนินการเกี่ยวกับสถานที่
update_time	Timestamp เอาต์พุตเท่านั้น เวลาที่แก้ไขลิงก์การดำเนินการเกี่ยวกับสถานที่ครั้งล่าสุด

ProviderType

ประเภทของผู้ให้บริการลิงก์ ที่อ่านได้เท่านั้น

Enum
PROVIDER_TYPE_UNSPECIFIED	ไม่ได้ระบุ
MERCHANT	ผู้ให้บริการบุคคลที่หนึ่ง เช่น ผู้ขายหรือเอเจนซีในนามของผู้ขาย
AGGREGATOR_3P	ผู้รวบรวมข้อมูลของบุคคลที่สาม เช่น พาร์ทเนอร์ Reserve with Google

PlaceActionType

ประเภทการดำเนินการเกี่ยวกับสถานที่ที่ทําได้โดยใช้ลิงก์

Enum
PLACE_ACTION_TYPE_UNSPECIFIED	ไม่ได้ระบุ
APPOINTMENT	ประเภทการดำเนินการคือการจองการนัดหมาย
ONLINE_APPOINTMENT	ประเภทการดำเนินการคือการจองการนัดหมายออนไลน์
DINING_RESERVATION	ประเภทการดำเนินการคือการจองโต๊ะอาหาร
FOOD_ORDERING	ประเภทการดำเนินการคือการสั่งอาหารสำหรับจัดส่งและ/หรือสั่งกลับบ้าน
FOOD_DELIVERY	ประเภทการดำเนินการคือการสั่งอาหารให้จัดส่งถึงที่
FOOD_TAKEOUT	ประเภทการดำเนินการคือการสั่งอาหารสำหรับสั่งกลับบ้าน
SHOP_ONLINE	ประเภทการดำเนินการคือการช็อปปิ้ง ซึ่งอาจเป็นการจัดส่งและ/หรือไปรับที่ร้านก็ได้

PlaceActionTypeMetadata

ข้อมูลเมตาสำหรับประเภทการดำเนินการเกี่ยวกับสถานที่ที่รองรับ

ช่อง
place_action_type	PlaceActionType ประเภทการดำเนินการเกี่ยวกับสถานที่
display_name	string ชื่อที่แสดงที่แปลแล้วสำหรับแอตทริบิวต์ (หากมี) หรือชื่อที่แสดงภาษาอังกฤษ

UpdatePlaceActionLinkRequest

ข้อความคำขอสำหรับ PlaceActions.UpdatePlaceActionLink

ช่อง
place_action_link	PlaceActionLink ต้องระบุ ลิงก์การดำเนินการเกี่ยวกับสถานที่ที่อัปเดต
update_mask	FieldMask ต้องระบุ ช่องที่ต้องการให้อัปเดต ช่องที่แก้ไขได้มีเพียง uri, place_action_type และ is_preferred หากลิงก์ที่อัปเดตนั้นมีอยู่แล้วในตําแหน่งเดียวกันโดยมี place_action_type และ uri เดียวกัน ก็จะดำเนินการไม่สำเร็จโดยมีข้อผิดพลาด ALREADY_EXISTS