Method: attributes.list

Menampilkan daftar atribut yang akan tersedia untuk lokasi dengan kategori utama dan negara yang ditentukan.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
parent

string

Opsional. Nama resource lokasi untuk mencari atribut yang tersedia. Jika kolom ini ditetapkan, categoryName, regionCode, languageCode, dan showAll tidak diperlukan dan tidak boleh ditetapkan.

Format: locations/{locationId} (misalnya, locations/1234567890).
categoryName

string

Opsional. ID stabil kategori utama untuk menemukan atribut yang tersedia. Harus dalam format categories/{category_id} (misalnya, categories/gcid:restaurant). Diperlukan jika parent tidak ditetapkan dan showAll salah.
regionCode

string

Opsional. Kode negara ISO 3166-1 alpha-2 untuk menemukan atribut yang tersedia. Wajib jika parent tidak ditetapkan.
languageCode

string

Opsional. Kode bahasa BCP 47 untuk mendapatkan nama tampilan atribut. Jika bahasa ini tidak tersedia, bahasa Inggris akan digunakan.
showAll

boolean

Opsional. Jika ditetapkan ke true, metadata untuk semua atribut yang tersedia akan ditampilkan, dengan mengabaikan kolom parent dan categoryName. languageCode dan regionCode wajib ada jika showAll ditetapkan ke true.
pageSize

integer

Jumlah atribut yang akan disertakan per halaman. Defaultnya adalah 200, minimumnya adalah 1.
pageToken

string

Jika ditentukan, halaman metadata atribut berikutnya akan diambil.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons untuk AttributesService.ListAttributeMetadata.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
Kolom
attributeMetadata[]

object (AttributeMetadata)

Kumpulan metadata atribut untuk atribut yang tersedia.
nextPageToken

string

Jika jumlah atribut melebihi ukuran halaman yang diminta, kolom ini akan diisi dengan token untuk mengambil halaman atribut berikutnya pada panggilan berikutnya ke attributes.list. Jika tidak ada atribut lagi, kolom ini tidak akan ada dalam respons.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.

AttributeMetadata

Metadata untuk atribut. Berisi informasi tampilan untuk atribut, termasuk nama yang dilokalkan dan judul untuk mengelompokkan atribut terkait.

Representasi JSON 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
Kolom
parent

string

ID unik untuk atribut.
valueType

enum (AttributeValueType)

Jenis nilai untuk atribut. Nilai yang ditetapkan dan diambil harus diharapkan memiliki jenis ini.
displayName

string

Nama tampilan yang dilokalkan untuk atribut, jika tersedia; jika tidak, nama tampilan dalam bahasa Inggris.
groupDisplayName

string

Nama tampilan yang dilokalkan dari grup yang berisi atribut ini, jika tersedia; jika tidak, nama grup dalam bahasa Inggris. Atribut terkait dikumpulkan ke dalam grup dan harus ditampilkan bersama di bawah judul yang diberikan di sini.
repeatable

boolean

Jika true, atribut mendukung beberapa nilai. Jika salah, hanya satu nilai yang harus diberikan.
valueMetadata[]

object (AttributeValueMetadata)

Untuk beberapa jenis atribut (misalnya, enum), daftar nilai yang didukung dan nama tampilan yang sesuai untuk nilai tersebut akan disediakan.
deprecated

boolean

Jika benar, atribut tidak digunakan lagi dan tidak boleh digunakan lagi. Jika tidak digunakan lagi, memperbarui atribut ini tidak akan menghasilkan error, tetapi pembaruan tidak akan disimpan. Pada suatu waktu setelah penghentian penggunaan, atribut akan dihapus sepenuhnya dan akan menjadi error.

AttributeValueMetadata

Metadata untuk nilai atribut yang didukung.

Representasi JSON 
{
  "value": value,
  "displayName": string
}
Kolom
value

value (Value format)

Nilai atribut.
displayName

string

Nama tampilan untuk nilai ini, dilokalkan jika tersedia; jika tidak, dalam bahasa Inggris. Nama tampilan nilai dimaksudkan untuk digunakan dalam konteks dengan nama tampilan atribut.

Misalnya, untuk atribut enum "WiFi", atribut ini dapat berisi "Paid" untuk mewakili Wi-Fi berbayar.