-
Notifications
You must be signed in to change notification settings - Fork 260
/
AddShoppingSmartAd.php
429 lines (390 loc) · 18.7 KB
/
AddShoppingSmartAd.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
<?php
/**
* Copyright 2019 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\ShoppingAds;
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\Lib\V3\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V3\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V3\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\V3\Common\ListingGroupInfo;
use Google\Ads\GoogleAds\V3\Common\MaximizeConversionValue;
use Google\Ads\GoogleAds\V3\Common\ShoppingSmartAdInfo;
use Google\Ads\GoogleAds\V3\Enums\AdGroupAdStatusEnum\AdGroupAdStatus;
use Google\Ads\GoogleAds\V3\Enums\AdGroupStatusEnum\AdGroupStatus;
use Google\Ads\GoogleAds\V3\Enums\AdGroupTypeEnum\AdGroupType;
use Google\Ads\GoogleAds\V3\Enums\AdvertisingChannelSubTypeEnum\AdvertisingChannelSubType;
use Google\Ads\GoogleAds\V3\Enums\AdvertisingChannelTypeEnum\AdvertisingChannelType;
use Google\Ads\GoogleAds\V3\Enums\BudgetDeliveryMethodEnum\BudgetDeliveryMethod;
use Google\Ads\GoogleAds\V3\Enums\CampaignStatusEnum\CampaignStatus;
use Google\Ads\GoogleAds\V3\Enums\ListingGroupTypeEnum\ListingGroupType;
use Google\Ads\GoogleAds\V3\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V3\Resources\Ad;
use Google\Ads\GoogleAds\V3\Resources\AdGroup;
use Google\Ads\GoogleAds\V3\Resources\AdGroupAd;
use Google\Ads\GoogleAds\V3\Resources\AdGroupCriterion;
use Google\Ads\GoogleAds\V3\Resources\Campaign;
use Google\Ads\GoogleAds\V3\Resources\Campaign\ShoppingSetting;
use Google\Ads\GoogleAds\V3\Resources\CampaignBudget;
use Google\Ads\GoogleAds\V3\Services\AdGroupAdOperation;
use Google\Ads\GoogleAds\V3\Services\AdGroupCriterionOperation;
use Google\Ads\GoogleAds\V3\Services\AdGroupOperation;
use Google\Ads\GoogleAds\V3\Services\CampaignBudgetOperation;
use Google\Ads\GoogleAds\V3\Services\CampaignOperation;
use Google\ApiCore\ApiException;
use Google\Protobuf\BoolValue;
use Google\Protobuf\DoubleValue;
use Google\Protobuf\Int64Value;
use Google\Protobuf\StringValue;
/**
* This example creates a Smart Shopping campaign, a Smart Shopping ad group, a Smart Shopping ad
* group ad and a listing group for "All products".
*
* Prerequisites
* - You need to have access to a Merchant Center account. You can find instructions
* to create a Merchant Center account here: https://support.google.com/merchants/answer/188924.
* This account must be linked to your Google Ads account. The integration instructions can be
* found at: https://developers.google.com/adwords/shopping/full-automation/articles/t15.
* - You need your Google Ads account to track conversions. The different ways to track conversions
* can be found here: https://support.google.com/google-ads/answer/1722054.
*/
class AddShoppingSmartAd
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
private const MERCHANT_CENTER_ACCOUNT_ID = 'INSERT_MERCHANT_CENTER_ACCOUNT_ID_HERE';
private const SHOULD_CREATE_DEFAULT_LISTING_GROUP = 'INSERT_BOOLEAN_TRUE_OR_FALSE_HERE';
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::MERCHANT_CENTER_ACCOUNT_ID => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::SHOULD_CREATE_DEFAULT_LISTING_GROUP => GetOpt::REQUIRED_ARGUMENT
]);
// 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::MERCHANT_CENTER_ACCOUNT_ID]
?: self::MERCHANT_CENTER_ACCOUNT_ID,
filter_var(
$options[ArgumentNames::SHOULD_CREATE_DEFAULT_LISTING_GROUP]
?: self::SHOULD_CREATE_DEFAULT_LISTING_GROUP,
FILTER_VALIDATE_BOOLEAN
)
);
} 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 int $merchantCenterAccountId the Merchant Center account ID
* @param bool $shouldCreateDefaultListingGroup indicates if a default listing
* group should be created for the ad group. Set to false if the listing group will be
* constructed elsewhere.
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $merchantCenterAccountId,
bool $shouldCreateDefaultListingGroup
) {
// Creates a budget to be used by the campaign that will be created below.
$budgetResourceName = self::addCampaignBudget($googleAdsClient, $customerId);
// Creates a Smart Shopping campaign.
$campaignResourceName = self::addSmartShoppingCampaign(
$googleAdsClient,
$customerId,
$budgetResourceName,
$merchantCenterAccountId
);
// Creates a Smart Shopping ad group.
$adGroupResourceName =
self::addSmartShoppingAdGroup($googleAdsClient, $customerId, $campaignResourceName);
// Creates a Smart Shopping ad group ad.
self::addSmartShoppingAdGroupAd($googleAdsClient, $customerId, $adGroupResourceName);
if ($shouldCreateDefaultListingGroup) {
// A product group is a subset of inventory. Listing groups are the equivalent
// of product groups in the API and allow you to bid on the chosen group or
// exclude a group from bidding.
// This method creates an ad group criterion containing a listing group.
self::addShoppingListingGroup(
$googleAdsClient,
$customerId,
$adGroupResourceName
);
}
}
/**
* Creates a new campaign budget for Smart Shopping ads in the specified client account.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @return string the resource name of the newly created budget
*/
private static function addCampaignBudget(GoogleAdsClient $googleAdsClient, int $customerId)
{
// Creates a campaign budget.
$budget = new CampaignBudget([
'name' => new StringValue(['value' => 'Interplanetary Cruise Budget #' . uniqid()]),
'delivery_method' => BudgetDeliveryMethod::STANDARD,
// The budget is specified in the local currency of the account.
// The amount should be specified in micros, where one million is equivalent to one
// unit.
'amount_micros' => new Int64Value(['value' => 50000000]),
// Budgets for Smart Shopping campaigns cannot be shared.
'explicitly_shared' => new BoolValue(['value' => false])
]);
// Creates a campaign budget operation.
$campaignBudgetOperation = new CampaignBudgetOperation();
$campaignBudgetOperation->setCreate($budget);
// Issues a mutate request.
$campaignBudgetServiceClient = $googleAdsClient->getCampaignBudgetServiceClient();
$response = $campaignBudgetServiceClient->mutateCampaignBudgets(
$customerId,
[$campaignBudgetOperation]
);
/** @var CampaignBudget $addedBudget */
$addedBudget = $response->getResults()[0];
printf(
"Added a budget with resource name '%s'.%s",
$addedBudget->getResourceName(),
PHP_EOL
);
return $addedBudget->getResourceName();
}
/**
* Creates a new shopping campaign for Smart Shopping ads in the specified client account.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param string $budgetResourceName the resource name of budget for a new campaign
* @param int $merchantCenterAccountId the Merchant Center account ID
* @return string the resource name of the newly created campaign
*/
private static function addSmartShoppingCampaign(
GoogleAdsClient $googleAdsClient,
int $customerId,
string $budgetResourceName,
int $merchantCenterAccountId
) {
// Configures the shopping settings for Smart Shopping campaigns.
$shoppingSettings = new ShoppingSetting([
// Sets the sales country of products to include in the campaign.
// Only products from Merchant Center targeting this country will appear in the
// campaign.
'sales_country' => new StringValue(['value' => 'US']),
'merchant_id' => new Int64Value(['value' => $merchantCenterAccountId])
]);
// Creates the campaign.
$campaign = new Campaign([
'name' => new StringValue(['value' => 'Interplanetary Cruise Campaign #' . uniqid()]),
// Configures settings related to shopping campaigns including
// advertising channel type, advertising sub-type and shopping setting.
'advertising_channel_type' => AdvertisingChannelType::SHOPPING,
'advertising_channel_sub_type' => AdvertisingChannelSubType::SHOPPING_SMART_ADS,
'shopping_setting' => $shoppingSettings,
// Recommendation: Set the campaign to PAUSED when creating it to prevent
// the ads from immediately serving. Set to ENABLED once you've added
// targeting and the ads are ready to serve.
'status' => CampaignStatus::PAUSED,
// Bidding strategy must be set directly on the campaign.
// Setting a portfolio bidding strategy by resource name is not supported.
// Maximize conversion value is the only strategy supported for Smart Shopping
// campaigns.
// An optional ROAS (Return on Advertising Spend) can be set for
// MaximizeConversionValue.
// The ROAS value must be specified as a ratio in the API. It is calculated by dividing
// "total value" by "total spend".
// For more information on maximize conversion value, see the support article:
// http://support.google.com/google-ads/answer/7684216.
'maximize_conversion_value' => new MaximizeConversionValue([
'target_roas' => new DoubleValue(['value' => 3.5])
]),
// Sets the budget.
'campaign_budget' => new StringValue(['value' => $budgetResourceName])
]);
// Creates a campaign operation.
$campaignOperation = new CampaignOperation();
$campaignOperation->setCreate($campaign);
// Issues a mutate request to add the campaign.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);
/** @var Campaign $addedCampaign */
$addedCampaign = $response->getResults()[0];
$addedCampaignResourceName = $addedCampaign->getResourceName();
printf(
"Added a Smart Shopping campaign with resource name: '%s'.%s",
$addedCampaignResourceName,
PHP_EOL
);
return $addedCampaignResourceName;
}
/**
* Creates a new ad group in the specified Smart Shopping campaign.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param string $campaignResourceName the resource name of the campaign that
* the new ad group will belong to
* @return string the resource name of the newly created ad group
*/
private static function addSmartShoppingAdGroup(
GoogleAdsClient $googleAdsClient,
int $customerId,
string $campaignResourceName
) {
// Creates an ad group.
$adGroup = new AdGroup([
'name' => new StringValue(['value' => 'Earth to Mars Cruise #' . uniqid()]),
'campaign' => new StringValue(['value' => $campaignResourceName]),
// Sets the ad group type to SHOPPING_SMART_ADS. This cannot be set to other types.
'type' => AdGroupType::SHOPPING_SMART_ADS,
'status' => AdGroupStatus::ENABLED
]);
// Creates an ad group operation.
$adGroupOperation = new AdGroupOperation();
$adGroupOperation->setCreate($adGroup);
// Issues a mutate request to add the ad group.
$adGroupServiceClient = $googleAdsClient->getAdGroupServiceClient();
$response = $adGroupServiceClient->mutateAdGroups($customerId, [$adGroupOperation]);
/** @var AdGroup $addedAdGroup */
$addedAdGroup = $response->getResults()[0];
$addedAdGroupResourceName = $addedAdGroup->getResourceName();
printf(
"Added a Smart Shopping ad group with resource name: '%s'.%s",
$addedAdGroupResourceName,
PHP_EOL
);
return $addedAdGroupResourceName;
}
/**
* Creates a new ad group ad in the specified Smart Shopping ad group.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param string $adGroupResourceName the resource name of the ad group that
* the new ad group ad will belong to
*/
private static function addSmartShoppingAdGroupAd(
GoogleAdsClient $googleAdsClient,
int $customerId,
string $adGroupResourceName
) {
// Creates a new ad group ad.
$adGroupAd = new AdGroupAd([
// Sets a new Smart Shopping ad.
'ad' => new Ad(['shopping_smart_ad' => new ShoppingSmartAdInfo()]),
// Sets the ad group.
'ad_group' => new StringValue(['value' => $adGroupResourceName])
]);
// Creates an ad group ad operation.
$adGroupAdOperation = new AdGroupAdOperation();
$adGroupAdOperation->setCreate($adGroupAd);
// Issues a mutate request to add the ad group ad.
$adGroupAdServiceClient = $googleAdsClient->getAdGroupAdServiceClient();
$response = $adGroupAdServiceClient->mutateAdGroupAds($customerId, [$adGroupAdOperation]);
/** @var AdGroupAd $addedAdGroupAd */
$addedAdGroupAd = $response->getResults()[0];
printf(
"Added a Smart Shopping ad group ad with resource name: '%s'.%s",
$addedAdGroupAd->getResourceName(),
PHP_EOL
);
}
/**
* Creates a new Shopping listing group for the specified ad group. This is known as a "product
* group" in the Google Ads user interface. The listing group will be added to the ad group
* using an "ad group criterion". For more information on listing groups see the Google Ads
* API Shopping guide: https://developers.google.com/google-ads/api/docs/shopping-ads/overview.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param string $adGroupResourceName the resource name of the ad group that
* the new listing group will belong to
*/
private static function addShoppingListingGroup(
GoogleAdsClient $googleAdsClient,
int $customerId,
string $adGroupResourceName
) {
// Creates a new ad group criterion. This will contain a listing group.
// This will be the listing group for 'All products' and will contain a single root node.
$adGroupCriterion = new AdGroupCriterion([
'ad_group' => new StringValue(['value' => $adGroupResourceName]),
'status' => AdGroupAdStatus::ENABLED,
// Creates a new listing group. This will be the top-level "root" node.
// Sets the type of the listing group to be a biddable unit.
'listing_group' => new ListingGroupInfo(['type' => ListingGroupType::UNIT])
// Note: Listing groups do not require bids for Smart Shopping campaigns.
]);
// Creates an ad group criterion operation.
$adGroupCriterionOperation = new AdGroupCriterionOperation();
$adGroupCriterionOperation->setCreate($adGroupCriterion);
// Issues a mutate request to add the ad group criterion.
$adGroupCriterionServiceClient = $googleAdsClient->getAdGroupCriterionServiceClient();
$response = $adGroupCriterionServiceClient->mutateAdGroupCriteria(
$customerId,
[$adGroupCriterionOperation]
);
/** @var AdGroupCriterion $addedAdGroupCriterion */
$addedAdGroupCriterion = $response->getResults()[0];
printf(
"Added an ad group criterion containing a listing group with resource name: '%s'.%s",
$addedAdGroupCriterion->getResourceName(),
PHP_EOL
);
}
}
AddShoppingSmartAd::main();