概要

Python クライアント ライブラリは GitHub でホストされ、パッケージは PyPI で入手できます。

要件

このライブラリには Python 3.8 以降が必要です。

前提条件

ライブラリをインストールする前に、デベロッパー トークンとクライアント顧客 ID が必要になります。取得方法については、前提条件のセクションをご覧ください。他の必要な OAuth2 トークンは、後の手順で生成します。

ランタイムと依存関係の互換性

Python クライアント ライブラリは、Python Software Foundation が公開しているサポートされているバージョンの Python ランタイムとの互換性を維持します。ただし、ステータスが「feature」または「prerelease」のバージョンは除きます。

新しいバージョンの Python ランタイムを採用する際は、リリース後の四半期末までに、最新のランタイムと互換性のある新しいバージョンの Python クライアント ライブラリをリリースすることを目指しています。たとえば、10 月に新しいランタイムがリリースされた場合、互換性のあるバージョンの Python クライアント ライブラリは、翌年の 3 月末までに利用可能になります。

サポート終了（EOL）に達した Python ランタイムは、python.org のサポートされていないバージョン セクションに記載されているサポート終了日を過ぎるとサポートされません。

EOL に達した後は、サポートされていない Python ランタイムと互換性のないバージョンの Python クライアント ライブラリをいつでもリリースする可能性があります。

依存関係（特に、Python クライアント ライブラリで必須としてリストされている Google が管理するパッケージ）については、Google が管理し、Google の OSS 破壊的変更ポリシーに従って「サポート対象」と見なされるパッケージとの互換性を維持します。

サポートされている Python ランタイムと依存関係の完全なリストについては、依存関係のページをご覧ください。

インストール

インストールのドキュメントの手順に沿って、PyPi からライブラリをインストールし、このページに戻ります。

構成

ライブラリをインストールしたら、ライブラリの構成を設定する必要があります。ライブラリを構成する方法は複数あり、構成に関するドキュメントで説明しています。

認証

構成タイプを選択したら、API にリクエストを行うために必要な残りの OAuth2 トークンを生成します。サポートされている OAuth2 フローは複数あり、以下のリストに記載されています。フローの違いと、アプリケーションに最適なフローの選択については、OAuth のドキュメントをご覧ください。

API リクエストの作成

OAuth2 トークンを構成に組み込んだら、API リクエストを行う準備が整います。ライブラリが API リクエストを行うように正しく構成されていることをテストする簡単な方法については、キャンペーンの取得の例をご覧ください。

get_campaigns.py サンプルを実行するには、ローカルにインストールした googleads-python クライアント ライブラリのルート ディレクトリで、次のコマンドを実行します。

$ python examples/basic_operations/get_campaigns.py -c \
  INSERT_YOUR_CUSTOMER_ID_HERE

参考情報

API リクエストを行えるようになったら、クライアント ライブラリの次の使用に進みます。