- คำขอ HTTP
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- AttributeMetadata
- AttributeValueMetadata
แสดงรายการแอตทริบิวต์ที่สามารถใช้ได้ในสถานที่ที่มีหมวดหมู่หลักและประเทศที่ระบุ
คำขอ HTTP
GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
parent |
ชื่อทรัพยากรของสถานที่ตั้งสำหรับค้นหาแอตทริบิวต์ที่ใช้ได้ หากตั้งค่าช่องนี้แล้ว คุณไม่จำเป็นต้องตั้งค่า categoryName,regionCode, languageCode และ showAll และต้องไม่ตั้งค่า |
categoryName |
รหัสหมวดหมู่หลักแบบคงที่สำหรับค้นหาแอตทริบิวต์ที่ใช้ได้ ต้องอยู่ในรูปแบบหมวดหมู่/{category_id} |
regionCode |
รหัสประเทศตามมาตรฐาน ISO 3166-1 alpha-2 เพื่อค้นหาแอตทริบิวต์ที่ใช้ได้ |
languageCode |
รหัสภาษา BCP 47 ที่จะใช้สำหรับชื่อที่แสดงของแอตทริบิวต์ หากยังไม่มีข้อมูลดังกล่าวจะเป็นภาษาอังกฤษ |
showAll |
ข้อมูลเมตาสำหรับแอตทริบิวต์ที่มีอยู่ทั้งหมดจะแสดงเมื่อตั้งค่าช่องนี้เป็น true โดยไม่สนใจช่องหลักและ categoryName ต้องมี languageCode และregionCode เมื่อตั้งค่า showAll เป็น true |
pageSize |
จำนวนแอตทริบิวต์ที่จะรวมไว้ในหน้าเว็บ ค่าเริ่มต้นคือ 200 และต่ำสุดคือ 1 |
pageToken |
หากระบุไว้ ระบบจะเรียกหน้าถัดไปของข้อมูลเมตาแอตทริบิวต์ |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
การตอบสนองสำหรับ AttributesService.ListAttributeMetadata
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"attributeMetadata": [
{
object ( |
ช่อง | |
---|---|
attributeMetadata[] |
คอลเล็กชันของข้อมูลเมตาของแอตทริบิวต์สำหรับแอตทริบิวต์ที่พร้อมใช้งาน |
nextPageToken |
หากจำนวนแอตทริบิวต์เกินขนาดหน้าเว็บที่ร้องขอ ระบบจะป้อนข้อมูลในช่องนี้ด้วยโทเค็นเพื่อดึงข้อมูลหน้าถัดไปของแอตทริบิวต์ในการเรียก |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
https://www.googleapis.com/auth/business.manage
ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0
AttributeMetadata
ข้อมูลเมตาสำหรับแอตทริบิวต์ มีข้อมูลที่แสดงสำหรับแอตทริบิวต์ ซึ่งรวมถึงชื่อที่แปลแล้ว และส่วนหัวสำหรับจัดกลุ่มแอตทริบิวต์ที่เกี่ยวข้องไว้ด้วยกัน
การแสดง JSON |
---|
{ "parent": string, "valueType": enum ( |
ช่อง | |
---|---|
parent |
ตัวระบุที่ไม่ซ้ำกันสำหรับแอตทริบิวต์ |
valueType |
ประเภทค่าสำหรับแอตทริบิวต์ ค่าที่ตั้งไว้และค่าที่ดึงมาควรเป็นค่าประเภทนี้ |
displayName |
ชื่อที่แสดงที่แปลแล้วสำหรับแอตทริบิวต์ (หากมี) หรือชื่อที่แสดงภาษาอังกฤษ |
groupDisplayName |
ชื่อที่แสดงซึ่งแปลเป็นภาษาท้องถิ่นของกลุ่มที่มีแอตทริบิวต์นี้ (หากมี) หรือไม่เช่นนั้นจะเป็นชื่อกลุ่มภาษาอังกฤษ ระบบจะรวบรวมแอตทริบิวต์ที่เกี่ยวข้องเป็นกลุ่มและควรแสดงร่วมกันภายใต้ส่วนหัวที่ให้ไว้ที่นี่ |
repeatable |
หากเป็น "จริง" แอตทริบิวต์จะรองรับหลายค่า หากเป็น "เท็จ" ควรระบุเพียงค่าเดียว |
valueMetadata[] |
สำหรับแอตทริบิวต์บางประเภท (เช่น enum) จะมีรายการค่าที่รองรับและชื่อที่แสดงที่เกี่ยวข้องสำหรับค่าเหล่านั้น |
deprecated |
หากเป็น "จริง" หมายความว่าเลิกใช้งานแอตทริบิวต์ดังกล่าวแล้วและไม่ควรใช้อีกต่อไป หากเลิกใช้งานแล้ว การอัปเดตแอตทริบิวต์นี้จะไม่ทำให้เกิดข้อผิดพลาด แต่ระบบจะไม่บันทึกการอัปเดต เมื่อถึงช่วงหนึ่งหลังจากเลิกใช้งาน ระบบจะนำแอตทริบิวต์ออกทั้งหมดและจะกลายเป็นข้อผิดพลาด |
AttributeValueMetadata
ข้อมูลเมตาสำหรับค่าแอตทริบิวต์ที่รองรับ
การแสดง JSON |
---|
{ "value": value, "displayName": string } |
ช่อง | |
---|---|
value |
ค่าแอตทริบิวต์ |
displayName |
ชื่อที่แสดงสำหรับค่านี้ ซึ่งแปลเป็นภาษาท้องถิ่นหากมี หรือเป็นภาษาอังกฤษ ชื่อที่แสดงของค่ามีไว้เพื่อใช้ในบริบทที่มีชื่อที่แสดงของแอตทริบิวต์ เช่น สำหรับแอตทริบิวต์ enum "WiFi" ค่านี้อาจมี "ชำระเงินแล้ว" เพื่อแสดงเป็น Wi-Fi แบบชำระเงิน |