前提条件の手順を完了し、Business Profile API へのアクセスがプロジェクトで承認されていることを確認してから続行してください。
API を有効にする
ビジネス プロフィールに関連付けられた次の 8 個の API を Google API Console で有効にする必要があります。
- Google My Business API
- My Business Account Management API
- My Business Lodging API
- My Business Place Actions API
- My Business Notifications API
- My Business Verifications API
- My Business Business Information API
- My Business Q&A API
API を有効にする
前提条件をすべて満たし、API へのアクセスを許可されているにもかかわらず、ショートカットを使用できない場合は、次の手順に沿って手動で API を有効にすることができます。
プロジェクトで API を有効にするには:
- Google API Console で API ライブラリを開きます。プロンプトが表示されたら、既存のプロジェクトのいずれかを選択するか、新しいプロジェクトを作成します。API ライブラリには、利用可能なすべての API がプロダクト ファミリーと人気度に応じて分類されて表示されます。
- 有効にしたい API がリストで見当たらない場合は、検索して見つけます。
- 有効にする API を選択し、[有効にする] ボタンをクリックします。
- プロンプトが表示されたら、請求機能を有効にします。
- プロンプトが表示されたら、API の利用規約に同意します。
Google Workspace をお使いの場合は、所属する Google Workspace 組織のアカウントで Google ビジネス プロフィールが有効になっていることを確認してください。所属する Google Workspace 組織のアカウントで Google ビジネス プロフィールが無効になっていると、GBP API を使用するときに「403 - 権限が拒否されました」というエラーが表示されます。
OAuth 2.0 クライアント ID をリクエストする
アプリケーションが非公開の保護データにアクセスするには、OAuth 2.0 クライアント ID が必要です。この ID を取得すると、アプリケーションはユーザーに代わって組織のビジネス情報にアクセスするための承認をリクエストできるようになります。
非公開のユーザーデータにアクセスする Business Profile API リクエストは、必ず OAuth 2.0 トークンとともに送信しなければなりません。
クライアント ID をまだ入手していない場合は、Google API Console の [認証情報] セクションに移動し、[認証情報を作成] > [OAuth クライアント ID] をクリックして OAuth 2.0 の認証情報を作成します。認証情報を作成すると、[認証情報] ページにクライアント ID が表示されます。クライアント ID をクリックすると、クライアント シークレット、リダイレクト URI、JavaScript 生成元アドレス、メールアドレスなどの詳細を確認できます。
REST の基礎を学習する
API は次の 2 つの方法で呼び出すことができます。
- HTTP リクエストを送信してレスポンスを解析する
- クライアント ライブラリを使用する
クライアント ライブラリを使用しない場合は、REST の基礎を理解している必要があります。
REST は、データをリクエストして変更するための便利で一貫したアプローチを提供するソフトウェア アーキテクチャのスタイルです。
REST という用語は、「Representational State Transfer」の略です。Google API の文脈では、Google が保存したデータの表現を HTTP 動詞を使用して取得および変更することを指します。
RESTful システムでは、リソースはデータストアに格納されます。クライアントはリソースの作成、取得、更新、削除などの特定の操作を実行するためにサーバーにリクエストを送信し、サーバーはその操作を実行してレスポンスを送信します。そのレスポンスは、多くの場合、指定されたリソースの表現形式です。
Google の RESTful API では、クライアントは GET、POST、PUT、DELETE などの HTTP 動詞を使用してアクションを指定します。また、次のような形式のグローバルに一意のユニフォーム リソース アイデンティファイア（URI）でリソースを指定します。
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
すべての API リソースは HTTP でアクセス可能な一意の URI を持っているため、REST はデータ キャッシュを活用して、ウェブの分散インフラストラクチャでの動作に対応します。
HTTP 1.1 標準のドキュメントに記載されているメソッド定義を参考にしてください。GET、POST、PUT、DELETE の仕様も記載されています。
Business Profile API の REST
Business Profile API のオペレーションは、REST HTTP 動詞に直接マッピングされます。
Business Profile API は、次の形式の URI で表されます。
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
API の各オペレーションと対応する URI の一覧は、Business Profile API リファレンス ドキュメントに記載されています。
リソースパスはエンドポイントによって異なります。
たとえば、アカウントへのリソースパスは次の形式で表されます。
accounts/accountId
ビジネス情報のリソースパスは、次の形式で表されます。
locations/locationId
JSON の基礎を学習する
Business Profile API では、データを JSON 形式で返します。
JavaScript Object Notation（JSON）は、任意のデータ構造を単純なテキストで表現できる、言語に依存しない共通のデータ形式です。詳しくは json.org をご覧ください。
Oauth Playground を使用して簡単な HTTP リクエストを作成する
Business Profile API を使ったテストでは、OAuth 2.0 Playground を使用できます。ただし、Business Profile API は限定公開であるため、使用するには Playground でいくつか追加の手順が必要となります。続行するには、ウェブ アプリケーションのクライアント ID が必要です。
- Google API Console にアクセスし、プロジェクトを開きます。ウェブ アプリケーション用の OAuth クライアント ID がない場合は、ID を作成します。
- [認証情報を作成] プルダウンで [OAuth クライアント ID] を選択します。
- [アプリケーションの種類] で [ウェブ アプリケーション] をクリックします。
有効なリダイレクト URI として次を追加します。
https://developers.google.com/oauthplayground
- [作成] をクリックします。
- クライアント ID をクリップボードにコピーします。
- OAuth 2.0 Playground に移動します。
- 歯車アイコンをクリックして設定オプションを開き、以下の変更を加えます。
- [OAuth flow] を [Client-side] に設定します。
- [Use your own OAuth credentials] をオンにします。
- OAuth クライアント ID を貼り付けます。
- 設定オプションを閉じます。
[Step 1 - Select & authorize APIs] の [Input your own scopes] という項目に、Business Profile API の次のスコープを貼り付けます。
https://www.googleapis.com/auth/business.manage
- [Authorize APIs] をクリックします。
- プロンプトが表示されたら、[Accept] をクリックします。
-
[Step 2 - Configure request to API] で、以下の URI を [Request URI] に貼り付けます。
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- [Send the request] をクリックします。レスポンスに「
200 OK」のステータスが表示されます。
さまざまなタイプのリクエストについて詳しくは、Business Profile API のリファレンスをご覧ください。
クライアント ライブラリ
Business Profile API クライアント ライブラリは、Business Profile API の機能をサポートし、すべての Google API に共通する機能（HTTP トランスポート、エラー処理、認証、JSON 解析など）も備えています。
クライアント ライブラリをダウンロードするには、ライブラリをご覧ください。