-
Notifications
You must be signed in to change notification settings - Fork 260
/
GenerateForecastMetrics.php
147 lines (133 loc) · 5.24 KB
/
GenerateForecastMetrics.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
<?php
/**
* Copyright 2019 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\Planning;
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\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V6\GoogleAdsClient;
use Google\Ads\GoogleAds\Lib\V6\GoogleAdsClientBuilder;
use Google\Ads\GoogleAds\Lib\V6\GoogleAdsException;
use Google\Ads\GoogleAds\Util\V6\ResourceNames;
use Google\Ads\GoogleAds\V6\Errors\GoogleAdsError;
use Google\Ads\GoogleAds\V6\Services\KeywordPlanKeywordForecast;
use Google\ApiCore\ApiException;
/**
* This code example generates forecast metrics for a keyword plan. To create a keyword plan,
* run AddKeywordPlan.php.
*/
class GenerateForecastMetrics
{
private const CUSTOMER_ID = 'INSERT_CUSTOMER_ID_HERE';
private const KEYWORD_PLAN_ID = 'INSERT_KEYWORD_PLAN_ID_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::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
ArgumentNames::KEYWORD_PLAN_ID => 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)
->build();
try {
self::runExample(
$googleAdsClient,
$options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID,
$options[ArgumentNames::KEYWORD_PLAN_ID] ?: self::KEYWORD_PLAN_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 $keywordPlanId the keyword plan ID
*/
public static function runExample(
GoogleAdsClient $googleAdsClient,
int $customerId,
int $keywordPlanId
) {
$keywordPlanServiceClient = $googleAdsClient->getKeywordPlanServiceClient();
// Issues a request to generate forecast metrics based on the specific keyword plan ID.
$generateForecastMetricsResponse = $keywordPlanServiceClient->generateForecastMetrics(
ResourceNames::forKeywordPlan($customerId, $keywordPlanId)
);
$i = 0;
foreach ($generateForecastMetricsResponse->getKeywordForecasts() as $forecast) {
/** @var KeywordPlanKeywordForecast $forecast */
$metrics = $forecast->getKeywordForecast();
printf(
"%d) Keyword ID: %s%s",
++$i,
$forecast->getKeywordPlanAdGroupKeyword(),
PHP_EOL
);
printf(
"Estimated daily clicks: %s%s",
is_null($metrics->getClicks()) ? 'null'
: sprintf("%.2f", $metrics->getClicks()),
PHP_EOL
);
printf(
"Estimated daily impressions: %s%s",
is_null($metrics->getImpressions())
? 'null' : sprintf("%.2f", $metrics->getImpressions()),
PHP_EOL
);
printf(
"Estimated average cpc (micros): %s%s",
is_null($metrics->getAverageCpc()) ? 'null' : $metrics->getAverageCpc(),
PHP_EOL
);
}
}
}
GenerateForecastMetrics::main();