Method: attributes.list

แสดงรายการแอตทริบิวต์ที่สามารถใช้ได้สำหรับสถานที่ตั้งที่มีหมวดหมู่หลักและประเทศที่ระบุ

คำขอ HTTP

GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes

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

พารามิเตอร์การค้นหา

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

string

ชื่อทรัพยากรของตำแหน่งเพื่อค้นหาแอตทริบิวต์ที่พร้อมใช้งาน หากตั้งค่าช่องนี้ไว้ ไม่จําเป็นต้องตั้ง categoryName, รหัสภูมิภาค, รหัสภาษา และ showAll
categoryName

string

รหัสแบบคงที่ของหมวดหมู่หลักสำหรับค้นหาแอตทริบิวต์ที่พร้อมใช้งาน ต้องอยู่ในรูปแบบหมวดหมู่/{category_id}
regionCode

string

รหัสประเทศ ISO 3166-1 alpha-2 เพื่อค้นหาแอตทริบิวต์ที่ใช้ได้
languageCode

string

รหัสภาษา BCP 47 ที่ใช้รับชื่อที่แสดงของแอตทริบิวต์ แต่หากไม่มีภาษาดังกล่าว ก็จะเป็นภาษาอังกฤษ
showAll

boolean

ระบบจะแสดงข้อมูลเมตาสำหรับแอตทริบิวต์ที่ใช้ได้ทั้งหมดเมื่อตั้งค่าช่องนี้เป็น "จริง" โดยไม่คำนึงถึงช่องหลักและ categoryName ต้องระบุ languageCode และregionCode เมื่อตั้งค่า showAll เป็น "จริง"
pageSize

integer

จำนวนแอตทริบิวต์ที่จะใส่ใน 1 หน้า ค่าเริ่มต้นคือ 200 และต่ำสุดคือ 1
pageToken

string

หากระบุไว้ ระบบจะดึงข้อมูลหน้าถัดไปของข้อมูลเมตาของแอตทริบิวต์

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

เนื้อหาของคำขอต้องว่างเปล่า

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

การตอบกลับสำหรับ AttributesService.ListAttributeMetadata

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

การแสดง JSON 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
ช่อง
attributeMetadata[]

object (AttributeMetadata)

คอลเล็กชันข้อมูลเมตาของแอตทริบิวต์สำหรับแอตทริบิวต์ที่พร้อมใช้งาน
nextPageToken

string

หากจำนวนแอตทริบิวต์เกินขนาดหน้าที่ขอ ระบบจะเติมข้อมูลในช่องนี้ด้วยโทเค็นเพื่อดึงข้อมูลแอตทริบิวต์หน้าถัดไปในการเรียก attributes.list ครั้งถัดไป หากไม่มีแอตทริบิวต์อื่นเพิ่มเติม ระบบจะไม่แสดงช่องนี้ในการตอบกลับ

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

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

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

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

AttributeMetadata

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

การแสดง JSON 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
ช่อง
parent

string

ตัวระบุที่ไม่ซ้ำกันสำหรับแอตทริบิวต์
valueType

enum (AttributeValueType)

ประเภทค่าของแอตทริบิวต์ ค่าที่กำหนดและดึงมาควรเป็นค่าประเภทนี้
displayName

string

ชื่อที่แสดงที่แปลแล้วของแอตทริบิวต์ (หากมี) ไม่เช่นนั้นจะใช้ชื่อที่แสดงเป็นภาษาอังกฤษ
groupDisplayName

string

ชื่อที่แสดงซึ่งแปลเป็นภาษาท้องถิ่นของกลุ่มที่มีแอตทริบิวต์นี้ (หากมี) หรือไม่เช่นนั้น จะใช้ชื่อกลุ่มภาษาอังกฤษ แอตทริบิวต์ที่เกี่ยวข้องจะรวบรวมเป็นกลุ่มและควรแสดงรวมกันภายใต้ส่วนหัวที่ระบุไว้ที่นี่
repeatable

boolean

หากเป็น "จริง" แอตทริบิวต์จะรองรับหลายค่า หากเป็น "เท็จ" ควรระบุเพียงค่าเดียว
valueMetadata[]

object (AttributeValueMetadata)

สำหรับแอตทริบิวต์บางประเภท (เช่น enum) จะมีการแสดงรายการค่าที่รองรับและชื่อที่แสดงที่เกี่ยวข้องสำหรับค่าเหล่านั้น
deprecated

boolean

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

AttributeValueMetadata

ข้อมูลเมตาสำหรับค่าแอตทริบิวต์ที่รองรับ

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

value (Value format)

ค่าแอตทริบิวต์
displayName

string

ชื่อที่แสดงสำหรับค่านี้ (หากมี) หรือไม่เช่นนั้น ให้เป็นภาษาอังกฤษ ชื่อที่แสดงของค่ามีไว้เพื่อใช้ในบริบทของชื่อที่แสดงของแอตทริบิวต์

เช่น สำหรับ "Wi-Fi" enum ของแอตทริบิวต์ ซึ่งอาจมี "Paid" เพื่อแสดง Wi-Fi แบบชำระเงิน