インストール

PyPI からライブラリをインストールするか、GitHub からクローンを作成するかにかかわらず、アクティブな仮想環境を使用して以下の手順を行うことをおすすめします。仮想環境を作成して有効にする方法については、仮想環境のドキュメントをご覧ください。

PyPI からモジュールをインストールする

このライブラリは PyPI で配布されており、pip を使用して次のコマンドでインストールできます。

python -m pip install google-ads

GitHub からライブラリをインストールする

ライブラリのソースコードは、GitHub からローカルマシンにクローンを作成できます。サンプルを簡単に実行したり、ライブラリ自体を開発したりするために、ソースコードのクローンを作成すると便利です。参考までに、いずれかの認証例を実行することは、ライブラリを使用できるように構成する際に必要な手順です。

  1. 環境に python3.8 以降が存在することを確認します。最も簡単な方法は、pyenv を使用する方法です。

    pyenv local 3.8
    
  2. GitHub からクライアント ライブラリのクローンを作成します。

    git clone git@github.com:googleads/google-ads-python.git
    
  3. リポジトリを入力してインストールします。

    cd google-ads-python
    python -m pip install .
    
  4. ライブラリを開発する場合は、変更の前後に単体テストを実行します。

    1. ご使用の環境で、サポートされているすべてのバージョンの Python 言語が使用可能であることを確認します。pyenv を使用する場合:

      pyenv local 3.8 3.9 3.10 3.11 3.12
      
    2. ライブラリのテスト固有の依存関係をインストールします。

      python -m pip install .[tests]
      
    3. 単体テストを実行して、ライブラリが正常に機能していることを確認します。

      nox
      
    4. 省略可: 単体テストは、Docker を使用して実行することもできます。まず、Docker をインストールする必要があります。次に、google-ads-python ディレクトリから次のコマンドを実行します。

      docker build -t google-ads-python:test .
      docker run -it google-ads-python:test nox