Class CreativesResource.ListRequest

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

Inheritance
object
ClientServiceRequest
ClientServiceRequest<CreativesListResponse>
DfareportingBaseServiceRequest<CreativesListResponse>
CreativesResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Dfareporting.v4
Assembly: Google.Apis.Dfareporting.v4.dll
Syntax
public class CreativesResource.ListRequest : DfareportingBaseServiceRequest<CreativesListResponse>, IClientServiceRequest<CreativesListResponse>, 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 creatives. Leave blank to select active and inactive creatives.

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

AdvertiserId

Select only creatives with this advertiser ID.

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

Archived

Select only archived creatives. Leave blank to select archived and unarchived creatives.

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

CampaignId

Select only creatives with this campaign ID.

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

CompanionCreativeIds

Select only in-stream video creatives with these companion IDs.

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

CreativeFieldIds

Select only creatives with these creative field IDs.

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

RenderingIds

Select only creatives with these rendering IDs.

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

SearchString

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

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

SizeIds

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

SortOrder

Order of sorted results.

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

StudioCreativeId

Select only creatives corresponding to this Studio creative ID.

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

Types

Select only creatives with these creative types.

Declaration
[RequestParameter("types", RequestParameterType.Query)]
public virtual CreativesResource.ListRequest.TypesEnum? Types { get; set; }
Property Value
Type Description
CreativesResource.ListRequest.TypesEnum?
Remarks

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

TypesList

Select only creatives with these creative types.

Declaration
[RequestParameter("types", RequestParameterType.Query)]
public virtual Repeatable<CreativesResource.ListRequest.TypesEnum> TypesList { get; set; }
Property Value
Type Description
Repeatable<CreativesResource.ListRequest.TypesEnum>
Remarks

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

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements