- HTTP isteği
- Sorgu parametreleri
- İstek metni
- Yanıt metni
- Yetkilendirme kapsamları
- AttributeMetadata
- AttributeValueMetadata
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 |
Kullanılabilir özellikleri aramak için konumun kaynak adı. Bu alan ayarlanırsa categoryName,regionCode, languageCode ve showAll zorunlu değildir ve ayarlanmamalıdır. |
categoryName |
Kullanılabilir özellikleri bulmak için birincil kategori sabit kimliği. Biçim kategorilerinde/{category_id} olmalıdır. |
regionCode |
Kullanılabilir özellikleri bulmak için kullanılan ISO 3166-1 alpha-2 ülke kodu. |
languageCode |
Özellik görünen adlarının alınacağı BCP 47 dil kodu. Bu dil mevcut değilse İngilizce olarak sağlanır. |
showAll |
Bu alan doğru değerine ayarlandığında üst ve kategoriAdı alanları dikkate alınmadan, kullanılabilir tüm özelliklerin meta verileri döndürülür. showAll değeri doğru olarak ayarlandığında languageCode ve regionCode gerekir. |
pageSize |
Sayfa başına eklenecek özellik sayısı. Varsayılan değer 200, minimum değer ise 1'dir. |
pageToken |
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 yanıtı.
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
JSON gösterimi |
---|
{
"attributeMetadata": [
{
object ( |
Alanlar | |
---|---|
attributeMetadata[] |
Kullanılabilir özellikler için özellik meta verisi koleksiyonu. |
nextPageToken |
Özellik sayısı istenen sayfa boyutunu aşıyorsa bu alan, |
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 (OAuth 2.0'a Genel Bakış) sayfasına göz atın.
AttributeMetadata
Bir özelliğin meta verileri. Yerelleştirilmiş bir ad ve ilgili özellikleri gruplandırmaya yönelik bir başlık da dahil olmak üzere, özelliğin görünen bilgilerini içerir.
JSON gösterimi |
---|
{ "parent": string, "valueType": enum ( |
Alanlar | |
---|---|
parent |
Özelliğin benzersiz tanımlayıcısıdır. |
valueType |
Özelliğin değer türü. Ayarlanan ve alınan değerlerin bu türde olması beklenmelidir. |
displayName |
Varsa özelliğin yerelleştirilmiş görünen adı; aksi takdirde, İngilizce görünen ad kullanılır. |
groupDisplayName |
Bu özelliği içeren grubun (varsa) yerelleştirilmiş görünen adı; Aksi takdirde, İngilizce grup adıdır. İlgili özellikler bir grup halinde toplanır ve burada verilen başlığın altında birlikte görüntülenmelidir. |
repeatable |
True (doğru) ise özellik birden çok değeri destekler. Yanlış ise yalnızca tek bir değer sağlanmalıdır. |
valueMetadata[] |
Bazı özellik türleri (ör. numaralandırmalar) için desteklenen değerlerin ve bu değerlere karşılık gelen görünen adların listesi sağlanır. |
deprecated |
True (doğru) ise, özellik desteği sonlandı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 bu özellik tamamen kaldırılır ve hataya dönüşür. |
AttributeValueMetadata
Desteklenen özellik değerlerinin meta verileri.
JSON gösterimi |
---|
{ "value": value, "displayName": string } |
Alanlar | |
---|---|
value |
Özellik değeri. |
displayName |
Bu değerin görünen adı (kullanılabilir olduğunda yerelleştirilmiş); İngilizce olarak görürsünüz. Değerin görünen adı, özelliğin görünen adıyla bağlamda kullanılmak üzere tasarlanmıştır. Örneğin, "Kablosuz" enum özelliği, bu "Ücretli" özelliğini içerebilir temsil eder. |