Class SitesResource.ListRequest

Retrieves a list of sites, possibly filtered. This method supports paging.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<SitesListResponse>
DfareportingBaseServiceRequest<SitesListResponse>
SitesResource.ListRequest
Implements
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Dfareporting.v3_5
Assembly: Google.Apis.Dfareporting.v3_5.dll
Syntax
public class SitesResource.ListRequest : DfareportingBaseServiceRequest<SitesListResponse>, IClientServiceRequest<SitesListResponse>, 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 sites that accept publisher paid placements.

Declaration
[RequestParameter("acceptsPublisherPaidPlacements", RequestParameterType.Query)]
public virtual bool? AcceptsPublisherPaidPlacements { get; set; }
Property Value
Type Description
bool?

AdWordsSite

Select only AdWords sites.

Declaration
[RequestParameter("adWordsSite", RequestParameterType.Query)]
public virtual bool? AdWordsSite { get; set; }
Property Value
Type Description
bool?

Approved

Select only approved sites.

Declaration
[RequestParameter("approved", RequestParameterType.Query)]
public virtual bool? Approved { get; set; }
Property Value
Type Description
bool?

CampaignIds

Select only sites with these campaign IDs.

Declaration
[RequestParameter("campaignIds", RequestParameterType.Query)]
public virtual Repeatable<string> CampaignIds { get; set; }
Property Value
Type Description
Repeatable<string>

DirectorySiteIds

Select only sites with these directory site IDs.

Declaration
[RequestParameter("directorySiteIds", RequestParameterType.Query)]
public virtual Repeatable<string> DirectorySiteIds { get; set; }
Property Value
Type Description
Repeatable<string>

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_5.Data.SitesListResponse>.HttpMethod

Ids

Select only 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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_5.Data.SitesListResponse>.MethodName

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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_5.Data.SitesListResponse>.RestPath

SearchString

Allows searching for objects by name, ID or keyName. Wildcards () are allowed. For example, "site2015" will return objects with names like "site June 2015", "site April 2015", or simply "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 "site" will match objects with name "my site", "site 2015", or simply "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 SitesResource.ListRequest.SortFieldEnum? SortField { get; set; }
Property Value
Type Description
SitesResource.ListRequest.SortFieldEnum?

SortOrder

Order of sorted results.

Declaration
[RequestParameter("sortOrder", RequestParameterType.Query)]
public virtual SitesResource.ListRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
SitesResource.ListRequest.SortOrderEnum?

SubaccountId

Select only sites with this subaccount ID.

Declaration
[RequestParameter("subaccountId", RequestParameterType.Query)]
public virtual long? SubaccountId { get; set; }
Property Value
Type Description
long?

UnmappedSite

Select only sites that have not been mapped to a directory site.

Declaration
[RequestParameter("unmappedSite", RequestParameterType.Query)]
public virtual bool? UnmappedSite { get; set; }
Property Value
Type Description
bool?

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Dfareporting.v3_5.DfareportingBaseServiceRequest<Google.Apis.Dfareporting.v3_5.Data.SitesListResponse>.InitParameters()

Implements