Method: attributes.list

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

คำขอ HTTP

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

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

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

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

string

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

รูปแบบ: locations/{locationId} (เช่น locations/1234567890)
categoryName

string

ไม่บังคับ รหัสคงที่ของหมวดหมู่หลักเพื่อค้นหาแอตทริบิวต์ที่ใช้ได้ ต้องอยู่ในรูปแบบ categories/{category_id} (เช่น categories/gcid:restaurant) ต้องระบุหากไม่ได้ตั้งค่า parent และ showAll เป็นเท็จ
regionCode

string

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

string

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

boolean

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

integer

จำนวนแอตทริบิวต์ที่จะรวมต่อหน้า ค่าเริ่มต้นคือ 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 Overview

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

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

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