重要なエンドポイントが無効化される前に、Google Business Profile API 統合をアップデートする必要があります。2022 年 4 月から発生する可能性がある機能中断を避けるため、サポート終了スケジュールと説明を参照しましょう。

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

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