// Copyright 2012 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 adwords.axis.v201306.advancedoperations;
import com.google.api.ads.adwords.axis.factory.AdWordsServices;
import com.google.api.ads.adwords.axis.v201306.cm.AdGroupAd;
import com.google.api.ads.adwords.axis.v201306.cm.AdGroupAdOperation;
import com.google.api.ads.adwords.axis.v201306.cm.AdGroupAdReturnValue;
import com.google.api.ads.adwords.axis.v201306.cm.AdGroupAdServiceInterface;
import com.google.api.ads.adwords.axis.v201306.cm.AdGroupAdStatus;
import com.google.api.ads.adwords.axis.v201306.cm.Operator;
import com.google.api.ads.adwords.axis.v201306.cm.TemplateAd;
import com.google.api.ads.adwords.axis.v201306.cm.TemplateElement;
import com.google.api.ads.adwords.axis.v201306.cm.TemplateElementField;
import com.google.api.ads.adwords.axis.v201306.cm.TemplateElementFieldType;
import com.google.api.ads.adwords.lib.client.AdWordsSession;
import com.google.api.ads.common.lib.auth.OfflineCredentials;
import com.google.api.ads.common.lib.auth.OfflineCredentials.Api;
import com.google.api.client.auth.oauth2.Credential;
/**
* This example adds a click-to-download templateAd to given ad group. To get
* adGroupId, run AddAdGroup.java.
*
* Credentials and properties in {@code fromFile()} are pulled from the
* "ads.properties" file. See README for more info.
*
* Tags: AdGroupAdService.mutate
*
* Category: adx-exclude
*
* @author Kevin Winter
*/
public class AddClickToDownloadAd {
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.ADWORDS)
.fromFile()
.build()
.generateCredential();
// Construct an AdWordsSession.
AdWordsSession session = new AdWordsSession.Builder()
.fromFile()
.withOAuth2Credential(oAuth2Credential)
.build();
long adGroupId = Long.parseLong("INSERT_AD_GROUP_ID_HERE");
AdWordsServices adWordsServices = new AdWordsServices();
runExample(adWordsServices, session, adGroupId);
}
public static void runExample(
AdWordsServices adWordsServices, AdWordsSession session, long adGroupId) throws Exception {
// Get the AdGroupAdService.
AdGroupAdServiceInterface adGroupAdService =
adWordsServices.get(session, AdGroupAdServiceInterface.class);
// Create the template ad.
TemplateAd clickToDownloadAppAd = new TemplateAd();
clickToDownloadAppAd.setName("Ad for jupiter adventure game");
clickToDownloadAppAd.setTemplateId(353L);
clickToDownloadAppAd.setUrl(
"http://play.google.com/store/apps/details?id=com.example.jupiteradventure");
clickToDownloadAppAd.setDisplayUrl("play.google.com");
// Create the template elements for the ad. You can refer to
// https://developers.google.com/adwords/api/docs/appendix/templateads
// for the list of available template fields.
TemplateElementField headline = new TemplateElementField();
headline.setName("headline");
headline.setFieldText("Enjoy a Jupiter Adventure");
headline.setType(TemplateElementFieldType.TEXT);
TemplateElementField description1 = new TemplateElementField();
description1.setName("description1");
description1.setFieldText("Realistic physics simulation");
description1.setType(TemplateElementFieldType.TEXT);
TemplateElementField description2 = new TemplateElementField();
description2.setName("description2");
description2.setFieldText("Race against players online");
description2.setType(TemplateElementFieldType.TEXT);
TemplateElementField appId = new TemplateElementField();
appId.setName("appId");
appId.setFieldText("com.example.jupiteradventure");
appId.setType(TemplateElementFieldType.TEXT);
TemplateElementField appStore = new TemplateElementField();
appStore.setName("appStore");
appStore.setFieldText("2");
appStore.setType(TemplateElementFieldType.ENUM);
TemplateElement adData = new TemplateElement();
adData.setUniqueName("adData");
adData.setFields(new TemplateElementField[] {headline, description1, description2, appId,
appStore});
clickToDownloadAppAd.setTemplateElements(new TemplateElement[] {adData});
// Create the AdGroupAd.
AdGroupAd clickToDownloadAppAdGroupAd = new AdGroupAd();
clickToDownloadAppAdGroupAd.setAdGroupId(adGroupId);
clickToDownloadAppAdGroupAd.setAd(clickToDownloadAppAd);
// Optional: Set the status.
clickToDownloadAppAdGroupAd.setStatus(AdGroupAdStatus.PAUSED);
// Create the operation.
AdGroupAdOperation operation = new AdGroupAdOperation();
operation.setOperator(Operator.ADD);
operation.setOperand(clickToDownloadAppAdGroupAd);
// Create the ads.
AdGroupAdReturnValue result = adGroupAdService.mutate(new AdGroupAdOperation[] {operation});
for (AdGroupAd adGroupAd : result.getValue()) {
System.out.printf("New click-to-download ad with id = \"%d\" and url = \"%s\" " +
"was created.", adGroupAd.getAd().getId(), adGroupAd.getAd().getUrl());
}
}
}