Method: attributes.list

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

HTTP リクエスト

GET https://mybusiness.googleapis.com/v4/attributes

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

クエリ パラメータ

パラメータ
name

string

使用可能な属性を検索するビジネスのリソース名。
categoryId

string

使用可能な属性を検索するメインカテゴリの固定の ID。
country

string

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

string

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

integer

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

string

指定すると、属性メタデータの次のページが取得されます。attributes.list の呼び出しが、リクエストしたページサイズを上回る数の結果を返すと、pageToken が返されます。

リクエスト本文

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

レスポンスの本文

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

Locations.ListAttributeMetadata に対するレスポンス メッセージです。

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

object (AttributeMetadata)

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

string

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

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。