$awqlString
$awqlString :string
A service query that embodies an AWQL string for making SOAP requests.
__construct(string $awqlString,integer|null $startIndex = null,integer|null $pageSize = null)
Creates a service query object from an AWQL string without the LIMIT clause.
Do not use this constructor, instances should be created by using the
ServiceQueryBuilder
instead.
string | $awqlString | the AWQL string without the LIMIT clause |
integer|null | $startIndex | optional, the start index of the first page |
integer|null | $pageSize | optional, the count of entries to be fetched in each page |
nextPage(\Google\AdsApi\AdWords\v201809\cm\Page|null $previousPage = null): \Google\AdsApi\AdWords\Query\v201809\ServiceQuery
Increases the start index by the current page size.
When querying against the `DataService`, an instance of `AdGroupBidLandscapePage` or `AdGroupBidLandscapePage` is required for this function to compute the current page size. These special page classes have their own paging mechanism which is different from other services. For details, see https://developers.google.com/adwords/api/docs/guides/bid-landscapes#paging_through_results
\Google\AdsApi\AdWords\v201809\cm\Page|null | $previousPage | optional, the previously fetched page
which must be an instance of either |
the current ServiceQuery
instance for chaining
hasNext(\Google\AdsApi\AdWords\v201809\cm\Page $previousPage): boolean
Checks if there are still entries to be fetched on the next page.
When querying against the `DataService`, an instance of `AdGroupBidLandscapePage` or `AdGroupBidLandscapePage` could be returned. These special page classes have their own paging mechanism which is different from other services. For details, see https://developers.google.com/adwords/api/docs/guides/bid-landscapes#paging_through_results
\Google\AdsApi\AdWords\v201809\cm\Page | $previousPage | the previously fetched page |
true if there are still entries to be fetched on next page; Otherwise, returns false
validate(string $awqlString,integer $startIndex,integer $pageSize)
Validates the arguments for constructing a service query object.
string | $awqlString | the AWQL string without the LIMIT clause |
integer | $startIndex | the start index of the first page |
integer | $pageSize | the count of entries to be fetched in each page |
when the AWQL string is null or empty, or contains a LIMIT clause
when the start index is a negative number, or when the page size is 0 or a negative number
countLandscapePoints(\Google\AdsApi\AdWords\v201809\cm\Page $page): integer
Counts the number of landscape points in a `AdGroupBidLandscapePage` or `AdGroupBidLandscapePage` page.
\Google\AdsApi\AdWords\v201809\cm\Page | $page | the previously fetched page which must be an
instance of either |
the count of landscape points in a given page