/
UsePortfolioBiddingStrategy.php
286 lines (261 loc) · 11.7 KB
/
UsePortfolioBiddingStrategy.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
<?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\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\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\TargetSpend;
use Google\Ads\GoogleAds\V16\Enums\AdvertisingChannelTypeEnum\AdvertisingChannelType;
use Google\Ads\GoogleAds\V16\Enums\BudgetDeliveryMethodEnum\BudgetDeliveryMethod;
use Google\Ads\GoogleAds\V16\Enums\CampaignStatusEnum\CampaignStatus;
use Google\Ads\GoogleAds\V16\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V16\Resources\BiddingStrategy;
use Google\Ads\GoogleAds\V16\Resources\Campaign;
use Google\Ads\GoogleAds\V16\Resources\Campaign\NetworkSettings;
use Google\Ads\GoogleAds\V16\Resources\CampaignBudget;
use Google\Ads\GoogleAds\V16\Services\BiddingStrategyOperation;
use Google\Ads\GoogleAds\V16\Services\CampaignBudgetOperation;
use Google\Ads\GoogleAds\V16\Services\CampaignOperation;
use Google\Ads\GoogleAds\V16\Services\MutateBiddingStrategiesRequest;
use Google\Ads\GoogleAds\V16\Services\MutateCampaignBudgetsRequest;
use Google\Ads\GoogleAds\V16\Services\MutateCampaignsRequest;
use Google\ApiCore\ApiException;
/**
* This example adds a portfolio bidding strategy and uses it to construct a campaign.
*/
class UsePortfolioBiddingStrategy
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
// Optional: Specify a campaign budget ID below to be used to create a campaign. If none is
// specified, this example will create a new campaign budget.
private const CAMPAIGN_BUDGET_ID = null;
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::CAMPAIGN_BUDGET_ID => 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::CAMPAIGN_BUDGET_ID] ?: self::CAMPAIGN_BUDGET_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
* @param int|null $campaignBudgetId the ID of the campaign budget to use if any
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
?int $campaignBudgetId
) {
$biddingStrategyResourceName = self::createBiddingStrategy($googleAdsClient, $customerId);
if (is_null($campaignBudgetId)) {
$campaignBudgetResourceName =
self::createSharedCampaignBudget($googleAdsClient, $customerId);
} else {
$campaignBudgetResourceName =
ResourceNames::forCampaignBudget($customerId, $campaignBudgetId);
}
self::createCampaignWithBiddingStrategy(
$googleAdsClient,
$customerId,
$biddingStrategyResourceName,
$campaignBudgetResourceName
);
}
/**
* Creates the portfolio bidding strategy.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @return string the resource name of created bidding strategy
*/
// [START use_portfolio_bidding_strategy_1]
private static function createBiddingStrategy(GoogleAdsClient $googleAdsClient, int $customerId)
{
// Creates a portfolio bidding strategy.
$portfolioBiddingStrategy = new BiddingStrategy([
'name' => 'Maximize Clicks #' . Helper::getPrintableDatetime(),
'target_spend' => new TargetSpend([
'cpc_bid_ceiling_micros' => 2000000
])
]);
// Constructs an operation that will create a portfolio bidding strategy.
$biddingStrategyOperation = new BiddingStrategyOperation();
$biddingStrategyOperation->setCreate($portfolioBiddingStrategy);
// Issues a mutate request to create the bidding strategy.
$biddingStrategyServiceClient = $googleAdsClient->getBiddingStrategyServiceClient();
$response = $biddingStrategyServiceClient->mutateBiddingStrategies(
MutateBiddingStrategiesRequest::build($customerId, [$biddingStrategyOperation])
);
/** @var BiddingStrategy $addedBiddingStrategy */
$addedBiddingStrategy = $response->getResults()[0];
// Prints out the resource name of the created bidding strategy.
printf(
"Created portfolio bidding strategy with resource name: '%s'.%s",
$addedBiddingStrategy->getResourceName(),
PHP_EOL
);
return $addedBiddingStrategy->getResourceName();
}
// [END use_portfolio_bidding_strategy_1]
/**
* Creates an explicitly shared budget to be used to create the campaign.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @return string the resource name of created shared budget
*/
// [START use_portfolio_bidding_strategy]
private static function createSharedCampaignBudget(
GoogleAdsClient $googleAdsClient,
int $customerId
) {
// Creates a shared budget.
$budget = new CampaignBudget([
'name' => 'Shared Interplanetary Budget #' . Helper::getPrintableDatetime(),
'delivery_method' => BudgetDeliveryMethod::STANDARD,
// Sets the amount of budget.
'amount_micros' => 50000000,
// Makes the budget explicitly shared.
'explicitly_shared' => true
]);
// Constructs a campaign budget operation.
$campaignBudgetOperation = new CampaignBudgetOperation();
$campaignBudgetOperation->setCreate($budget);
// Issues a mutate request to create the budget.
$campaignBudgetServiceClient = $googleAdsClient->getCampaignBudgetServiceClient();
$response = $campaignBudgetServiceClient->mutateCampaignBudgets(
MutateCampaignBudgetsRequest::build($customerId, [$campaignBudgetOperation])
);
/** @var CampaignBudget $addedBudget */
$addedBudget = $response->getResults()[0];
printf(
"Created a shared budget with resource name '%s'.%s",
$addedBudget->getResourceName(),
PHP_EOL
);
return $addedBudget->getResourceName();
}
// [END use_portfolio_bidding_strategy]
/**
* Creates a campaign with the created portfolio bidding strategy.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param string $biddingStrategyResourceName the bidding strategy resource name to use
* @param string $campaignBudgetResourceName the shared budget resource name to use
*/
private static function createCampaignWithBiddingStrategy(
GoogleAdsClient $googleAdsClient,
int $customerId,
string $biddingStrategyResourceName,
string $campaignBudgetResourceName
) {
// [START use_portfolio_bidding_strategy_2]
// Creates a Search campaign.
$campaign = new Campaign([
'name' => 'Interplanetary Cruise #' . Helper::getPrintableDatetime(),
'advertising_channel_type' => AdvertisingChannelType::SEARCH,
// 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,
// Configures the campaign network options.
'network_settings' => new NetworkSettings([
'target_google_search' => true,
'target_search_network' => true,
'target_content_network' => true,
]),
// Sets the bidding strategy and budget.
'bidding_strategy' => $biddingStrategyResourceName,
'campaign_budget' => $campaignBudgetResourceName
]);
// [END use_portfolio_bidding_strategy_2]
// Constructs a campaign operation.
$campaignOperation = new CampaignOperation();
$campaignOperation->setCreate($campaign);
// Issues a mutate request to add the campaign.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns(
MutateCampaignsRequest::build($customerId, [$campaignOperation])
);
/** @var Campaign $addedCampaign */
$addedCampaign = $response->getResults()[0];
printf(
"Created a campaign with resource name: '%s'.%s",
$addedCampaign->getResourceName(),
PHP_EOL
);
}
}
UsePortfolioBiddingStrategy::main();