/
GetGeoTargetConstantByNames.php
153 lines (140 loc) · 6.29 KB
/
GetGeoTargetConstantByNames.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
<?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\V2\Enums\GeoTargetConstantStatusEnum\GeoTargetConstantStatus;
use Google\Ads\GoogleAds\V2\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V2\Services\GeoTargetConstantSuggestion;
use Google\Ads\GoogleAds\V2\Services\SuggestGeoTargetConstantsRequest\LocationNames;
use Google\ApiCore\ApiException;
use Google\Protobuf\StringValue;
/**
* This code example gets geo target constants by given location names.
*/
class GetGeoTargetConstantByNames
{
// Locale is using ISO 639-1 format. If an invalid locale is given, 'en' will be used by
// default.
const LOCALE = 'en';
// A list of country codes can be referenced here:
// https://developers.google.com/adwords/api/docs/appendix/geotargeting.
const COUNTRY_CODE = 'FR';
// The location names to get suggested geo target constants.
private static $LOCATION_NAMES = ['Paris', 'Quebec', 'Spain', 'Deutschland'];
const PAGE_SIZE = 1000;
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::LOCATION_NAMES => GetOpt::MULTIPLE_ARGUMENT,
ArgumentNames::LOCALE => GetOpt::OPTIONAL_ARGUMENT,
ArgumentNames::COUNTRY_CODE => 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::LOCATION_NAMES] ?: self::$LOCATION_NAMES,
$options[ArgumentNames::LOCALE] ?: self::LOCALE,
$options[ArgumentNames::COUNTRY_CODE] ?: self::COUNTRY_CODE
);
} 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 array $locationNames the list of location names to get suggested geo target constants
* @param string $locale the locale of the geo target constant to be retrieved
* @param string $countryCode the country code of the geo target constant to be retrieved
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
array $locationNames,
string $locale,
string $countryCode
) {
$geoTargetConstantServiceClient = $googleAdsClient->getGeoTargetConstantServiceClient();
$names = [];
foreach ($locationNames as $locationName) {
$names[] = new StringValue(['value' => $locationName]);
}
$response = $geoTargetConstantServiceClient->suggestGeoTargetConstants(
new StringValue(['value' => $locale]),
new StringValue(['value' => $countryCode]),
['locationNames' => new LocationNames(['names' => $names])]
);
// Iterates over all geo target constant suggestion objects and prints the requested field
// values for each one.
foreach ($response->getGeoTargetConstantSuggestions() as $geoTargetConstantSuggestion) {
/** @var GeoTargetConstantSuggestion $geoTargetConstantSuggestion */
printf(
"Found '%s' ('%s','%s','%s',%s) in locale '%s' with reach %d"
. " for the search term '%s'.%s",
$geoTargetConstantSuggestion->getGeoTargetConstant()->getResourceName(),
$geoTargetConstantSuggestion->getGeoTargetConstant()->getNameUnwrapped(),
$geoTargetConstantSuggestion->getGeoTargetConstant()->getCountryCodeUnwrapped(),
$geoTargetConstantSuggestion->getGeoTargetConstant()->getTargetTypeUnwrapped(),
GeoTargetConstantStatus::name(
$geoTargetConstantSuggestion->getGeoTargetConstant()->getStatus()
),
$geoTargetConstantSuggestion->getLocaleUnwrapped(),
$geoTargetConstantSuggestion->getReachUnwrapped(),
$geoTargetConstantSuggestion->getSearchTermUnwrapped(),
PHP_EOL
);
}
}
}
GetGeoTargetConstantByNames::main();