Cloud Endpoints Portal 使用のスタートガイド

このページでは、Cloud Endpoints サービスのポータルの作成方法と、ポータルのユーザー インターフェースについて説明します。また、それぞれのタスクを実行するために最低限必要な Identity and Access Management のロールについても説明します。IAM の権限について詳しくは、以下をご覧ください。

前提条件

すでに以下を行っていることを前提としています。

ポータルの作成

ポータルを作成するには:

  1. Google Cloud コンソールで、[Endpoints] > [デベロッパー ポータル] ページに移動します。

    Cloud Endpoints Portal に移動

  2. API が含まれている Cloud プロジェクトを選択します。
  3. [ポータルを作成] をクリックします。ポータルの生成には、通常 5〜10 分かかります。ポータルの準備ができると、ポータルの URL が表示されます。

ポータルを作成すると、次のような効果があります。

  • ポータルの作成時に、Endpoints ポータル サービス エージェントのロールを持つサービス アカウントが service-YOUR_PROJECT_NUMBER@endpoints-portal.iam.gserviceaccount.com という名前で作成されます（YOUR_PROJECT_NUMBER は Cloud プロジェクトのプロジェクト番号です）。このサービス アカウントは、Google Cloud コンソールの Google Cloud プロジェクトの [IAM と管理] > [IAM] ページに表示されます。

  • ポータルが作成されると、ドメイン名 endpointsportal.YOUR_PROJECT_ID.cloud.goog が使用されます（YOUR_PROJECT_ID は Cloud プロジェクト ID です。）これをサポートするために、SSL/TLS 証明書と、プロジェクト ID を記録したパブリック DNS レコードが作成され、一般公開されている Certificate Transparency ログで検索可能になります。これは、ポータルが一般公開されていないとしても同じです。

API のポータルの表示

ポータルで API を表示するには:

  1. [エンドポイント] > [デベロッパー ポータル] ページの [ポータルの URL] セクションで URL をクリックします。

  2. ログイン プロンプトに従ってポータルに進みます。アカウントが複数ある場合は、API がある Cloud プロジェクトのアカウントを選択してください。

    ポータルのホームページが表示されます。この URL をブックマークすることをおすすめします。ポータルのホームページに、Cloud プロジェクト内のすべての API へのリンク一覧が表示されます。

  3. 調べたい API をクリックします。API のホームページが表示されます。

ポータルの UI の概要

API のホームページの下部にある以下のアイコンは、API のユーザーにとって有用な情報へのリンクです。

  • API リファレンス をクリックすると、Endpoints Frameworks の openapi.json ファイルから生成した SmartDocs API リファレンス ドキュメントの最初のページが表示されます。左側のナビゲーション バーを使用して、各メソッドとリソースの SmartDocs ドキュメントを表示できます。

  • スタートガイド をクリックすると、スタートガイドのサンプル コンテンツが表示されます。API ユーザーにポータルの URL を送信する前にこのドキュメントをカスタマイズし、API ユーザーがコード内で API を使用する際に必要な情報を提供します。スタートガイドのコンテンツを変更する方法については、カスタム ドキュメントの追加をご覧ください。

  • キーの取得 をクリックすると、[API とサービス] > [API ライブラリ] ページが表示されます。これにより、ユーザーは自身の GCP プロジェクトで API を有効にできます。

    API キーを必要とする API の場合、ユーザーは API を有効にした後、[API とサービス] > [認証情報] ページに移動して、コードで使用できる API キーを取得できます。ポータル URL を API ユーザーに送信する前に、API を使用するためのアクセス権を付与する必要があります。詳細については、API を有効にできるユーザーの制御をご覧ください。

ポータルの外観のカスタマイズ

ポータルの配色や表示されるアイコンなどを会社のウェブサイトとマッチするように変更できます。ポータルの外観を変更し、カスタム ドメインを設定することで、ブランディングされた環境をユーザーに提供できます。

ポータルの外観をカスタマイズするには:

  1. ページの右上隅にある設定アイコン をクリックします。

  2. [Site Wide] タブをクリックします。以下の外観を変更できます。

    • ロゴ
    • メインの色。ホームページとタイトルバーの背景色として使用されます。
    • サブの色。アイコンとリンクの色として使用されます。
    • ホームページのタイトル
    • ホームページの説明

  3. [Save] をクリックします。

ポータルの削除

ポータルを削除するには:

  1. Google Cloud コンソールで、[Endpoints] > [デベロッパー ポータル] ページに移動します。

    Cloud Endpoints Portal に移動

  2. API が含まれている Cloud プロジェクトを選択します。
  3. [削除] をクリックします。
  4. 確認ダイアログで [削除] をクリックします。

次のステップ

以下の内容について学習します。