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

Class AdGroupEstimateRequest

java.lang.Object

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

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

public class AdGroupEstimateRequest
extends EstimateRequest

Represents an ad group that will be estimated. Ad groups may be all new or all existing, or a mixture of new and existing. Only existing campaigns can contain estimates for existing ad groups.

To make a keyword estimates request in which estimates do not consider existing account information (e.g. historical ad group performance), set both adGroupId and the enclosing CampaignEstimateRequest's campaignId to null.

For more details on usage, refer to document at CampaignEstimateRequest.

Java class for AdGroupEstimateRequest complex type.

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

 <complexType name="AdGroupEstimateRequest">
   <complexContent>
     <extension base="{https://adwords.google.com/api/adwords/o/v201809}EstimateRequest">
       <sequence>
         <element name="adGroupId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="keywordEstimateRequests" type="{https://adwords.google.com/api/adwords/o/v201809}KeywordEstimateRequest" maxOccurs="unbounded" minOccurs="0"/>
         <element name="maxCpc" 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 Long	adGroupId
protected List<KeywordEstimateRequest>	keywordEstimateRequests
protected Money	maxCpc

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

estimateRequestType

Constructor Summary

Constructors

Constructor and Description
AdGroupEstimateRequest()

Method Summary

Modifier and Type	Method and Description
Long	getAdGroupId() Gets the value of the adGroupId property.
List<KeywordEstimateRequest>	getKeywordEstimateRequests() Gets the value of the keywordEstimateRequests property.
Money	getMaxCpc() Gets the value of the maxCpc property.
void	setAdGroupId(Long value) Sets the value of the adGroupId property.
void	setMaxCpc(Money value) Sets the value of the maxCpc 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

adGroupId

protected Long adGroupId

keywordEstimateRequests

protected List<KeywordEstimateRequest> keywordEstimateRequests

maxCpc

protected Money maxCpc

Constructor Detail

AdGroupEstimateRequest

public AdGroupEstimateRequest()

Method Detail

getAdGroupId

public Long getAdGroupId()

Gets the value of the adGroupId property.

Returns:

possible object is Long

setAdGroupId

public void setAdGroupId(Long value)

Sets the value of the adGroupId property.

Parameters:

value - allowed object is Long

getKeywordEstimateRequests

public List<KeywordEstimateRequest> getKeywordEstimateRequests()

Gets the value of the keywordEstimateRequests 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 keywordEstimateRequests property.

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

    getKeywordEstimateRequests().add(newItem);
 

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

getMaxCpc

public Money getMaxCpc()

Gets the value of the maxCpc property.

Returns:

possible object is Money

setMaxCpc

public void setMaxCpc(Money value)

Sets the value of the maxCpc property.

Parameters:

value - allowed object is Money