-
Notifications
You must be signed in to change notification settings - Fork 260
/
AddKeywordPlan.php
380 lines (333 loc) · 14.2 KB
/
AddKeywordPlan.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
<?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\Planning;
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\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V6\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V6\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V6\GoogleAdsException;
use Google\Ads\GoogleAds\Util\V6\ResourceNames;
use Google\Ads\GoogleAds\V6\Enums\KeywordMatchTypeEnum\KeywordMatchType;
use Google\Ads\GoogleAds\V6\Enums\KeywordPlanForecastIntervalEnum\KeywordPlanForecastInterval;
use Google\Ads\GoogleAds\V6\Enums\KeywordPlanNetworkEnum\KeywordPlanNetwork;
use Google\Ads\GoogleAds\V6\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V6\Resources\KeywordPlan;
use Google\Ads\GoogleAds\V6\Resources\KeywordPlanAdGroup;
use Google\Ads\GoogleAds\V6\Resources\KeywordPlanAdGroupKeyword;
use Google\Ads\GoogleAds\V6\Resources\KeywordPlanCampaign;
use Google\Ads\GoogleAds\V6\Resources\KeywordPlanCampaignKeyword;
use Google\Ads\GoogleAds\V6\Resources\KeywordPlanForecastPeriod;
use Google\Ads\GoogleAds\V6\Resources\KeywordPlanGeoTarget;
use Google\Ads\GoogleAds\V6\Services\KeywordPlanAdGroupKeywordOperation;
use Google\Ads\GoogleAds\V6\Services\KeywordPlanAdGroupOperation;
use Google\Ads\GoogleAds\V6\Services\KeywordPlanCampaignKeywordOperation;
use Google\Ads\GoogleAds\V6\Services\KeywordPlanCampaignOperation;
use Google\Ads\GoogleAds\V6\Services\KeywordPlanOperation;
use Google\ApiCore\ApiException;
/**
* This class creates a keyword plan, which can be reused for retrieving forecast metrics and
* historic metrics.
*/
class AddKeywordPlan
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_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
]);
// 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
);
} 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
*/
public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
$keywordPlanResource = self::createKeywordPlan(
$googleAdsClient,
$customerId
);
$planCampaignResource = self::createKeywordPlanCampaign(
$googleAdsClient,
$customerId,
$keywordPlanResource
);
$planAdGroupResource = self::createKeywordPlanAdGroup(
$googleAdsClient,
$customerId,
$planCampaignResource
);
self::createKeywordPlanAdGroupKeywords(
$googleAdsClient,
$customerId,
$planAdGroupResource
);
self::createKeywordPlanNegativeCampaignKeywords(
$googleAdsClient,
$customerId,
$planCampaignResource
);
}
/**
* Creates a keyword plan.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @return string the newly created keyword plan resource
*/
private static function createKeywordPlan(
GoogleAdsClient $googleAdsClient,
int $customerId
) {
// Creates a keyword plan.
$keywordPlan = new KeywordPlan([
'name' => 'Keyword plan for traffic estimate #' . uniqid(),
'forecast_period' => new KeywordPlanForecastPeriod([
'date_interval' => KeywordPlanForecastInterval::NEXT_QUARTER
])
]);
// Creates a keyword plan operation.
$keywordPlanOperation = new KeywordPlanOperation();
$keywordPlanOperation->setCreate($keywordPlan);
// Issues a mutate request to add the keyword plan.
$keywordPlanServiceClient = $googleAdsClient->getKeywordPlanServiceClient();
$response = $keywordPlanServiceClient->mutateKeywordPlans(
$customerId,
[$keywordPlanOperation]
);
$resourceName = $response->getResults()[0]->getResourceName();
printf("Created keyword plan: '%s'%s", $resourceName, PHP_EOL);
return $resourceName;
}
/**
* Creates the campaign for the keyword plan.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param string $keywordPlanResource the keyword plan resource
* @return string the newly created campaign resource
*/
private static function createKeywordPlanCampaign(
GoogleAdsClient $googleAdsClient,
int $customerId,
string $keywordPlanResource
) {
// Creates a keyword plan campaign.
$keywordPlanCampaign = new KeywordPlanCampaign([
'name' => 'Keyword plan campaign #' . uniqid(),
'cpc_bid_micros' => 1000000,
'keyword_plan_network' => KeywordPlanNetwork::GOOGLE_SEARCH,
'keyword_plan' => $keywordPlanResource,
]);
// See https://developers.google.com/adwords/api/docs/appendix/geotargeting
// for the list of geo target IDs.
$keywordPlanCampaign->setGeoTargets([
new KeywordPlanGeoTarget([
'geo_target_constant' => ResourceNames::forGeoTargetConstant(2840) // USA
])
]);
// See https://developers.google.com/adwords/api/docs/appendix/codes-formats#languages
// for the list of language criteria IDs.
// Set English as a language constant.
$keywordPlanCampaign->setLanguageConstants([ResourceNames::forLanguageConstant(1000)]);
// Creates a keyword plan campaign operation.
$keywordPlanCampaignOperation = new KeywordPlanCampaignOperation();
$keywordPlanCampaignOperation->setCreate($keywordPlanCampaign);
$keywordPlanCampaignServiceClient =
$googleAdsClient->getKeywordPlanCampaignServiceClient();
$response = $keywordPlanCampaignServiceClient->mutateKeywordPlanCampaigns(
$customerId,
[$keywordPlanCampaignOperation]
);
$planCampaignResource = $response->getResults()[0]->getResourceName();
printf("Created campaign for keyword plan: '%s'%s", $planCampaignResource, PHP_EOL);
return $planCampaignResource;
}
/**
* Creates the ad group for the keyword plan.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param string $planCampaignResource the resource name of the campaign under which the
* ad group is created
* @return string the newly created ad group resource
*/
private static function createKeywordPlanAdGroup(
GoogleAdsClient $googleAdsClient,
int $customerId,
string $planCampaignResource
) {
// Creates a keyword plan ad group.
$keywordPlanAdGroup = new KeywordPlanAdGroup([
'name' => 'Keyword plan ad group #' . uniqid(),
'cpc_bid_micros' => 2500000,
'keyword_plan_campaign' => $planCampaignResource
]);
// Creates a keyword plan ad group operation.
$keywordPlanAdGroupOperation = new KeywordPlanAdGroupOperation();
$keywordPlanAdGroupOperation->setCreate($keywordPlanAdGroup);
$keywordPlanAdGroupServiceClient = $googleAdsClient->getKeywordPlanAdGroupServiceClient();
$response = $keywordPlanAdGroupServiceClient->mutateKeywordPlanAdGroups(
$customerId,
[$keywordPlanAdGroupOperation]
);
$planAdGroupResource = $response->getResults()[0]->getResourceName();
printf("Created ad group for keyword plan: '%s'%s", $planAdGroupResource, PHP_EOL);
return $planAdGroupResource;
}
/**
* Creates ad group keywords for the keyword plan.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param string $planAdGroupResource the resource name of the ad group under which the
* keywords are created
*/
private static function createKeywordPlanAdGroupKeywords(
GoogleAdsClient $googleAdsClient,
int $customerId,
string $planAdGroupResource
) {
// Creates the ad group keywords for the keyword plan.
$keywordPlanAdGroupKeyword1 = new KeywordPlanAdGroupKeyword([
'text' => 'mars cruise',
'cpc_bid_micros' => 2000000,
'match_type' => KeywordMatchType::BROAD,
'keyword_plan_ad_group' => $planAdGroupResource
]);
$keywordPlanAdGroupKeyword2 = new KeywordPlanAdGroupKeyword([
'text' => 'cheap cruise',
'cpc_bid_micros' => 15000000,
'match_type' => KeywordMatchType::PHRASE,
'keyword_plan_ad_group' => $planAdGroupResource
]);
$keywordPlanAdGroupKeyword3 = new KeywordPlanAdGroupKeyword([
'text' => 'jupiter cruise',
'cpc_bid_micros' => 1990000,
'match_type' => KeywordMatchType::EXACT,
'keyword_plan_ad_group' => $planAdGroupResource
]);
$keywordPlanAdGroupKeywords =
[$keywordPlanAdGroupKeyword1, $keywordPlanAdGroupKeyword2, $keywordPlanAdGroupKeyword3];
// Creates an array of keyword plan ad group keyword operations.
$keywordPlanAdGroupKeywordOperations = [];
foreach ($keywordPlanAdGroupKeywords as $keyword) {
$keywordPlanAdGroupKeywordOperation = new KeywordPlanAdGroupKeywordOperation();
$keywordPlanAdGroupKeywordOperation->setCreate($keyword);
$keywordPlanAdGroupKeywordOperations[] = $keywordPlanAdGroupKeywordOperation;
}
$keywordPlanAdGroupKeywordServiceClient =
$googleAdsClient->getKeywordPlanAdGroupKeywordServiceClient();
// Adds the keyword plan ad group keywords.
$response = $keywordPlanAdGroupKeywordServiceClient->mutateKeywordPlanAdGroupKeywords(
$customerId,
$keywordPlanAdGroupKeywordOperations
);
/** @var KeywordPlanAdGroupKeyword $result */
foreach ($response->getResults() as $result) {
printf(
"Created ad group keyword for keyword plan: '%s'%s",
$result->getResourceName(),
PHP_EOL
);
}
}
/**
* Creates negative campaign keywords for the keyword plan.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param string $planCampaignResource the resource name of the campaign under which
* the keywords are created
*/
private static function createKeywordPlanNegativeCampaignKeywords(
GoogleAdsClient $googleAdsClient,
int $customerId,
string $planCampaignResource
) {
// Creates a negative campaign keyword for the keyword plan.
$keywordPlanCampaignKeyword = new KeywordPlanCampaignKeyword([
'text' => 'moon walk',
'match_type' => KeywordMatchType::BROAD,
'keyword_plan_campaign' => $planCampaignResource,
'negative' => true
]);
$keywordPlanCampaignKeywordOperation = new KeywordPlanCampaignKeywordOperation();
$keywordPlanCampaignKeywordOperation->setCreate($keywordPlanCampaignKeyword);
$keywordPlanCampaignKeywordServiceClient =
$googleAdsClient->getKeywordPlanCampaignKeywordServiceClient();
// Adds the negative campaign keyword.
$response = $keywordPlanCampaignKeywordServiceClient->mutateKeywordPlanCampaignKeywords(
$customerId,
[$keywordPlanCampaignKeywordOperation]
);
/** @var KeywordPlanCampaignKeyword $result */
foreach ($response->getResults() as $result) {
printf(
"Created negative campaign keyword for keyword plan: '%s'%s",
$result->getResourceName(),
PHP_EOL
);
}
}
}
AddKeywordPlan::main();