Business Profile Performance API がリリースされました。移行作業が必要です。
サポート終了スケジュールと、サポートが終了した古い v4 API から新しい v1 API に移行する手順をご確認ください。
こちらのアンケートにご回答いただき、サポート対象国に関して提供可能な場所、メニュー、料理の属性について理解を深め、食品のエクスペリエンス向上にご協力ください。

基本設定

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

前提条件の手順を完了し、Business Profile API へのアクセスがプロジェクトで承認されていることを確認してから続行してください。

API を有効にする

Google API Console で有効にする必要がある、ビジネス プロフィールに関連付けられた API が 8 つあります。

  • 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 を有効にする手順は、次のとおりです。

  1. Google API コンソールで API ライブラリを開きます。プロンプトが表示されたら、プロジェクトのいずれかを選択するか、新しいプロジェクトを作成します。API ライブラリには、利用できるすべての API がプロダクト ファミリーと人気度によって分類され、表示されます。
  2. 有効にする API がリストで見当たらない場合は、検索して見つけます。
  3. 有効にする API を選択し、[有効にする] ボタンをクリックします。
  4. プロンプトが表示されたら、請求機能を有効にします。
  5. プロンプトが表示されたら、API の利用規約に同意します。

OAuth 2.0 クライアント ID をリクエストする

アプリが非公開の保護データにアクセスするには、OAuth 2.0 クライアント ID が必要です。これにより、アプリはユーザーに代わって組織の位置情報にアクセスするための承認をリクエストできます。

非公開のユーザーデータにアクセスする Business Profile API リクエストは、必ず OAuth 2.0 トークンとともに送信しなければなりません。

まだ行っていない場合は、Google API Console の [認証情報] セクションに移動し、[認証情報を作成&OAuth クライアント ID] をクリックして、OAuth 2.0 認証情報を作成します。認証情報を作成すると、認証情報ページにクライアント ID が表示されます。クライアント ID をクリックすると、クライアント シークレット、リダイレクト URI、JavaScript 生成元アドレス、メールアドレスなどの詳細を確認できます。

REST の基礎を学習する

API は次の 2 つの方法で呼び出すことができます。

クライアント ライブラリを使用しない場合は、REST の基礎を理解している必要があります。

REST は、データをリクエストして変更するための便利で一貫したアプローチを提供するソフトウェア アーキテクチャのスタイルです。

REST という用語は、「Representational State Transfer」の略です。Google API のコンテキストでは、Google が保存したデータの表現を HTTP 動詞を使用して取得および変更することを指します。

RESTful システムでは、リソースはデータストアに格納されます。クライアントはリソースの作成、取得、更新、削除などの特定の操作を実行するためにサーバーにリクエストを送信し、サーバーはその操作を実行してレスポンスを送信します。そのレスポンスは、多くの場合、指定されたリソースの表現形式です。

Google の RESTful API では、クライアントは GETPOSTPUTDELETE などの HTTP 動詞を使用してアクションを指定します。クライアントは、次の形式のグローバルに一意のユニフォーム リソース識別子(URI)でリソースを指定します。

https://apiName.googleapis.com/apiVersion/resourcePath?parameters

すべての API リソースは HTTP でアクセス可能な一意の URI を持っているため、REST はデータ キャッシュを有効にし、ウェブの分散インフラストラクチャで動作するように最適化されています。

HTTP 1.1 標準のドキュメントのメソッド定義をご覧ください。GETPOSTPUTDELETE の仕様も記載されています。

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 をご覧ください。

単純な HTTP リクエストの作成

Business Profile API を使ったテストでは、OAuth 2.0 Playground を使用できます。Business Profile API は公開 API ではないため、Playground で使用するには追加の手順を行う必要があります。続行するには、ウェブ アプリケーションのクライアント ID が必要です。

  1. Google API Console に移動し、プロジェクトを開きます。ウェブ アプリケーション用の OAuth クライアント ID がない場合は、ID を作成します。
    1. [認証情報の作成] プルダウン リストから [OAuth クライアント ID] を選択します。
    2. [アプリケーションの種類] で、[ウェブ アプリケーション] をクリックします。
    3. 有効なリダイレクト URI として次を追加します。

       https://developers.google.com/oauthplayground
       
    4. [作成] をクリックします。
  2. クライアント ID をクリップボードにコピーします。
  3. OAuth 2.0 Playground にアクセスします。
  4. 歯車アイコンをクリックして設定オプションを開き、以下の変更を加えます。
    1. OAuth フロークライアント側に設定します。
    2. [Use your own OAuth credentials] をオンにします。
    3. OAuth クライアント ID を貼り付けます。
  5. 構成オプションを閉じます。
  6. 「ステップ 1 - API を選択して承認する」で、Business Profile API の次のスコープを [Input your own scopes] に貼り付けます。

    https://www.googleapis.com/auth/business.manage
    
  7. [Authorize APIs] をクリックします。
  8. プロンプトが表示されたら、[Accept] をクリックします。
  9. ステップ 2 - API へのリクエストを設定し、次の URI を [Request URI] 欄に貼り付けます。

    https://mybusinessaccountmanagement.googleapis.com/v1/accounts
    
  10. [Send the request] をクリックします。レスポンスに「200 OK」のステータスが表示されます。

さまざまなタイプのリクエストについて詳しくは、Business Profile API のリファレンスをご覧ください。

クライアント ライブラリ

Business Profile API クライアント ライブラリは、Business Profile API の機能をサポートし、HTTP トランスポート、エラー処理、認証、JSON 解析など、すべての Google API に共通する機能を提供します。

クライアント ライブラリをダウンロードするには、ライブラリをご覧ください。