Class SitesResource.ListRequest

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

Inheritance

System.Object

Google.Apis.Requests.ClientServiceRequest

Google.Apis.Requests.ClientServiceRequest<SitesListResponse>

DfareportingBaseServiceRequest<SitesListResponse>

SitesResource.ListRequest

Implements

Google.Apis.Requests.IClientServiceRequest<SitesListResponse>

Google.Apis.Requests.IClientServiceRequest

Inherited Members

DfareportingBaseServiceRequest<SitesListResponse>.Xgafv

DfareportingBaseServiceRequest<SitesListResponse>.AccessToken

DfareportingBaseServiceRequest<SitesListResponse>.Alt

DfareportingBaseServiceRequest<SitesListResponse>.Callback

DfareportingBaseServiceRequest<SitesListResponse>.Fields

DfareportingBaseServiceRequest<SitesListResponse>.Key

DfareportingBaseServiceRequest<SitesListResponse>.OauthToken

DfareportingBaseServiceRequest<SitesListResponse>.PrettyPrint

DfareportingBaseServiceRequest<SitesListResponse>.QuotaUser

DfareportingBaseServiceRequest<SitesListResponse>.UploadType

DfareportingBaseServiceRequest<SitesListResponse>.UploadProtocol

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.Execute()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.ExecuteAsStream()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.ExecuteAsync()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.ExecuteAsync(System.Threading.CancellationToken)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.ExecuteAsStreamAsync()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.ExecuteAsStreamAsync(System.Threading.CancellationToken)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.CreateRequest(System.Nullable<System.Boolean>)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.GenerateRequestUri()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.GetBody()

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.GetDefaultETagAction(System.String)

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.ETagAction

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.ModifyRequest

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.ValidateParameters

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.RequestParameters

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.Service

Google.Apis.Requests.ClientServiceRequest._unsuccessfulResponseHandlers

Google.Apis.Requests.ClientServiceRequest._exceptionHandlers

Google.Apis.Requests.ClientServiceRequest._executeInterceptors

Google.Apis.Requests.ClientServiceRequest.AddUnsuccessfulResponseHandler(Google.Apis.Http.IHttpUnsuccessfulResponseHandler)

Google.Apis.Requests.ClientServiceRequest.AddExceptionHandler(Google.Apis.Http.IHttpExceptionHandler)

Google.Apis.Requests.ClientServiceRequest.AddExecuteInterceptor(Google.Apis.Http.IHttpExecuteInterceptor)

Google.Apis.Requests.ClientServiceRequest.Credential

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.Dfareporting.v3_4

Assembly: Google.Apis.Dfareporting.v3_4.dll

Syntax

public class ListRequest : DfareportingBaseServiceRequest<SitesListResponse>, IClientServiceRequest<SitesListResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, Int64)

Constructs a new List request.

Declaration

public ListRequest(IClientService service, long profileId)

Parameters

Type	Name	Description
Google.Apis.Services.IClientService	service
System.Int64	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
System.Nullable<System.Boolean>

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
System.Nullable<System.Boolean>

AcceptsPublisherPaidPlacements

Select only sites that accept publisher paid placements.

Declaration

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

Property Value

Type	Description
System.Nullable<System.Boolean>

AdWordsSite

Select only AdWords sites.

Declaration

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

Property Value

Type	Description
System.Nullable<System.Boolean>

Approved

Select only approved sites.

Declaration

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

Property Value

Type	Description
System.Nullable<System.Boolean>

CampaignIds

Select only sites with these campaign IDs.

Declaration

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

Property Value

Type	Description
Google.Apis.Util.Repeatable<System.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
Google.Apis.Util.Repeatable<System.String>

HttpMethod

Gets the HTTP method.

Declaration

public override string HttpMethod { get; }

Property Value

Type	Description
System.String

Overrides

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.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
Google.Apis.Util.Repeatable<System.String>

MaxResults

Maximum number of results to return.

Declaration

[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual int? MaxResults { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

MethodName

Gets the method name.

Declaration

public override string MethodName { get; }

Property Value

Type	Description
System.String

Overrides

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.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
System.String

ProfileId

User profile ID associated with this request.

Declaration

[RequestParameter("profileId", RequestParameterType.Path)]
public virtual long ProfileId { 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

Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_4.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
System.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
System.Nullable<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
System.Nullable<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
System.Nullable<System.Int64>

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
System.Nullable<System.Boolean>

Methods

InitParameters()

Initializes List parameter list.

Declaration

protected override void InitParameters()

Overrides

Google.Apis.Dfareporting.v3_4.DfareportingBaseServiceRequest<Google.Apis.Dfareporting.v3_4.Data.SitesListResponse>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>

Google.Apis.Requests.IClientServiceRequest