- リソース: ロケーション
- JSON 表現
- PhoneNumbers
- カテゴリ
- カテゴリ
- ServiceType
- MoreHoursType
- BusinessHours
- TimePeriod
- SpecialHours
- SpecialHourPeriod
- ServiceAreaBusiness
- BusinessType
- Places
- PlaceInfo
- AdWordsLocationExtensions
- OpenInfo
- OpenForBusiness
- メタデータ
- プロフィール
- RelationshipData
- RelevantLocation
- RelationType
- MoreHours
- ServiceItem
- StructuredServiceItem
- FreeFormServiceItem
- ラベル
- メソッド
リソース: ロケーション
ビジネスです。これらのフィールドの詳細については、ヘルプセンターの記事をご覧ください。有効な業種のリストについては、カテゴリ エンドポイントをご覧ください。
| JSON 表現 |
|---|
{ "name": string, "languageCode": string, "storeCode": string, "title": string, "phoneNumbers": { object ( |
| フィールド | |
|---|---|
name |
ID。このビジネスの Google 識別子は |
languageCode |
変更不可。場所の言語。作成時に設定され、更新できません。 |
storeCode |
省略可。このビジネスの外部識別子。アカウント内で一意である必要があります。これにより、ビジネスとご自身の記録が関連付けられます。 |
title |
必須。ビジネスの名前は、店舗、ウェブサイト、販促品などで一貫して使用され、一般に知られているビジネスの実際の名称を反映させる必要があります。関連する追加情報は、リソースの他のフィールド( |
phoneNumbers |
省略可。顧客がビジネスに連絡するために使用できるさまざまな電話番号。 |
categories |
省略可。ビジネスを表すさまざまなカテゴリ。 |
storefrontAddress |
省略可。ビジネス拠点を表す正確な住所。遠隔地にある私書箱は使用できません。現時点では、住所に最大 5 つの |
websiteUri |
省略可。このビジネスの URL。可能であれば、すべての拠点やブランドに共通する一般的なウェブサイトや URL ではなく、このビジネス拠点専用の URL を使用してください |
regularHours |
省略可。ビジネスの営業時間。 |
specialHours |
省略可。ビジネスの特別営業時間。祝休日の営業時間など、通常の営業時間外の時間が含まれます。通常の営業時間よりこちらが優先されます。このフィールドは、通常の営業時間を設定しないと設定できません。 |
serviceArea |
省略可。非店舗型ビジネスとは、顧客のもとに出向いてサービスを提供するビジネスのことです。ビジネスが非店舗型ビジネスである場合、このフィールドはそのビジネスがサービスを提供する地域を表します。 |
labels[] |
省略可。ビジネスにタグを付けられるようにするための自由形式の文字列のコレクションです。これらのラベルはユーザーには表示されず、ビジネスのみに表示されます。ラベルごとに 1 ~ 255 文字で指定してください。 |
adWordsLocationExtensions |
省略可。AdWords に表示される追加情報。 |
latlng |
省略可。ユーザー指定の緯度と経度。ビジネスの作成時に、提供された住所のジオコード処理が行われた場合は無視されます。このフィールドは、作成時にユーザーが指定した |
openInfo |
省略可。ビジネスが現在営業中かどうかを示すフラグ。 |
metadata |
出力専用。編集不可能な追加情報です。 |
profile |
省略可。ご自身のビジネスについて自分の言葉で説明し、ビジネスや商品に関する独自のストーリーをユーザーと共有できます。 このフィールドは、宿泊施設カテゴリ(ホテル、モーテル、旅館など)を除くすべてのカテゴリで必須です。 |
relationshipData |
省略可。このビジネスに関連するすべてのビジネス拠点とチェーン。 |
moreHours[] |
省略可。ビジネスのさまざまな部門や特定の顧客向けの詳しい営業時間。 |
serviceItems[] |
省略可。販売者が対応しているサービスのリスト。サービスには、ヘアカット、給湯器の設置などがあります。重複するサービス項目は自動的に削除されます。 |
PhoneNumbers
ビジネスの電話番号のコレクション。更新中は、両方のフィールドを設定する必要があります。クライアントは、更新マスクを使用してメインの電話番号または追加の電話番号のみを更新することはできません。国際電話形式(「+1 415 555 0132」など)が推奨されます。詳しくは、https://developers.google.com/style/phone-numbers#international-phone-numbers) をご覧ください。
| JSON 表現 |
|---|
{ "primaryPhone": string, "additionalPhones": [ string ] } |
| フィールド | |
|---|---|
primaryPhone |
必須。個別のビジネス拠点に直接つながる電話番号を指定します。可能であれば、電話総合受付センターではなく、個々のお店の番号を使用します。 |
additionalPhones[] |
省略可。電話番号に加えて、ビジネスの電話連絡先を最大 2 件登録できます(携帯電話でも固定電話でもかまいませんが、FAX 番号は指定できません)。 |
カテゴリ
ビジネスを表すカテゴリのコレクション。更新中は、両方のフィールドを設定する必要があります。クライアントは、更新マスクを使用してメインカテゴリまたは追加カテゴリを個別に更新することはできません。
| JSON 表現 |
|---|
{ "primaryCategory": { object ( |
| フィールド | |
|---|---|
primaryCategory |
必須。このビジネスの中核事業を最もよく表すカテゴリ。 |
additionalCategories[] |
省略可。ビジネスを説明する追加のカテゴリ。カテゴリを選択すると、そのサービスを探しているユーザーに見つけてもらいやすくなります。ビジネス情報を正確かつ最新の状態に保つため、中核事業を表すカテゴリはできるだけ少なくします。できるだけ具体的で、なおかつ中心となる事業内容を示すカテゴリを選択します。 |
カテゴリ
カテゴリは業種を表すもので、事業内容を表すものではありません。有効なカテゴリ ID のリストと、対人可読な名前へのマッピングについては、categories.list をご覧ください。
| JSON 表現 |
|---|
{ "name": string, "displayName": string, "serviceTypes": [ { object ( |
| フィールド | |
|---|---|
name |
必須。このカテゴリの固定 ID(Google 提供)です。ビジネス情報の作成や更新の際にカテゴリを変更する場合は、値を指定する必要があります。 |
displayName |
出力専用。人間が読める形式のカテゴリ名です。ビジネスの読み取りの際に設定されます。ビジネス情報を変更する場合は、 |
serviceTypes[] |
出力専用。この業種で利用可能なすべてのサービスの種類の一覧。 |
moreHoursTypes[] |
出力専用。この業種で利用可能なその他の営業時間タイプ。 |
ServiceType
ビジネスが提供するサービスの種類を説明するメッセージ。
| JSON 表現 |
|---|
{ "serviceTypeId": string, "displayName": string } |
| フィールド | |
|---|---|
serviceTypeId |
出力専用。このサービスタイプの固定 ID(Google 提供)です。 |
displayName |
出力専用。サービスタイプの表示名(人が読める形式)。 |
MoreHoursType
通常の営業時間以外に、ビジネスが提供できる営業時間の詳細の種類。
| JSON 表現 |
|---|
{ "hoursTypeId": string, "displayName": string, "localizedDisplayName": string } |
| フィールド | |
|---|---|
hoursTypeId |
出力専用。この営業時間タイプに対して Google が提供する固定 ID。 |
displayName |
出力専用。営業時間タイプの英語の表示名(人が読める形式)。 |
localizedDisplayName |
出力専用。営業時間タイプのローカライズされた表示名(人が読める形式)。 |
BusinessHours
ビジネスが営業している期間を表します。[TimePeriod][google.mybusiness.mybusinessinformation.v1.TimePeriod] インスタンスのコレクションを保持します。
| JSON 表現 |
|---|
{
"periods": [
{
object ( |
| フィールド | |
|---|---|
periods[] |
必須。ビジネスが営業している時間のコレクションです。各期間は、1 週間のうちビジネスが営業している時間帯を表します。 |
TimePeriod
ビジネスが営業している期間を表します。指定した営業開始日時から始まり、指定した営業終了日時で終わります。営業終了時間は、営業開始時間の後、たとえば同日の後の時間か翌日に設定する必要があります。
| JSON 表現 |
|---|
{ "openDay": enum ( |
| フィールド | |
|---|---|
openDay |
必須。この期間が始まる |
openTime |
必須。有効な値は 00:00〜24:00 で、24:00 は曜日フィールドで指定した日が終了する深夜 0 時を表します。注: Proto3 JSON マッピングでは、デフォルトのゼロ値(00:00)は省略され、openTime に |
closeDay |
必須。この期間が終了する |
closeTime |
必須。有効な値は 00:00〜24:00 で、24:00 は曜日フィールドで指定した日が終了する深夜 0 時を表します。注: Proto3 JSON マッピングでは、デフォルトのゼロ値(00:00)は省略され、closeTime に |
SpecialHours
ビジネスの営業時間が通常の営業時間と異なる一連の期間を表します。
| JSON 表現 |
|---|
{
"specialHourPeriods": [
{
object ( |
| フィールド | |
|---|---|
specialHourPeriods[] |
必須。ビジネスの通常の時間帯に対する例外の一覧です。 |
SpecialHourPeriod
ビジネスの営業時間が通常の営業時間と異なる単一の期間を表します。特別営業時間が表す期間は 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 |
省略可。有効な値は 00:00〜24:00 で、24:00 は曜日フィールドで指定した日が終了する深夜 0 時を表します。 |
endDate |
省略可。この特別営業時間が終了する日付です。 |
closeTime |
省略可。有効な値は 00:00〜24:00 で、24:00 は曜日フィールドで指定した日が終了する深夜 0 時を表します。 |
closed |
省略可。true の場合、 |
ServiceAreaBusiness
非店舗型ビジネスとは、顧客のもとに出向いてサービスを提供するビジネスのことです(鍵業者や配管業者など)。
| JSON 表現 |
|---|
{ "businessType": enum ( |
| フィールド | |
|---|---|
businessType |
必須。非店舗型ビジネスの [type] [google.mybusiness.businessinfo.v1.ServiceAreaBusiness.BusinessType] を表します。 |
places |
省略可。そのビジネスがサービスを提供する地域を、場所のセットで定義します。 |
regionCode |
変更不可。この非店舗型ビジネスの拠点となる国 / 地域の CLDR 地域コード。詳細については、http://cldr.unicode.org/ と http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html をご覧ください。例: スイスの場合は「CH」。 このフィールドは、CUSTOMER_LOCATION_ONLY のビジネスでは必須であり、それ以外の場合は無視されます。 ここで指定する地域は、このビジネスがサービスを提供する地域とは異なる場合があります(例: 拠点を置く地域以外でサービスを提供する非店舗型ビジネス)。 このビジネス情報を作成後にオーナー確認が必要な場合、オーナー確認用に指定する住所は、この地域内にある必要があります。また、ビジネス オーナーまたはその正式な代表者は、指定したオーナー確認用の住所で郵便物を受け取れる必要があります。 |
BusinessType
このビジネスが、顧客のもとに出向いてオンサイトのサービスのみを提供する(レッカー車など)か、店舗とオンサイトの両方(イートイン スペースがあり、宅配もするピザ店など)でサービスを提供するかを表します。
| 列挙型 | |
|---|---|
BUSINESS_TYPE_UNSPECIFIED |
出力専用。指定されていません。 |
CUSTOMER_LOCATION_ONLY |
ビジネス拠点がある住所ではなく、周辺地域でのみサービスを提供します。ビジネスを CUSTOMER_AND_BUSINESS_LOCATION から CUSTOMER_LOCATION_ONLY に更新する場合は、位置情報の更新にフィールド マスク storefrontAddress を含め、フィールドを空に設定する必要があります。 |
CUSTOMER_AND_BUSINESS_LOCATION |
ビジネス拠点の住所とその周辺地域でサービスを提供します。 |
プレイス
場所のセットで表される地域の和集合を定義します。
| JSON 表現 |
|---|
{
"placeInfos": [
{
object ( |
| フィールド | |
|---|---|
placeInfos[] |
省略可。プレイス ID で表される地域です。最大 20 か所に制限されています。 |
PlaceInfo
プレイス ID で表される地域を定義します。
| JSON 表現 |
|---|
{ "placeName": string, "placeId": string } |
| フィールド | |
|---|---|
placeName |
必須。場所のローカライズされた名前です。例: |
placeId |
必須。場所の ID。リージョンに対応している必要があります。(https://developers.google.com/places/web-service/supported_types#table3) |
AdWordsLocationExtensions
AdWords に表示される追加情報。
| JSON 表現 |
|---|
{ "adPhone": string } |
| フィールド | |
|---|---|
adPhone |
必須。ビジネスのメインの電話番号の代わりに AdWords の住所表示オプションに表示される予備の電話番号です。 |
OpenInfo
ビジネスの営業状態に関する情報です。
| JSON 表現 |
|---|
{ "status": enum ( |
| フィールド | |
|---|---|
status |
必須。ビジネスが現在営業しているかどうかを表します。すべてのビジネスはデフォルトで営業中になります(休業中に変更された場合を除く)。 |
canReopen |
出力専用。このビジネスが再開の対象となるかどうかを示します。 |
openingDate |
省略可。ビジネスが開業した日付です。正確な日付が不明な場合は、年月のみを指定できます。日付は過去の日付か、1 年以内の将来の日付にする必要があります。 |
OpenForBusiness
ビジネスのステータスを表します。
| 列挙型 | |
|---|---|
OPEN_FOR_BUSINESS_UNSPECIFIED |
指定されていません。 |
OPEN |
ビジネスが営業していることを表します。 |
CLOSED_PERMANENTLY |
ビジネスが閉業したことを表します。 |
CLOSED_TEMPORARILY |
ビジネスが臨時休業していることを表します。 |
メタデータ
ビジネスに関する編集不可能な追加情報です。
| JSON 表現 |
|---|
{ "hasGoogleUpdated": boolean, "hasPendingEdits": boolean, "canDelete": boolean, "canOperateLocalPost": boolean, "canModifyServiceList": boolean, "canHaveFoodMenus": boolean, "canOperateHealthData": boolean, "canOperateLodgingData": boolean, "placeId": string, "duplicateLocation": string, "mapsUri": string, "newReviewUri": string, "canHaveBusinessCalls": boolean, "hasVoiceOfMerchant": boolean, "isParticularlyPersonalPlace": boolean } |
| フィールド | |
|---|---|
hasGoogleUpdated |
出力専用。このビジネスに関連付けられているプレイス ID に、クライアントが更新または拒否する必要がある変更があるかどうかを表します。このブール値が設定されている場合は、 |
hasPendingEdits |
出力専用。このビジネス拠点のプロパティに「編集内容が審査中」かどうかが示されるようになりました。 |
canDelete |
出力専用。API を使用してビジネス情報を削除できるかどうかを示します。 |
canOperateLocalPost |
出力専用。非推奨: このフィールドは入力されなくなり、今後のバージョンで削除される予定です。 |
canModifyServiceList |
出力専用。リスティングでサービスリストを変更できるかどうかを示します。 |
canHaveFoodMenus |
出力専用。リスティングが料理メニューの対象かどうかを示します。 |
canOperateHealthData |
出力専用。ロケーションが健康に関するデータを操作できるかどうかを示します。 |
canOperateLodgingData |
出力専用。ビジネスが宿泊施設のデータを操作できるかどうかを示します。 |
placeId |
出力専用。このビジネスが Google マップに表示されている場合は、そのビジネスのプレイス ID が入力されます。この ID はさまざまな Places API で使用できます。 このフィールドは、Create の呼び出し時に設定できますが、Update の呼び出し時には設定できません。 |
duplicateLocation |
出力専用。このビジネス情報が重複しているビジネス情報リソース。 |
mapsUri |
出力専用。マップ上のビジネスへのリンク。 |
newReviewUri |
出力専用。ユーザーがビジネスのクチコミを投稿できる Google 検索のページへのリンク。 |
canHaveBusinessCalls |
出力専用。リスティングがビジネス通話の対象かどうかを示します。 |
hasVoiceOfMerchant |
出力専用。リスティングに Voice of Merchant があるかどうかを示します。このブール値が false の場合は、locations.getVoiceOfMerchantState API を呼び出して、Voice of Merchant がない理由の詳細を取得する必要があります。 |
isParticularlyPersonalPlace |
出力専用。ビジネスが「特に個人的な場所」に分類されているかどうかを示します。つまり、ロケーション履歴の機能に制限があります。間違いであると思われる場合は、ヘルプセンターの記事をご覧ください。 |
プロフィール
ビジネスのプロフィールに関するすべての情報です。
| JSON 表現 |
|---|
{ "description": string } |
| フィールド | |
|---|---|
description |
必須。ビジネス オーナー自らが編集したビジネスの説明文です。他のユーザーは編集できません。 |
RelationshipData
この場所に関連するすべての親と子の場所の情報。
| JSON 表現 |
|---|
{ "parentLocation": { object ( |
| フィールド | |
|---|---|
parentLocation |
省略可。このロケーションが関連付けられている親ロケーション。 |
childrenLocations[] |
省略可。このビジネスが関連付けられている子ビジネスのリスト。 |
parentChain |
省略可。このビジネスが属するチェーンのリソース名。[チェーン ID の確認方法] [Locations.SearchChains] |
RelevantLocation
現在のビジネスと関係している別のビジネスの情報です。関係は DEPARTMENT_OF または INDEPENDENT_ESTABLISHMENT_OF のいずれかです。ここで指定する場所は、場所のどちら側(親 / 子)でもかまいません。
| JSON 表現 |
|---|
{
"placeId": string,
"relationType": enum ( |
| フィールド | |
|---|---|
placeId |
必須。リレーションの反対側にある場所を placeID で指定します。 |
relationType |
必須。関係のタイプ。 |
RelationType
指定する型関係。
| 列挙型 | |
|---|---|
RELATION_TYPE_UNSPECIFIED |
未指定 |
DEPARTMENT_OF |
これは、1 つの物理的なエリア、同じブランド / 上位管理 / 組織を共有しているものの、営業時間や電話番号などの主要な属性が異なる 2 つの場所の関係を表します。たとえば、Costco Pharmacy は Costco Wholesale の部門です。 |
INDEPENDENT_ESTABLISHMENT_IN |
これは、2 つの店舗が同じ物理的な場所に併設されているものの、異なる会社に属している場合(例: Safeway 内の Starbucks、ショッピング モール内の店舗)を表します。 |
MoreHours
特定の種類のビジネスで、ビジネス拠点が営業している期間。
| JSON 表現 |
|---|
{
"hoursTypeId": string,
"periods": [
{
object ( |
| フィールド | |
|---|---|
hoursTypeId |
必須。営業時間の種類。クライアントは、{#link businessCategories:BatchGet} を呼び出して、ビジネス拠点のカテゴリでサポートされている営業時間の種類を取得する必要があります。 |
periods[] |
必須。このビジネスの営業時間のコレクションです。各期間は、1 週間のうちビジネスが営業している時間帯を表します。 |
ServiceItem
1 つのサービス項目を説明するメッセージ。販売者が提供するサービスの種類を記述するために使用されます。たとえば、ヘアカットはサービスです。
| JSON 表現 |
|---|
{ "price": { object ( |
| フィールド | |
|---|---|
price |
省略可。サービス アイテムの金額を表します。価格を含める場合は、currencyCode と units を設定することをおすすめします。これは、サービス アイテムの固定価格として扱われます。 |
| 次のいずれかのフィールドを常に設定する必要があります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
structuredServiceItem |
省略可。このフィールドは、構造化されたサービスデータの場合に設定されます。 |
freeFormServiceItem |
省略可。このフィールドは、自由形式のサービスデータの場合に設定されます。 |
| 相互に排他的なフィールドの終了。 | |
StructuredServiceItem
販売者が提供する構造化されたサービスを表します。例: toilet_installation。
| JSON 表現 |
|---|
{ "serviceTypeId": string, "description": string } |
| フィールド | |
|---|---|
serviceTypeId |
必須。 |
description |
省略可。構造化されたサービス項目の説明。文字数制限は 300 文字です。 |
FreeFormServiceItem
販売者が提供する自由形式のサービスを表します。これらは、構造化サービスデータの一部として公開されていないサービスです。販売者は、GeoMerchant サーフェスを使用して、このようなサービスの名前を手動で入力します。
| JSON 表現 |
|---|
{
"category": string,
"label": {
object ( |
| フィールド | |
|---|---|
category |
必須。このフィールドは、カテゴリ名(カテゴリの固定 ID)を表します。 |
label |
必須。アイテムの言語タグ付きラベル。アイテム名は 140 文字以下、説明は 250 文字以下にすることをおすすめします。このフィールドは、入力がカスタム サービス アイテムの場合にのみ設定する必要があります。標準化されたサービスタイプは、serviceTypeId を使用して更新する必要があります。 |
ラベル
価格表、セクション、または商品アイテムを表示するときに使用するラベルです。
| JSON 表現 |
|---|
{ "displayName": string, "description": string, "languageCode": string } |
| フィールド | |
|---|---|
displayName |
必須。価格表、セクション、または商品アイテムの表示名です。 |
description |
省略可。価格表、セクション、または商品アイテムの説明です。 |
languageCode |
省略可。これらの文字列に適用する BCP 47 言語コードです。言語ごとに設定できるラベルのセットは 1 つのみです。 |
メソッド |
|
|---|---|
|
ログイン ユーザーが所有する新しいビジネス情報を作成します。 |
|
指定したアカウントのビジネス情報を一覧表示します。 |