Class AccountUserProfilesResource.ListRequest

Retrieves a list of account user profiles, possibly filtered. This method supports paging.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<AccountUserProfilesListResponse>
DfareportingBaseServiceRequest<AccountUserProfilesListResponse>
AccountUserProfilesResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Dfareporting.v4
Assembly: Google.Apis.Dfareporting.v4.dll
Syntax
public class AccountUserProfilesResource.ListRequest : DfareportingBaseServiceRequest<AccountUserProfilesListResponse>, IClientServiceRequest<AccountUserProfilesListResponse>, 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

Active

Select only active user profiles.

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

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

Ids

Select only user profiles 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 email. Wildcards () are allowed. For example, "user profile2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 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 "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".

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 AccountUserProfilesResource.ListRequest.SortFieldEnum? SortField { get; set; }
Property Value
Type Description
AccountUserProfilesResource.ListRequest.SortFieldEnum?

SortOrder

Order of sorted results.

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

SubaccountId

Select only user profiles with the specified subaccount ID.

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

UserRoleId

Select only user profiles with the specified user role ID.

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

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements