Class PeopleResource.SearchDirectoryPeopleRequest

Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<SearchDirectoryPeopleResponse>
PeopleServiceBaseServiceRequest<SearchDirectoryPeopleResponse>
PeopleResource.SearchDirectoryPeopleRequest
Implements
Inherited Members
Namespace: Google.Apis.PeopleService.v1
Assembly: Google.Apis.PeopleService.v1.dll
Syntax
public class PeopleResource.SearchDirectoryPeopleRequest : PeopleServiceBaseServiceRequest<SearchDirectoryPeopleResponse>, IClientServiceRequest<SearchDirectoryPeopleResponse>, IClientServiceRequest

Constructors

SearchDirectoryPeopleRequest(IClientService)

Constructs a new SearchDirectoryPeople request.

Declaration
public SearchDirectoryPeopleRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

HttpMethod

Gets the HTTP method.

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

MergeSources

Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.

Declaration
[RequestParameter("mergeSources", RequestParameterType.Query)]
public virtual PeopleResource.SearchDirectoryPeopleRequest.MergeSourcesEnum? MergeSources { get; set; }
Property Value
Type Description
PeopleResource.SearchDirectoryPeopleRequest.MergeSourcesEnum?
Remarks

Use this property to set a single value for the parameter, or MergeSourcesList to set multiple values. Do not set both properties.

MergeSourcesList

Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers.

Declaration
[RequestParameter("mergeSources", RequestParameterType.Query)]
public virtual Repeatable<PeopleResource.SearchDirectoryPeopleRequest.MergeSourcesEnum> MergeSourcesList { get; set; }
Property Value
Type Description
Repeatable<PeopleResource.SearchDirectoryPeopleRequest.MergeSourcesEnum>
Remarks

Use this property to set one or more values for the parameter. Do not set both this property and MergeSources.

MethodName

Gets the method name.

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

PageSize

Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

Optional. A page token, received from a previous response next_page_token. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchDirectoryPeople must match the first call that provided the page token.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Query

Required. Prefix query that matches fields in the person. Does NOT use the read_mask for determining what fields to match.

Declaration
[RequestParameter("query", RequestParameterType.Query)]
public virtual string Query { get; set; }
Property Value
Type Description
string

ReadMask

Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames

  • occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
Declaration
[RequestParameter("readMask", RequestParameterType.Query)]
public virtual object ReadMask { get; set; }
Property Value
Type Description
object

RestPath

Gets the REST path.

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

Sources

Required. Directory sources to return.

Declaration
[RequestParameter("sources", RequestParameterType.Query)]
public virtual PeopleResource.SearchDirectoryPeopleRequest.SourcesEnum? Sources { get; set; }
Property Value
Type Description
PeopleResource.SearchDirectoryPeopleRequest.SourcesEnum?
Remarks

Use this property to set a single value for the parameter, or SourcesList to set multiple values. Do not set both properties.

SourcesList

Required. Directory sources to return.

Declaration
[RequestParameter("sources", RequestParameterType.Query)]
public virtual Repeatable<PeopleResource.SearchDirectoryPeopleRequest.SourcesEnum> SourcesList { get; set; }
Property Value
Type Description
Repeatable<PeopleResource.SearchDirectoryPeopleRequest.SourcesEnum>
Remarks

Use this property to set one or more values for the parameter. Do not set both this property and Sources.

Methods

InitParameters()

Initializes SearchDirectoryPeople parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements