このチュートリアルでは、位置情報を作成および編集する方法について説明します。My Business Business Information API を使用すると、次のことができます。
ビジネス情報は Google 広告で使用できますが、使用する必要があります。 確認済み Google 検索と Google マップに表示されます。位置情報は accounts.locations あります
始める前に
My Business Business Information API を使用するには、 OAuth 2.0 認証情報を取得します。P-MAX キャンペーンを開始する方法 My Business Business Information API を使用する場合は、基本設定をご覧ください。
ビジネス情報を作成する
My Business Business Information API を使用すると、 accounts.locations.create。
<ph type="x-smartling-placeholder">ビジネスを作成するには、以下を使用します。
<ph type="x-smartling-placeholder">POST https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?requestId=requestId&validateOnly=True|False { "storeCode": "GOOG-SYD", "languageCode": "en-AU", "title": "Google Sydney", "phoneNumbers": { "primaryPhone": "02 9374 4000" } "storefrontAddress": { "addressLines": [ "Level 5", "48 Pirrama Road" ], "locality": "Pyrmont", "postalCode": "2009", "administrativeArea": "NSW", "regionCode": "AU" }, "websiteUri": "https://www.google.com.au/", "regularHours": { "periods": [ { "openDay": "MONDAY", "closeDay": "MONDAY", "openTime": "09:00", "closeTime": "17:00" }, { "openDay": "TUESDAY", "closeDay": "TUESDAY", "openTime": "09:00", "closeTime": "17:00" }, { "openDay": "WEDNESDAY", "closeDay": "WEDNESDAY", "openTime": "09:00", "closeTime": "17:00" }, { "openDay": "THURSDAY", "closeDay": "THURSDAY", "openTime": "09:00", "closeTime": "17:00" }, { "openDay": "FRIDAY", "closeDay": "FRIDAY", "openTime": "09:00", "closeTime": "17:00" } ] }, "categories": { "primaryCategory": { "name": "gcid:software_company" } } }
ビジネス情報を削除する
My Business Business Information API を使用すると、 locations.delete.
ビジネス情報を削除するには、次のように記述します。
<ph type="x-smartling-placeholder">DELETE https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}
名前を指定してビジネス情報を取得する
アカウントに多数のビジネスが関連付けられている場合は、 1 か所にまとめることができますお店やサービスの名前、特定のクエリを ロケーションと locations.get.
名前でロケーションを取得するには、次のように記述します。特定のフィールドを取得するには readMask を指定する必要があります。:
<ph type="x-smartling-placeholder">GET https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}?readMask={commaSeparatedFieldsToRetrieve}
Google マップのバージョンを返す
<ph type="x-smartling-placeholder">Google マップ版のビジネス情報を返すには、
googleUpdated
をリクエスト URL に設定します。次に例を示します。
GET https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}:googleUpdated?readMask={commaSeparatedFieldsToRetrieve}
結果がない場合は、404 NOT FOUND
HTTP ステータス コードが返されます。
返されます。Google による変更の管理について詳しくは、こちらをご覧ください。
ロケーションの一覧表示
複数のビジネス情報を管理する場合は、 アカウントに関連付けられているすべてのビジネス情報が表示されます。こちらの accounts.locations.list ユーザーに関連付けられているすべてのビジネス情報を一覧表示する API。
認証済みのユーザーが直接所有または管理しているすべてのビジネス情報のリストを表示するには、次のコマンドを使用します。 次のとおりです。
<ph type="x-smartling-placeholder">GET https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?readMask={commaSeparatedFieldsToRetrieve}
リクエスト URL のアカウントには、ワイルドカード '-'
を使用して
間接的に所有されている(グループで所有または管理されている)リスティング:
GET https://mybusinessbusinessinformation.googleapis.com/v1/accounts/-/locations?readMask={commaSeparatedFieldsToRetrieve}
ビジネス情報のリスト結果を絞り込む
<ph type="x-smartling-placeholder">フィルタを使用すると、 accounts.locations.list. リクエストをフィルタするには、次に示すようにフィルタ式をベース URL に追加します。 この例では:
GET https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?readMask={commaSeparatedFieldsToRetrieve}&filter={FIELD_NAME}=%22{YOUR_QUERY}%22
基本的なクエリ構文
制限の構文は次のとおりです。
<field><operator><value>
,
演算子は EQUALS(=)または HAS(:)のいずれかです。EQUALS(=)と HAS(:)
演算子は、locationName
を除くすべてのフィールドと同等です(
。
引用符は「%22」としてエンコードされます。プラス記号(+)は使用しません。
特に明記されていない限り、すべての比較で大文字と小文字は区別されません。 比較できます。例: 「4 ドライブ」「4, Privet Drive」と一致します
フィルタクエリで複数のフィールドを結合する
この API では、すべてのフィールド制限を AND で結び付けることができます。ただし、
OR キーワードの場合、すべての制限を同じキーワードに
表示されます。たとえば、locationName=A
または labels=B
は次に一致しません。
できます。
例
次の例は、次の条件に該当するすべてのビジネス情報を返すフィルタ式を示しています。 「Pepé Le Pew」という名前をつけました。「french_restaurant」またはまたは 「european_restaurant」、「新規営業」というラベルが表示されます
locationName=%22Pepé+Le+Pew%22+AND+ (categories=%22french_restaurant%22+OR+ categories=%22european_restaurant%22)+AND+ labels=%22newly+open%22
距離またはアカウントで検索
次の例は、特定のエリア内の場所を検索する方法を示しています 地点からの距離:
<ph type="x-smartling-placeholder">GET https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?readMask={commaSeparatedFieldsToRetrieve}&filter=distance(latlng, geopoint({latitude}, {longitude}))<{distance}
米国のコロラド州ボルダーから 1, 000 マイル圏内にあるビジネス拠点のみを取得するには:
GET https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?readMask={commaSeparatedFieldsToRetrieve}&filter=distance(latlng, geopoint(40.01, -105.27))<1000.0
サポートされているすべてのフィルタ フィールドのリスト
使用可能なすべてのフィールドの一覧を以下に示します。 フィルタリング:
フィールド | 説明と例 |
---|---|
文字列の照合フィールド | |
title |
ビジネス実世界の名前
|
categories |
メインカテゴリと追加カテゴリの組み合わせ。 なお、「gcid:」は省略する必要はありません。複数の 少なくとも 1 つのカテゴリがこの条件に一致する場合に、このフィルタが一致します。 パターンです。
|
phone_numbers.primary_phone |
E.164 形式のメインの電話番号(例: +441234567890)。
|
storefront_address.region_code |
住所の国/地域の CLDR 地域コード
|
storefront_address.administrative_area |
国または地域の郵送先住所として使用される最上位の行政区域
|
storefront_address.locality |
住所の市区町村の部分
|
storefront_address.postal_code |
住所の郵便番号
|
metadata.place_id |
ビジネスのオーナー確認が済んでおり、Google マップに関連付けられているか表示されている場合、このフィールドはそのビジネスのプレイス ID と同じになります。
|
openInfo.status |
ビジネスが現在営業中かどうかを示します
(
|
labels |
ビジネスにタグを付けられるようにするための自由形式の文字列のコレクション。イン 指定する場合、この値は完全に一致する トークンだけでなく、大文字と小文字も区別されます。例:ラベルが「XX YY」の場合 「XX」もまたは「xx yy」一致します。
|
storeCode |
このビジネスの外部識別子。アカウント内で一意である必要があります。
|
関数 | |
distance |
特定の地点からの距離に基づいてフィルタできます。
|
クエリ フィールドで並べ替え
結果はビジネス名または店舗コードで昇順または
降順で表示されます。並べ替え条件が複数ある場合は、カンマで区切って指定します。
orderBy
文字列。次の例のようになります。
GET https://mybusinessbusinessinformation.googleapis.com/v1/accounts/{accountId}/locations?readMask={commaSeparatedFieldsToRetrieve}&orderBy=locationName,storeCode
ビジネス情報を修正する
My Business Business Information API を使って、ビジネス情報の項目を locations.patch。
ビジネスの項目を変更するには、以下を使用します。
<ph type="x-smartling-placeholder">location フィールドとともにフィールドと更新された値を追加し、
更新されたフィールドのカンマ区切りのリスト。fieldMask
の値として指定します。
PATCH https://mybusinessbusinessinformation.googleapis.com/v1/locations/{locationId}?languageCode=language&validateOnly=True|False&updateMask=title { "title": "Google Shoes" }