Method: locations.getExtended

拡張メタデータを含む指定されたロケーションを返します。これには、販売者が提供したデータと、一般ユーザー向けの表示(異なる場合があります)の両方が含まれます。また、フィールドパスと、そのフィールドの編集の現在の状態、元のソース、不承認の詳細を記述するメタデータのマッピングも含まれます。

HTTP リクエスト

GET https://mybusinessbusinessinformation.googleapis.com/v1alpha/{name=locations/*}:getExtended

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

パスパラメータ

パラメータ
name

string

必須。取得するビジネスの名前です。

リクエストの本文

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

レスポンスの本文

ビジネス情報と、その編集メタデータおよび現在の公開ステータスを表します。

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

JSON 表現
{
  "locationProvidedByMerchant": {
    object (Location)
  },
  "locationSeenByConsumers": {
    object (Location)
  },
  "extendedFieldData": {
    string: {
      object (ExtendedFieldData)
    },
    ...
  }
}
フィールド
locationProvidedByMerchant

object (Location)

出力専用。販売者が管理する基盤となる位置情報。

locationSeenByConsumers

object (Location)

出力専用。現在 Google マップと Google 検索でユーザーに表示されている位置情報。

extendedFieldData

map (key: string, value: object (ExtendedFieldData))

出力専用。拡張フィールド データ。Location リソースの最上位フィールドの名前をキーとして使用します。

キーは常にプレーンな最上位フィールド名であり、ネストされたフィールドパスではありません。各最上位フィールドはアトミックに扱われるため、サブフィールドを変更すると、このマップでは最上位フィールドへの変更として扱われます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

認可スコープ

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

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

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