-
Notifications
You must be signed in to change notification settings - Fork 770
/
AddCampaignGroupsAndPerformanceTargets.php
executable file
·197 lines (168 loc) · 7.31 KB
/
AddCampaignGroupsAndPerformanceTargets.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
<?php
/**
* Copyright 2017 Google Inc. All Rights Reserved.
*
* 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
*
* http://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\AdsApi\Examples\AdWords\v201806\CampaignManagement;
require __DIR__ . '/../../../../vendor/autoload.php';
use Google\AdsApi\AdWords\AdWordsServices;
use Google\AdsApi\AdWords\AdWordsSession;
use Google\AdsApi\AdWords\AdWordsSessionBuilder;
use Google\AdsApi\AdWords\v201806\cm\Campaign;
use Google\AdsApi\AdWords\v201806\cm\CampaignGroup;
use Google\AdsApi\AdWords\v201806\cm\CampaignGroupOperation;
use Google\AdsApi\AdWords\v201806\cm\CampaignGroupPerformanceTarget;
use Google\AdsApi\AdWords\v201806\cm\CampaignGroupPerformanceTargetOperation;
use Google\AdsApi\AdWords\v201806\cm\CampaignGroupPerformanceTargetService;
use Google\AdsApi\AdWords\v201806\cm\CampaignGroupService;
use Google\AdsApi\AdWords\v201806\cm\CampaignOperation;
use Google\AdsApi\AdWords\v201806\cm\CampaignService;
use Google\AdsApi\AdWords\v201806\cm\EfficiencyTargetType;
use Google\AdsApi\AdWords\v201806\cm\Money;
use Google\AdsApi\AdWords\v201806\cm\Operator;
use Google\AdsApi\AdWords\v201806\cm\PerformanceTarget;
use Google\AdsApi\AdWords\v201806\cm\SpendTargetType;
use Google\AdsApi\AdWords\v201806\cm\VolumeGoalType;
use Google\AdsApi\Common\OAuth2TokenBuilder;
/**
* This code example adds a campaign group and sets a performance target for
* that group. To get campaigns, run GetCampaigns.php. To download reports, run
* DownloadCriteriaReportWithAwql.php.
*/
class AddCampaignGroupsAndPerformanceTargets
{
const CAMPAIGN_ID_1 = 'INSERT_CAMPAIGN_ID_1_HERE';
const CAMPAIGN_ID_2 = 'INSERT_CAMPAIGN_ID_2_HERE';
public static function runExample(
AdWordsServices $adWordsServices,
AdWordsSession $session,
$campaignIds
) {
$campaignGroup = self::createCampaignGroup($adWordsServices, $session);
self::addCampaignsToGroup(
$adWordsServices,
$session,
$campaignGroup,
$campaignIds
);
self::createPerformanceTarget($adWordsServices, $session, $campaignGroup);
}
private static function createCampaignGroup(
AdWordsServices $adWordsServices,
AdWordsSession $session
) {
$campaignGroupService = $adWordsServices->get($session, CampaignGroupService::class);
// Create the campaign group.
$campaignGroup = new CampaignGroup();
$campaignGroup->setName('Mars campaign group #' . uniqid());
// Create the operation.
$operation = new CampaignGroupOperation();
$operation->setOperand($campaignGroup);
$operation->setOperator(Operator::ADD);
$campaignGroup = $campaignGroupService->mutate([$operation])->getValue()[0];
printf(
"Campaign group with ID %d and name '%s' was created.\n",
$campaignGroup->getId(),
$campaignGroup->getName()
);
return $campaignGroup;
}
private static function addCampaignsToGroup(
AdWordsServices $adWordsServices,
AdWordsSession $session,
$campaignGroup,
$campaignIds
) {
$campaignService = $adWordsServices->get($session, CampaignService::class);
$operations = [];
foreach ($campaignIds as $campaignId) {
$campaign = new Campaign();
$campaign->setId($campaignId);
$campaign->setCampaignGroupId($campaignGroup->getId());
$operation = new CampaignOperation();
$operation->setOperand($campaign);
$operation->setOperator(Operator::SET);
$operations[] = $operation;
}
$campaigns = $campaignService->mutate($operations)->getValue();
printf(
"The following campaign IDs were added to the campaign group with ID %d:\n",
$campaignGroup->getId()
);
foreach ($campaigns as $campaign) {
printf("\t%d\n", $campaign->getId());
}
}
private static function createPerformanceTarget(
AdWordsServices $adWordsServices,
AdWordsSession $session,
CampaignGroup $campaignGroup
) {
$campaignGroupPerformanceTargetService = $adWordsServices->get(
$session,
CampaignGroupPerformanceTargetService::class
);
// Create the performance target.
$performanceTarget = new PerformanceTarget();
// Keep the CPC for the campaigns < $3.
$performanceTarget->setEfficiencyTargetType(
EfficiencyTargetType::CPC_LESS_THAN_OR_EQUAL_TO
);
$performanceTarget->setEfficiencyTargetValue(3000000);
// Keep the maximum spend under $50.
$performanceTarget->setSpendTargetType(SpendTargetType::MAXIMUM);
$maxSpend = new Money();
$maxSpend->setMicroAmount(500000000);
$performanceTarget->setSpendTarget($maxSpend);
// Aim for at least 3000 clicks.
$performanceTarget->setVolumeTargetValue(3000);
$performanceTarget->setVolumeGoalType(VolumeGoalType::MAXIMIZE_CLICKS);
// Start the performance target today, and run it for the next 90 days.
$startDate = date('Ymd', strtotime('now'));
$endDate = date('Ymd', strtotime('+90 day'));
$performanceTarget->setStartDate($startDate);
$performanceTarget->setEndDate($endDate);
// Create the campaign group performance target.
$campaignGroupPerformanceTarget = new CampaignGroupPerformanceTarget();
$campaignGroupPerformanceTarget->setCampaignGroupId(
$campaignGroup->getId()
);
$campaignGroupPerformanceTarget->setPerformanceTarget($performanceTarget);
// Create the operation.
$operation = new CampaignGroupPerformanceTargetOperation();
$operation->setOperand($campaignGroupPerformanceTarget);
$operation->setOperator(Operator::ADD);
$campaignGroupPerformanceTarget = $campaignGroupPerformanceTargetService->mutate([$operation])->getValue()[0];
// Display the results.
printf(
"Campaign group performance target with ID %d was added for campaign group ID %d.\n",
$campaignGroupPerformanceTarget->getId(),
$campaignGroupPerformanceTarget->getCampaignGroupId()
);
}
public static function main()
{
// Generate a refreshable OAuth2 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())->fromFile()->build();
// Construct an API session configured from a properties file and the
// OAuth2 credentials above.
$session = (new AdWordsSessionBuilder())->fromFile()->withOAuth2Credential($oAuth2Credential)->build();
self::runExample(
new AdWordsServices(),
$session,
[intval(self::CAMPAIGN_ID_1), intval(self::CAMPAIGN_ID_2)]
);
}
}
AddCampaignGroupsAndPerformanceTargets::main();