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

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

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」とenum 属性です。これには「Paid」が含まれる場合があります。(有料 Wi-Fi を表す)

メソッド

list

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