Method: attributes.list

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
parent

string

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

string

使用可能な属性を検索するメインカテゴリの固定の ID。category/{category_id} の形式にする必要があります。
regionCode

string

使用可能な属性を検索する ISO 3166-1 alpha-2 国コード。
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 の概要をご覧ください。

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

この属性を含むグループのローカライズされた表示名です（利用可能な場合）。それ以外の場合は英語のグループ名を使用します。関連する属性が 1 つのグループにまとめられ、ここに示す見出しでまとめて表示されます。
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」とenum 属性です。これには「Paid」が含まれる場合があります。（有料 Wi-Fi を表す）