Class PartnersResource.ChannelsResource.SitesResource.ListRequest
Lists sites in a channel.
Inheritance
Inherited Members
Namespace: Google.Apis.DisplayVideo.v1
Assembly: Google.Apis.DisplayVideo.v1.dll
Syntax
public class ListRequest : DisplayVideoBaseServiceRequest<ListSitesResponse>, IClientServiceRequest<ListSitesResponse>, IClientServiceRequestConstructors
ListRequest(IClientService, Int64, Int64)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, long partnerId, long channelId)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| System.Int64 | partnerId | |
| System.Int64 | channelId |
Properties
AdvertiserId
The ID of the advertiser that owns the parent channel.
Declaration
[RequestParameter("advertiserId", RequestParameterType.Query)]
public virtual long? AdvertiserId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
ChannelId
Required. The ID of the parent channel to which the requested sites belong.
Declaration
[RequestParameter("channelId", RequestParameterType.Path)]
public virtual long ChannelId { get; }Property Value
| Type | Description |
|---|---|
| System.Int64 |
Filter
Allows filtering by site fields. Supported syntax: * Filter expressions for site currently can
only contain at most one * restriction. * A restriction has the form of {field} {operator}
{value}. * The operator must be CONTAINS (:). * Supported fields: - urlOrAppId Examples: *
All sites for which the URL or app ID contains "google": urlOrAppId : "google"
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: * urlOrAppId (default) The default
sorting order is ascending. To specify descending order for a field, a suffix " desc" should be
added to the field name. Example: urlOrAppId 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 10000. 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 ListSites 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 owns the parent channel.
Declaration
[RequestParameter("partnerId", RequestParameterType.Path)]
public virtual long PartnerId { get; }Property Value
| Type | Description |
|---|---|
| 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()