構成

Google Ads API クライアント ライブラリには、ライブラリの動作をカスタマイズするための設定がいくつかあります。

App.config を使用した構成

Google Ads API 固有の設定はすべて、App.config ファイルの GoogleAdsApi ノードに保存されます。一般的な構成 App.config は次のとおりです。

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="GoogleAdsApi" type="System.Configuration.DictionarySectionHandler" />
  </configSections>
  <GoogleAdsApi>
    <!-- Set the service timeout in milliseconds. -->
    <add key="Timeout" value="2000" />

    <!-- Proxy settings for library. -->
    <add key="ProxyServer" value="http://localhost:8888"/>
    <add key="ProxyUser" value=""/>
    <add key="ProxyPassword" value=""/>
    <add key="ProxyDomain" value=""/>

    <!-- API-specific settings -->
    <add key="DeveloperToken" value="******"/>

    <!-- OAuth2 settings -->
    <add key = "OAuth2Mode" value="APPLICATION"/>
    <add key = "OAuth2ClientId" value = "******.apps.googleusercontent.com" />
    <add key = "OAuth2ClientSecret" value = "******" />
    <add key = "OAuth2RefreshToken" value = "******" />
  </GoogleAdsApi>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2" />
  </startup>
</configuration>

個別の App.config ファイルを指定する

App.config を整理したくない場合は、configSource プロパティを使用して、ライブラリ固有の設定を独自の構成ファイルに移動できます。

ステップ 1: App.config で configSource を指定する

App.config を次のように変更します。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="GoogleAdsApi" type="System.Configuration.DictionarySectionHandler"/>
  </configSections>
  <GoogleAdsApi configSource="GoogleAdsApi.config"/>
…
</configuration>

ステップ 2: 構成ファイルの内容を指定する

次に、configSource で指定した名前で別の構成ファイルを作成し、App.config からこのファイルに構成ノードを移動します。

<?xml version="1.0" encoding="utf-8" ?>
<GoogleAdsApi>
  … More settings.
</GoogleAdsApi>

ステップ 3: csproj のビルドルールを修正する

最後に、新しい構成ファイルをプロジェクトに追加します。このファイルのプロパティを [Always copy to output folder] に変更します。

次に、プロジェクトをビルドして実行します。アプリケーションが新しい構成ファイルから値の取得を開始します。

カスタム JSON ファイルを使用した構成

IConfigurationRoot インスタンスを使用してクライアント ライブラリを構成できます。

JSON ファイルを作成する

App.config ファイルと同様の構造の GoogleAdsApi.json ファイルを作成します。

{
    "Timeout": "2000",

    "ProxyServer": "http://localhost:8888",
    "ProxyUser": "",
    "ProxyPassword": "",
    "ProxyDomain": "",

    "DeveloperToken": "******",

    "OAuth2Mode": "APPLICATION",
    "OAuth2ClientId": "******.apps.googleusercontent.com",
    "OAuth2ClientSecret": "******",
    "OAuth2RefreshToken": "******",
}

構成を読み込む

次に、JSON ファイルを IConfigurationRoot に読み込みます。

ConfigurationBuilder builder = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("GoogleAdsApi.json");
IConfigurationRoot configRoot = builder.Build();

GoogleAdsConfig config = new GoogleAdsConfig(configRoot);
GoogleAdsClient client = new GoogleAdsClient(config);

settings.json の使用

このプロセスはカスタム JSON を使用する場合と同様ですが、キーが GoogleAdsApi という名前のセクションにある点が異なります。

{
    "GoogleAdsApi":
    {
        "DeveloperToken": "******",
        "OAuth2Mode": "APPLICATION",
        "OAuth2ClientId": "******.apps.googleusercontent.com",
        "OAuth2ClientSecret": "******",
        "OAuth2RefreshToken": "******",
        ...
    }
    // More settings...
}

次に、ページ内で IConfiguration インスタンスを使用します。

IConfigurationSection section = Configuration.GetSection("GoogleAdsApi");
GoogleAdsConfig config = new GoogleAdsConfig(section);
GoogleAdsClient client = new GoogleAdsClient(config);

実行時のライブラリの構成

実行時に GoogleAdsClient を初期化することもできます。

例 1: 実行時に構成を初期化する

GoogleAdsConfig config = new GoogleAdsConfig()
{
    DeveloperToken = "******",
    OAuth2Mode = "APPLICATION",
    OAuth2ClientId = "******.apps.googleusercontent.com",
    OAuth2ClientSecret = "******",
    OAuth2RefreshToken = "******"
};

GoogleAdsClient client = new GoogleAdsClient(config);

例 2: App.config から読み込むが、設定をオーバーライドする

GoogleAdsClient client = new GoogleAdsClient(config);
client.Config.DeveloperToken = "******";

環境変数を使用してライブラリを構成する

環境変数を使用して GoogleAdsClient を初期化することもできます。これらの設定は自動的に取得されないため、次に示すように、環境変数から設定を読み込む必要があります。

GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromEnvironmentVariables();
GoogleAdsClient client = new GoogleAdsClient(config);

サポートされている環境変数の一覧については、こちらをご覧ください。

設定に関する項目

Google 広告 .NET ライブラリでサポートされる設定は次のとおりです。

接続設定

  • Timeout: このキーを使用して、サービスのタイムアウトをミリ秒単位で設定します。デフォルト値は、googleads_grpc_service_config.jsonmethod_config/timeout の設定に基づいて設定されます。API 呼び出しの最大時間をより短く制限する必要がある場合は、値を小さくします。タイムアウトは 2 時間以上に設定できますが、API では長時間実行されるリクエストがタイムアウトし、DEADLINE_EXCEEDED エラーが返されることがあります。
  • ProxyServer: プロキシを使用してインターネットに接続している場合は、HTTP プロキシ サーバーの URL に設定します。
  • ProxyUser: プロキシ サーバーに対する認証に必要なユーザー名に設定します。ユーザー名が必要ない場合は、空白のままにしてください。
  • ProxyPassword: ProxyUser に値を設定する場合、これを ProxyUser のパスワードに設定します。
  • ProxyDomain: プロキシ サーバーで設定が必要な場合、この値は ProxyUser のドメインに設定します。
  • MaxReceiveMessageLengthInBytes: この設定を使用して、クライアント ライブラリが処理できる API レスポンスの最大サイズを増やします。デフォルト値は 64 MB です。
  • MaxMetadataSizeInBytes: この設定を使用して、クライアント ライブラリが処理できる API エラー レスポンスの最大サイズを増やします。デフォルト値は 16 MB です。

OAuth2 設定

OAuth2 を使用して Google Ads API サーバーに対する呼び出しを承認する場合は、次の構成キーを設定する必要があります。

  • AuthorizationMethod: OAuth2 に設定します。
  • OAuth2Mode: APPLICATION または SERVICE_ACCOUNT に設定します。
  • OAuth2ClientId: この値に OAuth2 クライアント ID を設定します。
  • OAuth2ClientSecret: この値に OAuth2 クライアント シークレットを設定します。
  • OAuth2Scope: 複数の API で OAuth2 トークンを承認する場合は、この値を別のスコープに設定します。この設定は省略可能です。

OAuth2Mode == APPLICATION を使用している場合は、次の追加の構成キーを設定する必要があります。

  • OAuth2RefreshToken: OAuth2 トークンを再利用する場合は、この値を事前に生成した OAuth2 更新トークンに設定します。この設定は省略可能です。
  • OAuth2RedirectUri: この値に OAuth2 リダイレクト URL を設定します。この設定は省略可能です。

詳細については、次のガイドをご覧ください。

OAuth2Mode == SERVICE_ACCOUNT を使用している場合は、次の追加の構成キーを設定する必要があります。

  • OAuth2PrnEmail: この値は、成り代わるアカウントのメールアドレスに設定します。
  • OAuth2SecretsJsonPath: OAuth2 JSON 構成ファイルのパスにこの値を設定します。

詳しくは、OAuth サービス アカウント フローガイドをご覧ください。

次の設定は、Google Ads API に固有のものです。

  • DeveloperToken: 開発者トークンに設定します。
  • LoginCustomerId: リクエストで使用する承認済み顧客のお客様 ID です。ハイフン(-)は使用できません。
  • LinkedCustomerId: このヘッダーは、Google 広告 UI のリンクされたアカウント(Google Ads API の AccountLink リソース)を通じて権限がある場合、エンティティのリソースを更新するメソッドでのみ必要です。この値は、指定した顧客 ID のリソースを更新するデータ プロバイダの顧客 ID に設定します。ハイフン(-)を設定しないでください。リンクされたアカウントについて詳しくは、ヘルプセンターをご覧ください。