OpenAPI

OpenAPI は、仕様を示しています。使用 OpenAPI 仕様 2.0 ビジネスメッセージとビジネス用の OpenAPI ドキュメントを作成できます。通信 API を使用して、その構造を記述します。

これにより、次のことが可能になります。

任意の言語でクライアントライブラリを作成する
サーバースタブを作成する
API 管理ツールを使用する

OpenAPI ドキュメントの基本構造

OpenAPI ドキュメントは、REST API のサーフェスを記述します。このドキュメントでは、 API の名前と説明、API の個々のエンドポイント（パス）呼び出し元の認証方法などがあります。

以下をクリックすると、この基本構造の例が表示されます。

JSON

    {
      "swagger": "2.0",
      "host": "businessmessages.googleapis.com",
      "info": {
        "title": "Business Messages API",
        "description": "",
        "version": "v1"
      },
      "paths": {
        "/v1/conversations/{conversationsId}/messages": {
          "post": {
            "description": "Sends a message from an agent to a user.",
            "parameters": [
              {
                "description": "Part of `parent`. Required. The conversation that contains the message. Resolves to \"conversations/{conversationId}\".",
                "type": "string",
                "in": "path",
                "required": true,
                "name": "conversationsId"
              },
              {
                "description": "Optional. A flag to send the specified fallback text instead of other message content.",
                "name": "forceFallback",
                "type": "boolean",
                "in": "query"
              },
              {
                "name": "message",
                "schema": {
                  "$ref": "#/definitions/BusinessMessagesMessage"
                },
                "in": "body",
                "description": "Required. The content of a message."
              }
            ],
            "tags": [
              "businessmessages"
            ],
            "operationId": "CreateMessage",
            "responses": {
              "default": {
                "schema": {
                  "$ref": "#/definitions/BusinessMessagesMessage"
                },
                "description": "Successful operation"
              }
            }
          }
        }
      }
    }

OpenAPI ドキュメントの構造について詳しくは、 Swagger のウェブサイト

OpenAPI ドキュメントにアクセスする方法

OpenAPI ドキュメントにアクセスするには、Google Cloud ビジネスメッセージとビジネスコミュニケーションを含むプラットフォーム（GCP）プロジェクト API が有効になりました。

以下のセクションをご覧ください。

GCP プロジェクトを作成する
API キーの作成
Business Messages API と Business Communications API を有効にする

これらの手順を完了すると、OpenAPI ドキュメントにアクセスできるようになります。

GCP プロジェクトを作成する

すでに GCP プロジェクトがある場合は、そのプロジェクトを使用して API キーを作成できます。

新しい GCP プロジェクトを作成する手順は次のとおりです。

[リソースの管理] に移動します。できます。
ページの上部にある [組織を選択] プルダウンリストで、プロジェクトを作成する組織を選択します。無料試用をご利用の場合は、この手順をスキップしてください。
[プロジェクトの作成] をクリックします。
[New Project] ウィンドウでプロジェクト名を入力し、請求先アカウントを選択する必要がありますプロジェクト名には、英数字、単一の文字、引用符、ハイフン、スペース、感嘆符を使用できます。長さは 4 ～ 30 文字です。
[ロケーション] に、新しいプロジェクトの親組織またはフォルダを入力します。
[作成] をクリックします。

API キーを作成する

[ [認証情報] ページ確認できます。
[認証情報を作成] をクリックし、[API キー] を選択します。

[API キーを作成しました] ダイアログボックスに、新しく作成したキーが表示されます。キーをコピーして安全に保管します。API キーについて詳しくは、こちらの API キーのドキュメント

Business Communications API と Business Messages API を有効にする

GCP プロジェクトでこれらの API を有効にする手順は次のとおりです。

[API とサービス] ページに移動します。
[プロジェクトを選択] プルダウンリストで、プロジェクトを選択します。
[API とサービスの有効化] をクリックします。
[API とサービスを検索] フィールドに「ビジネスメッセージ」と入力します。
[Business Messages API] を選択します。
[有効にする] をクリックします。
[API とサービスの有効化] をクリックします。
[API とサービスを検索] フィールドに「Business Communications」と入力します。
[Business Communications API] を選択します。
[有効にする] をクリックします。

これで、API キーに、API の OpenAPI ドキュメントにアクセスする権限が Business Messages API と Business Communications API です。

OpenAPI ドキュメントにアクセスする

Business Messages API の OpenAPI ドキュメントにアクセスするには、次のコマンドを実行します。

curl "https://businessmessages.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"

次のコマンドを実行して、Business Communications API の OpenAPI ドキュメントにアクセスします。

curl "https://businesscommunications.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"

API_KEY は実際の API キーに置き換えてください。

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