.NET クライアント ライブラリ

.NET クライアント ライブラリは GitHub でホストされ、NuGet パッケージとして配布されます。このライブラリには、認証情報の管理や Google Ads API サービス クライアントの作成を容易にするなど、API の使用に役立つ機能がいくつか用意されています。

このライブラリは、次の .NET フレームワークをサポートしています。

  • .NET Framework 4.7.2 以降（net472）
  • .NET Standard 2.1（netstandard2.1）
  • .NET 8.0（net8.0）

.NET Standard 2.1 は、他のいくつかの .NET バージョンおよび実装と互換性があるため、このライブラリは他の多くのプラットフォームでも正常に動作する可能性があります。ただし、互換性のテストは正式には行われていないため、これらのプラットフォームは正式にはサポートされていません。詳細については、.NET Standard 2.1 のドキュメントをご覧ください。

Google Ads API .NET ライブラリは、デフォルトのトランスポート層として Grpc.Net.Client を使用し、サポートされていないプラットフォームでは Grpc.Core にフォールバックします。UseGrpcCore を true に設定することで Grpc.Core の使用を強制できますが、Grpc.Core は非推奨であり、以前のメンテナンスのみを目的としています。詳細については、基本的な使用ガイドをご覧ください。

インストール

dotnet コマンドライン ツールを使用して、プロジェクトに Google.Ads.GoogleAds NuGet パッケージをインストールします。

dotnet add package Google.Ads.GoogleAds

appsettings.json、App.config、または環境変数から構成設定を読み込むには、Google.Ads.GoogleAds.Extensions パッケージもインストールします。

dotnet add package Google.Ads.GoogleAds.Extensions

最初の API 呼び出しを実行する

Google Ads API を使用するには、いくつかの手順に沿って API へのアクセス権を取得し、Google 広告アカウントを設定する必要があります。クイック スタート ガイドに沿って、Google 広告アカウントの設定など、重要な手順をすべて行ってください。

基本的な使用方法

構成設定を使用して GoogleAdsConfig と GoogleAdsClient を初期化し、GoogleAdsServiceClient を取得して、SearchStream でキャンペーン行をストリーミングします。

using System;
using Google.Ads.Gax.Config;
using Google.Ads.GoogleAds.Config;
using Google.Ads.GoogleAds.Lib;
using Google.Ads.GoogleAds.V26.Errors;
using Google.Ads.GoogleAds.V26.Services;

GoogleAdsConfig config = new GoogleAdsConfig()
{
    OAuth2Mode = OAuth2Flow.APPLICATION,
    OAuth2ClientId = "INSERT_CLIENT_ID.apps.googleusercontent.com",
    OAuth2ClientSecret = "INSERT_CLIENT_SECRET",
    OAuth2RefreshToken = "INSERT_REFRESH_TOKEN",
    LoginCustomerId = "INSERT_LOGIN_CUSTOMER_ID_HERE"
};

GoogleAdsClient client = new GoogleAdsClient(config);
GoogleAdsServiceClient googleAdsService =
    client.GetService(Services.V26.GoogleAdsService);

string customerId = "INSERT_CUSTOMER_ID_HERE";
string query =
    "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id";

try
{
    googleAdsService.SearchStream(
        customerId,
        query,
        delegate (SearchGoogleAdsStreamResponse response)
        {
            foreach (GoogleAdsRow row in response.Results)
            {
                Console.WriteLine(
                    $"Campaign ID {row.Campaign.Id}: {row.Campaign.Name}");
            }
        });
}
catch (GoogleAdsException ex)
{
    Console.WriteLine($"Request ID {ex.RequestId} failed: {ex.Message}");
}

.NET クライアント ライブラリの使用方法について詳しくは、基本的な使用方法ガイドをご覧ください。

承認と認証

.NET クライアント ライブラリは、OAuth 2.0 ユーザー認証情報（デスクトップ アプリケーションとウェブ アプリケーション用）、サービス アカウント、アプリケーションのデフォルト認証情報（v24.1.0 以降）、手動認証情報の挿入（v27.0.0 以降）など、認証と認可の複数のアプローチをサポートしています。詳細については、認可と認証のガイドをご覧ください。

構成とロギング

.NET クライアント ライブラリは、ランタイム オブジェクト、appsettings.json またはカスタム JSON ファイル、環境変数、App.config ファイルを使用して、複数の構成オプションとロギング オプションをサポートしています。クライアント ライブラリのロギング動作を変更する必要がある場合は、カスタム gRPC インターセプタ ガイドをご覧ください。

ユーティリティ

.NET クライアント ライブラリには、API の使いやすさを向上させるユーティリティ クラスが含まれています。これには、メディアと動画のアップロード ヘルパー（v27.2.0 以降の UploadVideo）が含まれます。詳細については、次のガイドをご覧ください。

アプリケーションのパフォーマンスを微調整する

アプリケーションのパフォーマンスを微調整する方法については、パフォーマンス チューニング ガイドをご覧ください。