Method: attributes.list

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
parent

string

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

string

使用可能な属性を検索するメインカテゴリの固定の ID です。「カテゴリ/{category_id}」の形式で指定してください。
regionCode

string

使用可能な属性を検索する ISO 3166-1 alpha-2 の国コードです。
languageCode

string

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

boolean

このフィールドが true に設定されている場合、使用可能なすべての属性のメタデータが返されます。親フィールドと 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 の概要をご覧ください。

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

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

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