-
Notifications
You must be signed in to change notification settings - Fork 260
/
AddSmartCampaign.php
954 lines (893 loc) · 43.7 KB
/
AddSmartCampaign.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
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
<?php
/**
* 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
*
* https://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\Ads\GoogleAds\Examples\AdvancedOperations;
require __DIR__ . '/../../vendor/autoload.php';
use GetOpt\GetOpt;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentNames;
use Google\Ads\GoogleAds\Examples\Utils\ArgumentParser;
use Google\Ads\GoogleAds\Examples\Utils\Helper;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V9\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V9\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V9\GoogleAdsException;
use Google\Ads\GoogleAds\Util\FieldMasks;
use Google\Ads\GoogleAds\Util\V9\ResourceNames;
use Google\Ads\GoogleAds\V9\Common\AdScheduleInfo;
use Google\Ads\GoogleAds\V9\Common\AdTextAsset;
use Google\Ads\GoogleAds\V9\Common\KeywordThemeInfo;
use Google\Ads\GoogleAds\V9\Common\LocationInfo;
use Google\Ads\GoogleAds\V9\Common\SmartCampaignAdInfo;
use Google\Ads\GoogleAds\V9\Enums\AdGroupTypeEnum\AdGroupType;
use Google\Ads\GoogleAds\V9\Enums\AdTypeEnum\AdType;
use Google\Ads\GoogleAds\V9\Enums\AdvertisingChannelSubTypeEnum\AdvertisingChannelSubType;
use Google\Ads\GoogleAds\V9\Enums\AdvertisingChannelTypeEnum\AdvertisingChannelType;
use Google\Ads\GoogleAds\V9\Enums\BudgetTypeEnum\BudgetType;
use Google\Ads\GoogleAds\V9\Enums\CampaignStatusEnum\CampaignStatus;
use Google\Ads\GoogleAds\V9\Enums\DayOfWeekEnum\DayOfWeek;
use Google\Ads\GoogleAds\V9\Enums\MinuteOfHourEnum\MinuteOfHour;
use Google\Ads\GoogleAds\V9\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V9\Resources\Ad;
use Google\Ads\GoogleAds\V9\Resources\AdGroup;
use Google\Ads\GoogleAds\V9\Resources\AdGroupAd;
use Google\Ads\GoogleAds\V9\Resources\Campaign;
use Google\Ads\GoogleAds\V9\Resources\CampaignBudget;
use Google\Ads\GoogleAds\V9\Resources\CampaignCriterion;
use Google\Ads\GoogleAds\V9\Resources\KeywordThemeConstant;
use Google\Ads\GoogleAds\V9\Resources\SmartCampaignSetting;
use Google\Ads\GoogleAds\V9\Resources\SmartCampaignSetting\PhoneNumber;
use Google\Ads\GoogleAds\V9\Services\AdGroupAdOperation;
use Google\Ads\GoogleAds\V9\Services\AdGroupOperation;
use Google\Ads\GoogleAds\V9\Services\CampaignBudgetOperation;
use Google\Ads\GoogleAds\V9\Services\CampaignCriterionOperation;
use Google\Ads\GoogleAds\V9\Services\CampaignOperation;
use Google\Ads\GoogleAds\V9\Services\MutateGoogleAdsResponse;
use Google\Ads\GoogleAds\V9\Services\MutateOperation;
use Google\Ads\GoogleAds\V9\Services\MutateOperationResponse;
use Google\Ads\GoogleAds\V9\Services\SmartCampaignSettingOperation;
use Google\Ads\GoogleAds\V9\Services\SmartCampaignSuggestionInfo;
use Google\Ads\GoogleAds\V9\Services\SmartCampaignSuggestionInfo\BusinessContext;
use Google\Ads\GoogleAds\V9\Services\SmartCampaignSuggestionInfo\LocationList;
use Google\Ads\GoogleAds\V9\Services\SuggestSmartCampaignBudgetOptionsRequest\SuggestionDataOneof;
use Google\ApiCore\ApiException;
use InvalidArgumentException;
/**
* This example adds a Smart campaign.
*
* More details on Smart campaigns can be found here:
* https://support.google.com/google-ads/answer/7652860
*/
class AddSmartCampaign
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
// Optional: Specify a keyword text used to retrieve keyword theme constant suggestions from the
// KeywordThemeConstantService. These keyword theme suggestions are generated using
// auto-completion data for the given text and may help improve the performance of the Smart
// campaign.
private const KEYWORD_TEXT = null;
// Optional: A keyword text used to create a freeform keyword theme, which is entirely
// user-specified and not derived from any suggestion service. Using free-form keyword themes is
// typically not recommended because they are less effective than suggested keyword themes,
// however they are useful in situations where a very specific term needs to be targeted.
private const FREEFORM_KEYWORD_TEXT = null;
// Optional: Specify the ID of a Google My Business (GMB) location. This is required if a
// business name is not provided. It can be retrieved using the GMB API, see:
// https://developers.google.com/my-business/reference/rest/v4/accounts.locations.
private const BUSINESS_LOCATION_ID = null;
// Optional: Specify the name of a Google My Business (GMB) business. This is required if a
// business location ID is not provided.
private const BUSINESS_NAME = null;
// Geo target constant for New York City.
private const GEO_TARGET_CONSTANT = '1023191';
// Country code is a two-letter ISO-3166 code, for a list of all codes see:
// https://developers.google.com/google-ads/api/reference/data/codes-formats#expandable-16
private const COUNTRY_CODE = 'US';
// For a list of all language codes, see:
// https://developers.google.com/google-ads/api/reference/data/codes-formats#expandable-7
private const LANGUAGE_CODE = 'en';
private const LANDING_PAGE_URL = 'http://www.example.com';
private const PHONE_NUMBER = '555-555-5555';
private const BUDGET_TEMPORARY_ID = '-1';
private const SMART_CAMPAIGN_TEMPORARY_ID = '-2';
private const AD_GROUP_TEMPORARY_ID = '-3';
// These define the minimum number of headlines and descriptions that are
// required to create an ad group ad in a Smart campaign.
private const NUM_REQUIRED_HEADLINES = 3;
private const NUM_REQUIRED_DESCRIPTIONS = 2;
private const UNSIGNED_64_BIT_RANGE_CEILING = 2 ** 64;
public static function main()
{
// Either pass the required parameters for this example on the command line, or insert them
// into the constants above.
$options = (new ArgumentParser())->parseCommandArguments([
ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::KEYWORD_TEXT => GetOpt::OPTIONAL_ARGUMENT,
ArgumentNames::FREEFORM_KEYWORD_TEXT => GetOpt::OPTIONAL_ARGUMENT,
ArgumentNames::BUSINESS_LOCATION_ID => GetOpt::OPTIONAL_ARGUMENT,
ArgumentNames::BUSINESS_NAME => GetOpt::OPTIONAL_ARGUMENT
]);
$businessLocationId =
$options[ArgumentNames::BUSINESS_LOCATION_ID] ?: self::BUSINESS_LOCATION_ID;
$businessName = $options[ArgumentNames::BUSINESS_NAME] ?: self::BUSINESS_NAME;
if ($businessLocationId && $businessName) {
throw new InvalidArgumentException(
'Both the business location ID and business name are provided but they are '
. 'mutually exclusive. Please only set a value for one of them.'
);
}
if (!$businessLocationId && !$businessName) {
throw new InvalidArgumentException(
'Neither the business location ID nor the business name are provided. Please set '
. 'a value for one of them.'
);
}
// Generate a refreshable OAuth2 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build();
// Construct a Google Ads client configured from a properties file and the
// OAuth2 credentials above.
$googleAdsClient = (new GoogleAdsClientBuilder())
->fromFile()
->withOAuth2Credential($oAuth2Credential)
->build();
try {
self::runExample(
$googleAdsClient,
$options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID,
$options[ArgumentNames::KEYWORD_TEXT] ?: self::KEYWORD_TEXT,
$options[ArgumentNames::FREEFORM_KEYWORD_TEXT] ?: self::FREEFORM_KEYWORD_TEXT,
$businessLocationId,
$businessName
);
} catch (GoogleAdsException $googleAdsException) {
printf(
"Request with ID '%s' has failed.%sGoogle Ads failure details:%s",
$googleAdsException->getRequestId(),
PHP_EOL,
PHP_EOL
);
foreach ($googleAdsException->getGoogleAdsFailure()->getErrors() as $error) {
/** @var GoogleAdsError $error */
printf(
"\t%s: %s%s",
$error->getErrorCode()->getErrorCode(),
$error->getMessage(),
PHP_EOL
);
}
exit(1);
} catch (ApiException $apiException) {
printf(
"ApiException was thrown with message '%s'.%s",
$apiException->getMessage(),
PHP_EOL
);
exit(1);
}
}
/**
* Runs the example.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param string|null $keywordText a keyword text used for generating keyword themes
* @param string|null $freeformKeywordText a keyword used to create a free-form keyword theme
* @param string|null $businessLocationId the ID of a Google My Business location
* @param string|null $businessName the name of a Google My Business
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
?string $keywordText,
?string $freeformKeywordText,
?string $businessLocationId,
?string $businessName
) {
// [START add_smart_campaign_12]
// Gets the SmartCampaignSuggestionInfo object which acts as the basis for many of the
// entities necessary to create a Smart campaign. It will be reused a number of times to
// retrieve suggestions for keyword themes, budget amount, ads, and campaign criteria.
$suggestionInfo = self::getSmartCampaignSuggestionInfo($businessLocationId, $businessName);
// Generates a list of keyword themes using the SuggestKeywordThemes method on the
// SmartCampaignSuggestService. It is strongly recommended that you use this strategy for
// generating keyword themes.
$keywordThemeConstants =
self::getKeywordThemeSuggestions($googleAdsClient, $customerId, $suggestionInfo);
// Optionally retrieves auto-complete suggestions for the given keyword text and adds them
// to the list of keyword themes.
if (!empty($keywordText)) {
$keywordThemeConstants = array_merge(
$keywordThemeConstants,
self::getKeywordTextAutoCompletions($googleAdsClient, $keywordText)
);
}
// Maps the list of KeywordThemeConstants to KeywordThemeInfos.
$keywordThemeInfos = array_map(function (KeywordThemeConstant $constant) {
return new KeywordThemeInfo([
'keyword_theme_constant' => $constant->getResourceName()
]);
}, $keywordThemeConstants);
// [START add_smart_campaign_13]
// Optionally includes any freeform keywords in verbatim.
if (!empty($freeformKeywordText)) {
$keywordThemeInfos[] =
new KeywordThemeInfo(['free_form_keyword_theme' => $freeformKeywordText]);
}
// [END add_smart_campaign_13]
// Includes the keyword suggestions in the overall SuggestionInfo object.
$suggestionInfo = $suggestionInfo->setKeywordThemes($keywordThemeInfos);
// [END add_smart_campaign_12]
$suggestedBudgetAmount = self::getBudgetSuggestion(
$googleAdsClient,
$customerId,
$suggestionInfo
);
$adSuggestions = self::getAdSuggestions($googleAdsClient, $customerId, $suggestionInfo);
// [START add_smart_campaign_7]
// The below methods create and return MutateOperations that we later provide to the
// GoogleAdsService.Mutate method in order to create the entities in a single request.
// Since the entities for a Smart campaign are closely tied to one-another it's considered
// a best practice to create them in a single Mutate request so they all complete
// successfully or fail entirely, leaving no orphaned entities.
// See: https://developers.google.com/google-ads/api/docs/mutating/overview.
$campaignBudgetOperation = self::createCampaignBudgetOperation(
$customerId,
$suggestedBudgetAmount
);
$smartCampaignOperation = self::createSmartCampaignOperation($customerId);
$smartCampaignSettingOperation = self::createSmartCampaignSettingOperation(
$customerId,
$businessLocationId,
$businessName
);
$campaignCriterionOperations = self::createCampaignCriterionOperations(
$customerId,
$keywordThemeInfos,
$suggestionInfo
);
$adGroupOperation = self::createAdGroupOperation($customerId);
$adGroupAdOperation = self::createAdGroupAdOperation($customerId, $adSuggestions);
// Issues a single mutate request to add the entities.
$googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
$response = $googleAdsServiceClient->mutate(
$customerId,
// It's important to create these entities in this order because they depend on
// each other, for example the SmartCampaignSetting and ad group depend on the
// campaign, and the ad group ad depends on the ad group.
array_merge(
[
$campaignBudgetOperation,
$smartCampaignOperation,
$smartCampaignSettingOperation,
],
$campaignCriterionOperations,
[
$adGroupOperation,
$adGroupAdOperation
]
)
);
self::printResponseDetails($response);
}
// [END add_smart_campaign_7]
/**
* Retrieves KeywordThemeConstants using the given suggestion info.
*
* Here we use the SuggestKeywordThemes method, which uses all of the business details included
* in the given SmartCampaignSuggestionInfo instance to generate keyword theme suggestions. This
* is the recommended way to generate keyword themes because it uses detailed information about
* your business, its location, and website content to generate keyword themes.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param SmartCampaignSuggestionInfo $suggestionInfo instance with details
* about the business being advertised
* @return KeywordThemeConstant[] a list of KeywordThemeConstants
*/
// [START add_smart_campaign_11]
private static function getKeywordThemeSuggestions(
GoogleAdsClient $googleAdsClient,
int $customerId,
SmartCampaignSuggestionInfo $suggestionInfo
): array {
$smartCampaignSuggestServiceClient =
$googleAdsClient->getSmartCampaignSuggestServiceClient();
// Issues a request to retrieve the keyword theme constants.
$response =
$smartCampaignSuggestServiceClient->suggestKeywordThemes($customerId, $suggestionInfo);
printf(
"Retrieved %d keyword theme constant suggestions from the SuggestKeywordThemes "
. "method.%s",
$response->getKeywordThemes()->count(),
PHP_EOL
);
return iterator_to_array($response->getKeywordThemes()->getIterator());
}
// [END add_smart_campaign_11]
/**
* Retrieves KeywordThemeConstants that are derived from autocomplete data for the given keyword
* text.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param string $keywordText a keyword text used for generating keyword themes
* @return KeywordThemeConstant[] a list of KeywordThemeConstants
*/
// [START add_smart_campaign]
private static function getKeywordTextAutoCompletions(
GoogleAdsClient $googleAdsClient,
string $keywordText
): array {
$keywordThemeConstantService = $googleAdsClient->getKeywordThemeConstantServiceClient();
// Issues a request to retrieve the keyword theme constants.
$response = $keywordThemeConstantService->suggestKeywordThemeConstants([
'queryText' => $keywordText,
'countryCode' => self::COUNTRY_CODE,
'languageCode' => self::LANGUAGE_CODE
]);
printf(
"Retrieved %d keyword theme constants using the keyword: '%s'.%s",
$response->getKeywordThemeConstants()->count(),
$keywordText,
PHP_EOL
);
return iterator_to_array($response->getKeywordThemeConstants()->getIterator());
}
// [END add_smart_campaign]
/**
* Builds a SmartCampaignSuggestionInfo object with business details.
*
* The details are used by the SmartCampaignSuggestService to suggest a budget amount as well
* as creatives for the ad.
*
* Note that when retrieving ad creative suggestions it's required that the "final_url",
* "language_code" and "keyword_themes" fields are set on the SmartCampaignSuggestionInfo
* instance.
*
* @param string|null $businessLocationId the ID of a Google My Business location
* @param string|null $businessName the name of a Google My Business
* @return SmartCampaignSuggestionInfo a SmartCampaignSuggestionInfo instance
*/
// [START add_smart_campaign_9]
private static function getSmartCampaignSuggestionInfo(
?string $businessLocationId,
?string $businessName
): SmartCampaignSuggestionInfo {
$suggestionInfo = new SmartCampaignSuggestionInfo([
// Adds the URL of the campaign's landing page.
'final_url' => self::LANDING_PAGE_URL,
// Adds the language code for the campaign.
'language_code' => self::LANGUAGE_CODE,
// Constructs location information using the given geo target constant. It's also
// possible to provide a geographic proximity using the "proximity" field,
// for example:
//
// 'proximity' => new ProximityInfo([
// 'address' => mew AddressInfo([
// 'post_code' => INSERT_POSTAL_CODE,
// 'province_code' => INSERT_PROVINCE_CODE,
// 'country_code' => INSERT_COUNTRY_CODE,
// 'province_name' => INSERT_PROVINCE_NAME,
// 'street_address' => INSERT_STREET_ADDRESS,
// 'street_address2' => INSERT_STREET_ADDRESS_2,
// 'city_name' => INSERT_CITY_NAME
// ]),
// 'radius' => INSERT_RADIUS,
// 'radius_units' => INSERT_RADIUS_UNITS
// ])
//
// For more information on proximities see:
// https://developers.google.com/google-ads/api/reference/rpc/latest/ProximityInfo
// Adds LocationInfo objects to the list of locations. You have the option of
// providing multiple locations when using location-based suggestions.
'location_list' => new LocationList([
// Sets one location to the resource name of the given geo target constant.
'locations' => [new LocationInfo([
'geo_target_constant' => ResourceNames::forGeoTargetConstant(
self::GEO_TARGET_CONSTANT
)
])]
]),
// Adds a schedule detailing which days of the week the business is open.
// This schedule describes a schedule in which the business is open on
// Mondays from 9am to 5pm.
'ad_schedules' => [new AdScheduleInfo([
// Sets the day of this schedule as Monday.
'day_of_week' => DayOfWeek::MONDAY,
// Sets the start hour to 9am.
'start_hour' => 9,
// Sets the end hour to 5pm.
'end_hour' => 17,
// Sets the start and end minute of zero, for example: 9:00 and 5:00.
'start_minute' => MinuteOfHour::ZERO,
'end_minute' => MinuteOfHour::ZERO
])]
]);
// Sets either of the business_location_id or business_name, depending on whichever is
// provided.
if ($businessLocationId) {
$suggestionInfo->setBusinessLocationId(
self::convertBusinessLocationId($businessLocationId)
);
} else {
$suggestionInfo->setBusinessContext(new BusinessContext([
'business_name' => $businessName
]));
}
return $suggestionInfo;
}
// [END add_smart_campaign_9]
/**
* Retrieves a suggested budget amount for a new budget.
*
* Using the SmartCampaignSuggestService to determine a daily budget for new and existing
* Smart campaigns is highly recommended because it helps the campaigns achieve optimal
* performance.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param SmartCampaignSuggestionInfo $suggestionInfo a SmartCampaignSuggestionInfo instance
* with details about the business being advertised
* @return int a daily budget amount in micros
*/
// [START add_smart_campaign_1]
private static function getBudgetSuggestion(
GoogleAdsClient $googleAdsClient,
int $customerId,
SmartCampaignSuggestionInfo $suggestionInfo
): int {
$suggestionData = new SuggestionDataOneof();
// You can retrieve suggestions for an existing campaign by setting the "campaign"
// field equal to the resource name of a campaign:
// $suggestionData->setCampaign('INSERT_CAMPAIGN_RESOURCE_NAME_HERE');
// Since these suggestions are for a new campaign, we're going to use the
// suggestion_info field instead.
$suggestionData->setSuggestionInfo($suggestionInfo);
// Issues a request to retrieve a budget suggestion.
$smartCampaignSuggestService = $googleAdsClient->getSmartCampaignSuggestServiceClient();
$response = $smartCampaignSuggestService->suggestSmartCampaignBudgetOptions(
$customerId,
$suggestionData
);
// Three tiers of options will be returned, a "low", "high" and "recommended". Here we will
// use the "recommended" option. The amount is specified in micros, where one million is
// equivalent to one currency unit.
$recommendation = $response->getRecommended();
printf(
"A daily budget amount of %d micros was suggested, garnering an estimated minimum of "
. "%d clicks and an estimated maximum of %d per day.%s",
$recommendation->getDailyAmountMicros(),
$recommendation->getMetrics()->getMinDailyClicks(),
$recommendation->getMetrics()->getMaxDailyClicks(),
PHP_EOL
);
return $recommendation->getDailyAmountMicros();
}
// [END add_smart_campaign_1]
/**
* Retrieves creative suggestions for a Smart campaign ad.
*
* Using the SmartCampaignSuggestService to suggest creatives for new and existing Smart
* campaigns is highly recommended because it helps the campaigns achieve optimal performance.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param SmartCampaignSuggestionInfo $suggestionInfo a SmartCampaignSuggestionInfo instance
* with details about the business being advertised
* @return SmartCampaignAdInfo|null a SmartCampaignAdInfo instance with suggested headlines and
* descriptions
*/
// [START add_smart_campaign_10]
private static function getAdSuggestions(
GoogleAdsClient $googleAdsClient,
int $customerId,
SmartCampaignSuggestionInfo $suggestionInfo
) {
// Unlike the SuggestSmartCampaignBudgetOptions method, it's only possible to use
// suggestion_info to retrieve ad creative suggestions.
// Issues a request to retrieve ad creative suggestions.
$smartCampaignSuggestService = $googleAdsClient->getSmartCampaignSuggestServiceClient();
$response = $smartCampaignSuggestService->suggestSmartCampaignAd(
$customerId,
$suggestionInfo
);
// The SmartCampaignAdInfo object in the response contains a list of up to three headlines
// and two descriptions. Note that some of the suggestions may have empty strings as text.
// Before setting these on the ad you should review them and filter out any empty values.
$adSuggestions = $response->getAdInfo();
if (is_null($adSuggestions)) {
return null;
}
print 'The following headlines were suggested:' . PHP_EOL;
foreach ($adSuggestions->getHeadlines() as $headline) {
print "\t" . ($headline->getText() ?: 'None') . PHP_EOL;
}
print 'And the following descriptions were suggested:' . PHP_EOL;
foreach ($adSuggestions->getDescriptions() as $description) {
print "\t" . ($description->getText() ?: 'None') . PHP_EOL;
}
return $adSuggestions;
}
// [END add_smart_campaign_10]
/**
* Creates a MutateOperation that creates a new CampaignBudget.
*
* A temporary ID will be assigned to this campaign budget so that it can be referenced by
* other objects being created in the same Mutate request.
*
* @param int $customerId the customer ID
* @param int $suggestedBudgetAmount a daily budget amount in micros
* @return MutateOperation a MutateOperation that creates a CampaignBudget
*/
// [START add_smart_campaign_2]
private static function createCampaignBudgetOperation(
int $customerId,
int $suggestedBudgetAmount
): MutateOperation {
// Creates the campaign budget object.
$campaignBudget = new CampaignBudget([
'name' => "Smart campaign budget #" . Helper::getPrintableDatetime(),
// A budget used for Smart campaigns must have the type SMART_CAMPAIGN.
'type' => BudgetType::SMART_CAMPAIGN,
// The suggested budget amount from the SmartCampaignSuggestService is a daily budget.
// We don't need to specify that here, because the budget period already defaults to
// DAILY.
'amount_micros' => $suggestedBudgetAmount,
// Sets a temporary ID in the budget's resource name so it can be referenced by the
// campaign in later steps.
'resource_name' =>
ResourceNames::forCampaignBudget($customerId, self::BUDGET_TEMPORARY_ID)
]);
// Creates the MutateOperation that creates the campaign budget.
return new MutateOperation([
'campaign_budget_operation' => new CampaignBudgetOperation([
'create' => $campaignBudget
])
]);
}
// [END add_smart_campaign_2]
/**
* Creates a MutateOperation that creates a new Smart campaign.
*
* A temporary ID will be assigned to this campaign so that it can be referenced by other
* objects being created in the same Mutate request.
*
* @param int $customerId the customer ID
* @return MutateOperation a MutateOperation that creates a campaign
*/
// [START add_smart_campaign_3]
private static function createSmartCampaignOperation(int $customerId): MutateOperation
{
// Creates the campaign object.
$campaign = new Campaign([
'name' => "Smart campaign #" . Helper::getPrintableDatetime(),
// Sets the campaign status as PAUSED. The campaign is the only entity in the mutate
// request that should have its' status set.
'status' => CampaignStatus::PAUSED,
// The advertising channel type is required to be SMART.
'advertising_channel_type' => AdvertisingChannelType::SMART,
// The advertising channel sub type is required to be SMART_CAMPAIGN.
'advertising_channel_sub_type' => AdvertisingChannelSubType::SMART_CAMPAIGN,
// Assigns the resource name with a temporary ID.
'resource_name' =>
ResourceNames::forCampaign($customerId, self::SMART_CAMPAIGN_TEMPORARY_ID),
// Sets the budget using the given budget resource name.
'campaign_budget' =>
ResourceNames::forCampaignBudget($customerId, self::BUDGET_TEMPORARY_ID)
]);
// Creates the MutateOperation that creates the campaign.
return new MutateOperation([
'campaign_operation' => new CampaignOperation(['create' => $campaign])
]);
}
// [END add_smart_campaign_3]
/**
* Creates a MutateOperation to create a new SmartCampaignSetting.
*
* SmartCampaignSettings are unique in that they only support UPDATE operations, which are
* used to update and create them. Below we will use a temporary ID in the resource name to
* associate it with the campaign created in the previous step.
*
* @param int $customerId the customer ID
* @param string|null $businessLocationId the ID of a Google My Business location
* @param string|null $businessName the name of a Google My Business
* @return MutateOperation a MutateOperation that creates a SmartCampaignSetting
*/
// [START add_smart_campaign_4]
private static function createSmartCampaignSettingOperation(
int $customerId,
?string $businessLocationId,
?string $businessName
): MutateOperation {
// Creates the smart campaign setting object.
$smartCampaignSetting = new SmartCampaignSetting([
// Sets a temporary ID in the campaign setting's resource name to associate it with
// the campaign created in the previous step.
'resource_name' => ResourceNames::forSmartCampaignSetting(
$customerId,
self::SMART_CAMPAIGN_TEMPORARY_ID
),
// Below we configure the SmartCampaignSetting using many of the same details used to
// generate a budget suggestion.
'phone_number' => new PhoneNumber([
'country_code' => self::COUNTRY_CODE,
'phone_number' => self::PHONE_NUMBER
]),
'final_url' => self::LANDING_PAGE_URL,
'advertising_language_code' => self::LANGUAGE_CODE,
]);
// It's required that either a business location ID or a business name is added to the
// SmartCampaignSetting.
if ($businessLocationId) {
$smartCampaignSetting->setBusinessLocationId(
self::convertBusinessLocationId($businessLocationId)
);
} else {
$smartCampaignSetting->setBusinessName($businessName);
}
// Creates the MutateOperation that creates the smart campaign setting with an update.
return new MutateOperation([
'smart_campaign_setting_operation' => new SmartCampaignSettingOperation([
'update' => $smartCampaignSetting,
// Sets the update mask on the operation. This is required since the smart campaign
// setting is created in an UPDATE operation. Here the update mask will be a list
// of all the fields that were set on the SmartCampaignSetting.
'update_mask' => FieldMasks::allSetFieldsOf($smartCampaignSetting)
])
]);
}
// [END add_smart_campaign_4]
/**
* Creates a list of MutateOperations that create new campaign criteria.
*
* @param int $customerId the customer ID
* @param KeywordThemeInfo[] $keywordThemeInfos a list of KeywordThemeInfos
* @param SmartCampaignSuggestionInfo $smartCampaignSuggestionInfo a SmartCampaignSuggestionInfo
* instance
* @return MutateOperation[] a list of MutateOperations that create new campaign criteria
*/
// [START add_smart_campaign_8]
private static function createCampaignCriterionOperations(
int $customerId,
array $keywordThemeInfos,
SmartCampaignSuggestionInfo $smartCampaignSuggestionInfo
): array {
$operations = [];
foreach ($keywordThemeInfos as $info) {
// Creates the campaign criterion object.
$campaignCriterion = new CampaignCriterion([
// Sets the campaign ID to a temporary ID.
'campaign' =>
ResourceNames::forCampaign($customerId, self::SMART_CAMPAIGN_TEMPORARY_ID),
// Sets the keyword theme to the given KeywordThemeInfo.
'keyword_theme' => $info
]);
// Creates the MutateOperation that creates the campaign criterion and adds it to the
// list of operations.
$operations[] = new MutateOperation([
'campaign_criterion_operation' => new CampaignCriterionOperation([
'create' => $campaignCriterion
])
]);
}
// Create a location criterion for each location in the suggestion info object to add
// corresponding location targeting to the Smart campaign.
foreach ($smartCampaignSuggestionInfo->getLocationList()->getLocations() as $location) {
// Creates the campaign criterion object.
$campaignCriterion = new CampaignCriterion([
// Sets the campaign ID to a temporary ID.
'campaign' =>
ResourceNames::forCampaign($customerId, self::SMART_CAMPAIGN_TEMPORARY_ID),
// Set the location to the given location.
'location' => $location
]);
// Creates the MutateOperation that creates the campaign criterion and adds it to the
// list of operations.
$operations[] = new MutateOperation([
'campaign_criterion_operation' => new CampaignCriterionOperation([
'create' => $campaignCriterion
])
]);
}
return $operations;
}
// [END add_smart_campaign_8]
/**
* Creates a MutateOperation that creates a new ad group.
*
* A temporary ID will be used in the campaign resource name for this ad group to associate
* it with the Smart campaign created in earlier steps. A temporary ID will also be used for
* its own resource name so that we can associate an ad group ad with it later in the process.
*
* Only one ad group can be created for a given Smart campaign.
*
* @param int $customerId the customer ID
* @return MutateOperation a MutateOperation that creates a new ad group
*/
// [START add_smart_campaign_5]
private static function createAdGroupOperation(int $customerId): MutateOperation
{
// Creates the ad group object.
$adGroup = new AdGroup([
// Sets the ad group ID to a temporary ID.
'resource_name' => ResourceNames::forAdGroup($customerId, self::AD_GROUP_TEMPORARY_ID),
'name' => "Smart campaign ad group #" . Helper::getPrintableDatetime(),
// Sets the campaign ID to a temporary ID.
'campaign' =>
ResourceNames::forCampaign($customerId, self::SMART_CAMPAIGN_TEMPORARY_ID),
// The ad group type must be set to SMART_CAMPAIGN_ADS.
'type' => AdGroupType::SMART_CAMPAIGN_ADS
]);
// Creates the MutateOperation that creates the ad group.
return new MutateOperation([
'ad_group_operation' => new AdGroupOperation(['create' => $adGroup])
]);
}
// [END add_smart_campaign_5]
/**
* Creates a MutateOperation that creates a new ad group ad.
*
* A temporary ID will be used in the ad group resource name for this ad group ad to associate
* it with the ad group created in earlier steps.
*
* @param int $customerId the customer ID
* @param SmartCampaignAdInfo|null $adSuggestions a SmartCampaignAdInfo object with ad creative
* suggestions
* @return MutateOperation a MutateOperation that creates a new ad group ad
*/
// [START add_smart_campaign_6]
private static function createAdGroupAdOperation(
int $customerId,
?SmartCampaignAdInfo $adSuggestions
): MutateOperation {
if (is_null($adSuggestions)) {
$smartCampaignAdInfo = new SmartCampaignAdInfo();
} else {
// The SmartCampaignAdInfo object includes headlines and descriptions retrieved
// from the SmartCampaignSuggestService::SuggestSmartCampaignAd method. It's
// recommended that users review and approve or update these creatives before
// they're set on the ad. It's possible that some or all of these assets may
// contain empty texts, which should not be set on the ad and instead should be
// replaced with meaningful texts from the user. Below we just accept the creatives
// that were suggested while filtering out empty assets, but individual workflows
// will vary here.
$smartCampaignAdInfo = new SmartCampaignAdInfo([
'headlines' => array_filter(
iterator_to_array($adSuggestions->getHeadlines()->getIterator()),
function ($value) {
return $value->getText();
}
),
'descriptions' => array_filter(
iterator_to_array($adSuggestions->getDescriptions()->getIterator()),
function ($value) {
return $value->getText();
}
)
]);
}
// Creates the ad group ad object.
$adGroupAd = new AdGroupAd([
// Sets the ad group ID to a temporary ID.
'ad_group' => ResourceNames::forAdGroup($customerId, self::AD_GROUP_TEMPORARY_ID),
'ad' => new Ad([
// Sets the type to SMART_CAMPAIGN_AD.
'type' => AdType::SMART_CAMPAIGN_AD,
'smart_campaign_ad' => $smartCampaignAdInfo
])
]);
// The SmartCampaignAdInfo object includes headlines and descriptions retrieved from the
// SmartCampaignSuggestService.SuggestSmartCampaignAd method. It's recommended that users
// review and approve or update these ads before they're set on the ad. It's possible that
// some or all of these assets may contain empty texts, which should not be set on the ad
// and instead should be replaced with meaningful texts from the user.
// Below we just accept the ads that were suggested while filtering out empty assets.
// If no headlines or descriptions were suggested, then we manually add some, otherwise
// this operation will generate an INVALID_ARGUMENT error. Individual workflows will likely
// vary here.
$currentHeadlinesCount = $smartCampaignAdInfo->getHeadlines()->count();
for ($i = 0; $i < self::NUM_REQUIRED_HEADLINES - $currentHeadlinesCount; $i++) {
$smartCampaignAdInfo->setHeadlines(
array_merge(
iterator_to_array($smartCampaignAdInfo->getHeadlines()),
[new AdTextAsset(['text' => 'Placeholder headline ' . $i])]
)
);
}
$currentDescriptionsCount = $smartCampaignAdInfo->getDescriptions()->count();
for ($i = 0; $i < self::NUM_REQUIRED_DESCRIPTIONS - $currentDescriptionsCount; $i++) {
$smartCampaignAdInfo->setDescriptions(
array_merge(
iterator_to_array($smartCampaignAdInfo->getDescriptions()),
[new AdTextAsset(['text' => 'Placeholder description ' . $i])]
)
);
}
// Creates the MutateOperation that creates the ad group ad.
return new MutateOperation([
'ad_group_ad_operation' => new AdGroupAdOperation(['create' => $adGroupAd])
]);
}
// [END add_smart_campaign_6]
/**
* Prints the details of a MutateGoogleAdsResponse.
*
* It only covers the expected types of operation result.
*
* @param MutateGoogleAdsResponse $response a MutateGoogleAdsResponse object
*/
private static function printResponseDetails(MutateGoogleAdsResponse $response)
{
// Parses the Mutate response to print details about the entities that were created by the
// request.
/** @var MutateOperationResponse $result */
foreach ($response->getMutateOperationResponses() as $result) {
$resourceType = "unrecognized";
$resourceName = "not found";
if ($result->hasCampaignBudgetResult()) {
$resourceType = "CampaignBudget";
$resourceName = $result->getCampaignBudgetResult()->getResourceName();
} elseif ($result->hasCampaignResult()) {
$resourceType = "Campaign";
$resourceName = $result->getCampaignResult()->getResourceName();
} elseif ($result->hasSmartCampaignSettingResult()) {
$resourceType = "SmartCampaignSetting";
$resourceName = $result->getSmartCampaignSettingResult()->getResourceName();
} elseif ($result->getAdGroupResult()) {
$resourceType = "AdGroup";
$resourceName = $result->getAdGroupResult()->getResourceName();
} elseif ($result->getAdGroupAdResult()) {
$resourceType = "AdGroupAd";
$resourceName = $result->getAdGroupAdResult()->getResourceName();
} elseif ($result->getCampaignCriterionResult()) {
$resourceType = "CampaignCriterion";
$resourceName = $result->getCampaignCriterionResult()->getResourceName();
}
printf(
"Created a(n) '%s' entity with resource_name: '%s'.%s",
$resourceType,
$resourceName,
PHP_EOL
);
}
}
/**
* Converts a business location ID to a signed 64 bit integer.
*
* A Google My business location ID may be outside of the range for a signed 64 bit integer
* (>= 2^63), which will cause an error to be thrown when it's set to the 'business_location_id'
* field on a SmartCampaignSuggestionInfo or SmartCampaignSetting instance.
* As PHP supports only signed integers, this method passes the specified parameter to intval(),
* which will automatically convert the value into a signed integer.
*
* If the specified value is greater than 64 bits, an error will be thrown.
*
* @param float $businessLocationId the ID of a Google My Business location
* @return int the converted business location ID in signed 64 bit
*/
// [START add_smart_campaign_14]
private static function convertBusinessLocationId(float $businessLocationId)
{
if ($businessLocationId >= self::UNSIGNED_64_BIT_RANGE_CEILING) {
// If the business location ID is outside of 64 bit range it can't be converted to a
// signed 64 bit integer and is invalid.
throw new InvalidArgumentException(
'The given business_location_id is outside of the range for a 64 bit integer'
);
}
return intval($businessLocationId);
}
// [END add_smart_campaign_14]
}
AddSmartCampaign::main();