Class PlacementsResource.ListRequest

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

Inheritance
object
ClientServiceRequest
ClientServiceRequest<PlacementsListResponse>
DfareportingBaseServiceRequest<PlacementsListResponse>
PlacementsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Dfareporting.v4
Assembly: Google.Apis.Dfareporting.v4.dll
Syntax
public class PlacementsResource.ListRequest : DfareportingBaseServiceRequest<PlacementsListResponse>, IClientServiceRequest<PlacementsListResponse>, 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

ActiveStatus

Select only placements with these active statuses.

Declaration
[RequestParameter("activeStatus", RequestParameterType.Query)]
public virtual PlacementsResource.ListRequest.ActiveStatusEnum? ActiveStatus { get; set; }
Property Value
Type Description
PlacementsResource.ListRequest.ActiveStatusEnum?
Remarks

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

ActiveStatusList

Select only placements with these active statuses.

Declaration
[RequestParameter("activeStatus", RequestParameterType.Query)]
public virtual Repeatable<PlacementsResource.ListRequest.ActiveStatusEnum> ActiveStatusList { get; set; }
Property Value
Type Description
Repeatable<PlacementsResource.ListRequest.ActiveStatusEnum>
Remarks

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

AdvertiserIds

Select only placements that belong to these advertisers.

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

CampaignIds

Select only placements that belong to these campaigns.

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

Compatibilities

Select only placements that are associated with these compatibilities. 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 in in-stream video ads developed with the VAST standard.

Declaration
[RequestParameter("compatibilities", RequestParameterType.Query)]
public virtual PlacementsResource.ListRequest.CompatibilitiesEnum? Compatibilities { get; set; }
Property Value
Type Description
PlacementsResource.ListRequest.CompatibilitiesEnum?
Remarks

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

CompatibilitiesList

Select only placements that are associated with these compatibilities. 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 in in-stream video ads developed with the VAST standard.

Declaration
[RequestParameter("compatibilities", RequestParameterType.Query)]
public virtual Repeatable<PlacementsResource.ListRequest.CompatibilitiesEnum> CompatibilitiesList { get; set; }
Property Value
Type Description
Repeatable<PlacementsResource.ListRequest.CompatibilitiesEnum>
Remarks

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

ContentCategoryIds

Select only placements that are associated with these content categories.

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

DirectorySiteIds

Select only placements that are associated with these directory sites.

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

GroupIds

Select only placements that belong to these placement groups.

Declaration
[RequestParameter("groupIds", RequestParameterType.Query)]
public virtual Repeatable<string> GroupIds { 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 placements with these IDs.

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

MaxEndDate

Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".

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

MaxResults

Maximum number of results to return.

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

MaxStartDate

Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".

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

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

MinEndDate

Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".

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

MinStartDate

Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".

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

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

PaymentSource

Select only placements with this payment source.

Declaration
[RequestParameter("paymentSource", RequestParameterType.Query)]
public virtual PlacementsResource.ListRequest.PaymentSourceEnum? PaymentSource { get; set; }
Property Value
Type Description
PlacementsResource.ListRequest.PaymentSourceEnum?

PlacementStrategyIds

Select only placements that are associated with these placement strategies.

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

PricingTypes

Select only placements with these pricing types.

Declaration
[RequestParameter("pricingTypes", RequestParameterType.Query)]
public virtual PlacementsResource.ListRequest.PricingTypesEnum? PricingTypes { get; set; }
Property Value
Type Description
PlacementsResource.ListRequest.PricingTypesEnum?
Remarks

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

PricingTypesList

Select only placements with these pricing types.

Declaration
[RequestParameter("pricingTypes", RequestParameterType.Query)]
public virtual Repeatable<PlacementsResource.ListRequest.PricingTypesEnum> PricingTypesList { get; set; }
Property Value
Type Description
Repeatable<PlacementsResource.ListRequest.PricingTypesEnum>
Remarks

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

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

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

SiteIds

Select only placements that are associated with these sites.

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

SizeIds

Select only placements that are associated with these sizes.

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

SortOrder

Order of sorted results.

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

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements