Class AdvertiserGroupsResource.ListRequest

Retrieves a list of advertiser groups, possibly filtered. This method supports paging.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<AdvertiserGroupsListResponse>
DfareportingBaseServiceRequest<AdvertiserGroupsListResponse>
AdvertiserGroupsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Dfareporting.v4
Assembly: Google.Apis.Dfareporting.v4.dll
Syntax
public class AdvertiserGroupsResource.ListRequest : DfareportingBaseServiceRequest<AdvertiserGroupsListResponse>, IClientServiceRequest<AdvertiserGroupsListResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, long)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, long profileId)
Parameters
Type Name Description
IClientService service
long profileId

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

Ids

Select only advertiser groups with these IDs.

Declaration
[RequestParameter("ids", RequestParameterType.Query)]
public virtual Repeatable<string> Ids { get; set; }
Property Value
Type Description
Repeatable<string>

MaxResults

Maximum number of results to return.

Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual int? MaxResults { get; set; }
Property Value
Type Description
int?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

PageToken

Value of the nextPageToken from the previous result page.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

ProfileId

User profile ID associated with this request.

Declaration
[RequestParameter("profileId", RequestParameterType.Path)]
public virtual long ProfileId { get; }
Property Value
Type Description
long

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

SearchString

Allows searching for objects by name or ID. Wildcards () are allowed. For example, "advertiser2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".

Declaration
[RequestParameter("searchString", RequestParameterType.Query)]
public virtual string SearchString { get; set; }
Property Value
Type Description
string

SortField

Field by which to sort the list.

Declaration
[RequestParameter("sortField", RequestParameterType.Query)]
public virtual AdvertiserGroupsResource.ListRequest.SortFieldEnum? SortField { get; set; }
Property Value
Type Description
AdvertiserGroupsResource.ListRequest.SortFieldEnum?

SortOrder

Order of sorted results.

Declaration
[RequestParameter("sortOrder", RequestParameterType.Query)]
public virtual AdvertiserGroupsResource.ListRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
AdvertiserGroupsResource.ListRequest.SortOrderEnum?

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements