Начало работы

В этом руководстве представлен краткий обзор того, как начать работу с библиотекой Google Ads API .NET.

Установка

Бинарные файлы клиентской библиотеки распространяются с помощью NuGet. Чтобы использовать клиентскую библиотеку, добавьте ссылку NuGet на пакет Google.Ads.GoogleAds в вашем проекте.

Настроить авторизацию

Чтобы авторизовать вызовы API, вам необходимо указать в библиотеке идентификатор клиента, секретный код клиента, токен обновления и токен разработчика.

Если вам нужно сгенерировать учетные данные

Если у вас уже есть учетные данные

  • Скопируйте узел GoogleAdsApi и раздел GoogleAdsApi в узле configSections из файла App.config на GitHub в ваш файл App.config / Web.config . Если вы установили пакет с помощью NuGet, эти узлы будут автоматически добавлены в ваш файл App.config / Web.config .
  • Включите токен разработчика, идентификатор клиента, секретный код клиента и токен обновления в App.config / Web.config вашего приложения.

Файл App.config , включенный в GitHub, хорошо документирован, но вы также можете обратиться к руководству по настройке , чтобы узнать больше, а также использовать альтернативные способы настройки клиентской библиотеки, такие как переменные среды.

Сделать вызов API

Основное использование клиентской библиотеки следующее:

// Create a Google Ads client.
GoogleAdsClient client = new GoogleAdsClient();

// Create the required service.
CampaignServiceClient campaignService =
    client.GetService(Services.V21.CampaignService);

// Make more calls to service class.

Создайте экземпляр GoogleAdsClient

Самый важный класс в библиотеке Google Ads API .NET — это класс GoogleAdsClient . Он позволяет создать преднастроенный класс службы, который можно использовать для выполнения вызовов API. GoogleAdsClient предоставляет конструктор по умолчанию, который создаёт объект пользователя, используя настройки, указанные в App.config и Web.config вашего приложения. Подробнее о параметрах конфигурации см. в руководстве по настройке.

// Create a new GoogleAdsClient with the App.config settings.
GoogleAdsClient user = new GoogleAdsClient();

Создать услугу

GoogleAdsClient предоставляет метод GetService , который можно использовать для создания службы Ads.

CampaignServiceClient campaignService = client.GetService(Services.V21.CampaignService);
// Now make calls to CampaignService.

Мы предоставляем класс Services , который перечисляет все поддерживаемые версии API и сервисы. Метод GetService принимает эти объекты перечисления в качестве аргумента при создании сервиса. Например, чтобы создать экземпляр CampaignServiceClient для версии V21 API Google Ads, необходимо вызвать метод GoogleAdsClient.GetService с аргументом Services.V21.CampaignService , как показано в предыдущем примере.

Безопасность потока

Совместное использование экземпляра GoogleAdsClient несколькими потоками небезопасно, поскольку изменения конфигурации экземпляра в одном потоке могут повлиять на службы, создаваемые в других потоках. Такие операции, как получение новых экземпляров служб из экземпляра GoogleAdsClient и параллельные вызовы нескольких служб, являются потокобезопасными.

Многопоточное приложение будет выглядеть примерно так:

GoogleAdsClient client1 = new GoogleAdsClient();
GoogleAdsClient client2 = new GoogleAdsClient();

Thread userThread1 = new Thread(addAdGroups);
Thread userThread2 = new Thread(addAdGroups);

userThread1.start(client1);
userThread2.start(client2);

userThread1.join();
userThread2.join();

public void addAdGroups(object data) {
  GoogleAdsClient client = (GoogleAdsClient) data;
  // Do more operations here.
  ...
}

Избегайте зависаний в приложениях .NET Framework

Синхронные методы могут привести к зависанию некоторых приложений .NET Framework. Типичным примером является выполнение вызовов API из метода обработчика событий приложения WinForm.

Есть два способа решения этой проблемы:

  1. Используйте устаревшую библиотеку Grpc.

    Вы можете настроить свойство UseGrpcCore в GoogleAdsConfig , чтобы использовать устаревшую библиотеку Grpc.Core вместо библиотеки по умолчанию Grpc.Net.Client . Этот метод не был тщательно протестирован в приложениях .NET Framework, поэтому он может не решить проблему. Вот пример кода:

    GoogleAdsConfig config = new GoogleAdsConfig();
config.UseGrpcCore = true;
GoogleAdsClient client = new GoogleAdsClient(config);

  2. Используйте асинхронные методы.

    Чтобы избежать зависаний, можно использовать асинхронные методы. Вот несколько примеров:

    SearchStream

    Выполняется вызов SearchStream() , и результаты отображаются в виде списка.

    private async void button1_Click(object sender, EventArgs e)
{
// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
    Services.V21.GoogleAdsService);
 
// Create a query that will retrieve all campaigns.
string query = @"SELECT
                campaign.id,
                campaign.name,
                campaign.network_settings.target_content_network
            FROM campaign
            ORDER BY campaign.id";
 
List items = new List();
Task t =  googleAdsService.SearchStreamAsync(customerId.ToString(), query,
    delegate (SearchGoogleAdsStreamResponse resp)
    {
        foreach (GoogleAdsRow googleAdsRow in resp.Results)
        {
            ListViewItem item = new ListViewItem();
            item.Text = googleAdsRow.Campaign.Id.ToString();
            item.SubItems.Add(googleAdsRow.Campaign.Name);
            items.Add(item);
        }
    }
);
await t;
listView1.Items.AddRange(items.ToArray());
}

    Бюджет кампании

    Создается вызов CampaignBudget, и имя ресурса нового бюджета отображается с помощью оповещения MessageBox .

    private async void button2_Click(object sender, EventArgs e)
{
// Get the BudgetService.
CampaignBudgetServiceClient budgetService = client.GetService(
    Services.V21.CampaignBudgetService);
 
// Create the campaign budget.
CampaignBudget budget = new CampaignBudget()
{
    Name = "Interplanetary Cruise Budget #" + ExampleUtilities.GetRandomString(),
    DeliveryMethod = BudgetDeliveryMethod.Standard,
    AmountMicros = 500000
};
 
// Create the operation.
CampaignBudgetOperation budgetOperation = new CampaignBudgetOperation()
{
    Create = budget
};
 
// Create the campaign budget.
Task t = budgetService.MutateCampaignBudgetsAsync(
    customerId.ToString(), new CampaignBudgetOperation[] { budgetOperation });
 
await t;
MutateCampaignBudgetsResponse response = t.Result;
MessageBox.Show(response.Results[0].ResourceName);
}

Обработка ошибок

Не каждый вызов API будет успешным. Сервер может выдать ошибки, если по какой-либо причине вызовы API завершатся неудачей. Важно отслеживать ошибки API и обрабатывать их соответствующим образом.

При возникновении ошибки API генерируется исключение GoogleAdsException . В нём содержится подробная информация, которая поможет вам понять, что пошло не так:

// Get the CampaignService.
CampaignServiceClient campaignService = client.GetService(Services.V21.CampaignService);

// Create a campaign for update.
Campaign campaignToUpdate = new Campaign()
{
    ResourceName = ResourceNames.Campaign(customerId, campaignId),
    // More fields to update.
    // ...
};

// Create the operation.
CampaignOperation operation = new CampaignOperation()
{
    Update = campaignToUpdate,
    UpdateMask = FieldMasks.AllSetFieldsOf(campaignToUpdate)
};

try
{
    // Update the campaign.
    MutateCampaignsResponse response = campaignService.MutateCampaigns(
        customerId.ToString(), new CampaignOperation[] { operation });

    // Display the results.
    // ...
}
catch (GoogleAdsException e)
{
    Console.WriteLine("Failure:");
    Console.WriteLine($"Message: {e.Message}");

    // Can examine to get more error details.
    Console.WriteLine($"Failure: {e.Failure}");

    // Can be shared with Google for further troubleshooting.
    Console.WriteLine($"Request ID: {e.RequestId}");
}