Class AdvertisersResource.CreativesResource.ListRequest

Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with ENTITY_STATUS_ARCHIVED will not be included in the results.

Inheritance

System.Object

Google.Apis.Requests.ClientServiceRequest

Google.Apis.Requests.ClientServiceRequest<ListCreativesResponse>

DisplayVideoBaseServiceRequest<ListCreativesResponse>

AdvertisersResource.CreativesResource.ListRequest

Implements

Google.Apis.Requests.IClientServiceRequest<ListCreativesResponse>

Google.Apis.Requests.IClientServiceRequest

Inherited Members

DisplayVideoBaseServiceRequest<ListCreativesResponse>.Xgafv

DisplayVideoBaseServiceRequest<ListCreativesResponse>.AccessToken

DisplayVideoBaseServiceRequest<ListCreativesResponse>.Alt

DisplayVideoBaseServiceRequest<ListCreativesResponse>.Callback

DisplayVideoBaseServiceRequest<ListCreativesResponse>.Fields

DisplayVideoBaseServiceRequest<ListCreativesResponse>.Key

DisplayVideoBaseServiceRequest<ListCreativesResponse>.OauthToken

DisplayVideoBaseServiceRequest<ListCreativesResponse>.PrettyPrint

DisplayVideoBaseServiceRequest<ListCreativesResponse>.QuotaUser

DisplayVideoBaseServiceRequest<ListCreativesResponse>.UploadType

DisplayVideoBaseServiceRequest<ListCreativesResponse>.UploadProtocol

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.Execute()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.ExecuteAsStream()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.ExecuteAsync()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.ExecuteAsync(System.Threading.CancellationToken)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.ExecuteAsStreamAsync()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.ExecuteAsStreamAsync(System.Threading.CancellationToken)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.CreateRequest(System.Nullable<System.Boolean>)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.GenerateRequestUri()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.GetBody()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.GetDefaultETagAction(System.String)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.ETagAction

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.ModifyRequest

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.ValidateParameters

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.RequestParameters

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.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.DisplayVideo.v1

Assembly: Google.Apis.DisplayVideo.v1.dll

Syntax

public class ListRequest : DisplayVideoBaseServiceRequest<ListCreativesResponse>, IClientServiceRequest<ListCreativesResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, Int64)

Constructs a new List request.

Declaration

public ListRequest(IClientService service, long advertiserId)

Parameters

Type	Name	Description
Google.Apis.Services.IClientService	service
System.Int64	advertiserId

Properties

AdvertiserId

Required. The ID of the advertiser to list creatives for.

Declaration

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

Property Value

Type	Description
System.Int64

Filter

Allows filtering by creative properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restriction for the same field must be combined by OR. * Restriction for different fields must be combined by AND. * Between ( and ) there can only be restrictions combined by OR for the same field. * A restriction has the form of {field} {operator} {value}. * The operator must be EQUALS (=) for the following fields: - entityStatus - creativeType. - dimensions - minDuration - maxDuration - approvalStatus - exchangeReviewStatus - dynamic

creativeId * The operator must be HAS (:) for the following fields: - lineItemIds * For entityStatus, minDuration, maxDuration, and dynamic there may be at most one restriction. * For dimensions, the value is in the form of "{width}x{height}". * For exchangeReviewStatus, the value is in the form of {exchange}-{reviewStatus}. * For minDuration and maxDuration, the value is in the form of "{duration}s". Only seconds are supported with millisecond granularity. * There may be multiple lineItemIds restrictions in order to search against multiple possible line item IDs. * There may be multiple creativeId restrictions in order to search against multiple possible creative IDs. Examples: * All native creatives: creativeType="CREATIVE_TYPE_NATIVE" * All active creatives with 300x400 or 50x100 dimensions: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100") * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms. dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED") * All video creatives that are associated with line item ID 1 or 2: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2) * Find creatives by multiple creative IDs: creativeId=1 OR creativeId=2 The length of this field should be no more than 500 characters.

Declaration

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

Property Value

Type	Description
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.DisplayVideo.v1.Data.ListCreativesResponse>.HttpMethod

MethodName

Gets the method name.

Declaration

public override string MethodName { get; }

Property Value

Type	Description
System.String

Overrides

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.MethodName

OrderBy

Field by which to sort the list. Acceptable values are: * creativeId (default) * createTime * mediaDuration * dimensions (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: createTime desc.

Declaration

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

Property Value

Type	Description
System.String

PageSize

Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

Declaration

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

Property Value

Type	Description
System.Nullable<System.Int32>

PageToken

A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListCreatives method. If not specified, the first page of results will be returned.

Declaration

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

Property Value

Type	Description
System.String

RestPath

Gets the REST path.

Declaration

public override string RestPath { get; }

Property Value

Type	Description
System.String

Overrides

Google.Apis.Requests.ClientServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

Declaration

protected override void InitParameters()

Overrides

Google.Apis.DisplayVideo.v1.DisplayVideoBaseServiceRequest<Google.Apis.DisplayVideo.v1.Data.ListCreativesResponse>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>

Google.Apis.Requests.IClientServiceRequest