Class InventorySourcesResource.ListRequest
Lists inventory sources that are accessible to the current user. The order is defined by the order_by
parameter. If a filter by entity_status is not specified, inventory sources with entity status
ENTITY_STATUS_ARCHIVED will not be included in the results.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.DisplayVideo.v1
Assembly: Google.Apis.DisplayVideo.v1.dll
Syntax
public class ListRequest : DisplayVideoBaseServiceRequest<ListInventorySourcesResponse>, IClientServiceRequest<ListInventorySourcesResponse>, IClientServiceRequestConstructors
ListRequest(IClientService)
Constructs a new List request.
Declaration
public ListRequest(IClientService service)Parameters
| Type | Name | Description |
|---|---|---|
| Google.Apis.Services.IClientService | service |
Properties
AdvertiserId
The ID of the advertiser that has access to the inventory source.
Declaration
[RequestParameter("advertiserId", RequestParameterType.Query)]
public virtual long? AdvertiserId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
Filter
Allows filtering by inventory source 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 must be EQUALS (=). * Supported fields: - status.entityStatus - commitment -
deliveryMethod - rateDetails.rateType - exchange Examples: * All active inventory sources:
status.entityStatus="ENTITY_STATUS_ACTIVE" * Inventory sources belonging to Google Ad Manager or
Rubicon exchanges: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON" 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) The default sorting
order is ascending. To specify descending order for a field, a suffix "desc" should be added to the
field name. For 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 100. If unspecified will default to 100.
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 ListInventorySources 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 |
PartnerId
The ID of the partner that has access to the inventory source.
Declaration
[RequestParameter("partnerId", RequestParameterType.Query)]
public virtual long? PartnerId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
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()