概要

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

要件

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

前提条件

ライブラリをインストールする前に、開発者トークンと クライアントのお客様 ID です。取得方法については、 前提条件セクションを参照してください。 必要な他の OAuth2 トークンは、後のステップで生成します。

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

Python クライアント ライブラリは、Python Software Foundation が公開しているサポート対象バージョンのセクションの Python ランタイムとの互換性を維持しています(ただし、ステータスが「機能」または「プレリリース」のバージョンを除きます)。

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

サポート終了(EOL)に達した Python ランタイムは、python.orgサポート対象外バージョンのセクションに記載されているサポート終了日以降はサポートされません。

Google がリリースする Python クライアント ライブラリのバージョンは、 EOL に達した時点でサポートされない Python ランタイムを解放する必要があります。

依存関係については(具体的には、Google 管理下にある、Compute Engine インスタンスで 必須として記載 使用している場合)は、今後追加されるパッケージと Google によって管理され、「サポート対象」と見なされますGoogle の OSS 互換性を破る変更ポリシー

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

インストール

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

構成

ライブラリをインストールしたら、 できます。ライブラリを設定する方法は複数あります。詳しくは、 構成のドキュメントをご覧ください。

認証

構成タイプを選択したら、構成タイプを API へのリクエストを行うのに必要な残りの OAuth2 トークン。複数の サポートされている OAuth2 フロー(以下のリストを参照)。詳細については、 フローの違いを確認し、どちらのフローが OAuth ドキュメントをご覧ください。

API リクエストの実行

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

get_campaigns.py サンプルを実行するには、ローカルのアプリケーションのルート ディレクトリで、 googleads-python クライアント ライブラリがインストールされている場合は、次のコマンドを実行します。

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

参考情報

API リクエストの送信が完了したら、クライアントの使用に進みます。 ライブラリ: