Method: attributes.list

Belirtilen birincil kategori ve ülkeye sahip bir konum için kullanılabilen özelliklerin listesini döndürür.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Sorgu parametreleri

Parametreler
parent

string

İsteğe bağlıdır. Kullanılabilir özelliklerin aranacağı konumun kaynak adı. Bu alan ayarlanırsa categoryName, regionCode, languageCode ve showAll gerekli değildir ve ayarlanmamalıdır.

Biçim: locations/{locationId} (ör. locations/1234567890).
categoryName

string

İsteğe bağlıdır. Mevcut özellikleri bulmak için birincil kategori sabit kimliği. categories/{category_id} biçiminde olmalıdır (ör. categories/gcid:restaurant). parent ayarlanmamışsa ve showAll yanlışsa zorunludur.
regionCode

string

İsteğe bağlıdır. Kullanılabilir özellikleri bulmak için ISO 3166-1 alfa-2 ülke kodu. parent ayarlanmamışsa zorunludur.
languageCode

string

İsteğe bağlıdır. Özellik görünen adlarının alınacağı dilin BCP 47 kodu. Bu dil mevcut değilse İngilizce olarak sunulur.
showAll

boolean

İsteğe bağlıdır. Doğru değerine ayarlanırsa parent ve categoryName alanları dikkate alınmadan mevcut tüm özelliklerin meta verileri döndürülür. showAll, doğru olarak ayarlandığında languageCode ve regionCode gereklidir.
pageSize

integer

Sayfa başına kaç özellik ekleneceği. Varsayılan değer 200, minimum değer 1'dir.
pageToken

string

Belirtilirse özellik meta verilerinin sonraki sayfası alınır.

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

AttributesService.ListAttributeMetadata için yanıt.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
Alanlar
attributeMetadata[]

object (AttributeMetadata)

Mevcut özellikler için özellik meta verileri koleksiyonu.
nextPageToken

string

Özellik sayısı istenen sayfa boyutunu aşarsa bu alan, attributes.list için sonraki çağrıda bir sonraki özellik sayfasını getirecek bir jetonla doldurulur. Başka özellik yoksa bu alan yanıtta yer almaz.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için OAuth 2.0 Overview sayfasını inceleyin.

AttributeMetadata

Bir özelliğin meta verileri. Özelliğin görüntüleme bilgilerini içerir. Bu bilgiler arasında yerelleştirilmiş bir ad ve ilgili özellikleri bir arada gruplandırmak için bir başlık bulunur.

JSON gösterimi 
{
  "parent": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "repeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "deprecated": boolean
}
Alanlar
parent

string

Özelliğin benzersiz tanımlayıcısı.
valueType

enum (AttributeValueType)

Özelliğin değer türü. Ayarlanan ve alınan değerlerin bu türde olması beklenir.
displayName

string

Özelliğin yerelleştirilmiş görünen adı (varsa) veya İngilizce görünen adı.
groupDisplayName

string

Varsa bu özelliği içeren grubun yerelleştirilmiş görünen adı, yoksa grubun İngilizce adı. İlgili özellikler bir grupta toplanır ve burada verilen başlık altında birlikte gösterilmelidir.
repeatable

boolean

"True" ise özellik birden fazla değeri destekler. false ise yalnızca tek bir değer sağlanmalıdır.
valueMetadata[]

object (AttributeValueMetadata)

Bazı özellik türleri (ör. enum'lar) için desteklenen değerlerin ve bu değerlere karşılık gelen görünen adların listesi sağlanır.
deprecated

boolean

Değer "true" ise özellik kullanımdan kaldırılmıştır ve artık kullanılmamalıdır. Desteği sonlandırıldıysa bu özelliğin güncellenmesi hataya neden olmaz ancak güncellemeler kaydedilmez. Desteği sonlandırıldıktan bir süre sonra özellik tamamen kaldırılır ve hata olarak kabul edilir.

AttributeValueMetadata

Desteklenen özellik değerleri için meta veriler.

JSON gösterimi 
{
  "value": value,
  "displayName": string
}
Alanlar
value

value (Value format)

Özellik değeri.
displayName

string

Bu değerin görünen adı, mümkünse yerelleştirilmiş, aksi takdirde İngilizce olarak gösterilir. Değer görünen adı, özellik görünen adıyla birlikte kullanılmak üzere tasarlanmıştır.

Örneğin, "WiFi" enum özelliği için bu, ücretli kablosuz bağlantıyı temsil eden "Ücretli" değerini içerebilir.