Class DirectorySitesResource.ListRequest
Retrieves a list of directory sites, possibly filtered. This method supports paging.
Inheritance
Inherited Members
Namespace: Google.Apis.Dfareporting.v3_5
Assembly: Google.Apis.Dfareporting.v3_5.dll
Syntax
public class DirectorySitesResource.ListRequest : DfareportingBaseServiceRequest<DirectorySitesListResponse>, IClientServiceRequest<DirectorySitesListResponse>, 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
AcceptsInStreamVideoPlacements
This search filter is no longer supported and will have no effect on the results returned.
Declaration
[RequestParameter("acceptsInStreamVideoPlacements", RequestParameterType.Query)]
public virtual bool? AcceptsInStreamVideoPlacements { get; set; }
Property Value
Type | Description |
---|---|
bool? |
AcceptsInterstitialPlacements
This search filter is no longer supported and will have no effect on the results returned.
Declaration
[RequestParameter("acceptsInterstitialPlacements", RequestParameterType.Query)]
public virtual bool? AcceptsInterstitialPlacements { get; set; }
Property Value
Type | Description |
---|---|
bool? |
AcceptsPublisherPaidPlacements
Select only directory sites that accept publisher paid placements. This field can be left blank.
Declaration
[RequestParameter("acceptsPublisherPaidPlacements", RequestParameterType.Query)]
public virtual bool? AcceptsPublisherPaidPlacements { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Active
Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
Declaration
[RequestParameter("active", RequestParameterType.Query)]
public virtual bool? Active { get; set; }
Property Value
Type | Description |
---|---|
bool? |
DfpNetworkCode
Select only directory sites with this Ad Manager network code.
Declaration
[RequestParameter("dfpNetworkCode", RequestParameterType.Query)]
public virtual string DfpNetworkCode { get; set; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Ids
Select only directory sites with these IDs.
Declaration
[RequestParameter("ids", RequestParameterType.Query)]
public virtual Repeatable<string> Ids { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<string> |
MaxResults
Maximum number of results to return.
Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual int? MaxResults { get; set; }
Property Value
Type | Description |
---|---|
int? |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
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 |
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 objects by name, ID or URL. Wildcards () are allowed. For example, "directory site2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 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 "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site".
Declaration
[RequestParameter("searchString", RequestParameterType.Query)]
public virtual string SearchString { get; set; }
Property Value
Type | Description |
---|---|
string |
SortField
Field by which to sort the list.
Declaration
[RequestParameter("sortField", RequestParameterType.Query)]
public virtual DirectorySitesResource.ListRequest.SortFieldEnum? SortField { get; set; }
Property Value
Type | Description |
---|---|
DirectorySitesResource.ListRequest.SortFieldEnum? |
SortOrder
Order of sorted results.
Declaration
[RequestParameter("sortOrder", RequestParameterType.Query)]
public virtual DirectorySitesResource.ListRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
DirectorySitesResource.ListRequest.SortOrderEnum? |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()