-
Notifications
You must be signed in to change notification settings - Fork 95
/
AddGoogleMyBusinessLocationExtensions.cs
462 lines (415 loc) · 21.5 KB
/
AddGoogleMyBusinessLocationExtensions.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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
// Copyright 2020 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 Google.Ads.GoogleAds.Lib;
using Google.Ads.GoogleAds.V5.Common;
using Google.Ads.GoogleAds.V5.Errors;
using Google.Ads.GoogleAds.V5.Resources;
using Google.Ads.GoogleAds.V5.Services;
using Google.Api.Gax;
using Grpc.Core;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using static Google.Ads.GoogleAds.V5.Common.Operand.Types;
using static Google.Ads.GoogleAds.V5.Enums.FeedOriginEnum.Types;
using static Google.Ads.GoogleAds.V5.Enums.MatchingFunctionOperatorEnum.Types;
using static Google.Ads.GoogleAds.V5.Enums.PlaceholderTypeEnum.Types;
using static Google.Ads.GoogleAds.V5.Resources.Feed.Types;
using static Google.Ads.GoogleAds.V5.Resources.Feed.Types.PlacesLocationFeedData.Types;
namespace Google.Ads.GoogleAds.Examples.V5
{
/// <summary>
/// This code example adds a feed that syncs feed items from a Google My Business (GMB) account
/// and associates the feed with a customer.
/// </summary>
public class AddGoogleMyBusinessLocationExtensions : ExampleBase
{
// The required scope for setting the OAuth info.
private const string GOOGLE_ADS_SCOPE = "https://www.googleapis.com/auth/adwords";
// The maximum number of attempts to make to retrieve the FeedMappings before throwing an
// exception.
private const int MAX_FEEDMAPPING_RETRIEVAL_ATTEMPTS = 10;
/// <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)
{
AddGoogleMyBusinessLocationExtensions codeExample =
new AddGoogleMyBusinessLocationExtensions();
Console.WriteLine(codeExample.Description);
GoogleAdsClient client = new GoogleAdsClient();
// The customer ID for which the call is made.
int customerId = int.Parse("INSERT_CUSTOMER_ID_HERE");
// The email address of either an owner or a manager of the GMB account.
string gmbEmailAddress = "INSERT_GMB_EMAIL_ADDRESS_HERE";
// If the gmbEmailAddress above is the same user you used to generate
// your Google Ads API refresh token, leave the assignment below unchanged.
// Otherwise, to obtain an access token for your GMB account, run the
// AuthenticateInStandaloneApplication code example while logged in as the same
// user as gmbEmailAddress. Copy and paste the AccessToken value into the
// assignment below and delete the line after it.
// string gmbAccessToken = "INSERT_GMB_ACCESS_TOKEN_HERE";
string gmbAccessToken = client.Config.OAuth2AccessToken;
// If the gmbEmailAddress above is for a GMB manager instead of the GMB
// account owner, then set businessAccountIdentifier to the Google+ Page ID of
// a location for which the manager has access. This information is available
// through the Google My Business API. See
// https://developers.google.com/my-business/reference/rest/v4/accounts.locations#locationkey
// for details.
string businessAccountId = null;
codeExample.Run(client, customerId, gmbEmailAddress, businessAccountId, gmbAccessToken);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description =>
"This code example adds a feed that syncs feed items from a Google My Business (GMB) " +
"account and associates the feed with a customer.";
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The customer ID for which the call is made.</param>
/// <param name="gmbEmailAddress">The Google My Business login email address.</param>
/// <param name="businessAccountId">The Google My Business account
/// identifier.</param>
/// <param name="gmbAccessToken">The OAuth2 access token for The Google My Business
/// account.</param>
public void Run(GoogleAdsClient client, long customerId, string gmbEmailAddress,
string businessAccountId, string gmbAccessToken)
{
try
{
if (string.IsNullOrEmpty(gmbAccessToken))
{
gmbAccessToken = client.Config.OAuth2AccessToken;
}
string gmbFeedResourceName = CreateGMBFeed(client, customerId, gmbEmailAddress,
businessAccountId, gmbAccessToken);
// After the completion of the Feed ADD operation above the added feed will not be
// available for usage in a CustomerFeed until the FeedMappings are created.
// We will wait with an exponential back-off policy until the feedmappings have
// been created.
WaitForGMBFeedToBeReady(client, customerId, gmbFeedResourceName);
CreateCustomerFeed(client, customerId, gmbFeedResourceName);
}
catch (GoogleAdsException e)
{
Console.WriteLine("Failure:");
Console.WriteLine($"Message: {e.Message}");
Console.WriteLine($"Failure: {e.Failure}");
Console.WriteLine($"Request ID: {e.RequestId}");
throw;
}
}
/// <summary>
/// Creates the Google My Business feed.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The customer ID for which the call is made.</param>
/// <param name="gmbEmailAddress">The Google My Business login email address.</param>
/// <param name="businessAccountId">The Google My Business account ID.</param>
/// <param name="gmbAccessToken">The OAuth2 access token for The Google My Business
/// account.</param>
/// <returns>ID of the newly created Google My Business feed.</returns>
private static string CreateGMBFeed(GoogleAdsClient client, long customerId,
string gmbEmailAddress, string businessAccountId, string gmbAccessToken)
{
// Optional: Delete all existing location extension feeds. This is an optional step,
// and is required for this code example to run correctly more than once.
// 1. Google Ads only allows one location extension feed per email address.
// 2. A Google Ads account cannot have a location extension feed and an affiliate
// location extension feed at the same time.
DeleteLocationExtensionFeeds(client, customerId);
// Get the FeedServiceClient.
FeedServiceClient feedService = client.GetService(Services.V5.FeedService);
// Creates a feed that will sync to the Google My Business account specified by
// gmbEmailAddress. Do not add FeedAttributes to this object as Google Ads will add
// them automatically because this will be a system generated feed.
Feed gmbFeed = new Feed()
{
Name = "Google My Business feed #" + ExampleUtilities.GetRandomString(),
PlacesLocationFeedData = new PlacesLocationFeedData()
{
EmailAddress = gmbEmailAddress,
// If the EmailAddress is for a GMB manager instead of the GMB
// account owner, then set BusinessAccountId to the Google+ Page ID of
// a location for which the manager has access. This information is available
// through the Google My Business API. See
// https://developers.google.com/my-business/reference/rest/v4/accounts.locations#locationkey
// for details.
BusinessAccountId = string.IsNullOrEmpty(businessAccountId) ?
null : businessAccountId,
// Used to filter Google My Business listings by labels. If entries exist in
// label_filters, only listings that have at least one of the labels set are
// candidates to be synchronized into FeedItems. If no entries exist in
// label_filters, then all listings are candidates for syncing.
LabelFilters = { "Stores in New York" },
// Sets the authentication info to be able to connect Google Ads to the GMB
// account.
OauthInfo = new OAuthInfo()
{
HttpMethod = "GET",
HttpRequestUrl = GOOGLE_ADS_SCOPE,
HttpAuthorizationHeader = $"Bearer {gmbAccessToken}"
},
},
// Since this feed's feed items will be managed by Google,
// you must set its origin to GOOGLE.
Origin = FeedOrigin.Google
};
FeedOperation operation = new FeedOperation()
{
Create = gmbFeed
};
// Adds the feed.
MutateFeedsResponse response =
feedService.MutateFeeds(customerId.ToString(), new[] { operation });
// Displays the results.
string gmbFeedResourceName = response.Results[0].ResourceName;
Console.WriteLine($"GMB feed created with resource name: {gmbFeedResourceName}.");
return gmbFeedResourceName;
}
/// <summary>
/// Deletes the old location extension feeds.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The customer ID for which the call is made.</param>
private static void DeleteLocationExtensionFeeds(GoogleAdsClient client, long customerId)
{
// To delete a location extension feed, you need to
// 1. Delete the CustomerFeed so that the location extensions from the feed stop
// serving.
// 2. Delete the feed so that Google Ads will no longer sync from the GMB account.
CustomerFeed[] oldCustomerFeeds = GetLocationExtensionCustomerFeeds(client, customerId);
if (oldCustomerFeeds.Length != 0)
{
DeleteCustomerFeeds(client, customerId, oldCustomerFeeds);
}
Feed[] feeds = GetLocationExtensionFeeds(client, customerId);
if (feeds.Length != 0)
{
RemoveFeeds(client, customerId, feeds);
}
}
/// <summary>
/// Gets the location extension feeds.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The customer ID for which the call is made.</param>
/// <returns>The list of location extension feeds.</returns>
private static Feed[] GetLocationExtensionFeeds(GoogleAdsClient client, long customerId)
{
List<Feed> feeds = new List<Feed>();
GoogleAdsServiceClient googleAdsService = client.GetService(
Services.V5.GoogleAdsService);
// Create the query.
string query = $"SELECT feed.resource_name, feed.status, " +
$"feed.places_location_feed_data.email_address, " +
$"feed.affiliate_location_feed_data.chain_ids " +
$" from feed where feed.status = ENABLED";
PagedEnumerable<SearchGoogleAdsResponse, GoogleAdsRow> result =
googleAdsService.Search(customerId.ToString(), query);
foreach (GoogleAdsRow row in result)
{
// A location extension feed can be identified by checking whether the
// PlacesLocationFeedData field is set (Location extensions feeds) or
// AffiliateLocationFeedData field is set (Affiliate location extension feeds)
Feed feed = row.Feed;
if (feed.PlacesLocationFeedData != null || feed.AffiliateLocationFeedData != null)
{
feeds.Add(feed);
}
}
return feeds.ToArray();
}
/// <summary>
/// Removes the feeds.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The customer ID for which the call is made.</param>
/// <param name="feeds">The list of feeds to remove.</param>
private static void RemoveFeeds(GoogleAdsClient client, long customerId, Feed[] feeds)
{
List<FeedOperation> operations = new List<FeedOperation>();
foreach (Feed feed in feeds)
{
FeedOperation operation = new FeedOperation()
{
Remove = feed.ResourceName,
};
operations.Add(operation);
}
FeedServiceClient feedService = client.GetService(
Services.V5.FeedService);
feedService.MutateFeeds(customerId.ToString(), operations.ToArray());
}
private static CustomerFeed[] GetLocationExtensionCustomerFeeds(GoogleAdsClient client,
long customerId)
{
List<CustomerFeed> customerFeeds = new List<CustomerFeed>();
GoogleAdsServiceClient googleAdsService = client.GetService(
Services.V5.GoogleAdsService);
// Create the query. A location extension customer feed can be identified by filtering
// for placeholder_types=LOCATION (location extension feeds) or
// placeholder_types =AFFILIATE_LOCATION (affiliate location extension feeds)
string query = $"SELECT customer_feed.resource_name, customer_feed.feed, " +
$"customer_feed.status, customer_feed.matching_function.function_string from " +
$"customer_feed " +
$"WHERE customer_feed.placeholder_types CONTAINS " +
$"ANY(LOCATION, AFFILIATE_LOCATION) and customer_feed.status=ENABLED";
PagedEnumerable<SearchGoogleAdsResponse, GoogleAdsRow> result =
googleAdsService.Search(customerId.ToString(), query);
foreach (GoogleAdsRow row in result)
{
customerFeeds.Add(row.CustomerFeed);
}
return customerFeeds.ToArray();
}
/// <summary>
/// Deletes the customer feeds.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The customer ID for which the call is made.</param>
/// <param name="customerFeeds">The customer feeds to delete.</param>
private static void DeleteCustomerFeeds(GoogleAdsClient client, long customerId,
CustomerFeed[] customerFeeds)
{
List<CustomerFeedOperation> operations = new List<CustomerFeedOperation>();
foreach (CustomerFeed customerFeed in customerFeeds)
{
CustomerFeedOperation operation = new CustomerFeedOperation()
{
Remove = customerFeed.ResourceName,
};
operations.Add(operation);
}
CustomerFeedServiceClient feedService = client.GetService(
Services.V5.CustomerFeedService);
feedService.MutateCustomerFeeds(customerId.ToString(), operations.ToArray());
}
/// <summary>
/// Gets the Google My Business feed mapping.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The customer ID for which the call is made.</param>
/// <param name="gmbFeedResourceName">The GMB feed resource name.</param>
/// <returns>The newly created feed mapping.</returns>
private static FeedMapping GetGMBFeedMapping(GoogleAdsClient client, long customerId,
string gmbFeedResourceName)
{
// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
Services.V5.GoogleAdsService);
// Create the query.
string query = $"SELECT feed_mapping.resource_name, feed_mapping.status FROM " +
$"feed_mapping WHERE feed_mapping.feed = '{gmbFeedResourceName}' and " +
$"feed_mapping.status = ENABLED and feed_mapping.placeholder_type = LOCATION" +
$" LIMIT 1";
// Issue a search request.
PagedEnumerable<SearchGoogleAdsResponse, GoogleAdsRow> result =
googleAdsService.Search(customerId.ToString(), query);
// Display the results.
GoogleAdsRow googleAdsRow = result.FirstOrDefault();
return (googleAdsRow == null) ? null : googleAdsRow.FeedMapping;
}
/// <summary>
/// Waits for GMB feed to be ready.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The customer ID for which the call is made.</param>
/// <param name="gmbFeedResourceName">Name of the GMB feed resource.</param>
private static void WaitForGMBFeedToBeReady(GoogleAdsClient client, long customerId,
string gmbFeedResourceName)
{
int numAttempts = 0;
int sleepSeconds = 0;
while (numAttempts < MAX_FEEDMAPPING_RETRIEVAL_ATTEMPTS)
{
// Once you create a feed, Google's servers will setup the feed by creating feed
// attributes and feedmapping. Once the feedmapping is created, it is ready to be
// used for creating customer feed.
// This process is asynchronous, so we wait until the feed mapping is created,
// peforming exponential backoff.
FeedMapping feedMapping = GetGMBFeedMapping(client,
customerId, gmbFeedResourceName);
if (feedMapping == null)
{
numAttempts++;
sleepSeconds = (int) (5 * Math.Pow(2, numAttempts));
Console.WriteLine($"Checked: #{numAttempts} time(s). GMB feed is not ready " +
$"yet. Waiting {sleepSeconds} seconds before trying again.");
Thread.Sleep(sleepSeconds * 1000);
}
else
{
Console.WriteLine($"GMB Feed {gmbFeedResourceName} is now ready.");
return;
}
}
throw new RpcException(new Status(StatusCode.DeadlineExceeded,
$"GMB Feed is not ready after {MAX_FEEDMAPPING_RETRIEVAL_ATTEMPTS}" +
$" retries."));
}
/// <summary>
/// Creates the customer feed.
/// </summary>
/// <param name="client">The client.</param>
/// <param name="customerId">The customer identifier.</param>
/// <param name="gmbFeedResourceName">Name of the GMB feed resource.</param>
private static void CreateCustomerFeed(GoogleAdsClient client, long customerId,
string gmbFeedResourceName)
{
// Get the CustomerFeedService.
CustomerFeedServiceClient customerFeedService = client.GetService(
Services.V5.CustomerFeedService);
// Adds a CustomerFeed that associates the feed with this customer for
// the LOCATION placeholder type.
CustomerFeed customerFeed = new CustomerFeed()
{
Feed = gmbFeedResourceName,
PlaceholderTypes = { PlaceholderType.Location },
MatchingFunction = new MatchingFunction()
{
LeftOperands =
{
new Operand()
{
ConstantOperand = new ConstantOperand()
{
BooleanValue = true
}
}
},
// Specify the function string as IDENTITY(true) to mark this feed as enabled.
FunctionString = "IDENTITY(true)",
Operator = MatchingFunctionOperator.Identity
},
};
CustomerFeedOperation operation = new CustomerFeedOperation()
{
Create = customerFeed
};
MutateCustomerFeedsResponse customerFeedsResponse =
customerFeedService.MutateCustomerFeeds(
customerId.ToString(), new[] { operation });
// Displays the result.
string addedCustomerFeed = customerFeedsResponse.Results[0].ResourceName;
Console.WriteLine($"Customer feed created with resource name: {addedCustomerFeed}.");
return;
}
}
}