Class CampaignsResource.ListRequest

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

Inheritance
object
ClientServiceRequest
ClientServiceRequest<CampaignsListResponse>
DfareportingBaseServiceRequest<CampaignsListResponse>
CampaignsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Dfareporting.v4
Assembly: Google.Apis.Dfareporting.v4.dll
Syntax
public class CampaignsResource.ListRequest : DfareportingBaseServiceRequest<CampaignsListResponse>, IClientServiceRequest<CampaignsListResponse>, 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 campaigns whose advertisers belong to these advertiser groups.

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

AdvertiserIds

Select only campaigns that belong to these advertisers.

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

Archived

Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.

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

AtLeastOneOptimizationActivity

Select only campaigns that have at least one optimization activity.

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

ExcludedIds

Exclude campaigns with these IDs.

Declaration
[RequestParameter("excludedIds", RequestParameterType.Query)]
public virtual Repeatable<string> ExcludedIds { 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

Ids

Select only campaigns 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

OverriddenEventTagId

Select only campaigns that have overridden this event tag ID.

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

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 campaigns by name or ID. Wildcards () are allowed. For example, "campaign2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 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 "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".

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

SortOrder

Order of sorted results.

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

SubaccountId

Select only campaigns that belong to this subaccount.

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

Implements