GSP294

概要

API（アプリケーション プログラミング インターフェース）は、開発者がコンピューティング リソースやデータにアクセスできるようにするためのソフトウェア プログラムです。さまざまな分野の企業が API を一般公開しており、開発者は自身のアプリケーションやコードベースに専用のツール、サービス、ライブラリを組み込むことができます。

このラボでは、API のアーキテクチャと基本機能について復習します。Google Cloud Shell で Cloud Storage API メソッドを構成して実行する実践演習も行います。このラボを受講すると、API 通信、アーキテクチャ、認証の基本原理を理解できるようになります。また、API に関する実践的な経験を積んで、今後のラボやプロジェクトに活かすこともできます。

API - 内容と目的

API を使うとデータとコンピューティング リソースにアクセスできるため、開発者の作業効率が大幅に向上します。プログラム、メソッド、データセットをすべてゼロからビルドするよりも、API を使用する方がはるかに簡単です。API は抽象化の原則に基づいてビルドされています。ご自身の環境で使用するために、API の内部の仕組みや複雑な部分を理解する必要はありません。

API は、開発者が使用することを前提に作成されているため、多くの場合、グラフィカル ユーザー インターフェース（GUI）は提供されません。ただし、例外もあります。Google は API Explorer という新しいツールをリリースしました。このツールを使用すると、さまざまな Google API をインタラクティブに試すことができます（詳しくは、後で API Explorer: Qwik Start ラボをご覧ください）。

Cloud APIs

Google は、さまざまな分野に適用できる API を提供しています。API は、ウェブ開発、ML、データ サイエンス、システム管理ワークフローでよく使用されます。しかし、これは使用例のごく一部です。たとえば AnyAPI を調べれば、利用できる API がどれだけあるかがわかるでしょう。

Qwiklabs でラボ インスタンス用の新しい Google Cloud プロジェクトがプロビジョニングされるときは、ほとんどの API がバックグラウンドで有効化されるため、すぐにラボのタスクを開始できます。Qwiklabs 以外で独自のプロジェクトを作成した場合、特定の API をユーザー自身で有効にする必要があります。

Google Cloud ユーザーとしての熟練度が増すにつれ、ワークフローでさらに多くの API を使用するようになるでしょう。経験豊富なユーザーは、ツールとサービスの実行に Google Cloud コンソールをほとんど使用せず、ほぼローカル環境のみに Cloud API を統合して使用します。さまざまな言語でさまざまな Google API を使用できるように、Google は多くのハンズオンラボを提供しています。

このラボでは、API ライブラリを見て、どのような Google API が利用できるか確認します。

目標

このラボでは、次のことについて学びます。

• Google API
• API のアーキテクチャ
• HTTP プロトコルとメソッド
• エンドポイント
• REST（Representational State Transfer）および RESTful API
• JSON（JavaScript Object Notation）
• API 認証サービス

前提条件

これは入門レベルのラボで、API の予備知識や Google API の使用経験がほとんどない、またはまったくない方を対象としています。シェル環境やコマンドライン インターフェース ツールの知識があることが推奨されますが、必須ではありません。Google Cloud コンソールと Cloud Storage に関する知識は必須です。このため、このラボを受講する前に少なくとも次に示すラボを受講してください。

• Qwiklabs と Google Cloud の概要
• Cloud Storage: Qwik Start - Cloud コンソール

準備ができたら下にスクロールし、手順に沿ってラボ環境を設定します。

設定と要件

[ラボを開始] ボタンをクリックする前に

こちらの説明をお読みください。ラボには時間制限があり、一時停止することはできません。タイマーは、Google Cloud のリソースを利用できる時間を示しており、[ラボを開始] をクリックするとスタートします。

このハンズオンラボでは、シミュレーションやデモ環境ではなく実際のクラウド環境を使って、ラボのアクティビティを行います。そのため、ラボの受講中に Google Cloud にログインおよびアクセスするための、新しい一時的な認証情報が提供されます。

このラボを完了するためには、下記が必要です。

• 標準的なインターネット ブラウザ（Chrome を推奨）

注: このラボの実行には、シークレット モード（推奨）またはシークレット ブラウジング ウィンドウを使用してください。これにより、個人アカウントと受講者アカウント間の競合を防ぎ、個人アカウントに追加料金が発生しないようにすることができます。

• ラボを完了するための時間（開始後は一時停止できません）

注: このラボでは、受講者アカウントのみを使用してください。別の Google Cloud アカウントを使用すると、そのアカウントに料金が発生する可能性があります。

ラボを開始して Google Cloud コンソールにログインする方法

1. [ラボを開始] ボタンをクリックします。ラボの料金をお支払いいただく必要がある場合は、表示されるダイアログでお支払い方法を選択してください。 左側の [ラボの詳細] ペインには、以下が表示されます。

   • [Google Cloud コンソールを開く] ボタン
   • 残り時間
   • このラボで使用する必要がある一時的な認証情報
   • このラボを行うために必要なその他の情報（ある場合）

2. [Google Cloud コンソールを開く] をクリックします（Chrome ブラウザを使用している場合は、右クリックして [シークレット ウィンドウで開く] を選択します）。

   ラボでリソースがスピンアップし、別のタブで [ログイン] ページが表示されます。

   ヒント: タブをそれぞれ別のウィンドウで開き、並べて表示しておきましょう。

   注: [アカウントの選択] ダイアログが表示されたら、[別のアカウントを使用] をクリックします。

3. 必要に応じて、下のユーザー名をコピーして、[ログイン] ダイアログに貼り付けます。

   {{{user_0.username | "Username"}}}

   [ラボの詳細] ペインでもユーザー名を確認できます。

4. [次へ] をクリックします。

5. 以下のパスワードをコピーして、[ようこそ] ダイアログに貼り付けます。

   {{{user_0.password | "Password"}}}

   [ラボの詳細] ペインでもパスワードを確認できます。

6. [次へ] をクリックします。

   重要: ラボで提供された認証情報を使用する必要があります。Google Cloud アカウントの認証情報は使用しないでください。 注: このラボでご自身の Google Cloud アカウントを使用すると、追加料金が発生する場合があります。

7. その後次のように進みます。

   • 利用規約に同意してください。
   • 一時的なアカウントなので、復元オプションや 2 要素認証プロセスは設定しないでください。
   • 無料トライアルには登録しないでください。

その後、このタブで Google Cloud コンソールが開きます。

注: Google Cloud のプロダクトやサービスにアクセスするには、ナビゲーション メニューをクリックするか、[検索] フィールドにサービス名またはプロダクト名を入力します。

Cloud Shell をアクティブにする

Cloud Shell は、開発ツールと一緒に読み込まれる仮想マシンです。5 GB の永続ホーム ディレクトリが用意されており、Google Cloud で稼働します。Cloud Shell を使用すると、コマンドラインで Google Cloud リソースにアクセスできます。

1. Google Cloud コンソールの上部にある「Cloud Shell をアクティブにする」アイコン をクリックします。

2. ウィンドウで次の操作を行います。

   • Cloud Shell 情報ウィンドウで操作を進めます。
   • Cloud Shell が認証情報を使用して Google Cloud API を呼び出すことを承認します。

接続した時点で認証が完了しており、プロジェクトに各自の Project_ID、 が設定されます。出力には、このセッションの PROJECT_ID を宣言する次の行が含まれています。

Your Cloud Platform project in this session is set to {{{project_0.project_id | "PROJECT_ID"}}}

gcloud は Google Cloud のコマンドライン ツールです。このツールは、Cloud Shell にプリインストールされており、タブ補完がサポートされています。

3. （省略可）次のコマンドを使用すると、有効なアカウント名を一覧表示できます。

gcloud auth list

4. [承認] をクリックします。

出力:

ACTIVE: * ACCOUNT: {{{user_0.username | "ACCOUNT"}}} To set the active account, run: $ gcloud config set account `ACCOUNT`

5. （省略可）次のコマンドを使用すると、プロジェクト ID を一覧表示できます。

gcloud config list project

出力:

[core] project = {{{project_0.project_id | "PROJECT_ID"}}} 注: Google Cloud における gcloud ドキュメントの全文については、gcloud CLI の概要ガイドをご覧ください。

プロジェクトのリージョンを設定する

次のコマンドを実行して、プロジェクトのリージョンを設定します。

gcloud config set compute/region {{{project_0.default_region | Region}}}

API が動作する仕組み

API のアーキテクチャ

API（アプリケーション プログラミング インターフェース）は、プログラムが互いに通信できるようにするための一連のメソッドです。効果的に通信を行うためには、データの転送と解釈を定める明確なプロトコルにプログラムが準拠する必要があります。インターネットは、API がプログラム間でリクエストとレスポンスを送信するために使用する標準の通信チャネルです。ウェブベースの API は、クライアント サーバー モデルを基盤となるアーキテクチャとして使用して情報を交換します。クライアントは、コンピューティング リソースやデータをリクエストするコンピューティング デバイスです。サーバーには、データやコンピューティング リソースが保存されており、クライアントのリクエストを解釈して処理します。

HTTP プロトコルとメソッド

API は通信チャネルとしてウェブを使用しているため、その多くは HTTP プロトコルに準拠しています。HTTP プロトコルは、インターネットを介してクライアントとサーバー間で行われるデータ交換のルールとメソッドを定義しています。HTTP プロトコルを利用する API は「HTTP リクエスト メソッド」（「HTTP 動詞」ともいいます）を使用して、クライアント リクエストをサーバーに送信します。最も一般的な HTTP リクエスト メソッドは、GET、POST、PUT、DELETE です。GET はクライアントがサーバーからデータを取得するために使用し、PUT は既存のデータを置き換えるか、データが存在しない場合はデータを作成するために使用します。POST は主に新しいリソースを作成するために使用し、DELETE はクライアントが指定した、サーバー上のデータやリソースを削除します。

エンドポイント

API は HTTP メソッドを使用して、サーバー上でホストされているデータやコンピューティング サービスとやり取りします。特定のリソースに同じようにアクセスする方法がない場合、このメソッドは役に立ちません。そこで、クライアントが単純かつ確実な方法で必要なリソースにアクセスできるよう、API ではエンドポイントという通信チャネルが使用されます。エンドポイントは、サーバー上でホストされているデータやコンピューティング リソースへのアクセス ポイントで、HTTP URI の形式を取ります。特定のリソースまたはリソースのコンテナへのパスを作成するために、API のベース URL に追加されます。また、クエリ文字列をエンドポイントに追加することにより、API のリクエスト処理に必要となる変数を渡すことができます。

REST と RESTful API

HTTP プロトコル、リクエスト メソッド、エンドポイントを利用する API は、RESTful API と呼ばれます。RESTful API はサーバー上に存在し、クライアント リクエストの実施者として機能します。このモデルは、HTTP メソッド（動詞）が作用するエンドポイント（名詞）のフレームワークを定義し、API はこのフレームワークを使用してリクエストを処理します。まとめると、RESTful API はクライアント サーバー モデルを利用し、HTTP プロトコルに準拠し、HTTP リクエスト メソッドを利用し、エンドポイントを利用して特定のリソースにアクセスします。

理解度チェック

以下の選択問題に答え、今回のラボで学習した内容の理解を深めましょう。

タスク 1. API ライブラリの使用

このセクションでは、API ライブラリを探索し、API を有効にします。API ライブラリは、すべての Google API の一元的な場所です。API ライブラリを使用して、プロジェクト全体で API を有効化、無効化、管理できます。

1. ナビゲーション メニューを開き、[API とサービス] > [ライブラリ] を選択します。

API ライブラリには、200 を超える Google API のクイック アクセス、ドキュメント、構成オプションが用意されています。コンソールに格納されてはいますが、ライブラリでは Google Cloud 中心の API だけでなく、すべての Google API にアクセスできることに注目してください。これは重要なポイントです。つまり API はすべての Google サービスの基礎であって、Google API のすべてが Google Cloud のカテゴリに分類されるわけではありません。

では実際に API ライブラリで API を有効化してみましょう。ここではフィットネス サイトのモバイル開発者として、Google Fitness API を使用してアプリケーションをビルドすることを想定します。

2. 「API とサービスを検索」検索バーに「Fitness API」と入力して、Enter キーを押します。
3. 検索結果のリストで、Fitness API をクリックします。続いて [有効にする] をクリックします。

[Fitness API] ページが開きます。API のステータスは [有効] になっています。

API ライブラリには、各項目（チュートリアルとドキュメント、利用規約、API Explorer で利用できるインタラクティブ メソッド）へのリンクがあります。指標と使用状況に関する情報を確認するには、[API とサービス] ダッシュボードを使用します。このページで、割り当ての表示とリクエスト、リソースとデータへのアクセスの制御、指標の表示を行うことができます。

4. これらの機能のうちの 1 つを実際に確認するには、[割り当てとシステム上限] タブを選択します。

5. これにより、この API で 1 日あたりと 1 分あたりに処理できるクエリの数が表示されます。

これで、Cloud 以外の API をプロビジョニングできました。次のセクションでは、API のアーキテクチャと基本機能について学びます。次に、Cloud Storage API の使用を実践します。

理解度チェック

以下の選択問題に答え、今回のラボで学習した内容の理解を深めましょう。

タスク 2. Cloud コンソールで JSON ファイルを作成

これまで学んだことを応用するために、Cloud Shell で Cloud Storage REST/JSON API を呼び出してバケットを作成し、コンテンツをアップロードします。

1. 新しいタブで、Google Cloud Storage JSON API を開き、Cloud Storage API が有効になっているか確認します。API が有効になっていることに注目してください。

2. Cloud Shell で次のコマンドを実行して、values.json というファイルを作成、編集します。

nano values.json

3. 次をコピーして nano テキスト エディタに貼り付けます。バケットには一意のバケット名が必要なため、バケット名にはプロジェクト ID が使用されます。

{ "name": "{{{project_0.project_id | Project_ID}}}-bucket", "location": "us", "storageClass": "multi_regional" } 注: プロジェクト ID はグローバルに一意であるため、バケット名として使用できます。

4. 完了したら、Ctrl+X キー、Y キー、Enter キーを押して nano テキスト エディタを終了します。

Key-Value ペアを 3 つ（name、location、storageClass）持つオブジェクトを含む JSON ファイルを作成しました。これらは、gsutil コマンドライン ツールやコンソールでバケットを作成するときに必要な値と同じです。

Cloud Storage REST/JSON API を使用してバケットを作成する前に、適切な認証と認可のポリシーを用意しておく必要があります。

タスク 3. Cloud Storage JSON/REST API の認証と認可

認証と認可

認証と認可は同じ意味で使用されることがよくありますが、実際にはこれらは同じではありません。

• 「認証」とは、クライアントの身元を判別するためのプロセスです。
• 「認可」とは、認証されたクライアントが一連のリソースに対してどのような権限を持つかを判断するためのプロセスです。

認証とはユーザーを識別するもので、認可とはユーザーが行えることを決定するものです。

Google API が使用する認証 / 認可サービスには、「API キー」、「サービス アカウント」、「OAuth」の 3 種類があります。API は、リクエストするリソースと API の呼び出し元に応じて、これらの認証サービスのいずれかを使用します。

API キー

API キーは、通常は暗号化された文字列の形式で提供されるシークレット トークンで、手軽に生成して使用できます。多くの場合、公開されているデータやメソッドを提供する API は、開発者が手軽に利用できるようユーザー認証に API キーを使用します。

Google Cloud の場合、API キーは API を呼び出す呼び出し元プロジェクトを識別します。これにより、API キーは使用状況の情報をプロジェクトに関連付け、アクセスが許可されていないプロジェクトや API によって有効化されていないプロジェクトからの呼び出しを拒否できます。

OAuth

OAuth トークンは形式が API キーに似ているもののより安全で、ユーザー アカウントや ID にリンクさせることができます。OAuth トークンは主に、API が開発者にユーザーデータにアクセスする手段を提供する場合に使用されます。

API キーは開発者に API のすべての機能へのアクセスを許可しますが、OAuth クライアント ID はすべてスコープに基づき、ID ごとに異なる特権が付与されます。

サービス アカウント

サービス アカウントは、個々のエンドユーザーではなく、アプリケーションや仮想マシン（VM）に属している特別な種類の Google アカウントです。アプリケーションは Google API の呼び出しにサービス アカウントの ID を使用するため、ユーザーは直接関与しません。

サービス アカウントを使用するには、アプリケーションにサービス アカウントの秘密鍵を提供します。アプリケーションが Cloud Functions、Google App Engine、Compute Engine、または Google Kubernetes Engine 上で実行されている場合は、組み込みサービス アカウントを使用できます。

特にサービス アカウントとロールを扱うラボについては、サービス アカウントとロール: 基礎をご覧ください。

Cloud Storage は、ユーザーデータをホストしてアクセスを提供するプラットフォームであり、サービスを使用する前に OAuth トークンを生成する必要があります。

1. 新しいタブで OAuth 2.0 Playground を開きます。このサービスを使用すると、OAuth トークンを簡単に生成できます。

2. 下にスクロールして、[Cloud Storage API v1] を選択します。

3. 次に [https://www.googleapis.com/auth/devstorage.full_control] スコープを選択します。

4. [Authorize APIs] という青いボックスをクリックすると、Google ログインページが開きます。

5. ユーザー名を選択し、権限を求められたら [Allow] をクリックします。

OAuth 2.0 Playground が開きます。[Step 2] に認証コードが生成されていることを確認します。

6. [Exchange authorization code for tokens] をクリックします。ステップ 3 に移動した場合は、ステップ 2 のパネルをクリックします。

7. アクセス トークンをコピーして、次のステップで使用します。

タスク 4. Cloud Storage JSON/REST API でバケットを作成

1. Cloud Shell セッションに戻ります。CLI プロンプトで「ls」と入力し、Enter キーを押します。先ほど作成した values.json ファイルと、README-cloudshell.txt ファイルが表示されます。

出力:

README-cloudshell.txt values.json

2. 次のコマンドを実行して OAuth2 トークンを環境変数として設定します。<YOUR_TOKEN> は生成したアクセス トークンに置き換えます。

export OAUTH2_TOKEN=<YOUR_TOKEN>

3. 次のコマンドを実行して、プロジェクト ID を環境変数として設定します。

export PROJECT_ID=$(gcloud config get-value project)

4. 次のコマンドを実行して Cloud Storage バケットを作成します。

curl -X POST --data-binary @values.json \ -H "Authorization: Bearer $OAUTH2_TOKEN" \ -H "Content-Type: application/json" \ "https://www.googleapis.com/storage/v1/b?project=$PROJECT_ID"

5. 次のような出力が返されます。

{ "kind": "storage#bucket", "selfLink": "https://www.googleapis.com/storage/v1/b/qwiklabs-gcp-02-5d551758b5a7", "id": "qwiklabs-gcp-02-5d551758b5a7", "name": "qwiklabs-gcp-02-5d551758b5a7", "projectNumber": "670840659006", "metageneration": "1", "location": "US", "storageClass": "MULTI_REGIONAL", "etag": "CAE=", "timeCreated": "2020-11-11T06:41:40.901Z", "updated": "2020-11-11T06:41:40.901Z", "iamConfiguration": { "bucketPolicyOnly": { "enabled": false }, "uniformBucketLevelAccess": { "enabled": false } }, "locationType": "multi-region" } 注: 「Use of this bucket name is restricted」や「Sorry, that name is not available」といったエラー メッセージが表示された場合、名前がバケットの命名規則に矛盾しています。values.json ファイルを編集して、バケット名を変更してください。

このリクエストは、これまで学んできたことの集大成です。curl CLI ツールを使用して HTTP POST メソッドをリクエストし、values.json ファイルをリクエスト本文に渡しました。また、OAuth トークンと JSON 仕様をリクエスト ヘッダーとして渡しました。このリクエストは、Cloud Storage エンドポイントにルーティングされました。このエンドポイントには、プロジェクト ID が設定されたクエリ文字列パラメータが含まれています。

新規作成した Cloud Storage バケットを表示する

• 新しく作成したバケットを確認するには、ナビゲーション メニューから [Cloud Storage] > [バケット] を選択します。

完了したタスクをテストする

[進行状況を確認] をクリックして、実行したタスクを確認します。Cloud Storage JSON/REST API でバケットが正常に作成されている場合は、評価スコアが更新されます。

Cloud Storage JSON/REST API でバケットを作成する

タスク 5. Cloud Storage JSON/REST API を使用してファイルをアップロード

Cloud Storage JSON/REST API を使用してバケットにファイルをアップロードすることもできます。

1. 次の画像をパソコンに保存し、demo-image.png という名前を付けます。

2. Cloud Shell セッションで、右上のその他メニューのアイコンをクリックします。[アップロード] > [ファイル選択] をクリックします。demo-image.png ファイルを選択してアップロードします。画像がディレクトリに追加されます。

3. 次のコマンドを実行して画像ファイルへのパスを取得します。

realpath demo-image.png

次のような出力が返されます。

/home/gcpstaging25084_student/demo-image.png

4. 次のコマンドを実行してファイルパスを環境変数として設定します。<DEMO_IMAGE_PATH> は前述のコマンドの出力に置き換えます。

export OBJECT=<DEMO_IMAGE_PATH>

5. 次のコマンドを実行してバケット名を環境変数として設定します。

export BUCKET_NAME={{{project_0.project_id | Project_ID}}}-bucket

6. 次のコマンドを実行して、デモ画像を Cloud Storage バケットにアップロードします。

curl -X POST --data-binary @$OBJECT \ -H "Authorization: Bearer $OAUTH2_TOKEN" \ -H "Content-Type: image/png" \ "https://www.googleapis.com/upload/storage/v1/b/$BUCKET_NAME/o?uploadType=media&name=demo-image"

次のような出力が返されます。

{ "kind": "storage#object", "id": "qwiklabs-gcp-02-5d551758b5a7/demo-image/1605077118178936", "selfLink": "https://www.googleapis.com/storage/v1/b/qwiklabs-gcp-02-5d551758b5a7/o/demo-image", "mediaLink": "https://www.googleapis.com/download/storage/v1/b/qwiklabs-gcp-02-5d551758b5a7/o/demo-image?generation=1605077118178936&alt=media", "name": "demo-image", "bucket": "qwiklabs-gcp-02-5d551758b5a7", "generation": "1605077118178936", "metageneration": "1", "contentType": "image/png", "storageClass": "MULTI_REGIONAL", "size": "401951", "md5Hash": "LbpHpwhnApQKQx9IEXjTsQ==", "crc32c": "j5oPrg==", "etag": "CPis3Zvy+ewCEAE=", "timeCreated": "2020-11-11T06:45:18.178Z", "updated": "2020-11-11T06:45:18.178Z", "timeStorageClassUpdated": "2020-11-11T06:45:18.178Z" }

7. バケットに追加した画像を表示するには、ナビゲーション メニューを開いて [Cloud Storage] > [バケット] を選択します。

8. バケット名をクリックすると、demo-image が追加されていることがわかります。

9. 画像名をクリックして、[オブジェクトの詳細] ページを開きます。

完了したタスクをテストする

[進行状況を確認] をクリックして、実行したタスクを確認します。Cloud Storage JSON/REST API を使用してファイルが正常にアップロードされている場合は、評価スコアが更新されます。

Cloud Storage JSON/REST API を使用してファイルをアップロードする

お疲れさまでした

このラボでは、API について理解を深め、Cloud Storage JSON/REST API を使用した演習を行いました。また、Cloud API、API アーキテクチャ、HTTP プロトコルとメソッド、エンドポイント、RESTful API、JSON、API 認証の方法について学びました。これで、Qwiklabs の他の API ラボを受講する準備が整いました。

次のステップと詳細情報

次のラボを確認し、API の他の演習も行ってください。

• API Explorer: Qwik Start
• Cloud Natural Language API: Qwik Start

Google Cloud トレーニングと認定資格

Google Cloud トレーニングと認定資格を通して、Google Cloud 技術を最大限に活用できるようになります。必要な技術スキルとベスト プラクティスについて取り扱うクラスでは、学習を継続的に進めることができます。トレーニングは基礎レベルから上級レベルまであり、オンデマンド、ライブ、バーチャル参加など、多忙なスケジュールにも対応できるオプションが用意されています。認定資格を取得することで、Google Cloud テクノロジーに関するスキルと知識を証明できます。

マニュアルの最終更新日: 2024 年 2 月 26 日

ラボの最終テスト日: 2024 年 2 月 26 日

Copyright 2025 Google LLC. All rights reserved. Google および Google のロゴは Google LLC の商標です。その他すべての企業名および商品名はそれぞれ各社の商標または登録商標です。