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.v1
Assembly: Google.Apis.DisplayVideo.v1.dll
Syntax
public class ListRequest : DisplayVideoBaseServiceRequest<ListLineItemsResponse>, IClientServiceRequest<ListLineItemsResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, Int64)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, long advertiserId)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
System.Int64 | 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 |
---|---|
System.Int64 |
Filter
Allows filtering by line item properties. 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 operator used on
flight.dateRange.endDate
must be LESS THAN (<). * The operator used onupdateTime
must beGREATER THAN OR EQUAL TO (&gt;=)
orLESS THAN OR EQUAL TO (&lt;=)
. * The operator used onwarningMessages
must beHAS (:)
. * The operators used on all other fields must beEQUALS (=)
. * Supported properties: -campaignId
-displayName
-insertionOrderId
-entityStatus
-lineItemId
-lineItemType
-flight.dateRange.endDate
(input formatted as YYYY-MM-DD) -warningMessages
-flight.triggerId
-updateTime
(input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ) -targetedChannelId
-targetedNegativeKeywordListId
Examples: * All line items under an insertion order:insertionOrderId="1234"
* AllENTITY_STATUS_ACTIVE
orENTITY_STATUS_PAUSED
andLINE_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 whose flight dates end before March 28, 2019:flight.dateRange.endDate&lt;"2019-03-28"
* All line items that haveNO_VALID_CREATIVE
inwarningMessages
:warningMessages:"NO_VALID_CREATIVE"
* All line items with an update time less than or equal to2020-11-04T18:54:47Z (format of ISO 8601)
:updateTime&lt;="2020-11-04T18:54:47Z"
* All line items with an update time greater than or equal to2020-11-04T18:54:47Z (format of ISO 8601)
:updateTime&gt;="2020-11-04T18:54:47Z"
* All line items that are using both the specified channel and specified negative keyword list in their targeting:targetedNegativeKeywordListId=789 AND targetedChannelId=12345
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
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
OrderBy
Field by which to sort the list. Acceptable values are: * displayName
(default) * entityStatus
*
flight.dateRange.endDate
* 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 |
---|---|
System.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 |
---|---|
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 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 |
---|---|
System.String |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()