// Copyright 2013 Google Inc. All Rights Reserved.
//
// 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
//
// http://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 dfp.axis.v201311.labelservice;
import com.google.api.ads.common.lib.auth.OfflineCredentials;
import com.google.api.ads.common.lib.auth.OfflineCredentials.Api;
import com.google.api.ads.dfp.axis.factory.DfpServices;
import com.google.api.ads.dfp.axis.v201311.Label;
import com.google.api.ads.dfp.axis.v201311.LabelServiceInterface;
import com.google.api.ads.dfp.lib.client.DfpSession;
import com.google.api.client.auth.oauth2.Credential;
/**
* This example updates a label's description. To determine which labels
* exist, run GetAllLabels.java.
*
* Credentials and properties in {@code fromFile()} are pulled from the
* "ads.properties" file. See README for more info.
*
* Tags: LabelService.getLabel
* Tags: LabelService.updateLabels
*
* @author Adam Rogal
*/
public class UpdateLabels {
// Set the ID of the label to update.
private static final String LABEL_ID = "INSERT_LABEL_ID_HERE";
public static void runExample(DfpServices dfpServices, DfpSession session, long labelId)
throws Exception {
// Get the LabelService.
LabelServiceInterface labelService =
dfpServices.get(session, LabelServiceInterface.class);
// Get the label.
Label label = labelService.getLabel(labelId);
// Update the label description.
label.setDescription("New label description");
// Update the label on the server.
Label[] labels =
labelService.updateLabels(new Label[] {label});
for (Label updatedLabel : labels) {
System.out.printf("Label with ID \"%d\" and name \"%s\" was updated.\n", updatedLabel.getId(),
updatedLabel.getName());
}
}
public static void main(String[] args) throws Exception {
// Generate a refreshable OAuth2 credential similar to a ClientLogin token
// and can be used in place of a service account.
Credential oAuth2Credential = new OfflineCredentials.Builder()
.forApi(Api.DFP)
.fromFile()
.build()
.generateCredential();
// Construct a DfpSession.
DfpSession session = new DfpSession.Builder()
.fromFile()
.withOAuth2Credential(oAuth2Credential)
.build();
DfpServices dfpServices = new DfpServices();
runExample(dfpServices, session, Long.parseLong(LABEL_ID));
}
}