-
Notifications
You must be signed in to change notification settings - Fork 95
/
UseCrossAccountBiddingStrategy.cs
308 lines (281 loc) · 14.4 KB
/
UseCrossAccountBiddingStrategy.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
using System;
using System.Collections.Generic;
using System.Linq;
using CommandLine;
using Google.Ads.Gax.Examples;
using Google.Ads.Gax.Util;
using Google.Ads.GoogleAds.Lib;
using Google.Ads.GoogleAds.V12.Common;
using Google.Ads.GoogleAds.V12.Errors;
using Google.Ads.GoogleAds.V12.Resources;
using Google.Ads.GoogleAds.V12.Services;
using static Google.Ads.GoogleAds.V12.Enums.BiddingStrategyTypeEnum.Types;
namespace Google.Ads.GoogleAds.Examples.V12
{
/// <summary>
/// This code example adds a cross-account bidding strategy to a manager account and attaches it
/// to a client customer's campaign. Also lists all the bidding strategies that are owned by the
/// manager and accessible by the customer.
/// Please read our guide pages more information on bidding strategies:
/// https://developers.google.com/google-ads/api/docs/campaigns/bidding/cross-account-strategies
/// </summary>
public class UseCrossAccountBiddingStrategy : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="UseCrossAccountBiddingStrategy"/>
/// example.
/// </summary>
public class Options : OptionsBase
{
/// <summary>
/// The Google Ads client customer ID for which the call is made.
/// </summary>
[Option("customerId", Required = true, HelpText =
"The Google Ads client customer ID for which the call is made.")]
public long CustomerId { get; set; }
/// <summary>
/// The ID of the account that owns the cross-account bidding strategy. This is
/// typically the ID of the manager account.
/// </summary>
[Option("managerCustomerId", Required = true, HelpText =
"The ID of the account that owns the cross-account bidding strategy. This is" +
"typically the ID of the manager account.")]
public long ManagerCustomerId { get; set; }
/// <summary>
/// The ID of the campaign owned by the customer ID to which the cross-account bidding
/// strategy will be attached.
/// </summary>
[Option("campaignId", Required = true, HelpText =
"The ID of the campaign owned by the customer ID to which the cross-account " +
"bidding strategy will be attached.")]
public long CampaignId { get; set; }
}
/// <summary>
/// Main method, to run this code example as a standalone application.
/// </summary>
/// <param name="args">The command line arguments.</param>
public static void Main(string[] args)
{
Options options = ExampleUtilities.ParseCommandLine<Options>(args);
UseCrossAccountBiddingStrategy codeExample = new UseCrossAccountBiddingStrategy();
Console.WriteLine(codeExample.Description);
codeExample.Run(new GoogleAdsClient(), options.CustomerId, options.ManagerCustomerId,
options.CampaignId);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description =>
"This code example adds a cross-account bidding strategy to a manager account and " +
"attaches it to a client customer's campaign. Also lists all the bidding strategies " +
"that are owned by the manager and accessible by the customer.\n" +
"Please read our guide pages more information on bidding strategies:" +
"https://developers.google.com/google-ads/api/docs/campaigns/bidding/cross-account-strategies";
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The Google Ads client customer ID for which the call is
/// made.</param>
/// <param name="managerCustomerId">The manager customer ID.</param>
/// <param name="campaignId">The ID of the campaign owned by the customer ID to which the
/// cross-account bidding strategy will be attached.</param>
public void Run(GoogleAdsClient client, long customerId, long managerCustomerId,
long campaignId)
{
try
{
string biddingStrategyResourceName =
CreateBiddingStrategy(client, managerCustomerId);
ListManagerOwnedBiddingStrategies(client, managerCustomerId);
ListCustomerAccessibleBiddingStrategies(client, customerId);
AttachCrossAccountBiddingStrategyToCampaign(client, customerId, campaignId,
biddingStrategyResourceName);
}
catch (GoogleAdsException e)
{
Console.WriteLine("Failure:");
Console.WriteLine($"Message: {e.Message}");
Console.WriteLine($"Failure: {e.Failure}");
Console.WriteLine($"Request ID: {e.RequestId}");
throw;
}
}
// [START create_cross_account_strategy]
/// <summary>
/// Creates a new TargetSpend (Maximize Clicks) cross-account bidding strategy in the
/// specified manager account.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="managerCustomerId">The manager customer ID.</param>
/// <returns>The resource name of the newly created bidding strategy.</returns>
private string CreateBiddingStrategy(GoogleAdsClient client, long managerCustomerId)
{
BiddingStrategyServiceClient biddingStrategyServiceClient =
client.GetService(Services.V12.BiddingStrategyService);
// Create a portfolio bidding strategy.
// [START set_currency_code]
BiddingStrategy portfolioBiddingStrategy = new BiddingStrategy
{
Name = $"Maximize clicks #{ExampleUtilities.GetRandomString()}",
TargetSpend = new TargetSpend(),
// Set the currency of the new bidding strategy. If not provided, the bidding
// strategy uses the manager account's default currency.
CurrencyCode = "USD"
};
// [END set_currency_code]
// Send a create operation that will create the portfolio bidding strategy.
MutateBiddingStrategiesResponse mutateBiddingStrategiesResponse =
biddingStrategyServiceClient.MutateBiddingStrategies(managerCustomerId.ToString(),
new[]
{
new BiddingStrategyOperation
{
Create = portfolioBiddingStrategy
}
});
// Print and return the resource name of the newly created cross-account bidding
// strategy.
string biddingStrategyResourceName =
mutateBiddingStrategiesResponse.Results.First().ResourceName;
Console.WriteLine("Created cross-account bidding strategy " +
$"'{biddingStrategyResourceName}'.");
return biddingStrategyResourceName;
}
// [END create_cross_account_strategy]
// [START list_manager_strategies]
/// <summary>
/// Lists all cross-account bidding strategies in a specified manager account.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="managerCustomerId">The manager customer ID.</param>
private void ListManagerOwnedBiddingStrategies(GoogleAdsClient client,
long managerCustomerId)
{
GoogleAdsServiceClient googleAdsServiceClient =
client.GetService(Services.V12.GoogleAdsService);
// Create a GAQL query that will retrieve all cross-account bidding strategies.
string query = @"
SELECT
bidding_strategy.id,
bidding_strategy.name,
bidding_strategy.type,
bidding_strategy.currency_code
FROM bidding_strategy";
// Issue a streaming search request, then iterate through and print the results.
googleAdsServiceClient.SearchStream(managerCustomerId.ToString(), query,
delegate(SearchGoogleAdsStreamResponse resp)
{
Console.WriteLine("Cross-account bid strategies in manager account " +
$"{managerCustomerId}:");
foreach (GoogleAdsRow googleAdsRow in resp.Results)
{
BiddingStrategy biddingStrategy = googleAdsRow.BiddingStrategy;
Console.WriteLine($"\tID: {biddingStrategy.Id}\n" +
$"\tName: {biddingStrategy.Name}\n" +
"\tStrategy type: " +
$"{Enum.GetName(typeof(BiddingStrategyType), biddingStrategy.Type)}\n" +
$"\tCurrency: {biddingStrategy.CurrencyCode}\n\n");
}
}
);
}
// [END list_manager_strategies]
// [START list_accessible_strategies]
/// <summary>
/// Lists all bidding strategies available to specified client customer account. This
/// includes both portfolio bidding strategies owned by the client customer account and
/// cross-account bidding strategies shared by any of its managers.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The Google Ads client customer ID for which the call is
/// made.</param>
private void ListCustomerAccessibleBiddingStrategies(GoogleAdsClient client,
long customerId)
{
GoogleAdsServiceClient googleAdsServiceClient =
client.GetService(Services.V12.GoogleAdsService);
// Create a GAQL query that will retrieve all accessible bidding strategies.
string query = @"
SELECT
accessible_bidding_strategy.resource_name,
accessible_bidding_strategy.id,
accessible_bidding_strategy.name,
accessible_bidding_strategy.type,
accessible_bidding_strategy.owner_customer_id,
accessible_bidding_strategy.owner_descriptive_name
FROM accessible_bidding_strategy";
// Uncomment the following WHERE clause addition to the query to filter results to
// *only* cross-account bidding strategies shared with the current customer by a manager
// (and not also include the current customer's portfolio bidding strategies).
// query += $" WHERE accessible_bidding_strategy.owner_customer_id != {customerId}";
// Issue a streaming search request, then iterate through and print the results.
googleAdsServiceClient.SearchStream(customerId.ToString(), query,
delegate(SearchGoogleAdsStreamResponse resp)
{
Console.WriteLine($"All bid strategies accessible by account {customerId}:");
foreach (GoogleAdsRow googleAdsRow in resp.Results)
{
AccessibleBiddingStrategy biddingStrategy =
googleAdsRow.AccessibleBiddingStrategy;
Console.WriteLine($"\tID: {biddingStrategy.Id}\n" +
$"\tName: {biddingStrategy.Name}\n" +
$"\tStrategy type: {biddingStrategy.Type.ToString()}\n" +
$"\tOwner customer ID: {biddingStrategy.OwnerCustomerId}\n" +
$"\tOwner description: {biddingStrategy.OwnerDescriptiveName}\n\n");
}
}
);
}
// [END list_accessible_strategies]
// [START attach_strategy]
/// <summary>
/// Attaches a specified cross-account bidding strategy to a campaign owned by a specified
/// client customer account.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The Google Ads client customer ID for which the call is
/// made.</param>
/// <param name="campaignId">The ID of the campaign owned by the customer ID to which the
/// cross-account bidding strategy will be attached.</param>
/// <param name="biddingStrategyResourceName">A cross-account bidding strategy resource
/// name.</param>
private void AttachCrossAccountBiddingStrategyToCampaign(GoogleAdsClient client,
long customerId, long campaignId, string biddingStrategyResourceName)
{
CampaignServiceClient campaignServiceClient =
client.GetService(Services.V12.CampaignService);
Campaign campaign = new Campaign
{
ResourceName = ResourceNames.Campaign(customerId, campaignId),
BiddingStrategy = biddingStrategyResourceName
};
// Mutate the campaign and print the resource name of the updated campaign.
MutateCampaignsResponse mutateCampaignsResponse =
campaignServiceClient.MutateCampaigns(customerId.ToString(), new[]
{
new CampaignOperation
{
Update = campaign,
UpdateMask = FieldMasks.AllSetFieldsOf(campaign)
}
});
Console.WriteLine("Updated campaign with resource name " +
$"'{mutateCampaignsResponse.Results.First().ResourceName}'.");
}
// [END attach_strategy]
}
}