Class AdsResource.ListRequest

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

Inheritance

object

ClientServiceRequest

ClientServiceRequest<AdsListResponse>

DfareportingBaseServiceRequest<AdsListResponse>

AdsResource.ListRequest

Implements

IClientServiceRequest<AdsListResponse>

IClientServiceRequest

Inherited Members

DfareportingBaseServiceRequest<AdsListResponse>.Xgafv

DfareportingBaseServiceRequest<AdsListResponse>.AccessToken

DfareportingBaseServiceRequest<AdsListResponse>.Alt

DfareportingBaseServiceRequest<AdsListResponse>.Callback

DfareportingBaseServiceRequest<AdsListResponse>.Fields

DfareportingBaseServiceRequest<AdsListResponse>.Key

DfareportingBaseServiceRequest<AdsListResponse>.OauthToken

DfareportingBaseServiceRequest<AdsListResponse>.PrettyPrint

DfareportingBaseServiceRequest<AdsListResponse>.QuotaUser

DfareportingBaseServiceRequest<AdsListResponse>.UploadType

DfareportingBaseServiceRequest<AdsListResponse>.UploadProtocol

ClientServiceRequest<AdsListResponse>.Execute()

ClientServiceRequest<AdsListResponse>.ExecuteAsStream()

ClientServiceRequest<AdsListResponse>.ExecuteAsync()

ClientServiceRequest<AdsListResponse>.ExecuteAsync(CancellationToken)

ClientServiceRequest<AdsListResponse>.ExecuteAsStreamAsync()

ClientServiceRequest<AdsListResponse>.ExecuteAsStreamAsync(CancellationToken)

ClientServiceRequest<AdsListResponse>.CreateRequest(bool?)

ClientServiceRequest<AdsListResponse>.GenerateRequestUri()

ClientServiceRequest<AdsListResponse>.GetBody()

ClientServiceRequest<AdsListResponse>.GetDefaultETagAction(string)

ClientServiceRequest<AdsListResponse>.ETagAction

ClientServiceRequest<AdsListResponse>.ModifyRequest

ClientServiceRequest<AdsListResponse>.ValidateParameters

ClientServiceRequest<AdsListResponse>.ApiVersion

ClientServiceRequest<AdsListResponse>.RequestParameters

ClientServiceRequest<AdsListResponse>.Service

ClientServiceRequest._unsuccessfulResponseHandlers

ClientServiceRequest._exceptionHandlers

ClientServiceRequest._executeInterceptors

ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)

ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)

ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)

ClientServiceRequest.Credential

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Dfareporting.v4

Assembly: Google.Apis.Dfareporting.v4.dll

Syntax

public class AdsResource.ListRequest : DfareportingBaseServiceRequest<AdsListResponse>, IClientServiceRequest<AdsListResponse>, 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

Active

Select only active ads.

Declaration

[RequestParameter("active", RequestParameterType.Query)]
public virtual bool? Active { get; set; }

Property Value

Type	Description
bool?

AdvertiserId

Select only ads with this advertiser ID.

Declaration

[RequestParameter("advertiserId", RequestParameterType.Query)]
public virtual long? AdvertiserId { get; set; }

Property Value

Type	Description
long?

Archived

Select only archived ads.

Declaration

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

Property Value

Type	Description
bool?

AudienceSegmentIds

Select only ads with these audience segment IDs.

Declaration

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

Property Value

Type	Description
Repeatable<string>

CampaignIds

Select only ads with these campaign IDs.

Declaration

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

Property Value

Type	Description
Repeatable<string>

Compatibility

Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.

Declaration

[RequestParameter("compatibility", RequestParameterType.Query)]
public virtual AdsResource.ListRequest.CompatibilityEnum? Compatibility { get; set; }

Property Value

Type	Description
AdsResource.ListRequest.CompatibilityEnum?

CreativeIds

Select only ads with these creative IDs assigned.

Declaration

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

Property Value

Type	Description
Repeatable<string>

CreativeOptimizationConfigurationIds

Select only ads with these creative optimization configuration IDs.

Declaration

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

Property Value

Type	Description
Repeatable<string>

DynamicClickTracker

Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.

Declaration

[RequestParameter("dynamicClickTracker", RequestParameterType.Query)]
public virtual bool? DynamicClickTracker { get; set; }

Property Value

Type	Description
bool?

HttpMethod

Gets the HTTP method.

Declaration

public override string HttpMethod { get; }

Property Value

Type	Description
string

Overrides

ClientServiceRequest<AdsListResponse>.HttpMethod

Ids

Select only ads with these IDs.

Declaration

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

Property Value

Type	Description
Repeatable<string>

LandingPageIds

Select only ads with these landing page IDs.

Declaration

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

ClientServiceRequest<AdsListResponse>.MethodName

OverriddenEventTagId

Select only ads with this event tag override 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

PlacementIds

Select only ads with these placement IDs assigned.

Declaration

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

Property Value

Type	Description
Repeatable<string>

ProfileId

User profile ID associated with this request.

Declaration

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

Property Value

Type	Description
long

RemarketingListIds

Select only ads whose list targeting expression use these remarketing list IDs.

Declaration

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

Property Value

Type	Description
Repeatable<string>

RestPath

Gets the REST path.

Declaration

public override string RestPath { get; }

Property Value

Type	Description
string

Overrides

ClientServiceRequest<AdsListResponse>.RestPath

SearchString

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

Declaration

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

Property Value

Type	Description
string

SizeIds

Select only ads with these size IDs.

Declaration

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

Property Value

Type	Description
Repeatable<string>

SortField

Field by which to sort the list.

Declaration

[RequestParameter("sortField", RequestParameterType.Query)]
public virtual AdsResource.ListRequest.SortFieldEnum? SortField { get; set; }

Property Value

Type	Description
AdsResource.ListRequest.SortFieldEnum?

SortOrder

Order of sorted results.

Declaration

[RequestParameter("sortOrder", RequestParameterType.Query)]
public virtual AdsResource.ListRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
AdsResource.ListRequest.SortOrderEnum?

SslCompliant

Select only ads that are SSL-compliant.

Declaration

[RequestParameter("sslCompliant", RequestParameterType.Query)]
public virtual bool? SslCompliant { get; set; }

Property Value

Type	Description
bool?

SslRequired

Select only ads that require SSL.

Declaration

[RequestParameter("sslRequired", RequestParameterType.Query)]
public virtual bool? SslRequired { get; set; }

Property Value

Type	Description
bool?

Type

Select only ads with these types.

Declaration

[RequestParameter("type", RequestParameterType.Query)]
public virtual AdsResource.ListRequest.TypeEnum? Type { get; set; }

Property Value

Type	Description
AdsResource.ListRequest.TypeEnum?

Remarks

Use this property to set a single value for the parameter, or TypeList to set multiple values. Do not set both properties.

TypeList

Select only ads with these types.

Declaration

[RequestParameter("type", RequestParameterType.Query)]
public virtual Repeatable<AdsResource.ListRequest.TypeEnum> TypeList { get; set; }

Property Value

Type	Description
Repeatable<AdsResource.ListRequest.TypeEnum>

Remarks

Use this property to set one or more values for the parameter. Do not set both this property and Type.

Methods

InitParameters()

Initializes List parameter list.

Declaration

protected override void InitParameters()

Overrides

DfareportingBaseServiceRequest<AdsListResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>

IClientServiceRequest