Class CampaignsResource.ListRequest

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

Inheritance

System.Object

Google.Apis.Requests.ClientServiceRequest

Google.Apis.Requests.ClientServiceRequest<CampaignsListResponse>

DfareportingBaseServiceRequest<CampaignsListResponse>

CampaignsResource.ListRequest

Implements

Google.Apis.Requests.IClientServiceRequest<CampaignsListResponse>

Google.Apis.Requests.IClientServiceRequest

Inherited Members

DfareportingBaseServiceRequest<CampaignsListResponse>.Xgafv

DfareportingBaseServiceRequest<CampaignsListResponse>.AccessToken

DfareportingBaseServiceRequest<CampaignsListResponse>.Alt

DfareportingBaseServiceRequest<CampaignsListResponse>.Callback

DfareportingBaseServiceRequest<CampaignsListResponse>.Fields

DfareportingBaseServiceRequest<CampaignsListResponse>.Key

DfareportingBaseServiceRequest<CampaignsListResponse>.OauthToken

DfareportingBaseServiceRequest<CampaignsListResponse>.PrettyPrint

DfareportingBaseServiceRequest<CampaignsListResponse>.QuotaUser

DfareportingBaseServiceRequest<CampaignsListResponse>.UploadType

DfareportingBaseServiceRequest<CampaignsListResponse>.UploadProtocol

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.Execute()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.ExecuteAsStream()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.ExecuteAsync()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.ExecuteAsync(System.Threading.CancellationToken)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.ExecuteAsStreamAsync()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.ExecuteAsStreamAsync(System.Threading.CancellationToken)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.CreateRequest(System.Nullable<System.Boolean>)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.GenerateRequestUri()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.GetBody()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.GetDefaultETagAction(System.String)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.ETagAction

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.ModifyRequest

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.ValidateParameters

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.RequestParameters

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.Service

Google.Apis.Requests.ClientServiceRequest._unsuccessfulResponseHandlers

Google.Apis.Requests.ClientServiceRequest._exceptionHandlers

Google.Apis.Requests.ClientServiceRequest._executeInterceptors

Google.Apis.Requests.ClientServiceRequest.AddUnsuccessfulResponseHandler(Google.Apis.Http.IHttpUnsuccessfulResponseHandler)

Google.Apis.Requests.ClientServiceRequest.AddExceptionHandler(Google.Apis.Http.IHttpExceptionHandler)

Google.Apis.Requests.ClientServiceRequest.AddExecuteInterceptor(Google.Apis.Http.IHttpExecuteInterceptor)

Google.Apis.Requests.ClientServiceRequest.Credential

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.Dfareporting.v3_4

Assembly: Google.Apis.Dfareporting.v3_4.dll

Syntax

public class ListRequest : DfareportingBaseServiceRequest<CampaignsListResponse>, IClientServiceRequest<CampaignsListResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, Int64)

Constructs a new List request.

Declaration

public ListRequest(IClientService service, long profileId)

Parameters

Type	Name	Description
Google.Apis.Services.IClientService	service
System.Int64	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
Google.Apis.Util.Repeatable<System.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
Google.Apis.Util.Repeatable<System.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
System.Nullable<System.Boolean>

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
System.Nullable<System.Boolean>

ExcludedIds

Exclude campaigns with these IDs.

Declaration

[RequestParameter("excludedIds", RequestParameterType.Query)]
public virtual Repeatable<string> ExcludedIds { get; set; }

Property Value

Type	Description
Google.Apis.Util.Repeatable<System.String>

HttpMethod

Gets the HTTP method.

Declaration

public override string HttpMethod { get; }

Property Value

Type	Description
System.String

Overrides

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.HttpMethod

Ids

Select only campaigns with these IDs.

Declaration

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

Property Value

Type	Description
Google.Apis.Util.Repeatable<System.String>

MaxResults

Maximum number of results to return.

Declaration

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

Property Value

Type	Description
System.Nullable<System.Int32>

MethodName

Gets the method name.

Declaration

public override string MethodName { get; }

Property Value

Type	Description
System.String

Overrides

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.MethodName

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
System.Nullable<System.Int64>

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
System.String

ProfileId

User profile ID associated with this request.

Declaration

[RequestParameter("profileId", RequestParameterType.Path)]
public virtual long ProfileId { get; }

Property Value

Type	Description
System.Int64

RestPath

Gets the REST path.

Declaration

public override string RestPath { get; }

Property Value

Type	Description
System.String

Overrides

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.RestPath

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
System.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
System.Nullable<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
System.Nullable<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
System.Nullable<System.Int64>

Methods

InitParameters()

Initializes List parameter list.

Declaration

protected override void InitParameters()

Overrides

Google.Apis.Dfareporting.v3_4.DfareportingBaseServiceRequest<Google.Apis.Dfareporting.v3_4.Data.CampaignsListResponse>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>

Google.Apis.Requests.IClientServiceRequest