-
Notifications
You must be signed in to change notification settings - Fork 260
/
AddCampaignTargetingCriteria.php
245 lines (225 loc) · 10.4 KB
/
AddCampaignTargetingCriteria.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
<?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\Targeting;
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\V2\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V2\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V2\GoogleAdsException;
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Util\V2\ResourceNames;
use Google\Ads\GoogleAds\V2\Common\AddressInfo;
use Google\Ads\GoogleAds\V2\Common\KeywordInfo;
use Google\Ads\GoogleAds\V2\Common\LocationInfo;
use Google\Ads\GoogleAds\V2\Common\ProximityInfo;
use Google\Ads\GoogleAds\V2\Enums\KeywordMatchTypeEnum\KeywordMatchType;
use Google\Ads\GoogleAds\V2\Enums\ProximityRadiusUnitsEnum\ProximityRadiusUnits;
use Google\Ads\GoogleAds\V2\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V2\Resources\CampaignCriterion;
use Google\Ads\GoogleAds\V2\Services\CampaignCriterionOperation;
use Google\ApiCore\ApiException;
use Google\Protobuf\BoolValue;
use Google\Protobuf\DoubleValue;
use Google\Protobuf\StringValue;
/**
* This example adds campaign targeting criteria. To get campaign targeting criteria, run
* GetCampaignTargetingCriteria.php.
*/
class AddCampaignTargetingCriteria
{
const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
const CAMPAIGN_ID = 'INSERT_CAMPAIGN_ID_HERE';
// Specify the keyword text to be created as a negative campaign criterion.
const KEYWORD_TEXT = 'INSERT_KEYWORD_TEXT_HERE';
// Specify the location ID below.
// For more information on determining LOCATION_ID value, see:
// https://developers.google.com/adwords/api/docs/appendix/geotargeting.
const LOCATION_ID = 21167; // New York
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_ID => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::KEYWORD_TEXT => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::LOCATION_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)
->build();
try {
self::runExample(
$googleAdsClient,
$options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID,
$options[ArgumentNames::CAMPAIGN_ID] ?: self::CAMPAIGN_ID,
$options[ArgumentNames::KEYWORD_TEXT] ?: self::KEYWORD_TEXT,
$options[ArgumentNames::LOCATION_ID] ?: self::LOCATION_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
);
}
} catch (ApiException $apiException) {
printf(
"ApiException was thrown with message '%s'.%s",
$apiException->getMessage(),
PHP_EOL
);
}
}
/**
* Runs the example.
*
* @param GoogleAdsClient $googleAdsClient the Google Ads API client
* @param int $customerId the customer ID
* @param int $campaignId the campaign ID to add a criterion to
* @param string $keywordText the keyword text to be added as a negative campaign criterion
* @param int $locationId the location ID to be targeted
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $campaignId,
string $keywordText,
$locationId
) {
$campaignResourceName = ResourceNames::forCampaign($customerId, $campaignId);
$operations = [
// Creates a campaign criterion operation for the specified keyword text.
self::createNegativeKeywordCampaignCriterionOperation(
$keywordText,
$campaignResourceName
),
// Creates a campaign criterion operation for the specified location ID.
self::createLocationCampaignCriterionOperation($locationId, $campaignResourceName),
// Creates a campaign criterion operation for the area around a specific address
// (proximity).
self::createProximityCampaignCriterionOperation($campaignResourceName)
];
// Issues a mutate request to add the campaign criterion.
$campaignCriterionServiceClient = $googleAdsClient->getCampaignCriterionServiceClient();
$response =
$campaignCriterionServiceClient->mutateCampaignCriteria($customerId, $operations);
printf("Added %d campaign criteria:%s", $response->getResults()->count(), PHP_EOL);
foreach ($response->getResults() as $addedCampaignCriterion) {
/** @var CampaignCriterion $addedCampaignCriterion */
print $addedCampaignCriterion->getResourceName() . PHP_EOL;
}
}
/**
* Creates a campaign criterion operation using the specified keyword text. The keyword text
* will be used to create a negative campaign criterion.
*
* @param string $keywordText the keyword text to be added
* @param string $campaignResourceName the campaign resource name that the created criterion
* belongs to
* @return CampaignCriterionOperation the created campaign criterion operation
*/
private static function createNegativeKeywordCampaignCriterionOperation(
string $keywordText,
$campaignResourceName
) {
// Constructs a negative campaign criterion for the specified campaign ID using the
// specified keyword text info.
$campaignCriterion = new CampaignCriterion([
// Creates a keyword with BROAD match type.
'keyword' => new KeywordInfo([
'text' => new StringValue(['value' => $keywordText]),
'match_type' => KeywordMatchType::BROAD
]),
// Sets the campaign criterion as a negative criterion.
'negative' => new BoolValue(['value' => true]),
'campaign' => new StringValue(['value' => $campaignResourceName])
]);
return new CampaignCriterionOperation(['create' => $campaignCriterion]);
}
/**
* Creates a campaign criterion operation using the specified location ID.
*
* @param int $locationId the specified location ID
* @param string $campaignResourceName the campaign resource name that the created criterion
* belongs to
* @return CampaignCriterionOperation the created campaign criterion operation
*/
private static function createLocationCampaignCriterionOperation(
int $locationId,
string $campaignResourceName
) {
// Constructs a campaign criterion for the specified campaign ID using the specified
// location ID.
$campaignCriterion = new CampaignCriterion([
// Creates a location using the specified location ID.
'location' => new LocationInfo([
'geo_target_constant' => new StringValue(
// Besides using location ID, you can also search by location names using
// GeoTargetConstantServiceClient::suggestGeoTargetConstants() and directly
// apply GeoTargetConstant::$resourceName here. An example can be found
// in GetGeoTargetConstantByNames.php.
['value' => ResourceNames::forGeoTargetConstant($locationId)]
)
]),
'campaign' => new StringValue(['value' => $campaignResourceName])
]);
return new CampaignCriterionOperation(['create' => $campaignCriterion]);
}
/**
* Creates a campaign criterion operation for the area around a specific address (proximity).
*
* @param string $campaignResourceName the campaign resource name that the created criterion
* belongs to
* @return CampaignCriterionOperation the created campaign criterion operation
*/
private static function createProximityCampaignCriterionOperation(string $campaignResourceName)
{
// Constructs a campaign criterion as a proximity.
$campaignCriterion = new CampaignCriterion([
'proximity' => new ProximityInfo([
'address' => new AddressInfo([
'street_address' => new StringValue(['value' => '38 avenue de l\'Opéra']),
'city_name' => new StringValue(['value' => 'Paris']),
'postal_code' => new StringValue(['value' => '75002']),
'country_code' => new StringValue(['value' => 'FR']),
]),
'radius' => new DoubleValue(['value' => 10.0]),
// Default is kilometers.
'radius_units' => ProximityRadiusUnits::MILES
]),
'campaign' => new StringValue(['value' => $campaignResourceName])
]);
return new CampaignCriterionOperation(['create' => $campaignCriterion]);
}
}
AddCampaignTargetingCriteria::main();