REST Resource: attributes

リソース: AttributeMetadata

属性のメタデータ。ローカライズされた名前や関連属性をグループ化するための見出しなど、属性の表示情報が含まれます。

JSON 表現
{
  "attributeId": string,
  "valueType": enum (AttributeValueType),
  "displayName": string,
  "groupDisplayName": string,
  "isRepeatable": boolean,
  "valueMetadata": [
    {
      object (AttributeValueMetadata)
    }
  ],
  "isDeprecated": boolean
}
フィールド
attributeId

string

属性の ID です。

valueType

enum (AttributeValueType)

属性の値の型。設定および取得する値は、次のタイプにする必要があります。

displayName

string

この属性のローカライズされた表示名(利用可能な場合)。それ以外の場合は、英語の表示名。

groupDisplayName

string

この属性を含むグループのローカライズされた表示名(利用可能な場合)。それ以外の場合は、英語のグループ名。関連属性がグループにまとめられ、ここに示す見出しの下にまとめて表示されます。

isRepeatable

boolean

true の場合、属性で複数の値がサポートされます。false の場合、値を 1 つだけ指定する必要があります。

valueMetadata[]

object (AttributeValueMetadata)

一部の属性タイプ(列挙型など)については、サポートされている値と、それらの値に対応する表示名のリストが提供されます。

isDeprecated

boolean

true の場合、属性は非推奨であるため、使用しないでください。非推奨の場合、この属性を更新してもエラーにはなりませんが、更新は保存されません。この属性は、サポートが終了した後のある時点で完全に削除され、エラーになります。

AttributeValueMetadata

サポートされている属性値のメタデータ。

JSON 表現
{
  "value": value,
  "displayName": string
}
フィールド
value

value (Value format)

属性値。

displayName

string

この値の表示名。ローカライズ可能な場合はローカライズされます。それ以外の場合は英語です。値の表示名は、属性の表示名と一緒に使用することが意図されています。

たとえば、「Wi-Fi」列挙型属性には、有料 Wi-Fi を表す「有料」を含めることができます。

Methods

list

指定したメインカテゴリと国のビジネスで使用可能な属性のリストを返します。