com.google.api.ads.adwords.axis.utils.v201710

Class ServiceQuery

java.lang.Object

com.google.api.ads.adwords.axis.utils.v201710.ServiceQuery

All Implemented Interfaces:

ServiceQueryInterface<com.google.api.ads.adwords.axis.v201710.cm.Page>

public final class ServiceQuery
extends Object
implements ServiceQueryInterface<com.google.api.ads.adwords.axis.v201710.cm.Page>

A service query that embodies AWQL string for making SOAP requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceQuery.Builder Builds a ServiceQuery object.

Nested classes/interfaces inherited from interface com.google.api.ads.adwords.lib.utils.ServiceQueryInterface

ServiceQueryInterface.BuilderInterface<PageT,SortOrderT>

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	hashCode()
boolean	hasNext(com.google.api.ads.adwords.axis.v201710.cm.AdGroupBidLandscapePage page) Checks if there is still an ad group bid landscape page left to query.
boolean	hasNext(com.google.api.ads.adwords.axis.v201710.cm.CriterionBidLandscapePage page) Checks if there is still an criterion bid landscape page left to query.
boolean	hasNext(com.google.api.ads.adwords.axis.v201710.cm.Page page) Checks if there is still a page left to query.
ServiceQuery	nextPage(com.google.api.ads.adwords.axis.v201710.cm.AdGroupBidLandscapePage page) Sets the LIMIT clause of the AWQL to the next page calculated by using the total number of landscape points in AdGroupBidLandscapePage.
ServiceQuery	nextPage(com.google.api.ads.adwords.axis.v201710.cm.CriterionBidLandscapePage page) Sets the LIMIT clause of the AWQL to the next page calculated by using the total number of landscape points in CriterionBidLandscapePage.
ServiceQuery	nextPage(com.google.api.ads.adwords.axis.v201710.cm.Page page) Sets the LIMIT clause of the AWQL to the next page.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

nextPage

public ServiceQuery nextPage(@Nullable
                             com.google.api.ads.adwords.axis.v201710.cm.Page page)

Description copied from interface: ServiceQueryInterface

Sets the LIMIT clause of the AWQL to the next page. If page is null, it will set not change the index and stay at the current LIMIT clause.

This method is meant to be used with ServiceQueryInterface.hasNext(Object). The page is necessary when using DataService, as its paging mechanism is different from other services. For details, see https://developers.google.com/adwords/api/docs/guides/bid-landscapes#paging_through_results.

Specified by:

nextPage in interface ServiceQueryInterface<com.google.api.ads.adwords.axis.v201710.cm.Page>

Parameters:

page - the page whose size will be used to increment the index in the LIMIT clause

Returns:

this service query object

nextPage

public ServiceQuery nextPage(@Nullable
                             com.google.api.ads.adwords.axis.v201710.cm.AdGroupBidLandscapePage page)

Sets the LIMIT clause of the AWQL to the next page calculated by using the total number of landscape points in AdGroupBidLandscapePage. If page is null, this will not change the LIMIT clause.

This method is meant to be used with hasNext(). The page is necessary when using DataService, as its paging mechanism is different from other services. For details, see https://developers.google.com/adwords/api/docs/guides/bid-landscapes#paging_through_results.

Parameters:

page - the ad group bid landscape page whose total number of landscape points will be used to increment the index in the LIMIT clause

Returns:

this service query object

nextPage

public ServiceQuery nextPage(@Nullable
                             com.google.api.ads.adwords.axis.v201710.cm.CriterionBidLandscapePage page)

Sets the LIMIT clause of the AWQL to the next page calculated by using the total number of landscape points in CriterionBidLandscapePage. If page is null, this will not change the LIMIT clause.

This method is meant to be used with hasNext(). The page is necessary when using DataService, as its paging mechanism is different from other services. For details, see https://developers.google.com/adwords/api/docs/guides/bid-landscapes#paging_through_results.

Parameters:

page - the criterion bid landscape page whose total number of landscape points will be used to increment the index in the LIMIT clause

Returns:

this service query object

hasNext

public boolean hasNext(@Nullable
                       com.google.api.ads.adwords.axis.v201710.cm.Page page)

Description copied from interface: ServiceQueryInterface

Checks if there is still a page left to query. This method is meant to be used with ServiceQueryInterface.nextPage(Object).

Specified by:

hasNext in interface ServiceQueryInterface<com.google.api.ads.adwords.axis.v201710.cm.Page>

Returns:

true if there is still a page left

hasNext

public boolean hasNext(@Nullable
                       com.google.api.ads.adwords.axis.v201710.cm.AdGroupBidLandscapePage page)

Checks if there is still an ad group bid landscape page left to query.

This method is meant to be used with nextPage(AdGroupBidLandscapePage). The page is necessary when using DataService, as its paging mechanism is different from other services. For details, see https://developers.google.com/adwords/api/docs/guides/bid-landscapes#paging_through_results.

Parameters:

page - the ad group bid landscape page whose total number of landscape points will be used to determine if there is still a page left

Returns:

true if there is still a page left

hasNext

public boolean hasNext(@Nullable
                       com.google.api.ads.adwords.axis.v201710.cm.CriterionBidLandscapePage page)

Checks if there is still an criterion bid landscape page left to query.

This method is meant to be used with nextPage(CriterionBidLandscapePage). The page is necessary when using DataService, as its paging mechanism is different from other services. For details, see https://developers.google.com/adwords/api/docs/guides/bid-landscapes#paging_through_results.

Parameters:

page - the criterion bid landscape page whose total number of landscape points will be used to determine if there is still a page left

Returns:

true if there is still a page left

toString

public String toString()

Specified by:

toString in interface ServiceQueryInterface<com.google.api.ads.adwords.axis.v201710.cm.Page>

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object