/
AddHotelListingGroupTree.php
436 lines (403 loc) · 17.8 KB
/
AddHotelListingGroupTree.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
<?php
/**
* Copyright 2018 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\Travel;
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\V16\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V16\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V16\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Util\V16\ResourceNames;
use Google\Ads\GoogleAds\V16\Common\HotelClassInfo;
use Google\Ads\GoogleAds\V16\Common\HotelCountryRegionInfo;
use Google\Ads\GoogleAds\V16\Common\ListingDimensionInfo;
use Google\Ads\GoogleAds\V16\Common\ListingGroupInfo;
use Google\Ads\GoogleAds\V16\Enums\AdGroupStatusEnum\AdGroupStatus;
use Google\Ads\GoogleAds\V16\Enums\ListingGroupTypeEnum\ListingGroupType;
use Google\Ads\GoogleAds\V16\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V16\Resources\AdGroupCriterion;
use Google\Ads\GoogleAds\V16\Services\AdGroupCriterionOperation;
use Google\Ads\GoogleAds\V16\Services\MutateAdGroupCriteriaRequest;
use Google\ApiCore\ApiException;
/**
* This example shows how to add a hotel listing group tree, which has two levels. The first level
* is partitioned by the hotel class. The second level is partitioned by the country region.
*
* Each level is composed of two types of nodes: `UNIT` and `SUBDIVISION`.
* `UNIT` nodes serve as a leaf node in a tree and can have bid amount set.
* `SUBDIVISION` nodes serve as an internal node where a subtree will be built. The `SUBDIVISION`
* node can't have bid amount set.
* See https://developers.google.com/google-ads/api/docs/hotel-ads/overview for more information.
*
* Note: Only one listing group tree can be added. Attempting to add another listing group tree to
* an ad group that already has one will fail.
*/
class AddHotelListingGroupTree
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
private const AD_GROUP_ID = 'INSERT_AD_GROUP_ID_HERE';
// Specify the CPC bid micro amount to be set on a created ad group criterion.
// For simplicity, each ad group criterion will use the below amount equally. In practice, you
// probably want to use different values for each ad group criterion.
private const PERCENT_CPC_BID_MICRO_AMOUNT = 1000000;
/**
* @var int $nextTempId
*
* The next temporary criterion ID to be used, which is a negative integer.
*
* When creating a tree, we need to specify the parent-child relationships
* between nodes. However, until a criterion has been created on the server
* we do not have a criterion ID with which to refer to it.
*
* Instead we can specify temporary IDs that are specific to a single mutate
* request. Once a criterion is created, it is assigned an ID as normal and
* the temporary ID will no longer refer to it.
*/
private static $nextTempId = -1;
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::AD_GROUP_ID => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::PERCENT_CPC_BID_MICRO_AMOUNT => GetOpt::OPTIONAL_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)
// We set this value to true to show how to use GAPIC v2 source code. You can remove the
// below line if you wish to use the old-style source code. Note that in that case, you
// probably need to modify some parts of the code below to make it work.
// For more information, see
// https://developers.devsite.corp.google.com/google-ads/api/docs/client-libs/php/gapic.
->usingGapicV2Source(true)
->build();
try {
self::runExample(
$googleAdsClient,
$options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID,
$options[ArgumentNames::AD_GROUP_ID] ?: self::AD_GROUP_ID,
$options[ArgumentNames::PERCENT_CPC_BID_MICRO_AMOUNT]
?: self::PERCENT_CPC_BID_MICRO_AMOUNT
);
} 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 $adGroupId the ad group ID
* @param int $percentCpcBidMicroAmount the percent CPC bid micro amount to set on created ad
* group criteria
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $adGroupId,
int $percentCpcBidMicroAmount
) {
$operations = [];
// Creates the root of the tree as a SUBDIVISION node.
$rootResourceName =
self::addRootNode($customerId, $adGroupId, $operations, $percentCpcBidMicroAmount);
// Creates child nodes of level 1, partitioned by the hotel class info.
$otherHotelResourceName = self::addLevel1Nodes(
$customerId,
$adGroupId,
$rootResourceName,
$operations,
$percentCpcBidMicroAmount
);
// Creates child nodes of level 2, partitioned by the hotel country region info.
self::addLevel2Nodes(
$customerId,
$adGroupId,
$otherHotelResourceName,
$operations,
$percentCpcBidMicroAmount
);
$adGroupCriterionServiceClient = $googleAdsClient->getAdGroupCriterionServiceClient();
$response = $adGroupCriterionServiceClient->mutateAdGroupCriteria(
MutateAdGroupCriteriaRequest::build($customerId, $operations)
);
printf("Added %d listing group info entities.%s", count($response->getResults()), PHP_EOL);
foreach ($response->getResults() as $adGroupCriterion) {
print $adGroupCriterion->getResourceName() . PHP_EOL;
}
}
/**
* Creates the root node of the listing group tree and adds its create operation to the
* operations list.
*
* @param int $customerId the customer ID
* @param int $adGroupId the ad group ID
* @param AdGroupCriterionOperation[] $operations the operations
* @param int $percentCpcBidMicroAmount the CPC bid micro amount to set on created ad group
* criteria
* @return string the root node's resource name
*/
private static function addRootNode(
int $customerId,
int $adGroupId,
array &$operations,
int $percentCpcBidMicroAmount
) {
// Creates the root of the tree as a SUBDIVISION node.
$root = self::createListingGroupInfo(ListingGroupType::SUBDIVISION);
$rootAdGroupCriterion =
self::createAdGroupCriterion($customerId, $adGroupId, $root, $percentCpcBidMicroAmount);
$operation = self::generateCreateOperation($rootAdGroupCriterion);
$operations[] = $operation;
self::$nextTempId--;
return $rootAdGroupCriterion->getResourceName();
}
/**
* Creates child nodes of level 1, partitioned by the hotel class info.
*
* @param int $customerId the customer ID
* @param int $adGroupId the ad group ID
* @param string $rootResourceName the resource name of the root node
* @param AdGroupCriterionOperation[] $operations the operations list
* @param int $percentCpcBidMicroAmount the CPC bid micro amount to set on created ad group
* criteria
* @return string the "other hotel classes" node's resource name, which serves as a parent node
* for the next level
*/
// [START add_hotel_listing_group_tree]
private static function addLevel1Nodes(
int $customerId,
int $adGroupId,
string $rootResourceName,
array &$operations,
int $percentCpcBidMicroAmount
) {
// Creates hotel class info and dimension info for 5-star hotels.
$fiveStarredDimensionInfo = new ListingDimensionInfo([
'hotel_class' => new HotelClassInfo(['value' => 5])
]);
// Creates listing group info for 5-star hotels as a UNIT node.
$fiveStarredUnit = self::createListingGroupInfo(
ListingGroupType::UNIT,
$rootResourceName,
$fiveStarredDimensionInfo
);
// Creates an ad group criterion for 5-star hotels.
$fiveStarredAdGroupCriterion = self::createAdGroupCriterion(
$customerId,
$adGroupId,
$fiveStarredUnit,
$percentCpcBidMicroAmount
);
// Decrements the temp ID for the next ad group criterion.
self::$nextTempId--;
$operation = self::generateCreateOperation($fiveStarredAdGroupCriterion);
$operations[] = $operation;
// You can also create more UNIT nodes for other hotel classes by copying the above code in
// this method and modifying the value passed to HotelClassInfo() to the value you want.
// For instance, passing 4 instead of 5 in the above code will create a UNIT node of 4-star
// hotels instead.
// Creates hotel class info and dimension info for other hotel classes by *not* specifying
// any attributes on those object.
$othersHotelsDimensionInfo = new ListingDimensionInfo([
'hotel_class' => new HotelClassInfo()
]);
// Creates listing group info for other hotel classes as a SUBDIVISION node, which will be
// used as a parent node for children nodes of the next level.
$otherHotelsSubDivision = self::createListingGroupInfo(
ListingGroupType::SUBDIVISION,
$rootResourceName,
$othersHotelsDimensionInfo
);
// Creates an ad group criterion for other hotel classes.
$otherHotelsAdGroupCriterion = self::createAdGroupCriterion(
$customerId,
$adGroupId,
$otherHotelsSubDivision,
$percentCpcBidMicroAmount
);
$operation = self::generateCreateOperation($otherHotelsAdGroupCriterion);
$operations[] = $operation;
self::$nextTempId--;
return $otherHotelsAdGroupCriterion->getResourceName();
}
// [END add_hotel_listing_group_tree]
/**
* Creates child nodes of level 2, partitioned by the country region.
*
* @param int $customerId the customer ID
* @param int $adGroupId the ad group ID
* @param string $parentResourceName the resource name of parent criterion for all nodes at this
* level
* @param AdGroupCriterionOperation[] $operations the operations list
* @param int $percentCpcBidMicroAmount the CPC bid micro amount to set on created ad group
* criteria
*/
private static function addLevel2Nodes(
int $customerId,
int $adGroupId,
string $parentResourceName,
array &$operations,
int $percentCpcBidMicroAmount
) {
// The criterion ID for Japan is 2392.
// See https://developers.google.com/adwords/api/docs/appendix/geotargeting for criteria ID
// of other countries.
$japanGeoTargetConstantId = 2392;
$japanDimensionInfo = new ListingDimensionInfo([
// Creates hotel country region info and dimension info for hotels in Japan.
'hotel_country_region' => new HotelCountryRegionInfo([
'country_region_criterion' =>
ResourceNames::forGeoTargetConstant($japanGeoTargetConstantId)
])
]);
// Creates listing group info for hotels in Japan as a UNIT node.
$japanHotelsUnit = self::createListingGroupInfo(
ListingGroupType::UNIT,
$parentResourceName,
$japanDimensionInfo
);
// Creates an ad group criterion for hotels in Japan.
$japanHotelsAdGroupCriterion = self::createAdGroupCriterion(
$customerId,
$adGroupId,
$japanHotelsUnit,
$percentCpcBidMicroAmount
);
// Decrements the temp ID for the next ad group criterion.
self::$nextTempId--;
$operation = self::generateCreateOperation($japanHotelsAdGroupCriterion);
$operations[] = $operation;
// Creates hotel class info and dimension info for hotels in other regions.
$otherHotelRegionsDimensionInfo = new ListingDimensionInfo([
'hotel_country_region' => new HotelCountryRegionInfo()
]);
// Creates listing group info for hotels in other regions as a UNIT node.
// The "others" node is always required for every level of the tree.
$otherHotelRegionsUnit = self::createListingGroupInfo(
ListingGroupType::UNIT,
$parentResourceName,
$otherHotelRegionsDimensionInfo
);
// Creates an ad group criterion for other hotel country regions.
$otherHotelRegionsAdGroupCriterion = self::createAdGroupCriterion(
$customerId,
$adGroupId,
$otherHotelRegionsUnit,
$percentCpcBidMicroAmount
);
$operation = self::generateCreateOperation($otherHotelRegionsAdGroupCriterion);
$operations[] = $operation;
}
/**
* Creates the listing group info with the provided parameters.
*
* @param int $listingGroupType the listing group type
* @param string|null $parentCriterionResourceName optional, the resource name of parent
* criterion ID of the listing group info
* @param ListingDimensionInfo|null $caseValue optional, the dimension info for the listing
* group
* @return ListingGroupInfo the created listing group info
*/
private static function createListingGroupInfo(
int $listingGroupType,
string $parentCriterionResourceName = null,
ListingDimensionInfo $caseValue = null
) {
$listingGroupInfo = new ListingGroupInfo([
'type' => $listingGroupType
]);
if (!is_null($parentCriterionResourceName)) {
$listingGroupInfo->setParentAdGroupCriterion($parentCriterionResourceName);
$listingGroupInfo->setCaseValue($caseValue);
}
return $listingGroupInfo;
}
/**
* Creates an ad group criterion from the provided listing group info.
* Bid amount will be set on the created ad group criterion when listing group info type is
* `UNIT`. Setting bid amount for `SUBDIVISION` types is not allowed.
*
* @param int $customerId the customer ID
* @param int $adGroupId the ad group ID
* @param ListingGroupInfo $listingGroupInfo the listing group info
* @param int $percentCpcBidMicroAmount the CPC bid micro amount to set for the ad group
* criterion
* @return AdGroupCriterion the created ad group criterion
*/
private static function createAdGroupCriterion(
int $customerId,
int $adGroupId,
ListingGroupInfo $listingGroupInfo,
int $percentCpcBidMicroAmount
) {
$adGroupCriterion = new AdGroupCriterion([
'status' => AdGroupStatus::ENABLED,
'listing_group' => $listingGroupInfo,
'resource_name' =>
ResourceNames::forAdGroupCriterion($customerId, $adGroupId, self::$nextTempId)
]);
// Bids are valid only for UNIT nodes.
if ($listingGroupInfo->getType() == ListingGroupType::UNIT) {
$adGroupCriterion->setPercentCpcBidMicros($percentCpcBidMicroAmount);
}
return $adGroupCriterion;
}
/**
* Creates an operation for creating the specified ad group criterion.
*
* @param AdGroupCriterion $adGroupCriterion the ad group criterion to create an operation for
* @return AdGroupCriterionOperation the created ad group criterion operation
*/
private static function generateCreateOperation(AdGroupCriterion $adGroupCriterion)
{
$operation = new AdGroupCriterionOperation();
$operation->setCreate($adGroupCriterion);
return $operation;
}
}
AddHotelListingGroupTree::main();