com.google.api.ads.adwords.jaxws.v201809.o

Class CampaignEstimateRequest

java.lang.Object

com.google.api.ads.adwords.jaxws.v201809.o.EstimateRequest

com.google.api.ads.adwords.jaxws.v201809.o.CampaignEstimateRequest

public class CampaignEstimateRequest
extends EstimateRequest

Represents a campaign that will be estimated.

Returns traffic estimates for the requested set of campaigns. The campaigns can be all new or all existing, or a mixture of new and existing. Only existing campaigns may contain estimates for existing ad groups.

For existing campaigns, the campaign and optionally the ad group will be used as context to produce more accurate estimates. Traffic estimates may only be requested on keywords, so regardless of whether campaign and ad group IDs are provided or left blank, at least one keyword is required to estimate traffic.

To make a keyword estimates request in which estimates do not consider existing account information (e.g. historical ad group performance), set campaignId to null.

Java class for CampaignEstimateRequest complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="CampaignEstimateRequest">
   <complexContent>
     <extension base="{https://adwords.google.com/api/adwords/o/v201809}EstimateRequest">
       <sequence>
         <element name="campaignId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="adGroupEstimateRequests" type="{https://adwords.google.com/api/adwords/o/v201809}AdGroupEstimateRequest" maxOccurs="unbounded" minOccurs="0"/>
         <element name="criteria" type="{https://adwords.google.com/api/adwords/cm/v201809}Criterion" maxOccurs="unbounded" minOccurs="0"/>
         <element name="networkSetting" type="{https://adwords.google.com/api/adwords/cm/v201809}NetworkSetting" minOccurs="0"/>
         <element name="dailyBudget" type="{https://adwords.google.com/api/adwords/cm/v201809}Money" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AdGroupEstimateRequest>	adGroupEstimateRequests
protected Long	campaignId
protected List<Criterion>	criteria
protected Money	dailyBudget
protected NetworkSetting	networkSetting

Fields inherited from class com.google.api.ads.adwords.jaxws.v201809.o.EstimateRequest

estimateRequestType

Constructor Summary

Constructors

Constructor and Description
CampaignEstimateRequest()

Method Summary

Modifier and Type	Method and Description
List<AdGroupEstimateRequest>	getAdGroupEstimateRequests() Gets the value of the adGroupEstimateRequests property.
Long	getCampaignId() Gets the value of the campaignId property.
List<Criterion>	getCriteria() Gets the value of the criteria property.
Money	getDailyBudget() Gets the value of the dailyBudget property.
NetworkSetting	getNetworkSetting() Gets the value of the networkSetting property.
void	setCampaignId(Long value) Sets the value of the campaignId property.
void	setDailyBudget(Money value) Sets the value of the dailyBudget property.
void	setNetworkSetting(NetworkSetting value) Sets the value of the networkSetting property.

Methods inherited from class com.google.api.ads.adwords.jaxws.v201809.o.EstimateRequest

getEstimateRequestType, setEstimateRequestType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

campaignId

protected Long campaignId

adGroupEstimateRequests

protected List<AdGroupEstimateRequest> adGroupEstimateRequests

criteria

protected List<Criterion> criteria

networkSetting

protected NetworkSetting networkSetting

dailyBudget

protected Money dailyBudget

Constructor Detail

CampaignEstimateRequest

public CampaignEstimateRequest()

Method Detail

getCampaignId

public Long getCampaignId()

Gets the value of the campaignId property.

Returns:

possible object is Long

setCampaignId

public void setCampaignId(Long value)

Sets the value of the campaignId property.

Parameters:

value - allowed object is Long

getAdGroupEstimateRequests

public List<AdGroupEstimateRequest> getAdGroupEstimateRequests()

Gets the value of the adGroupEstimateRequests property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the adGroupEstimateRequests property.

For example, to add a new item, do as follows:

    getAdGroupEstimateRequests().add(newItem);
 

Objects of the following type(s) are allowed in the list AdGroupEstimateRequest

getCriteria

public List<Criterion> getCriteria()

Gets the value of the criteria property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the criteria property.

For example, to add a new item, do as follows:

    getCriteria().add(newItem);
 

Objects of the following type(s) are allowed in the list Criterion

getNetworkSetting

public NetworkSetting getNetworkSetting()

Gets the value of the networkSetting property.

Returns:

possible object is NetworkSetting

setNetworkSetting

public void setNetworkSetting(NetworkSetting value)

Sets the value of the networkSetting property.

Parameters:

value - allowed object is NetworkSetting

getDailyBudget

public Money getDailyBudget()

Gets the value of the dailyBudget property.

Returns:

possible object is Money

setDailyBudget

public void setDailyBudget(Money value)

Sets the value of the dailyBudget property.

Parameters:

value - allowed object is Money