概要

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

要件

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

前提条件

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

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

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

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

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

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

依存関係(特に、Python クライアント ライブラリによって必須としてリストされている Google が管理するパッケージ)については、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 リクエストの送信が完了したら、次のクライアント ライブラリの使用に進みます。