Method: attributes.list

Belirtilen birincil kategori ve ülkeye sahip bir konum için kullanılabilecek ö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

Kullanılabilir özellikleri aramak için konumun kaynak adı. Bu alan ayarlanırsa categoryName, areaCode, LanguageCode ve showAll zorunlu değildir ve ayarlanmamalıdır.
categoryName

string

Kullanılabilir özellikleri bulmak için kullanılan birincil kategorinin kararlı kimliği. Kategori/{category_id} biçiminde olmalıdır.
regionCode

string

Kullanılabilir özellikleri bulmak için ISO 3166-1 alpha-2 ülke kodu.
languageCode

string

Özellik görünen adlarını almak için BCP 47 dil kodu. Bu dil mevcut değilse, mesajlar İngilizce olarak sağlanır.
showAll

boolean

Bu alan doğru değerine ayarlandığında, üst ve kategoriAdı alanları dikkate alınmadan tüm kullanılabilir özelliklerin meta verileri döndürülür. showAll değeri doğru olarak ayarlandığında,languageCode ve areaCode gereklidir.
pageSize

integer

Sayfa başına eklenecek özellik sayısı. Varsayılan değer 200, minimum değer 1'dir.
pageToken

string

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

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

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)

Kullanılabilir özellikler için özellik meta verisi koleksiyonu.
nextPageToken

string

Özellik sayısı istenen sayfa boyutunu aşıyorsa bu alan, sonraki bir attributes.list çağrısında bulunan özelliklerin sonraki sayfasını getirmek için 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'a Genel Bakış başlıklı makaleye bakın.

AttributeMetadata

Bir özelliğin meta verileri. Yerelleştirilmiş bir ad ve alakalı özelliklerin birlikte gruplandırılması için bir başlık da dahil olmak üzere özellik için görüntüleme bilgilerini içerir.

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ıdır.
valueType

enum (AttributeValueType)

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

string

Varsa özelliğin yerelleştirilmiş görünen adı; aksi takdirde İngilizce görünen ad.
groupDisplayName

string

Varsa bu özelliği içeren grubun yerelleştirilmiş görünen adı (varsa); İngilizce grup adı. İlgili özellikler bir grup halinde toplanır ve burada verilen başlığın altında birlikte görüntülenmesi gerekir.
repeatable

boolean

True (doğru) ise özellik birden çok değeri destekler. Yanlış değerine ayarlanırsa yalnızca tek bir değer sağlanmalıdır.
valueMetadata[]

object (AttributeValueMetadata)

Bazı özellik türleri (örneğin, numaralandırmalar) için desteklenen değerlerin ve bu değerlere karşılık gelen görünen adların bir 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. Kullanımdan kaldırılırsa bu özelliğin güncellenmesi hataya neden olmaz ancak güncellemeler kaydedilmez. Kullanımdan kaldırıldıktan sonra bir noktada özellik tamamen kaldırılacak ve bir hataya dönüşecektir.

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, mevcut olan yerlerde yerelleştirilmiş, aksi takdirde İngilizce görünen adı. Değer görünen adı, özelliğin görünen adıyla bağlam içinde kullanılması amaçlanmıştır.

Örneğin, "Kablosuz" numaralandırma özelliğinde bu, ücretli kablosuz bağlantıyı temsil edecek şekilde "Ücretli" ifadesini içerebilir.