Class AdvertisersResource.ListRequest

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

Inheritance
object
ClientServiceRequest
ClientServiceRequest<AdvertisersListResponse>
DfareportingBaseServiceRequest<AdvertisersListResponse>
AdvertisersResource.ListRequest
Implements
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Dfareporting.v3_5
Assembly: Google.Apis.Dfareporting.v3_5.dll
Syntax
public class AdvertisersResource.ListRequest : DfareportingBaseServiceRequest<AdvertisersListResponse>, IClientServiceRequest<AdvertisersListResponse>, 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

AdvertiserGroupIds

Select only advertisers with these advertiser group IDs.

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

FloodlightConfigurationIds

Select only advertisers with these floodlight configuration IDs.

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

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_5.Data.AdvertisersListResponse>.HttpMethod

Ids

Select only advertisers with these IDs.

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

IncludeAdvertisersWithoutGroupsOnly

Select only advertisers which do not belong to any advertiser group.

Declaration
[RequestParameter("includeAdvertisersWithoutGroupsOnly", RequestParameterType.Query)]
public virtual bool? IncludeAdvertisersWithoutGroupsOnly { get; set; }
Property Value
Type Description
bool?

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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_5.Data.AdvertisersListResponse>.MethodName

OnlyParent

Select only advertisers which use another advertiser's floodlight configuration.

Declaration
[RequestParameter("onlyParent", RequestParameterType.Query)]
public virtual bool? OnlyParent { get; set; }
Property Value
Type Description
bool?

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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_5.Data.AdvertisersListResponse>.RestPath

SearchString

Allows searching for objects by name or ID. Wildcards () are allowed. For example, "advertiser2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 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 "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser" .

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 AdvertisersResource.ListRequest.SortFieldEnum? SortField { get; set; }
Property Value
Type Description
AdvertisersResource.ListRequest.SortFieldEnum?

SortOrder

Order of sorted results.

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

Status

Select only advertisers with the specified status.

Declaration
[RequestParameter("status", RequestParameterType.Query)]
public virtual AdvertisersResource.ListRequest.StatusEnum? Status { get; set; }
Property Value
Type Description
AdvertisersResource.ListRequest.StatusEnum?

SubaccountId

Select only advertisers with these subaccount IDs.

Declaration
[RequestParameter("subaccountId", RequestParameterType.Query)]
public virtual long? SubaccountId { get; set; }
Property Value
Type Description
long?

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Dfareporting.v3_5.DfareportingBaseServiceRequest<Google.Apis.Dfareporting.v3_5.Data.AdvertisersListResponse>.InitParameters()

Implements