Class DirectorySiteContactsResource.ListRequest
Retrieves a list of directory site contacts, possibly filtered. This method supports paging.
Inheritance
Inherited Members
Namespace: Google.Apis.Dfareporting.v3_2
Assembly: Google.Apis.Dfareporting.v3_2.dll
Syntax
public class ListRequest : DfareportingBaseServiceRequest<DirectorySiteContactsListResponse>, IClientServiceRequest<DirectorySiteContactsListResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, Int64)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, long profileId)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
System.Int64 | profileId |
Properties
DirectorySiteIds
Select only directory site contacts with these directory site IDs. This is a required field.
Declaration
[RequestParameter("directorySiteIds", RequestParameterType.Query)]
public virtual Repeatable<string> DirectorySiteIds { get; set; }
Property Value
Type | Description |
---|---|
Repeatable<System.String> |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
Ids
Select only directory site contacts with these IDs.
Declaration
[RequestParameter("ids", RequestParameterType.Query)]
public virtual Repeatable<string> Ids { get; set; }
Property Value
Type | Description |
---|---|
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
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
SearchString
Allows searching for objects by name, ID or email. Wildcards () are allowed. For example, "directory site contact2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 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 contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact".
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 DirectorySiteContactsResource.ListRequest.SortFieldEnum? SortField { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<DirectorySiteContactsResource.ListRequest.SortFieldEnum> |
SortOrder
Order of sorted results.
Declaration
[RequestParameter("sortOrder", RequestParameterType.Query)]
public virtual DirectorySiteContactsResource.ListRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<DirectorySiteContactsResource.ListRequest.SortOrderEnum> |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()