-
Notifications
You must be signed in to change notification settings - Fork 256
/
SearchForGoogleAdsFields.php
184 lines (171 loc) · 7.29 KB
/
SearchForGoogleAdsFields.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
<?php
/**
* Copyright 2022 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\BasicOperations;
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\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\V16\Enums\GoogleAdsFieldCategoryEnum\GoogleAdsFieldCategory;
use Google\Ads\GoogleAds\V16\Enums\GoogleAdsFieldDataTypeEnum\GoogleAdsFieldDataType;
use Google\Ads\GoogleAds\V16\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V16\Resources\GoogleAdsField;
use Google\Ads\GoogleAds\V16\Services\SearchGoogleAdsFieldsRequest;
use Google\ApiCore\ApiException;
/**
* Searches for GoogleAdsFields that match a given prefix, retrieving metadata such as
* whether the field is selectable, filterable, or sortable, along with the data type and the fields
* that are selectable with the field. Each GoogleAdsField represents either a resource (such as
* customer, campaign) or a field (such as metrics.impressions, campaign.id).
*/
class SearchForGoogleAdsFields
{
private const NAME_PREFIX = 'INSERT_NAME_PREFIX_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::NAME_PREFIX => 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)
// 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::NAME_PREFIX] ?: self::NAME_PREFIX
);
} 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 string $namePrefix the name prefix to use in the query
*/
public static function runExample(GoogleAdsClient $googleAdsClient, string $namePrefix)
{
$googleAdsFieldServiceClient = $googleAdsClient->getGoogleAdsFieldServiceClient();
// Searches for all fields whose name begins with the specified namePrefix.
// A single "%" is the wildcard token in the Google Ads Query language.
$query = "SELECT name, category, selectable, filterable, sortable, selectable_with, "
. "data_type, is_repeated WHERE name LIKE '$namePrefix%'";
$response = $googleAdsFieldServiceClient->searchGoogleAdsFields(
SearchGoogleAdsFieldsRequest::build($query)
);
if (iterator_count($response->getIterator()) === 0) {
printf(
"No GoogleAdsFields found with a name that begins with %s.%s",
$namePrefix,
PHP_EOL
);
return;
}
// Iterates over all rows and prints our the metadata of each matching GoogleAdsField.
foreach ($response->iterateAllElements() as $googleAdsField) {
/** @var GoogleAdsField $googleAdsField */
printf("%s:%s", $googleAdsField->getName(), PHP_EOL);
printf(
" %-16s: %s%s",
"category:",
GoogleAdsFieldCategory::name($googleAdsField->getCategory()),
PHP_EOL
);
printf(
" %-16s: %s%s",
"data type:",
GoogleAdsFieldDataType::name($googleAdsField->getDataType()),
PHP_EOL
);
printf(
" %-16s: %s%s",
"selectable:",
$googleAdsField->getSelectable() ? 'true' : 'false',
PHP_EOL
);
printf(
" %-16s: %s%s",
"filterable:",
$googleAdsField->getFilterable() ? 'true' : 'false',
PHP_EOL
);
printf(
" %-16s: %s%s",
"sortable:",
$googleAdsField->getSortable() ? 'true' : 'false',
PHP_EOL
);
printf(
" %-16s: %s%s",
"repeated:",
$googleAdsField->getIsRepeated() ? 'true' : 'false',
PHP_EOL
);
if ($googleAdsField->getSelectableWith()->count() > 0) {
// Prints the list of fields that are selectable with the field.
$selectableWithFields =
iterator_to_array($googleAdsField->getSelectableWith()->getIterator());
// Sorts and then prints the list.
sort($selectableWithFields);
print ' selectable with:' . PHP_EOL;
foreach ($selectableWithFields as $selectableWithField) {
/** @var string $selectableWithField */
printf(" $selectableWithField%s", PHP_EOL);
}
}
}
}
}
SearchForGoogleAdsFields::main();