adwords.axis.v201309.basicoperations.AddCampaigns.java Source code

Java tutorial

Introduction

Here is the source code for adwords.axis.v201309.basicoperations.AddCampaigns.java

Source

// 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.v201309.basicoperations;

import com.google.api.ads.adwords.axis.factory.AdWordsServices;
import com.google.api.ads.adwords.axis.v201309.cm.AdServingOptimizationStatus;
import com.google.api.ads.adwords.axis.v201309.cm.BiddingStrategyConfiguration;
import com.google.api.ads.adwords.axis.v201309.cm.BiddingStrategyType;
import com.google.api.ads.adwords.axis.v201309.cm.Budget;
import com.google.api.ads.adwords.axis.v201309.cm.BudgetBudgetDeliveryMethod;
import com.google.api.ads.adwords.axis.v201309.cm.BudgetBudgetPeriod;
import com.google.api.ads.adwords.axis.v201309.cm.BudgetOperation;
import com.google.api.ads.adwords.axis.v201309.cm.BudgetServiceInterface;
import com.google.api.ads.adwords.axis.v201309.cm.Campaign;
import com.google.api.ads.adwords.axis.v201309.cm.CampaignOperation;
import com.google.api.ads.adwords.axis.v201309.cm.CampaignReturnValue;
import com.google.api.ads.adwords.axis.v201309.cm.CampaignServiceInterface;
import com.google.api.ads.adwords.axis.v201309.cm.CampaignStatus;
import com.google.api.ads.adwords.axis.v201309.cm.FrequencyCap;
import com.google.api.ads.adwords.axis.v201309.cm.GeoTargetTypeSetting;
import com.google.api.ads.adwords.axis.v201309.cm.GeoTargetTypeSettingPositiveGeoTargetType;
import com.google.api.ads.adwords.axis.v201309.cm.KeywordMatchSetting;
import com.google.api.ads.adwords.axis.v201309.cm.Level;
import com.google.api.ads.adwords.axis.v201309.cm.ManualCpcBiddingScheme;
import com.google.api.ads.adwords.axis.v201309.cm.Money;
import com.google.api.ads.adwords.axis.v201309.cm.NetworkSetting;
import com.google.api.ads.adwords.axis.v201309.cm.Operator;
import com.google.api.ads.adwords.axis.v201309.cm.Setting;
import com.google.api.ads.adwords.axis.v201309.cm.TimeUnit;
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;

import org.joda.time.DateTime;

/**
 * This example adds campaigns.
 *
 * Credentials and properties in {@code fromFile()} are pulled from the
 * "ads.properties" file. See README for more info.
 *
 * Tags: CampaignService.mutate, BudgetService.mutate
 *
 * Category: adx-exclude
 *
 * @author Adam Rogal
 */
public class AddCampaigns {

    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();

        AdWordsServices adWordsServices = new AdWordsServices();

        runExample(adWordsServices, session);
    }

    public static void runExample(AdWordsServices adWordsServices, AdWordsSession session) throws Exception {
        // Get the BudgetService.
        BudgetServiceInterface budgetService = adWordsServices.get(session, BudgetServiceInterface.class);

        // Create a budget, which can be shared by multiple campaigns.
        Budget sharedBudget = new Budget();
        sharedBudget.setName("Interplanetary Cruise #" + System.currentTimeMillis());
        Money budgetAmount = new Money();
        budgetAmount.setMicroAmount(50000000L);
        sharedBudget.setAmount(budgetAmount);
        sharedBudget.setDeliveryMethod(BudgetBudgetDeliveryMethod.STANDARD);
        sharedBudget.setPeriod(BudgetBudgetPeriod.DAILY);

        BudgetOperation budgetOperation = new BudgetOperation();
        budgetOperation.setOperand(sharedBudget);
        budgetOperation.setOperator(Operator.ADD);

        // Add the budget
        Long budgetId = budgetService.mutate(new BudgetOperation[] { budgetOperation }).getValue(0).getBudgetId();

        // Get the CampaignService.
        CampaignServiceInterface campaignService = adWordsServices.get(session, CampaignServiceInterface.class);

        // Create campaign.
        Campaign campaign = new Campaign();
        campaign.setName("Interplanetary Cruise #" + System.currentTimeMillis());
        campaign.setStatus(CampaignStatus.PAUSED);
        BiddingStrategyConfiguration biddingStrategyConfiguration = new BiddingStrategyConfiguration();
        biddingStrategyConfiguration.setBiddingStrategyType(BiddingStrategyType.MANUAL_CPC);

        // You can optionally provide a bidding scheme in place of the type.
        ManualCpcBiddingScheme cpcBiddingScheme = new ManualCpcBiddingScheme();
        cpcBiddingScheme.setEnhancedCpcEnabled(false);
        biddingStrategyConfiguration.setBiddingScheme(cpcBiddingScheme);

        campaign.setBiddingStrategyConfiguration(biddingStrategyConfiguration);

        // You can optionally provide these field(s).
        campaign.setStartDate(new DateTime().plusDays(1).toString("yyyyMMdd"));
        campaign.setStartDate(new DateTime().plusDays(30).toString("yyyyMMdd"));
        campaign.setAdServingOptimizationStatus(AdServingOptimizationStatus.ROTATE);
        campaign.setFrequencyCap(new FrequencyCap(5L, TimeUnit.DAY, Level.ADGROUP));

        // Only the budgetId should be sent, all other fields will be ignored by CampaignService.
        Budget budget = new Budget();
        budget.setBudgetId(budgetId);
        campaign.setBudget(budget);

        // Set the campaign network options to Search and Search Network.
        NetworkSetting networkSetting = new NetworkSetting();
        networkSetting.setTargetGoogleSearch(true);
        networkSetting.setTargetSearchNetwork(true);
        networkSetting.setTargetContentNetwork(false);
        networkSetting.setTargetPartnerSearchNetwork(false);
        campaign.setNetworkSetting(networkSetting);

        // Set options that are not required.
        GeoTargetTypeSetting geoTarget = new GeoTargetTypeSetting();
        geoTarget.setPositiveGeoTargetType(GeoTargetTypeSettingPositiveGeoTargetType.DONT_CARE);
        KeywordMatchSetting keywordMatch = new KeywordMatchSetting();
        keywordMatch.setOptIn(Boolean.FALSE);
        campaign.setSettings(new Setting[] { geoTarget, keywordMatch });

        // You can create multiple campaigns in a single request.
        Campaign campaign2 = new Campaign();
        campaign2.setName("Interplanetary Cruise banner #" + System.currentTimeMillis());
        campaign2.setStatus(CampaignStatus.PAUSED);
        BiddingStrategyConfiguration biddingStrategyConfiguration2 = new BiddingStrategyConfiguration();
        biddingStrategyConfiguration2.setBiddingStrategyType(BiddingStrategyType.MANUAL_CPC);
        campaign2.setBiddingStrategyConfiguration(biddingStrategyConfiguration2);

        Budget budget2 = new Budget();
        budget2.setBudgetId(budgetId);
        campaign2.setBudget(budget2);

        NetworkSetting networkSetting2 = new NetworkSetting();
        networkSetting2.setTargetGoogleSearch(false);
        networkSetting2.setTargetSearchNetwork(false);
        networkSetting2.setTargetContentNetwork(true);
        networkSetting2.setTargetPartnerSearchNetwork(false);
        campaign2.setNetworkSetting(networkSetting2);

        KeywordMatchSetting keywordMatch2 = new KeywordMatchSetting();
        keywordMatch2.setOptIn(Boolean.FALSE);
        campaign2.setSettings(new Setting[] { keywordMatch2 });

        // Create operations.
        CampaignOperation operation = new CampaignOperation();
        operation.setOperand(campaign);
        operation.setOperator(Operator.ADD);
        CampaignOperation operation2 = new CampaignOperation();
        operation2.setOperand(campaign2);
        operation2.setOperator(Operator.ADD);

        CampaignOperation[] operations = new CampaignOperation[] { operation, operation2 };

        // Add campaigns.
        CampaignReturnValue result = campaignService.mutate(operations);

        // Display campaigns.
        for (Campaign campaignResult : result.getValue()) {
            System.out.println("Campaign with name \"" + campaignResult.getName() + "\" and id \""
                    + campaignResult.getId() + "\" was added.");
        }
    }
}