Class PeopleResource.ListDirectoryPeopleRequest

Provides a list of domain profiles and domain contacts in the authenticated user's domain directory. When the sync_token is specified, resources deleted since the last sync will be returned as a person with PersonMetadata.deleted set to true. When the page_token or sync_token is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at List the directory people that have changed.

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

Constructors

ListDirectoryPeopleRequest(IClientService)

Constructs a new ListDirectoryPeople request.

Declaration
public ListDirectoryPeopleRequest(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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.ListDirectoryPeopleResponse>.HttpMethod

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.ListDirectoryPeopleRequest.MergeSourcesEnum? MergeSources { get; set; }
Property Value
Type Description
PeopleResource.ListDirectoryPeopleRequest.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.ListDirectoryPeopleRequest.MergeSourcesEnum> MergeSourcesList { get; set; }
Property Value
Type Description
Repeatable<PeopleResource.ListDirectoryPeopleRequest.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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.ListDirectoryPeopleResponse>.MethodName

PageSize

Optional. The number of people to include in the response. Valid values are between 1 and 1000, 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 people.listDirectoryPeople 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

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

RequestSyncToken

Optional. Whether the response should return next_sync_token. It can be used to get incremental changes since the last request by setting it on the request sync_token. More details about sync behavior at people.listDirectoryPeople.

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

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.PeopleService.v1.Data.ListDirectoryPeopleResponse>.RestPath

Sources

Required. Directory sources to return.

Declaration
[RequestParameter("sources", RequestParameterType.Query)]
public virtual PeopleResource.ListDirectoryPeopleRequest.SourcesEnum? Sources { get; set; }
Property Value
Type Description
PeopleResource.ListDirectoryPeopleRequest.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.ListDirectoryPeopleRequest.SourcesEnum> SourcesList { get; set; }
Property Value
Type Description
Repeatable<PeopleResource.ListDirectoryPeopleRequest.SourcesEnum>
Remarks

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

SyncToken

Optional. A sync token, received from a previous response next_sync_token Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to people.listDirectoryPeople must match the first call that provided the sync token. More details about sync behavior at people.listDirectoryPeople.

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

Methods

InitParameters()

Initializes ListDirectoryPeople parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements