- 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, areaCode, LanguageCode ve showAll zorunlu değildir ve ayarlanmamalıdır. |
categoryName |
Kullanılabilir özellikleri bulmak için kullanılan birincil kategorinin kararlı kimliği. Kategori/{category_id} biçiminde olmalıdır. |
regionCode |
Kullanılabilir özellikleri bulmak için ISO 3166-1 alpha-2 ülke kodu. |
languageCode |
Ö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 |
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 |
Sayfa başına eklenecek özellik sayısı. Varsayılan değer 200, minimum değer 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 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 ( |
Alanlar | |
---|---|
attributeMetadata[] |
Kullanılabilir özellikler için özellik meta verisi koleksiyonu. |
nextPageToken |
Özellik sayısı istenen sayfa boyutunu aşıyorsa bu alan, sonraki bir |
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 ( |
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ı beklenir. |
displayName |
Varsa özelliğin yerelleştirilmiş görünen adı; aksi takdirde İngilizce görünen ad. |
groupDisplayName |
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 |
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[] |
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 |
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 |
Özellik değeri. |
displayName |
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. |