-
Notifications
You must be signed in to change notification settings - Fork 176
/
GenerateForecastMetrics.java
114 lines (102 loc) · 4.69 KB
/
GenerateForecastMetrics.java
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
// 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.
package com.google.ads.googleads.examples.planning;
import com.beust.jcommander.Parameter;
import com.google.ads.googleads.examples.utils.ArgumentNames;
import com.google.ads.googleads.examples.utils.CodeSampleParams;
import com.google.ads.googleads.lib.GoogleAdsClient;
import com.google.ads.googleads.v13.errors.GoogleAdsError;
import com.google.ads.googleads.v13.errors.GoogleAdsException;
import com.google.ads.googleads.v13.services.ForecastMetrics;
import com.google.ads.googleads.v13.services.GenerateForecastMetricsResponse;
import com.google.ads.googleads.v13.services.KeywordPlanKeywordForecast;
import com.google.ads.googleads.v13.services.KeywordPlanServiceClient;
import com.google.ads.googleads.v13.utils.ResourceNames;
import java.io.FileNotFoundException;
import java.io.IOException;
/**
* Creates a keyword plan, which can be reused for retrieving forecast metrics and historic metrics.
*/
public class GenerateForecastMetrics {
private static class GenerateForecastMetricParams extends CodeSampleParams {
@Parameter(
names = ArgumentNames.CUSTOMER_ID,
description = "The customer in which to create a new keyword plan.")
public Long customerId;
@Parameter(
names = ArgumentNames.KEYWORD_PLAN_ID,
description = "The keyword plan ID for which to generate metrics.")
public Long keywordPlanId;
}
public static void main(String[] args) {
GenerateForecastMetricParams params = new GenerateForecastMetricParams();
if (!params.parseArguments(args)) {
// Optional, specify the customer ID for which the call is made.
params.customerId = Long.valueOf("INSERT_CUSTOMER_ID");
params.keywordPlanId = Long.valueOf("INSERT_KEYWORD_PLAN_ID");
}
GoogleAdsClient googleAdsClient = null;
try {
googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (FileNotFoundException fnfe) {
System.err.printf(
"Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe);
System.exit(1);
} catch (IOException ioe) {
System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
System.exit(1);
}
try {
new GenerateForecastMetrics()
.runExample(googleAdsClient, params.customerId, params.keywordPlanId);
} catch (GoogleAdsException gae) {
// GoogleAdsException is the base class for most exceptions thrown by an API request.
// Instances of this exception have a message and a GoogleAdsFailure that contains a
// collection of GoogleAdsErrors that indicate the underlying causes of the
// GoogleAdsException.
System.err.printf(
"Request ID %s failed due to GoogleAdsException. Underlying errors:%n",
gae.getRequestId());
int i = 0;
for (GoogleAdsError googleAdsError : gae.getGoogleAdsFailure().getErrorsList()) {
System.err.printf(" Error %d: %s%n", i++, googleAdsError);
}
System.exit(1);
}
}
/**
* Runs the code example.
*
* @param googleAdsClient the Google Ads API client.
* @param customerId the client customer ID.
* @param planId the plan ID.
*/
// [START generate_forecast_metrics]
private void runExample(GoogleAdsClient googleAdsClient, Long customerId, Long planId) {
String planResourceName = ResourceNames.keywordPlan(customerId, planId);
try (KeywordPlanServiceClient client =
googleAdsClient.getLatestVersion().createKeywordPlanServiceClient()) {
GenerateForecastMetricsResponse response = client.generateForecastMetrics(planResourceName);
int i = 0;
for (KeywordPlanKeywordForecast forecast : response.getKeywordForecastsList()) {
ForecastMetrics metrics = forecast.getKeywordForecast();
System.out.printf("%d Keyword ID: %s%n", ++i, forecast.getKeywordPlanAdGroupKeyword());
System.out.printf("Estimated daily clicks: %f%n", metrics.getClicks());
System.out.printf("Estimated daily impressions: %f%n", metrics.getImpressions());
System.out.printf("Estimated average cpc (micros): %d%n%n", metrics.getAverageCpc());
}
}
}
// [END generate_forecast_metrics]
}