Class AdvertisersResource.LineItemsResource.ListRequest
Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by
entity_status is not specified, line items with ENTITY_STATUS_ARCHIVED
will not be included in the
results.
Inheritance
Inherited Members
Namespace: Google.Apis.DisplayVideo.v2
Assembly: Google.Apis.DisplayVideo.v2.dll
Syntax
public class AdvertisersResource.LineItemsResource.ListRequest : DisplayVideoBaseServiceRequest<ListLineItemsResponse>, IClientServiceRequest<ListLineItemsResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, long)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, long advertiserId)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
long | advertiserId |
Properties
AdvertiserId
Required. The ID of the advertiser to list line items for.
Declaration
[RequestParameter("advertiserId", RequestParameterType.Path)]
public virtual long AdvertiserId { get; }
Property Value
Type | Description |
---|---|
long |
Filter
Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or
more restrictions. * Restrictions can be combined by AND
or OR
logical operators. A sequence of
restrictions implicitly uses AND
. * A restriction has the form of {field} {operator} {value}
. *
The updateTime
field must use the GREATER THAN OR EQUAL TO (>=)
or LESS THAN OR EQUAL TO (<=)
operators. * All other fields must use the EQUALS (=)
operator. Supported fields: *
campaignId
* displayName
* entityStatus
* insertionOrderId
* lineItemId
* lineItemType
*
updateTime
(input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ
) Examples: * All line items under
an insertion order: insertionOrderId="1234"
* All ENTITY_STATUS_ACTIVE
or ENTITY_STATUS_PAUSED
and LINE_ITEM_TYPE_DISPLAY_DEFAULT
line items under an advertiser:
(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
* All line items with an update time less than or
equal to 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54:47Z"
*
All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO
8601): updateTime>="2020-11-04T18:54:47Z"
The length of this field should be no more than
500 characters. Reference our filter LIST
requests
guide for more information.
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
OrderBy
Field by which to sort the list. Acceptable values are: * displayName
(default) * entityStatus
*
updateTime
The default sorting order is ascending. To specify descending order for a field, a
suffix "desc" should be added to the field name. Example: displayName desc
.
Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type | Description |
---|---|
string |
PageSize
Requested page size. Must be between 1
and 200
. 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 |
---|---|
int? |
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 ListLineItems
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 |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()