Method: attributes.list

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

HTTP リクエスト

GET https://mybusinessbusinessinformation.googleapis.com/v1/attributes

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
parent

string

省略可。利用可能な属性を検索するビジネスのリソース名。このフィールドが設定されている場合、categoryName、regionCode、languageCode、showAll は必須ではなく、設定しないでください。

形式: locations/{locationId}（例: locations/1234567890）。
categoryName

string

省略可。使用可能な属性を検索するメインカテゴリの固定の ID です。categories/{category_id} の形式（例: categories/gcid:restaurant）にする必要があります。parent が設定されておらず、showAll が false の場合は必須です。
regionCode

string

省略可。使用可能な属性を検索する ISO 3166-1 alpha-2 の国コードです。parent が設定されていない場合は必須。
languageCode

string

省略可。属性の表示名を取得する言語の BCP 47 コード。この言語が利用できない場合は、英語で提供されます。
showAll

boolean

省略可。true に設定すると、parent フィールドと categoryName フィールドを無視して、使用可能なすべての属性のメタデータが返されます。showAll が true に設定されている場合、languageCode と regionCode は必須です。
pageSize

integer

1 ページあたりに含める属性数です。デフォルトは 200、最小値は 1 です。
pageToken

string

指定すると、属性メタデータの次のページが取得されます。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

AttributesService.ListAttributeMetadata のレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "attributeMetadata": [
    {
      object (AttributeMetadata)
    }
  ],
  "nextPageToken": string
}
フィールド
attributeMetadata[]

object (AttributeMetadata)

使用可能な属性の属性メタデータのコレクションです。
nextPageToken

string

属性数がリクエストしたページサイズを超えた場合、このフィールドには、後続の attributes.list の呼び出しで属性の次のページを取得するためのトークンが入力されます。取得する属性がそれ以上ない場合、このフィールドはレスポンスに含められません。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/business.manage

詳細については、OAuth 2.0 Overview をご覧ください。

AttributeMetadata

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

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

string

属性の固有識別子。
valueType

enum (AttributeValueType)

属性の値の型。設定、取得される値は、この型になると想定されます。
displayName

string

この属性のローカライズ版の表示名です。ローカライズ版が存在しない場合は、英語の表示名になります。
groupDisplayName

string

この属性を含むグループのローカライズ版の表示名です。ローカライズ版が存在しない場合は、英語の表示名になります。関連属性がグループにまとめられ、ここに示される見出しを使ってまとめて表示されます。
repeatable

boolean

true の場合、属性で複数の値が使用できます。false の場合、指定できる値は 1 つのみです。
valueMetadata[]

object (AttributeValueMetadata)

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

boolean

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

AttributeValueMetadata

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

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

value (Value format)

属性値。
displayName

string

この値の表示名。ローカライズ版が存在する場合はローカライズ版、存在しない場合は英語になります。値の表示名は、属性の表示名とともに使用することを想定しています。

たとえば、「WiFi」列挙型属性の場合、有料 Wi-Fi を表す「Paid」が含まれることがあります。