- リソース: ロケーション
- JSON 表現
- 営業時間
- TimePeriod
- DayOfWeek
- SpecialHours
- SpecialHourPeriod
- ServiceAreaBusiness
- 業種
- PointRadius
- LatLng
- プレイス
- PlaceInfo
- LocationKey
- AdWordsLocationExtensions
- OpenInfo
- OpenForBusiness
- LocationState
- 属性
- RepeatedEnumAttributeValue
- UrlAttributeValue
- メタデータ
- 重複
- アクセス
- PriceList
- ラベル
- セクション
- セクションのタイプ
- アイテム
- Money
- プロフィール
- RelationshipData
- 営業時間
- メソッド
リソース: ロケーション
ビジネスです。各フィールドの詳細についてはヘルプセンターの記事を、有効な業種の一覧についてはカテゴリ エンドポイントをご覧ください。
JSON 表現 | |
---|---|
{ "name": string, "languageCode": string, "storeCode": string, "locationName": string, "primaryPhone": string, "additionalPhones": [ string ], "address": { object ( |
フィールド | |
---|---|
name |
このビジネスの Google 識別子は 一致のコンテキストでは、このフィールドは指定されません。 |
languageCode |
ビジネスの言語。作成時に設定し、更新できません。 |
storeCode |
このビジネスの外部識別子。アカウント内で一意である必要があります。これにより、ビジネスとご自身の記録が関連付けられます。 |
locationName |
地域名は、店舗、ウェブサイト、事務用品で一貫して使用し、顧客に認知されている、実際のビジネスの名称を反映したものにする必要があります。関連性のある追加情報は、リソースの他のフィールド( |
primaryPhone |
個別のビジネス拠点に直接つながる電話番号を指定します。可能であれば、電話総合受付センターではなく、個々のお店の番号を使用します。 |
additionalPhones[] |
電話番号に加えて、ビジネスの電話連絡先を最大 2 件登録できます(携帯電話でも固定電話でもかまいませんが、FAX 番号は指定できません)。 |
address |
ビジネス拠点を表す正確な住所。遠隔地にある私書箱は使用できません。現時点では、住所に最大 5 つの |
primaryCategory |
このビジネスの中核事業を最もよく表すカテゴリ。 |
additionalCategories[] |
ビジネスを説明する追加のカテゴリ。カテゴリを設定すると、そのサービスを探しているユーザーに見つけてもらいやすくなります。ビジネス情報を正確かつ最新の状態に保つため、中核事業を表すカテゴリはできるだけ少なくします。できるだけ具体的で、なおかつ中心となる事業内容を示すカテゴリを選択します。 |
websiteUrl |
このビジネスの URL。可能であれば、すべての拠点やブランドに共通する一般的なウェブサイトや URL ではなく、このビジネス拠点専用の URL を使用してください |
regularHours |
ビジネスの営業時間。 |
specialHours |
ビジネスの特別営業時間。祝休日の営業時間など、通常の営業時間外の時間が含まれます。通常の営業時間よりも優先されます。 |
serviceArea |
非店舗型ビジネスとは、顧客のもとに出向いてサービスを提供するビジネスのことです。ビジネスが非店舗型ビジネスである場合、このフィールドはそのビジネスがサービスを提供する地域を表します。 |
locationKey |
このビジネスを他の Google サービス(Google+ ページや Google マップの場所など)にリンクするキーのコレクション。 |
labels[] |
ビジネスにタグを付けられるようにするための自由形式の文字列のコレクション。これらのラベルはユーザーには表示されず、自分にのみ表示されます。ラベルあたり 255 文字の制限があります。 |
adWordsLocationExtensions |
AdWords に表示される追加情報。 |
latlng |
ユーザー指定の緯度と経度。ビジネスの作成時に、提供された住所のジオコード処理が行われた場合は無視されます。このフィールドは、作成時にユーザーが指定した |
openInfo |
ビジネスが現在営業しているかどうかを示すフラグ。 |
locationState |
出力のみ。ビジネスの状態を反映した一連のブール値。 |
attributes[] |
このビジネスの属性。 |
metadata |
出力のみ。ユーザーが編集できない追加情報。 |
priceLists[] |
サポート終了: この地域の価格表情報です。 |
profile |
自身のビジネスについて自分の言葉で説明し、ビジネスや商品に関する独自のストーリーをユーザーと共有します。 |
relationshipData |
このビジネスに関連するすべての拠点とチェーン。 |
moreHours[] |
事業部門や特定の顧客の営業時間を追加する。 |
営業時間
ビジネスが営業している期間を表します。TimePeriod
インスタンスのコレクションを保持します。
JSON 表現 | |
---|---|
{
"periods": [
{
object ( |
フィールド | |
---|---|
periods[] |
ビジネスが営業している時間のコレクションです。各期間は、1 週間のうちビジネスが営業している時間帯を表します。 |
期間
ビジネスが営業している期間を表します。指定した営業開始日時から始まり、指定した営業終了日時で終わります。営業終了時間は、営業開始時間の後、たとえば同じ日の後の時間か翌日に設定する必要があります。
JSON 表現 | |
---|---|
{ "openDay": enum ( |
フィールド | |
---|---|
openDay |
この期間が始まる |
openTime |
24 時間の ISO 8601 拡張形式(hh:mm)で表した時刻です。有効な値は 00:00 ~ 24:00 で、24:00 は曜日フィールドで指定した日が終了する深夜 0 時を表します。 |
closeDay |
この期間の終了日時( |
closeTime |
24 時間の ISO 8601 拡張形式(hh:mm)で表した時刻です。有効な値は 00:00 ~ 24:00 で、24:00 は曜日フィールドで指定した日が終了する深夜 0 時を表します。 |
DayOfWeek
曜日を表します。
列挙型 | |
---|---|
DAY_OF_WEEK_UNSPECIFIED |
曜日が特定されていない。 |
MONDAY |
月曜日 |
TUESDAY |
火曜日 |
WEDNESDAY |
水曜日 |
THURSDAY |
木曜日 |
FRIDAY |
Friday |
SATURDAY |
Saturday |
SUNDAY |
日曜日 |
特別営業時間
ビジネスの営業時間が通常の営業時間と異なる一連の期間を表します。
JSON 表現 | |
---|---|
{
"specialHourPeriods": [
{
object ( |
フィールド | |
---|---|
specialHourPeriods[] |
ビジネスの通常の営業時間に対する例外の一覧です。 |
特別営業時間
ビジネスの営業時間が通常の営業時間と異なる単一の期間を表します。特別営業時間が表す期間は 24 時間未満でなければなりません。openTime
と startDate
は、closeTime
と endDate
より前の日付にする必要があります。closeTime
と endDate
は、指定した startDate
の翌日の午前 11 時 59 分まで延長できます。たとえば、次の入力は有効です。
startDate=2015-11-23, openTime=08:00, closeTime=18:00
startDate=2015-11-23, endDate=2015-11-23, openTime=08:00,
closeTime=18:00 startDate=2015-11-23, endDate=2015-11-24,
openTime=13:00, closeTime=11:59
次の入力は無効です。
startDate=2015-11-23, openTime=13:00, closeTime=11:59
startDate=2015-11-23, endDate=2015-11-24, openTime=13:00,
closeTime=12:00 startDate=2015-11-23, endDate=2015-11-25,
openTime=08:00, closeTime=18:00
JSON 表現 | |
---|---|
{ "startDate": { object ( |
フィールド | |
---|---|
startDate |
この特別営業時間が始まる日付です。 |
openTime |
営業開始時の |
endDate |
この特別営業時間が終了する日付です。 |
closeTime |
閉店時の |
isClosed |
true の場合、 |
ServiceAreaBusiness
非店舗型ビジネスとは、顧客のもとに出向いてサービスを提供するビジネスのことです(鍵業者や配管業者など)。
JSON 表現 | |
---|---|
{ "businessType": enum ( |
フィールド | ||
---|---|---|
businessType |
非店舗型ビジネスの |
|
共用体フィールド coverageArea 。ビジネスがサービスを提供するサービス提供地域を示します。coverageArea は次のいずれかになります。 |
||
radius |
出力のみ。このビジネスがサービスを提供する地域を、中心からの半径で表します。 |
|
places |
そのビジネスがサービスを提供する地域を、場所のセットで定義します。 |
業種
このビジネスが、顧客のもとに出向いてオンサイトのサービスのみを提供する(レッカー車など)か、店舗とオンサイトの両方(イートイン スペースがあり、宅配もするピザ店など)でサービスを提供するかを表します。
列挙型 | |
---|---|
BUSINESS_TYPE_UNSPECIFIED |
出力のみ。指定されていません。 |
CUSTOMER_LOCATION_ONLY |
ビジネス拠点がある住所ではなく、周辺地域でのみサービスを提供します。 |
CUSTOMER_AND_BUSINESS_LOCATION |
ビジネス拠点の住所とその周辺地域でサービスを提供している。 |
ポイント半径
特定の地点を中心とした半径(緯度/経度)。
JSON 表現 | |
---|---|
{
"latlng": {
object ( |
フィールド | |
---|---|
latlng |
半径で定義した地域の中心を指定する緯度と経度です。 |
radiusKm |
その地域の中心地点からの距離です。キロメートルで表されます。 |
LatLng
緯度と経度のペアを表すオブジェクト。緯度 / 経度を表す 2 組の倍数で表現されます。特に指定のない限り、このオブジェクトは WGS84 標準に準拠している必要があります。値は正規化範囲内で指定する必要があります。
JSON 表現 | |
---|---|
{ "latitude": number, "longitude": number } |
フィールド | |
---|---|
latitude |
緯度(度単位)。範囲 [-90.0, +90.0] 内になければなりません。 |
longitude |
経度(度単位)。範囲 [-180.0, +180.0] 内になければなりません。 |
プレイス
場所のセットで表される地域の和集合を定義します。
JSON 表現 | |
---|---|
{
"placeInfos": [
{
object ( |
フィールド | |
---|---|
placeInfos[] |
プレイス ID で表される地域です。最大 20 か所に制限されます。 |
PlaceInfo
場所 ID で表される地域を定義します。
JSON 表現 | |
---|---|
{ "name": string, "placeId": string } |
フィールド | |
---|---|
name |
場所のローカライズされた名前ですたとえば、 |
placeId |
場所の ID です。リージョンに対応している必要があります。 |
ロケーション キー
ビジネスの代替キーまたはサロゲートキーの参照です。
JSON 表現 | |
---|---|
{ "plusPageId": string, "placeId": string, "explicitNoPlaceId": boolean, "requestId": string } |
フィールド | |
---|---|
plusPageId |
出力のみ。このビジネスに関連付けられた Google+ ページがある場合は、このビジネスの Google+ ページ ID が入力されます。 |
placeId |
ビジネスのオーナー確認が済んでおり、Google マップに関連付けられているか表示されている場合は、そのビジネスのプレイス ID が入力されます。この ID はさまざまな Places API で使用できます。 ビジネスのオーナー確認が済んでいない場合でも、そのビジネスが Google マップに表示される場所に関連付けられていれば、このフィールドに値が入力されることがあります。 このフィールドは、Create の呼び出し時に設定できますが、Update の呼び出し時には設定できません。 追加の |
explicitNoPlaceId |
出力のみ。値が true の場合は、関連付けがまだ行われていないケースとは異なり、プレイス ID が意図的に未設定となっていることを表します。 |
requestId |
出力のみ。このビジネスの作成に使用された |
AdWords 住所表示オプション
AdWords に表示される追加情報。
JSON 表現 | |
---|---|
{ "adPhone": string } |
フィールド | |
---|---|
adPhone |
ビジネス拠点のメインの電話番号ではなく、AdWords の住所表示オプションに表示される予備の電話番号です。 |
OpenInfo
ビジネスの営業状態に関する情報です。
JSON 表現 | |
---|---|
{ "status": enum ( |
フィールド | |
---|---|
status |
ビジネスが現在営業しているかどうかを示します。すべてのビジネスはデフォルトで営業中になります(休業中に変更された場合を除く)。 |
canReopen |
出力のみ。このビジネスが営業再開の条件を満たしているかどうかを示します。 |
openingDate |
ビジネスが最初にオープンした日付。正確な日付が不明な場合は、年月のみを指定できます。過去の日付または 1 年以内の日付を指定する必要があります。 |
営業対象
ビジネスのステータスを表します。
列挙型 | |
---|---|
OPEN_FOR_BUSINESS_UNSPECIFIED |
指定されていません。 |
OPEN |
ビジネスが営業していることを表します。 |
CLOSED_PERMANENTLY |
ビジネスが閉業したことを表します。 |
CLOSED_TEMPORARILY |
ビジネスが臨時休業していることを示します。この値は、公開済みのビジネス情報にのみ適用できます(locationState.is_published = true)。ステータス フィールドをこの値に更新する場合、クライアントは updateMask を明示的に openInfo.status に設定する必要があります。この更新呼び出し中に、他の更新マスクを設定することはできません。これは一時的な制限で、まもなく緩和される予定です。 |
住所表示オプション
Location の状態を反映した一連のブール値を含みます。
JSON 表現 | |
---|---|
{ "isGoogleUpdated": boolean, "isDuplicate": boolean, "isSuspended": boolean, "canUpdate": boolean, "canDelete": boolean, "isVerified": boolean, "needsReverification": boolean, "isPendingReview": boolean, "isDisabled": boolean, "isPublished": boolean, "isDisconnected": boolean, "isLocalPostApiDisabled": boolean, "canModifyServiceList": boolean, "canHaveFoodMenus": boolean, "hasPendingEdits": boolean, "hasPendingVerification": boolean, "canOperateHealthData": boolean, "canOperateLodgingData": boolean } |
フィールド | |
---|---|
isGoogleUpdated |
出力のみ。このビジネスに関連付けられているプレイス ID に変更があるかどうかを表します。 |
isDuplicate |
出力のみ。ビジネスが別のビジネスと重複しているかどうかを表します。 |
isSuspended |
出力のみ。ビジネスが強制停止されているかどうかを表します。強制停止されているビジネスは、Google のサービスのエンドユーザーには表示されません。間違いであると思われる場合は、ヘルプセンターの記事をご覧ください。 |
canUpdate |
出力のみ。ビジネスが更新可能かどうかを表します。 |
canDelete |
出力のみ。Google My Business API を使ってビジネス情報を削除できるかどうかを示します。 |
isVerified |
出力のみ。ビジネスのオーナー確認が済んでいるかどうかを表します。 |
needsReverification |
出力のみ。ビジネスの再確認が必要かどうかを指定します。 |
isPendingReview |
出力のみ。ビジネスのクチコミが保留中かどうかを表します。 |
isDisabled |
出力のみ。ビジネスが無効になっているかどうかを示します。 |
isPublished |
出力のみ。ビジネスが公開されているかどうかを表します。 |
isDisconnected |
出力のみ。ビジネスと Google マップのプレイスとの接続が解除されているかどうかを示します。 |
isLocalPostApiDisabled |
出力のみ。このビジネスの accounts.locations.localPosts が無効になっているかどうかを示します。 |
canModifyServiceList |
出力のみ。リスティングが ServiceList を変更できるかどうかを示します。 |
canHaveFoodMenus |
出力のみ。リスティングが食品メニューの対象かどうかを示します。 |
hasPendingEdits |
出力のみ。このビジネスのプロパティのいずれかが編集保留状態であるかどうかを示します。 |
hasPendingVerification |
出力のみ。ビジネスに保留中のオーナー確認リクエストがあるかどうかを表します。 |
canOperateHealthData |
出力のみ。ビジネスがヘルスデータに対して操作できるかどうかを示します。 |
canOperateLodgingData |
出力のみ。ビジネスが宿泊施設のデータに対して操作できるかどうかを示します。 |
属性
ビジネスの属性です。属性は、ビジネスに関する追加情報を提供します。ビジネスに設定できる属性は、そのビジネスのプロパティ(カテゴリなど)によって異なります。使用可能な属性は Google によって決定され、API の変更なしに追加、削除される場合があります。
JSON 表現 | |
---|---|
{ "attributeId": string, "valueType": enum ( |
フィールド | |
---|---|
attributeId |
属性の ID。属性 ID は Google から提供されます。 |
valueType |
出力のみ。この属性に含まれる値の型です。この値は、値の解釈方法を決定するために使用されます。 |
values[] |
この属性の値。提供される値の型は、その属性に想定されるものと一致する必要があります。AttributeValueType をご覧ください。複数の属性値を指定する場合は、このフィールドを繰り返します。属性のタイプでサポートされる値は 1 つのみです。 |
repeatedEnumValue |
属性値の型が REPEATED_ENUM の場合は属性値が含まれ、他の値フィールドは空にする必要があります。 |
urlValues[] |
属性値の型が URL の場合、このフィールドにはこの属性の値が含まれます。その他の値フィールドは空にしてください。 |
RepeatedEnumAttributeValue
valueType
が REPEATED_ENUM の属性の値。これは、設定されている ID(true)と未設定(false)の 2 つの値 ID のリストで構成されます。指定されていない値は不明とみなされます。少なくとも 1 つの値を指定する必要があります。
JSON 表現 | |
---|---|
{ "setValues": [ string ], "unsetValues": [ string ] } |
フィールド | |
---|---|
setValues[] |
設定されている列挙値。 |
unsetValues[] |
未設定の列挙値。 |
URL 属性値
URL が valueType
の属性の値。
JSON 表現 | |
---|---|
{ "url": string } |
フィールド | |
---|---|
url |
URL。 |
メタデータ
ユーザーが編集できない、ビジネスに関する追加情報。
JSON 表現 | |
---|---|
{
"duplicate": {
object ( |
フィールド | |
---|---|
duplicate |
このビジネスが重複しているビジネスに関する情報です。 |
mapsUrl |
マップ上のビジネスへのリンク。 |
newReviewUrl |
ユーザーがビジネスのクチコミを投稿することができる Google 検索ページへのリンク。 |
重複している
このビジネスが重複しているビジネスに関する情報です。
JSON 表現 | |
---|---|
{
"locationName": string,
"placeId": string,
"access": enum ( |
フィールド | |
---|---|
locationName |
複製されたビジネスのリソース名です。認証されたユーザーがそのビジネスへのアクセス権を持っており、そのロケーションが削除されない場合にのみ入力されます。 |
placeId |
重複している場所のプレイス ID。 |
access |
ユーザーが重複しているビジネスにアクセスできるかどうかを示します。 |
知る
複製したビジネスに対するユーザーのアクセスレベル。これは「責任」に代わるもので、代わりに使用してください。
列挙型 | |
---|---|
ACCESS_UNSPECIFIED |
指定されていません。 |
ACCESS_UNKNOWN |
ユーザーが、重複している場所へのアクセス権を持っているかどうかを判断できません。 |
ALLOWED |
ユーザーは、複製したビジネスへのアクセス権を持っています。 |
INSUFFICIENT |
ユーザーは、複製したビジネス情報にアクセスできません。 |
価格表
非推奨: アイテム価格情報のリスト。価格リストは 1 つ以上の価格リストとして構成され、各アイテムには 1 つ以上のアイテムを含むセクションが含まれます。たとえば、食品の価格リストは、朝食、ランチ、ディナーのメニューを表し、ハンバーガー、ステーキ、シーフードのメニューも用意されています。
JSON 表現 | |
---|---|
{ "priceListId": string, "labels": [ { object ( |
フィールド | |
---|---|
priceListId |
必須。価格リストの ID です。この地域内で、価格表、セクション、商品アイテム ID を複製することはできません。 |
labels[] |
必須。料金リストの言語タグラベル。 |
sourceUrl |
料金リストの取得元のソース URL(省略可)。たとえば、メニュー情報を取得するために自動的にスクレイピングされたページの URL などです。 |
sections[] |
必須。この価格表のセクション。各価格表には少なくとも 1 つのセクションを含める必要があります。 |
ラベル
価格表、セクション、またはアイテムを表示するときに使用するラベル。
JSON 表現 | |
---|---|
{ "displayName": string, "description": string, "languageCode": string } |
フィールド | |
---|---|
displayName |
必須。価格表、セクション、または商品アイテムの表示名です。 |
description |
(省略可)価格表、セクション、または商品アイテムの説明です。 |
languageCode |
(省略可)これらの文字列に適用する BCP-47 言語コードです。言語ごとに設定できるラベルのセットは 1 つのみです。 |
セクション
1 つ以上のアイテムを含む価格表のセクション。
JSON 表現 | |
---|---|
{ "sectionId": string, "labels": [ { object ( |
フィールド | |
---|---|
sectionId |
必須。セクションの ID。この地域内で、価格表、セクション、商品アイテム ID を複製することはできません。 |
labels[] |
必須。セクションの言語タグ付きラベルです。セクション名と説明は 140 文字以下にすることをおすすめします。少なくとも 1 つのラベルセットが必要です。 |
sectionType |
(省略可)現在の価格表セクションのタイプ。デフォルト値は FOOD です。 |
items[] |
価格リストのこのセクションに含まれる商品アイテム。 |
SectionType
セクションのタイプ。
列挙型 | |
---|---|
SECTION_TYPE_UNSPECIFIED |
指定されていません。 |
FOOD |
セクションに食品を表すアイテムが含まれています。 |
SERVICES |
セクションには、サービスを表すアイテムが含まれます。 |
項目
単一のリストアイテム。価格表内の商品アイテムのバリエーションごとに、固有の価格データを含む独自の商品アイテムが必要です。
JSON 表現 | |
---|---|
{ "itemId": string, "labels": [ { object ( |
フィールド | |
---|---|
itemId |
必須。商品アイテムの ID。この地域内で、価格表、セクション、商品アイテム ID を複製することはできません。 |
labels[] |
必須。アイテムの言語タグを含むラベルです。商品アイテム名は 140 文字以下、説明は 250 文字以下にすることをおすすめします。少なくとも 1 つのラベルセットが必要です。 |
price |
(省略可)商品アイテムの価格。 |
金額
金額をその通貨タイプで表します。
JSON 表現 | |
---|---|
{ "currencyCode": string, "units": string, "nanos": integer } |
フィールド | |
---|---|
currencyCode |
ISO 4217 で定義されている 3 文字の通貨コード。 |
units |
金額の整数部分の単位です。たとえば、 |
nanos |
金額のナノ(10^-9)単位。値は -999,999,999~+999,999,999 の範囲(両端を含む)で指定する必要があります。 |
プロファイル
ビジネスのプロフィールに関するすべての情報です。
JSON 表現 | |
---|---|
{ "description": string } |
フィールド | |
---|---|
description |
声で場所の説明を入力します。他のユーザーは編集できません。 |
関係データ
このビジネスに関連するすべての親と子のビジネス情報の情報。
JSON 表現 | |
---|---|
{ "parentChain": string } |
フィールド | |
---|---|
parentChain |
このビジネスが加盟しているチェーンのリソース名です。 |
営業時間の詳細
ビジネスのタイプによって、特定のビジネスが営業している期間です。
JSON 表現 | |
---|---|
{
"hoursTypeId": string,
"periods": [
{
object ( |
フィールド | |
---|---|
hoursTypeId |
必須。営業時間の種類。お客様のビジネス拠点のカテゴリでサポートされている営業時間のタイプを取得するには、{#link businessCategories:BatchGet} を呼び出す必要があります。 |
periods[] |
必須。ビジネスが営業している時間のコレクションです。各期間は、1 週間のうちビジネスが営業している時間帯を表します。 |
Methods |
|
---|---|
|
ビジネスをプレイス ID に関連付けます。 |
|
指定したアカウント内の指定したすべてのビジネスを取得します。 |
|
指定したすべてのビジネスに対し、ページ分けされたクチコミの一覧を返します。 |
|
ビジネスとそのプレイス ID の関連付けをクリアします。 |
|
指定されたアカウントが所有する新しい location を作成して返します。 |
|
ビジネスを削除します。 |
|
特定の言語でビジネスについて有効なすべてのオーナー確認オプションを報告します。 |
|
指定したビジネスに一致するすべてのビジネスを検索します。 |
|
指定したビジネスを取得します。 |
|
特定の場所の食品メニューを返します。 |
|
指定したビジネスの、Google によって更新されたバージョンを取得します。 |
|
特定のビジネスの医療機関の属性を返します。 |
|
ビジネスの指定されたサービスリストを取得します。 |
|
指定したアカウントのビジネス情報を一覧表示します。 |
|
指定したビジネスを更新します。 |
|
地域別に 1 つ以上の指標に関する分析情報を含むレポートを返します。 |
(deprecated) |
ユーザーがオーナーとなっているアカウントから同じユーザーが管理する別のアカウントにビジネスを移動します。 |
|
特定の地域のフードメニューを更新します。 |
|
特定のビジネスの医療機関の属性を更新します。 |
|
ビジネスの指定されたサービスリストを更新します。 |
|
ビジネスのオーナー確認プロセスを開始します。 |