-
Notifications
You must be signed in to change notification settings - Fork 176
/
FindAndRemoveCriteriaFromSharedSet.java
192 lines (174 loc) · 8.32 KB
/
FindAndRemoveCriteriaFromSharedSet.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
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
// 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.
package com.google.ads.googleads.examples.advancedoperations;
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.v4.enums.CriterionTypeEnum.CriterionType;
import com.google.ads.googleads.v4.errors.GoogleAdsError;
import com.google.ads.googleads.v4.errors.GoogleAdsException;
import com.google.ads.googleads.v4.resources.SharedCriterion;
import com.google.ads.googleads.v4.resources.SharedSet;
import com.google.ads.googleads.v4.services.GoogleAdsRow;
import com.google.ads.googleads.v4.services.GoogleAdsServiceClient;
import com.google.ads.googleads.v4.services.GoogleAdsServiceClient.SearchPagedResponse;
import com.google.ads.googleads.v4.services.MutateSharedCriteriaResponse;
import com.google.ads.googleads.v4.services.MutateSharedCriterionResult;
import com.google.ads.googleads.v4.services.SearchGoogleAdsRequest;
import com.google.ads.googleads.v4.services.SharedCriterionOperation;
import com.google.ads.googleads.v4.services.SharedCriterionServiceClient;
import com.google.common.base.Joiner;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
/**
* Demonstrates how to find shared sets, how to find shared set criteria, and how to remove shared
* set criteria.
*/
public class FindAndRemoveCriteriaFromSharedSet {
private static final int PAGE_SIZE = 1_000;
private static class FindAndRemoveCriteriaFromSharedSetParams extends CodeSampleParams {
@Parameter(names = ArgumentNames.CUSTOMER_ID, required = true)
private Long customerId;
@Parameter(names = ArgumentNames.CAMPAIGN_ID, required = true)
private Long campaignId;
}
public static void main(String[] args) throws IOException {
FindAndRemoveCriteriaFromSharedSetParams params =
new FindAndRemoveCriteriaFromSharedSetParams();
if (!params.parseArguments(args)) {
// Either pass the required parameters for this example on the command line, or insert them
// into the code here. See the parameter class definition above for descriptions.
params.customerId = Long.parseLong("INSERT_CUSTOMER_ID_HERE");
params.campaignId = Long.parseLong("INSERT_CAMPAIGN_ID_HERE");
}
GoogleAdsClient googleAdsClient;
try {
googleAdsClient = GoogleAdsClient.newBuilder().fromPropertiesFile().build();
} catch (FileNotFoundException fnfe) {
System.err.printf(
"Failed to load GoogleAdsClient configuration from file. Exception: %s%n", fnfe);
return;
} catch (IOException ioe) {
System.err.printf("Failed to create GoogleAdsClient. Exception: %s%n", ioe);
return;
}
try {
new FindAndRemoveCriteriaFromSharedSet()
.runExample(googleAdsClient, params.customerId, params.campaignId);
} 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);
}
}
}
/**
* Runs the example.
*
* @param googleAdsClient the Google Ads API client.
* @param customerId the client customer ID.
* @param campaignId the campaign ID.
* @throws GoogleAdsException if an API request failed with one or more service errors.
*/
private void runExample(GoogleAdsClient googleAdsClient, long customerId, long campaignId) {
List<Long> sharedSetIds = new ArrayList<>();
List<String> criterionResourceNames = new ArrayList<>();
// Retrieves all shared sets associated with the campaign.
try (GoogleAdsServiceClient googleAdsServiceClient =
googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
String searchQuery =
String.format(
"SELECT shared_set.id, shared_set.name FROM campaign_shared_set WHERE "
+ "campaign.id = %d",
campaignId);
SearchGoogleAdsRequest request =
SearchGoogleAdsRequest.newBuilder()
.setCustomerId(Long.toString(customerId))
.setPageSize(PAGE_SIZE)
.setQuery(searchQuery)
.build();
SearchPagedResponse searchPagedResponse = googleAdsServiceClient.search(request);
for (GoogleAdsRow googleAdsRow : searchPagedResponse.iterateAll()) {
SharedSet sharedSet = googleAdsRow.getSharedSet();
System.out.printf(
"Campaign shared set with ID %d and name '%s' was found.%n",
sharedSet.getId().getValue(), sharedSet.getName().getValue());
sharedSetIds.add(sharedSet.getId().getValue());
}
}
// Retrieves shared criteria for all found shared sets.
try (GoogleAdsServiceClient googleAdsServiceClient =
googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
String searchQuery =
String.format(
"SELECT shared_criterion.type, shared_criterion.keyword.text, "
+ " shared_criterion.keyword.match_type, shared_set.id "
+ " FROM shared_criterion "
+ " WHERE shared_set.id IN (%s)",
Joiner.on(",").join(sharedSetIds));
SearchGoogleAdsRequest request =
SearchGoogleAdsRequest.newBuilder()
.setCustomerId(Long.toString(customerId))
.setPageSize(PAGE_SIZE)
.setQuery(searchQuery)
.build();
SearchPagedResponse searchPagedResponse = googleAdsServiceClient.search(request);
for (GoogleAdsRow googleAdsRow : searchPagedResponse.iterateAll()) {
SharedCriterion sharedCriterion = googleAdsRow.getSharedCriterion();
if (sharedCriterion.getType() == CriterionType.KEYWORD) {
System.out.printf(
"Shared criterion with resource name '%s' for negative keyword with text '%s' and "
+ "match type '%s' was found.%n",
sharedCriterion.getResourceName(),
sharedCriterion.getKeyword().getText(),
sharedCriterion.getKeyword().getMatchType());
} else {
System.out.printf(
"Shared criterion with resource name '%s' was found.",
sharedCriterion.getResourceName());
}
criterionResourceNames.add(sharedCriterion.getResourceName());
}
}
// Removes the criteria.
try (SharedCriterionServiceClient sharedCriterionServiceClient =
googleAdsClient.getLatestVersion().createSharedCriterionServiceClient()) {
List<SharedCriterionOperation> operations = new ArrayList<>();
for (String criterionResourceName : criterionResourceNames) {
SharedCriterionOperation operation =
SharedCriterionOperation.newBuilder().setRemove(criterionResourceName).build();
operations.add(operation);
}
// Sends the operation in a mutate request.
MutateSharedCriteriaResponse response =
sharedCriterionServiceClient.mutateSharedCriteria(Long.toString(customerId), operations);
// Prints the resource name of each removed object.
for (MutateSharedCriterionResult mutateSharedCriterionResult : response.getResultsList()) {
System.out.printf(
"Removed shared criterion with resource name: '%s'.%n",
mutateSharedCriterionResult.getResourceName());
}
}
}
}