このページは Cloud Translation API によって翻訳されました。

基本的な「Google 翻訳」をデプロイするPython 3 上の Cloud Functions のアプリ

1. 概要

この一連の Codelab（ご自分のペースで進められる実践型のチュートリアル）は、デベロッパーがアプリケーションのデプロイ時に利用できるさまざまなオプションを理解できるよう支援することを目的としています。この Codelab では、Python で Google Cloud Translation API を使用して、ローカルで実行するか、Cloud サーバーレスコンピューティングプラットフォーム（App Engine、Cloud Functions、Cloud Run）にデプロイする方法を学習します。このチュートリアルのリポジトリにあるサンプルアプリは、構成を少し変更するだけで、（少なくとも）8 通りの方法でデプロイできます。

ローカル Flask サーバー（Python 2）
ローカル Flask サーバー（Python 3）
App Engine（Python 2）
App Engine（Python 3）
Cloud Functions（Python 3）
Cloud Run（Docker 経由の Python 2）
Cloud Run（Docker 経由の Python 3）
Cloud Run（Cloud Buildpack を介した Python 3）

この Codelab では、上記の太字のプラットフォームにこのアプリをデプロイすることに焦点を当てます。

方法を学ぶ対象

Google Cloud APIs、特に Cloud Translation API（Advanced/v3）を使用する
基本的なウェブアプリケーションをローカルで実行するか、Cloud サーバーレスコンピューティングプラットフォームにデプロイする

必要なもの

有効な Cloud 請求先アカウントを持つ Google Cloud プロジェクト
ローカル実行用にインストールされた Flask、またはクラウドベースのデプロイ用に有効になっている Cloud サーバーレスコンピューティングプラットフォーム
基本的な Python スキル
基本的なオペレーティングシステムコマンドに関する実践的な知識

アンケート

このチュートリアルの利用方法をお選びください。

通読して演習を行う

通読のみ

Python のご利用経験はどの程度ありますか？

初心者

中級者

上級者

Google Cloud サービスの使用経験はどの程度ありますか？

初心者

中級者

上級者

2. 設定と要件

セルフペース型の環境設定

Google Cloud Console にログインして、プロジェクトを新規作成するか、既存のプロジェクトを再利用します。Gmail アカウントも Google Workspace アカウントもまだお持ちでない場合は、アカウントを作成してください。

プロジェクト名は、このプロジェクトの参加者に表示される名称です。Google API では使用されない文字列で、いつでも更新できます。
プロジェクト ID は、すべての Google Cloud プロジェクトにおいて一意でなければならず、不変です（設定後は変更できません）。Cloud Console により一意の文字列が自動生成されます（通常は内容を意識する必要はありません）。ほとんどの Codelab では、プロジェクト ID を参照する必要があります（通常、プロジェクト ID は「PROJECT_ID」の形式です）。好みの文字列でない場合は、別のランダムな ID を生成するか、独自の ID を試用して利用可能であるかどうかを確認することができます。プロジェクトの作成後、ID は「フリーズ」されます。
3 つ目の値として、一部の API が使用するプロジェクト番号があります。これら 3 つの値について詳しくは、こちらのドキュメントをご覧ください。

次に、Cloud のリソースや API を使用するために、Cloud Console で課金を有効にする必要があります。この Codelab の操作をすべて行って、費用が生じたとしても、少額です。このチュートリアルを終了した後に課金が発生しないようにリソースをシャットダウンするには、Codelab の最後にある「クリーンアップ」の手順を行います。Google Cloud の新規ユーザーは、300 米ドル分の無料トライアルプログラムをご利用いただけます。

3. Translation API を有効にする

このセクションでは、Google API を一般に有効にする方法について説明します。サンプルアプリでは、Cloud Translation API と Cloud Functions サービスを有効にします。

はじめに

アプリケーションで使用する Google API に関係なく、API は有効にする必要があります。次の例は、Cloud Vision API を有効にする 2 つの方法を示しています。1 つの Cloud API を有効にする方法を学んだら、他の API も有効にできます。手順は同じです。

オプション 1: Cloud Shell またはコマンドラインインターフェースから

Cloud コンソールから API を有効にするのが一般的ですが、コマンドラインからすべてを行うことを好むデベロッパーもいます。これを行うには、API の「サービス名」を調べる必要があります。URL のように見えます（SERVICE_NAME.googleapis.com）。サポートされているプロダクトについては、サポートされているプロダクトの表をご覧ください。また、Google Discovery API を使用してプログラムでクエリすることもできます。

この情報を確認したら、Cloud Shell（または gcloud コマンドラインツールがインストールされているローカル開発環境）を使用して、次のように API を有効にします。

gcloud services enable SERVICE_NAME.googleapis.com

たとえば、次のコマンドは Cloud Vision API を有効にします。

gcloud services enable vision.googleapis.com

このコマンドで App Engine が有効になります。

gcloud services enable appengine.googleapis.com

1 つのリクエストで複数の API を有効にすることもできます。たとえば、次のコマンドラインでは、Cloud Run、Cloud Artifact Registry、Cloud Translation API が有効になります。

gcloud services enable artifactregistry.googleapis.com run.googleapis.com translate.googleapis.com

オプション 2: Cloud コンソールから

API Manager で Vision API を有効にすることもできます。Cloud コンソールから API Manager に移動し、[ライブラリ] を選択します。

Cloud Vision API を有効にするには、検索バーに「vision」と入力します。入力した内容に一致する項目がすべて表示されます。

有効にする API を選択し、[有効にする] をクリックします。

費用

多くの Google API は無料でご利用いただけますが、Google Cloud のプロダクトと API の使用は無料ではありません。Cloud APIs を有効にすると、有効な請求先アカウントの入力を求められる場合があります。ただし、一部の Google Cloud プロダクトには、超過した場合のみに料金が発生する Always Free 枠（1 日または 1 か月）が用意されています。この枠を超えないと、クレジットカード（または指定されたお支払い方法）に請求は発生しません。

有効にする前に、API の料金情報を確認してください。特に、無料の利用枠があるかどうか、ある場合はその内容を確認してください。Cloud Vision API を有効にする場合は、料金情報ページを確認します。Cloud Vision には無料の割り当てがあります。使用量の合計が上限（月ごと）を超えない限り、料金は発生しません。

料金と無料の階層は Google API によって異なります。例:

Google Cloud/GCP - 各プロダクトの課金方法は異なり、通常は vCPU サイクル、ストレージコンシューマ、メモリ使用量、従量制のいずれかになります。上記の無料 tier の情報をご覧ください。
Google マップ - 一連の API を備えており、ユーザーは毎月 $200 分の無料クレジットを利用できます。
Google Workspace（旧 G Suite）API - Workspace の月額サブスクリプション料金でカバーされるため、Gmail、Google ドライブ、カレンダー、ドキュメント、スプレッドシート、スライドの API などの使用に伴う直接的な料金が発生することはありません。

Google プロダクトごとに課金方法が異なるため、API ドキュメントで該当する情報を確認してください

概要

Google API の一般的な有効化方法を理解できたところで、API マネージャーに移動し、Cloud Translation API と Cloud Functions サービスの両方を有効にします（まだ有効になっていない場合）。後者はアプリケーションで使用するため、前者は Cloud Functions をデプロイするためです。コマンドラインから行う場合は、代わりに次のコマンドを使用します。

gcloud services enable cloudfunctions.googleapis.com translate.googleapis.com

月間割り当ては [Always Free] の概要ページには記載されていませんが、Translation API の料金ページには、すべてのユーザーが毎月一定量の翻訳文字数を取得できると記載されています。このしきい値を下回っている場合、API からの請求は発生しません。Google Cloud に関連するその他の料金がある場合は、最後に「クリーンアップ」セクションで説明します。

4. サンプルアプリのコードを取得する

ローカルまたは Cloud Shell（git clone コマンドを使用）でリポジトリのコードクローンを作成するか、次のスクリーンショットに示すように、緑色の [Code] ボタンから ZIP ファイルをダウンロードします。

これで準備は完了です。このチュートリアルではファイルの削除や変更を行う可能性があるため、このチュートリアル用にフォルダの完全なコピーを作成します。別のデプロイを行う場合は、元のものをコピーして最初からやり直すことができます。これにより、クローンを作成したりダウンロードしたりする必要がなくなります。

5. サンプルアプリの概要

このサンプルアプリは、ユーザーに英語のテキストを入力して、そのテキストのスペイン語の翻訳を受け取るよう求める、シンプルな Google 翻訳派生アプリです。main.py ファイルを開いて、仕組みを確認しましょう。ライセンスに関するコメント付きの行を除くと、上部と下部は次のようになります。

from flask import Flask, render_template, request
import google.auth
from google.cloud import translate

app = Flask(__name__)
_, PROJECT_ID = google.auth.default()
TRANSLATE = translate.TranslationServiceClient()
PARENT = 'projects/{}'.format(PROJECT_ID)
SOURCE, TARGET = ('en', 'English'), ('es', 'Spanish')

# . . . [translate() function definition] . . .

if __name__ == '__main__':
    import os
    app.run(debug=True, threaded=True, host='0.0.0.0',
            port=int(os.environ.get('PORT', 8080)))

インポートにより、Flask の機能、google.auth モジュール、Cloud Translation API クライアントライブラリが導入されます。
グローバル変数は、Flask アプリ、Cloud プロジェクト ID、Translation API クライアント、Translation API 呼び出しの親「ロケーションパス」、ソース言語とターゲット言語を表します。この場合は英語（en）とスペイン語（es）ですが、これらの値は Cloud Translation API でサポートされている他の言語コードに変更できます。
下部にある大きな if ブロックは、このアプリをローカルで実行するチュートリアルで使用されます。このブロックは、Flask 開発用サーバーを使用してアプリを提供します。このセクションは、ウェブサーバーがコンテナにバンドルされていない場合に備えて、Cloud Run のデプロイのチュートリアルでも使用されます。コンテナ内でサーバーのバンドルを有効にするよう求められますが、この手順を忘れた場合、アプリコードは Flask 開発環境サーバーを使用するようにフォールバックします。（App Engine や Cloud Functions では問題になりません。これらのプラットフォームはソースベースのプラットフォームであるため、Google Cloud がデフォルトのウェブサーバーを用意して実行します）。

最後に、main.py の中央に、アプリケーションの核となる translate() 関数があります。

@app.route('/', methods=['GET', 'POST'])
def translate(gcf_request=None):
    """
    main handler - show form and possibly previous translation
    """

    # Flask Request object passed in for Cloud Functions
    # (use gcf_request for GCF but flask.request otherwise)
    local_request = gcf_request if gcf_request else request

    # reset all variables (GET)
    text = translated = None

    # if there is data to process (POST)
    if local_request.method == 'POST':
        text = local_request.form['text']
        data = {
            'contents': [text],
            'parent': PARENT,
            'target_language_code': TARGET[0],
        }
        # handle older call for backwards-compatibility
        try:
            rsp = TRANSLATE.translate_text(request=data)
        except TypeError:
            rsp = TRANSLATE.translate_text(**data)
        translated = rsp.translations[0].translated_text

    # create context & render template
    context = {
        'orig':  {'text': text, 'lc': SOURCE},
        'trans': {'text': translated, 'lc': TARGET},
    }
    return render_template('index.html', **context)

メインの関数は、ユーザー入力を受け取り、Translation API を呼び出して処理を行います。詳しく見ていきましょう。

local_request 変数を使用して、リクエストが Cloud Functions から送信されているかどうかを確認します。Cloud Functions は独自の Flask リクエストオブジェクトを送信しますが、他のすべての場合（ローカルで実行する場合や、App Engine または Cloud Run にデプロイする場合）は、Flask からリクエストオブジェクトを直接取得します。
フォームの基本変数をリセットします。これは主に GET リクエストを対象としています。POST リクエストには、これらの値に代わるデータが含まれます。
POST の場合は、翻訳するテキストを取得し、API メタデータ要件を表す JSON 構造を作成します。次に、API を呼び出し、ユーザーが古いライブラリを使用している場合は、以前のバージョンの API にフォールバックします。
いずれの場合も、実際の結果（POST）またはデータなし（GET）をテンプレートコンテキストにフォーマットしてレンダリングします。

アプリケーションのビジュアル部分は、テンプレート index.html ファイルにあります。以前に翻訳された結果（空白の場合）が表示され、その後に翻訳対象のフォームが表示されます。

<!doctype html>
<html><head><title>My Google Translate 1990s</title><body>
<h2>My Google Translate (1990s edition)</h2>

{% if trans['text'] %}
    <h4>Previous translation</h4>
    <li><b>Original</b>:   {{ orig['text'] }}  (<i>{{ orig['lc'][0] }}</i>)</li>
    <li><b>Translated</b>: {{ trans['text'] }} (<i>{{ trans['lc'][0] }}</i>)</li>
{% endif %}

<h4>Enter <i>{{ orig['lc'][1] }}</i> text to translate to <i>{{ trans['lc'][1] }}</i>:</h4>
<form method="POST"><input name="text"><input type="submit"></form>
</body></html>

6. サービスをデプロイします。

変換サービスを（Python 3）Cloud Functions にデプロイするには、次のコマンドを実行します。

gcloud functions deploy translate --runtime python37 --trigger-http --allow-unauthenticated

出力は次のようになります。また、次のステップに関するプロンプトも表示されます。

$ gcloud functions deploy translate --runtime python37 --trigger-http --allow-unauthenticated
Deploying function (may take a while - up to 2 minutes)...⠹
For Cloud Build Stackdriver Logs, visit: https://console.cloud.google.com/logs/viewer?project=PROJECT_ID&advancedFilter=resource.type%3Dbuild%0Aresource.labels.build_id%3D7e32429d-ec36-422c-8a8b-43c4d661a15c%0AlogName%3Dprojects%2FPROJECT_ID%2Flogs%2Fcloudbuild
Deploying function (may take a while - up to 2 minutes)...done.
availableMemoryMb: 256
buildId: 7e32429d-ec36-422c-8a8b-43c4d661a15
entryPoint: translate
httpsTrigger:
  securityLevel: SECURE_OPTIONAL
  url: https://REGION-PROJECT_ID.cloudfunctions.net/translate
ingressSettings: ALLOW_ALL
labels:
  deployment-tool: cli-gcloud
name: projects/PROJECT_ID/locations/REGION/functions/translate
runtime: python37
serviceAccountEmail: PROJECT_ID@appspot.gserviceaccount.com
sourceUploadUrl: https://storage.googleapis.com/gcf-upload-REGION-873f8448-838f-4eb2-beda-3e200a1420d/cb1cbdca-34eb-41d0-88d6-c276d5205fb.zip?GoogleAccessId=service-104690130103@gcf-admin-robot.iam.gserviceaccount.com&Expires=1619139674
status: ACTIVE
timeout: 60s
updateTime: '2021-04-23T00:32:58.065Z'
versionId: '3'

これで、アプリは世界中で利用可能になりました。デプロイの出力に表示されているように、プロジェクト ID を含む URL でアプリにアクセスできるはずです。URL は https://REGION-PROJECT_ID.cloudfunctions.net/translate のようになります。これは、選択したリージョンと Cloud プロジェクト ID によって異なります。

何か翻訳して、その仕組みをご確認ください。

7. まとめ

これで、Cloud Translation API を有効にして必要な認証情報を取得し、シンプルなウェブアプリを Cloud Functions にデプロイする方法について学習しました。このデプロイの詳細については、リポジトリのこの表をご覧ください。

クリーンアップ

Cloud Translation API では、一定数の翻訳文字を毎月無料で実行できます。App Engine には無料の割り当てもあります。これは、Cloud Functions や Cloud Run にも当てはまります。いずれかの上限を超えると、料金が発生します。次の Codelab に進む場合は、アプリをシャットダウンする必要はありません。

次のチュートリアルに進む準備がまだ完了していない場合や、デプロイしたばかりのアプリがインターネットで検出されることについて懸念がある場合は、App Engine アプリを無効にする、Cloud Functions を削除する、Cloud Run サービスを無効にすることで、課金されないようにしてください。次の Codelab に進む準備ができた時点で、再度有効にできます。ただし、このアプリケーションや他の Codelab を続行せず、すべてを完全に削除する場合は、プロジェクトをシャットダウンしてください。

また、Google Cloud サーバーレスコンピューティングプラットフォームにデプロイすると、ビルドとストレージの費用が少額かかります。Cloud Build には、Cloud Storage と同様に独自の無料の割り当て枠があります。透明性を高めるために、Cloud Build はアプリケーションイメージをビルドし、Cloud Container Registry またはその後継である Artifact Registry に保存します。そのイメージのストレージは、そのイメージをサービスに転送する際の下り（外向き）ネットワークと同様に、割り当ての一部を使用します。ただし、お住まいの地域でこのような無料枠が提供されていない場合があります。ストレージの使用量に注意して、発生する費用を最小限に抑えてください。

8. 参考情報

以降のセクションでは、このチュートリアルで学んだ知識を補完するための追加の参考資料と推奨される演習について説明します。

追加の調査

Translation API の使用方法を理解できたので、さらにスキルを磨くために、いくつかの演習を行いましょう。学習パスを続行するには、サンプルアプリを変更して次の操作を行います。

ローカルで実行するか、Google Cloud サーバーレスコンピューティングプラットフォームにデプロイするには、この Codelab の他のエディションをすべて完了してください（repo README をご覧ください）。
別のプログラミング言語を使用して、このチュートリアルを完了します。
別の原文の言語または訳文の言語をサポートするように、このアプリを変更します。
このアプリケーションをアップグレードして、テキストを複数の言語に翻訳できるようにします。テンプレートファイルを変更して、サポートされているターゲット言語のプルダウンを表示します。

詳細

Google Apps Engine

Google Cloud Functions

Google Cloud Run

Google Cloud Buildpacks、Container Registry、Artifact Registry

Google Cloud Translation と Google ML Kit

その他の Google Cloud プロダクト/ページ

Python と Flask

Flask

ライセンス

このチュートリアルはクリエイティブコモンズ表示 2.0 汎用ライセンスに基づいて使用許諾されていますが、リポジトリ内のソースコードは Apache 2 に基づいて使用許諾されています。