Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdWords.v201809.Paging Class Reference

Specifies the page of results to return in the response. A page is specified by the result position to start at and the maximum number of results to return. More...

Classes

class  Fields
 List of all supported fields for the Paging class. More...
 
class  FilterableFields
 List of all supported filterable fields for the Paging class. More...
 
class  SelectableFields
 List of all supported selectable fields for the Paging class. More...
 

Public Member Functions

void IncreaseOffsetBy (int pageSize)
 Increases the offset by a given value. More...
 
void IncreaseOffset ()
 Increases the offset by numberResults. More...
 
override string ToString ()
 Returns a string that represents this instance. More...
 

Public Attributes

const int DEFAULT_PAGE_SIZE = 500
 The default page size. More...
 

Properties

int startIndex [get, set]
 Index of the first result to return in this page. This field must be greater than or equal to 0. More...
 
bool startIndexSpecified [get, set]
 
int numberResults [get, set]
 Maximum number of results to return in this page. Set this to a reasonable value to limit the number of results returned per page. This field must be greater than or equal to 0. More...
 
bool numberResultsSpecified [get, set]
 
static Paging Default [get]
 Gets the default instance. More...
 

Detailed Description

Specifies the page of results to return in the response. A page is specified by the result position to start at and the maximum number of results to return.

Specifies the page of results to return in the response. A page is specified by the result position to start at and the maximum number of results to return.

Member Function Documentation

void Google.Api.Ads.AdWords.v201809.Paging.IncreaseOffset ( )
inline

Increases the offset by numberResults.

void Google.Api.Ads.AdWords.v201809.Paging.IncreaseOffsetBy ( int  pageSize)
inline

Increases the offset by a given value.

Parameters
pageSizeSize of the page.
override string Google.Api.Ads.AdWords.v201809.Paging.ToString ( )
inline

Returns a string that represents this instance.

Returns
A string that represents this instance.

Member Data Documentation

const int Google.Api.Ads.AdWords.v201809.Paging.DEFAULT_PAGE_SIZE = 500

The default page size.

Property Documentation

int Google.Api.Ads.AdWords.v201809.Paging.numberResults
getset

Maximum number of results to return in this page. Set this to a reasonable value to limit the number of results returned per page. This field must be greater than or equal to 0.

bool Google.Api.Ads.AdWords.v201809.Paging.numberResultsSpecified
getset

true, if a value is specified for numberResults, false otherwise.

bool Google.Api.Ads.AdWords.v201809.Paging.startIndexSpecified
getset

true, if a value is specified for startIndex, false otherwise.


The documentation for this class was generated from the following files: