-
Notifications
You must be signed in to change notification settings - Fork 770
/
AddSitelinksUsingFeeds.php
567 lines (518 loc) · 20.8 KB
/
AddSitelinksUsingFeeds.php
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
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
<?php
/**
* Copyright 2017 Google Inc. All Rights Reserved.
*
* 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.
*/
namespace Google\AdsApi\Examples\AdWords\v201809\Extensions;
require __DIR__ . '/../../../../vendor/autoload.php';
use Google\AdsApi\AdWords\AdWordsServices;
use Google\AdsApi\AdWords\AdWordsSession;
use Google\AdsApi\AdWords\AdWordsSessionBuilder;
use Google\AdsApi\AdWords\v201809\cm\AttributeFieldMapping;
use Google\AdsApi\AdWords\v201809\cm\CampaignFeed;
use Google\AdsApi\AdWords\v201809\cm\CampaignFeedOperation;
use Google\AdsApi\AdWords\v201809\cm\CampaignFeedService;
use Google\AdsApi\AdWords\v201809\cm\Feed;
use Google\AdsApi\AdWords\v201809\cm\FeedAttribute;
use Google\AdsApi\AdWords\v201809\cm\FeedAttributeType;
use Google\AdsApi\AdWords\v201809\cm\FeedItem;
use Google\AdsApi\AdWords\v201809\cm\FeedItemAdGroupTarget;
use Google\AdsApi\AdWords\v201809\cm\FeedItemAttributeValue;
use Google\AdsApi\AdWords\v201809\cm\FeedItemCriterionTarget;
use Google\AdsApi\AdWords\v201809\cm\FeedItemGeoRestriction;
use Google\AdsApi\AdWords\v201809\cm\FeedItemOperation;
use Google\AdsApi\AdWords\v201809\cm\FeedItemService;
use Google\AdsApi\AdWords\v201809\cm\FeedItemTargetOperation;
use Google\AdsApi\AdWords\v201809\cm\FeedItemTargetService;
use Google\AdsApi\AdWords\v201809\cm\FeedMapping;
use Google\AdsApi\AdWords\v201809\cm\FeedMappingOperation;
use Google\AdsApi\AdWords\v201809\cm\FeedMappingService;
use Google\AdsApi\AdWords\v201809\cm\FeedOperation;
use Google\AdsApi\AdWords\v201809\cm\FeedOrigin;
use Google\AdsApi\AdWords\v201809\cm\FeedService;
use Google\AdsApi\AdWords\v201809\cm\GeoRestriction;
use Google\AdsApi\AdWords\v201809\cm\Location;
use Google\AdsApi\AdWords\v201809\cm\MatchingFunction;
use Google\AdsApi\AdWords\v201809\cm\Operator;
use Google\AdsApi\Common\OAuth2TokenBuilder;
/**
* This example adds a sitelinks feed and associates it with a campaign.
* To get campaigns, run GetCampaigns.php.
*/
class AddSitelinksUsingFeeds
{
const CAMPAIGN_ID = 'INSERT_CAMPAIGN_ID_HERE';
// Optional: Enter the ID of ad group for which you want to restrict the
// first feed item to only serve with ads.
// Leave this as null if you don't want to make such restriction.
const AD_GROUP_ID = null;
// See the Placeholder reference page for a list of all the placeholder
// types and fields.
// https://developers.google.com/adwords/api/docs/appendix/placeholders.html
const PLACEHOLDER_SITELINKS = 1;
const PLACEHOLDER_FIELD_SITELINK_LINK_TEXT = 1;
const PLACEHOLDER_FIELD_SITELINK_FINAL_URL = 5;
const PLACEHOLDER_FIELD_LINE_2_TEXT = 3;
const PLACEHOLDER_FIELD_LINE_3_TEXT = 4;
public static function runExample(
AdWordsServices $adWordsServices,
AdWordsSession $session,
$campaignId,
$adGroupId = null
) {
$sitelinksData = self::createSitelinksFeed($adWordsServices, $session);
$sitelinksData = self::createSitelinksFeedItems(
$adWordsServices,
$session,
$sitelinksData
);
self::createSitelinksFeedMapping(
$adWordsServices,
$session,
$sitelinksData
);
self::createSitelinksCampaignFeed(
$adWordsServices,
$session,
$sitelinksData,
$campaignId
);
// Optional: Restrict the first feed item to only serve with ads for the
// specified ad group ID.
if ($adGroupId !== null) {
self::restrictFeedItemToAdGroup(
$adWordsServices,
$session,
$sitelinksData['sitelinksFeedId'],
$sitelinksData['sitelinkFeedItemIds'][0],
$adGroupId
);
}
}
/**
* Creates the feed that holds the sitelinks data.
*/
private static function createSitelinksFeed(
AdWordsServices $adWordsServices,
AdWordsSession $session
) {
$feedService = $adWordsServices->get($session, FeedService::class);
// Holds the IDs associated to the feeds metadata.
$sitelinksData = [];
// Create feed attributes.
$textAttribute = new FeedAttribute();
$textAttribute->setType(FeedAttributeType::STRING);
$textAttribute->setName('Link Text');
$finalUrlAttribute = new FeedAttribute();
$finalUrlAttribute->setType(FeedAttributeType::URL_LIST);
$finalUrlAttribute->setName('Link URL');
$line2Attribute = new FeedAttribute();
$line2Attribute->setType(FeedAttributeType::STRING);
$line2Attribute->setName('Line 2');
$line3Attribute = new FeedAttribute();
$line3Attribute->setType(FeedAttributeType::STRING);
$line3Attribute->setName('Line 3');
// Create the feed.
$sitelinksFeed = new Feed();
$sitelinksFeed->setName('Feed For Sitelinks #' . uniqid());
$sitelinksFeed->setAttributes([
$textAttribute,
$finalUrlAttribute,
$line2Attribute,
$line3Attribute
]);
$sitelinksFeed->setOrigin(FeedOrigin::USER);
// Create the feed operation and add it on the server.
$operation = new FeedOperation();
$operation->setOperator(Operator::ADD);
$operation->setOperand($sitelinksFeed);
$result = $feedService->mutate([$operation]);
// Print out some information about the created feed.
$savedFeed = $result->getValue()[0];
$sitelinksData['sitelinksFeedId'] = $savedFeed->getId();
$savedAttributes = $savedFeed->getAttributes();
$sitelinksData['linkTextFeedAttributeId'] =
$savedAttributes[0]->getId();
$sitelinksData['linkFinalUrlFeedAttributeId'] =
$savedAttributes[1]->getId();
$sitelinksData['line2FeedAttribute'] = $savedAttributes[2]->getId();
$sitelinksData['line3FeedAttribute'] = $savedAttributes[3]->getId();
printf(
"Feed with name '%s', ID %d with linkTextAttributeId %d, "
. "linkFinalUrlAttributeId %d, line2AttributeId %d and "
. "line3AttributeId %d was created.%s",
$savedFeed->getName(),
$savedFeed->getId(),
$savedAttributes[0]->getId(),
$savedAttributes[1]->getId(),
$savedAttributes[2]->getId(),
$savedAttributes[3]->getId(),
PHP_EOL
);
return $sitelinksData;
}
/**
* Creates sitelinks feed items and add it to the feed.
*/
private static function createSitelinksFeedItems(
AdWordsServices $adWordsServices,
AdWordsSession $session,
array $sitelinksData
) {
$feedItemService =
$adWordsServices->get($session, FeedItemService::class);
// Create operations to add feed items.
$home = self::newSitelinkFeedItemAddOperation(
$sitelinksData,
'Home',
'http://www.example.com',
'Home line 2',
'Home line 3'
);
$stores = self::newSitelinkFeedItemAddOperation(
$sitelinksData,
'Stores',
'http://www.example.com/stores',
'Stores line 2',
'Stores line 3'
);
$onSale = self::newSitelinkFeedItemAddOperation(
$sitelinksData,
'On Sale',
'http://www.example.com/sale',
'On Sale line 2',
'On Sale line 3'
);
$support = self::newSitelinkFeedItemAddOperation(
$sitelinksData,
'Support',
'http://www.example.com/support',
'Support line 2',
'Support line 3'
);
$products = self::newSitelinkFeedItemAddOperation(
$sitelinksData,
'Products',
'http://www.example.com/products',
'Products line 2',
'Products line 3'
);
// This site link is using geographical targeting to use
// LOCATION_OF_PRESENCE.
$aboutUs = self::newSitelinkFeedItemAddOperation(
$sitelinksData,
'About Us',
'http://www.example.com/about',
'About Us line 2',
'About Us line 3',
true
);
// Add feed item operations on the server and print out some information.
$result = $feedItemService->mutate(
[$home, $stores, $onSale, $support, $products, $aboutUs]
);
$sitelinksData['sitelinkFeedItemIds'] = [];
foreach ($result->getValue() as $feedItem) {
printf(
'Feed item with feed item ID %d was added.%s',
$feedItem->getFeedItemId(),
PHP_EOL
);
$sitelinksData['sitelinkFeedItemIds'][] =
$feedItem->getFeedItemId();
}
// Target the "aboutUs" sitelink to geographically target California.
// See https://developers.google.com/adwords/api/docs/appendix/geotargeting
// for location criteria of supported locations.
self::restrictFeedItemToGeoTarget(
$adWordsServices,
$session,
$result->getValue()[5],
21137
);
return $sitelinksData;
}
/**
* Maps the feed attributes to the sitelink placeholders.
*/
private static function createSitelinksFeedMapping(
AdWordsServices $adWordsServices,
AdWordsSession $session,
array $sitelinksData
) {
$feedMappingService =
$adWordsServices->get($session, FeedMappingService::class);
// Map the feed attribute IDs to the field ID constants.
$linkTextFieldMapping = new AttributeFieldMapping();
$linkTextFieldMapping->setFeedAttributeId(
$sitelinksData['linkTextFeedAttributeId']
);
$linkTextFieldMapping->setFieldId(
self::PLACEHOLDER_FIELD_SITELINK_LINK_TEXT
);
$linkFinalUrlFieldMapping = new AttributeFieldMapping();
$linkFinalUrlFieldMapping->setFeedAttributeId(
$sitelinksData['linkFinalUrlFeedAttributeId']
);
$linkFinalUrlFieldMapping->setFieldId(
self::PLACEHOLDER_FIELD_SITELINK_FINAL_URL
);
$line2FieldMapping = new AttributeFieldMapping();
$line2FieldMapping->setFeedAttributeId(
$sitelinksData['line2FeedAttribute']
);
$line2FieldMapping->setFieldId(self::PLACEHOLDER_FIELD_LINE_2_TEXT);
$line3FieldMapping = new AttributeFieldMapping();
$line3FieldMapping->setFeedAttributeId(
$sitelinksData['line3FeedAttribute']
);
$line3FieldMapping->setFieldId(self::PLACEHOLDER_FIELD_LINE_3_TEXT);
// Create the feed mapping and feed mapping operation.
$feedMapping = new FeedMapping();
$feedMapping->setPlaceholderType(self::PLACEHOLDER_SITELINKS);
$feedMapping->setFeedId($sitelinksData['sitelinksFeedId']);
$feedMapping->setAttributeFieldMappings(
[
$linkTextFieldMapping,
$linkFinalUrlFieldMapping,
$line2FieldMapping,
$line3FieldMapping
]
);
$operation = new FeedMappingOperation();
$operation->setOperand($feedMapping);
$operation->setOperator(Operator::ADD);
// Create the feed mapping operation on the server and print out some
// information.
$result = $feedMappingService->mutate([$operation]);
foreach ($result->getValue() as $feedMapping) {
printf(
'Feed mapping with ID %d and placeholder type %d was '
. 'saved for feed with ID %d.%s',
$feedMapping->getFeedMappingId(),
$feedMapping->getPlaceholderType(),
$feedMapping->getFeedId(),
PHP_EOL
);
}
}
/**
* Creates the campaign feed associated to the populated feed data for the
* specified campaign ID.
*/
private static function createSitelinksCampaignFeed(
AdWordsServices $adWordsServices,
AdWordsSession $session,
array $sitelinksData,
$campaignId
) {
$campaignFeedService =
$adWordsServices->get($session, CampaignFeedService::class);
$matchingFunctionString = sprintf(
'AND( IN(FEED_ITEM_ID, {%s}), EQUALS(CONTEXT.DEVICE, "Mobile") )',
implode(',', $sitelinksData['sitelinkFeedItemIds'])
);
// Create a campaign feed and its feed function.
$campaignFeed = new CampaignFeed();
$campaignFeed->setFeedId($sitelinksData['sitelinksFeedId']);
$campaignFeed->setCampaignId($campaignId);
$matchingFunction = new MatchingFunction();
$matchingFunction->setFunctionString($matchingFunctionString);
$campaignFeed->setMatchingFunction($matchingFunction);
$campaignFeed->setPlaceholderTypes([self::PLACEHOLDER_SITELINKS]);
// Create the campaign feed operation.
$operation = new CampaignFeedOperation();
$operation->setOperand($campaignFeed);
$operation->setOperator(Operator::ADD);
// Create the campaign feed on the server and print out some information.
$result = $campaignFeedService->mutate([$operation]);
foreach ($result->getValue() as $savedCampaignFeed) {
printf(
'Campaign with ID %d was associated with feed with ID %d.%s',
$savedCampaignFeed->getCampaignId(),
$savedCampaignFeed->getFeedId(),
PHP_EOL
);
}
}
/**
* Creates feed item ad group target for a specified feed ID, feed item ID,
* and ad group ID.
*/
private static function restrictFeedItemToAdGroup(
AdWordsServices $adWordsServices,
AdWordsSession $session,
$feedId,
$feedItemId,
$adGroupId
) {
$feedItemTargetService = $adWordsServices->get(
$session,
FeedItemTargetService::class
);
// Create a feed item ad group target.
$feedItemAdGroupTarget = new FeedItemAdGroupTarget();
$feedItemAdGroupTarget->setFeedId($feedId);
$feedItemAdGroupTarget->setFeedItemId($feedItemId);
$feedItemAdGroupTarget->setAdGroupId($adGroupId);
// Create a feed item ad group target operation.
$operation = new FeedItemTargetOperation();
$operation->setOperand($feedItemAdGroupTarget);
$operation->setOperator(Operator::ADD);
// Create the feed item ad group target on the server and print out
// some information.
$result = $feedItemTargetService->mutate([$operation]);
$feedItemAdGroupTarget = $result->getValue()[0];
printf(
'Feed item target for feed ID %d and feed item ID %d was '
. 'created to restrict serving to ad group ID %d.%s',
$feedItemAdGroupTarget->getFeedId(),
$feedItemAdGroupTarget->getFeedItemId(),
$feedItemAdGroupTarget->getAdGroupId(),
PHP_EOL
);
}
/**
* Restricts the first feed item to only serve with ads for the specified
* location ID.
*
* @param AdWordsServices $adWordsServices the AdWords services
* @param AdWordsSession $session the AdWords session
* @param FeedItem $feedItem the feed item to restrict
* @param int $locationId the location ID to which the feed item will be
* restricted
*/
private static function restrictFeedItemToGeoTarget(
AdWordsServices $adWordsServices,
AdWordsSession $session,
FeedItem $feedItem,
$locationId
) {
$feedItemTargetService = $adWordsServices->get(
$session,
FeedItemTargetService::class
);
// Optional: Restrict the feed item to only serve with ads for the
// specified geo target.
$feedItemCriterionTarget = new FeedItemCriterionTarget();
$feedItemCriterionTarget->setFeedId($feedItem->getFeedId());
$feedItemCriterionTarget->setFeedItemId($feedItem->getFeedItemId());
$location = new Location();
// The IDs can be found in the documentation or retrieved with the
// LocationCriterionService.
$location->setId($locationId);
$feedItemCriterionTarget->setCriterion($location);
// Create a feed item target operation.
$operation = new FeedItemTargetOperation();
$operation->setOperand($feedItemCriterionTarget);
$operation->setOperator(Operator::ADD);
// Create the feed item target on the server and print out
// some information.
$result = $feedItemTargetService->mutate([$operation]);
$feedItemCriterionTarget = $result->getValue()[0];
printf(
'Feed item target for feed ID %d and feed item ID %d was '
. 'created to restrict serving to location ID %d.%s',
$feedItemCriterionTarget->getFeedId(),
$feedItemCriterionTarget->getFeedItemId(),
$feedItemCriterionTarget->getCriterion()->getId(),
PHP_EOL
);
}
/**
* Creates a site link feed item and wraps it in an ADD operation.
*
* @param array $sitelinksData IDs associated to created sitelinks feed
* metadata
* @param string $text the text of the sitelink
* @param string $finalUrl the final URL of the sitelink
* @param string $line2 the first line of the sitelink description
* @param string $line3 the second line of the sitelink description
* @param bool|null $restrictToLop whether to restrict the feed item to
* location of presence
* @return FeedItemOperation the created ADD operation of site link feed
* item
*/
private static function newSitelinkFeedItemAddOperation(
array $sitelinksData,
$text,
$finalUrl,
$line2,
$line3,
$restrictToLop = null
) {
// Create the feed item attribute values for our text values.
$linkTextAttributeValue = new FeedItemAttributeValue();
$linkTextAttributeValue->setFeedAttributeId(
$sitelinksData['linkTextFeedAttributeId']
);
$linkTextAttributeValue->setStringValue($text);
$linkFinalUrlAttributeValue = new FeedItemAttributeValue();
$linkFinalUrlAttributeValue->setFeedAttributeId(
$sitelinksData['linkFinalUrlFeedAttributeId']
);
$linkFinalUrlAttributeValue->setStringValues([$finalUrl]);
$line2AttributeValue = new FeedItemAttributeValue();
$line2AttributeValue->setFeedAttributeId(
$sitelinksData['line2FeedAttribute']
);
$line2AttributeValue->setStringValue($line2);
$line3AttributeValue = new FeedItemAttributeValue();
$line3AttributeValue->setFeedAttributeId(
$sitelinksData['line3FeedAttribute']
);
$line3AttributeValue->setStringValue($line3);
// Create the feed item.
$item = new FeedItem();
$item->setFeedId($sitelinksData['sitelinksFeedId']);
$item->setAttributeValues(
[
$linkTextAttributeValue,
$linkFinalUrlAttributeValue,
$line2AttributeValue,
$line3AttributeValue
]
);
// OPTIONAL: Restrict targeting only to people physically within the
// location.
if ($restrictToLop === true) {
$item->setGeoTargetingRestriction(
new FeedItemGeoRestriction(GeoRestriction::LOCATION_OF_PRESENCE)
);
}
// Create the feed item operation.
$operation = new FeedItemOperation();
$operation->setOperand($item);
$operation->setOperator(Operator::ADD);
return $operation;
}
public static function main()
{
// Generate a refreshable OAuth2 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build();
// Construct an API session configured from a properties file and the
// OAuth2 credentials above.
$session = (new AdWordsSessionBuilder())
->fromFile()
->withOAuth2Credential($oAuth2Credential)
->build();
self::runExample(
new AdWordsServices(),
$session,
intval(self::CAMPAIGN_ID),
self::AD_GROUP_ID === null ? null : intval(self::AD_GROUP_ID)
);
}
}
AddSitelinksUsingFeeds::main();