Class: Google::Apis::PeopleV1::PeopleServiceService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/people_v1/service.rb

Overview

People API

Provides access to information about profiles and contacts.

Examples:

require 'google/apis/people_v1'

People = Google::Apis::PeopleV1 # Alias the module
service = People::PeopleServiceService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PeopleServiceService

Returns a new instance of PeopleServiceService.



45
46
47
48
49
50
 
# File 'lib/google/apis/people_v1/service.rb', line 45

def initialize
  super('https://people.googleapis.com/', '',
        client_name: 'google-apis-people_v1',
        client_version: Google::Apis::PeopleV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40
 
# File 'lib/google/apis/people_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



43
44
45
 
# File 'lib/google/apis/people_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#batch_contact_group_get(max_members: nil, resource_names: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::BatchGetContactGroupsResponse

Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.

Parameters:

  • max_members (Fixnum) (defaults to: nil) —

    Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not set, which will return zero members.

  • resource_names (Array<String>, String) (defaults to: nil) —

    Required. The resource names of the contact groups to get.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/apis/people_v1/service.rb', line 76

def batch_contact_group_get(max_members: nil, resource_names: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/contactGroups:batchGet', options)
  command.response_representation = Google::Apis::PeopleV1::BatchGetContactGroupsResponse::Representation
  command.response_class = Google::Apis::PeopleV1::BatchGetContactGroupsResponse
  command.query['maxMembers'] = max_members unless max_members.nil?
  command.query['resourceNames'] = resource_names unless resource_names.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#copy_other_contact_to_my_contacts_group(resource_name, copy_other_contact_to_my_contacts_group_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::Person

Copies an "Other contact" to a new contact in the user's "myContacts" group

Parameters:

  • resource_name (String) —

    Required. The resource name of the "Other contact" to copy.

  • copy_other_contact_to_my_contacts_group_request_object (Google::Apis::PeopleV1::CopyOtherContactToMyContactsGroupRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/google/apis/people_v1/service.rb', line 318

def copy_other_contact_to_my_contacts_group(resource_name, copy_other_contact_to_my_contacts_group_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resourceName}:copyOtherContactToMyContactsGroup', options)
  command.request_representation = Google::Apis::PeopleV1::CopyOtherContactToMyContactsGroupRequest::Representation
  command.request_object = copy_other_contact_to_my_contacts_group_request_object
  command.response_representation = Google::Apis::PeopleV1::Person::Representation
  command.response_class = Google::Apis::PeopleV1::Person
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_contact_group(create_contact_group_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::ContactGroup

Create a new contact group owned by the authenticated user.

Parameters:

  • create_contact_group_request_object (Google::Apis::PeopleV1::CreateContactGroupRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/google/apis/people_v1/service.rb', line 106

def create_contact_group(create_contact_group_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/contactGroups', options)
  command.request_representation = Google::Apis::PeopleV1::CreateContactGroupRequest::Representation
  command.request_object = create_contact_group_request_object
  command.response_representation = Google::Apis::PeopleV1::ContactGroup::Representation
  command.response_class = Google::Apis::PeopleV1::ContactGroup
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_person_contact(person_object = nil, person_fields: nil, sources: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::Person

Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names

Parameters:

  • person_object (Google::Apis::PeopleV1::Person) (defaults to: nil)
  • person_fields (String) (defaults to: nil) —

    Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. 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
  • sources (Array<String>, String) (defaults to: nil) —

    Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/google/apis/people_v1/service.rb', line 421

def create_person_contact(person_object = nil, person_fields: nil, sources: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/people:createContact', options)
  command.request_representation = Google::Apis::PeopleV1::Person::Representation
  command.request_object = person_object
  command.response_representation = Google::Apis::PeopleV1::Person::Representation
  command.response_class = Google::Apis::PeopleV1::Person
  command.query['personFields'] = person_fields unless person_fields.nil?
  command.query['sources'] = sources unless sources.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_contact_group(resource_name, delete_contacts: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::Empty

Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.

Parameters:

  • resource_name (String) —

    Required. The resource name of the contact group to delete.

  • delete_contacts (Boolean) (defaults to: nil) —

    Optional. Set to true to also delete the contacts in the specified group.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



140
141
142
143
144
145
146
147
148
149
 
# File 'lib/google/apis/people_v1/service.rb', line 140

def delete_contact_group(resource_name, delete_contacts: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+resourceName}', options)
  command.response_representation = Google::Apis::PeopleV1::Empty::Representation
  command.response_class = Google::Apis::PeopleV1::Empty
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['deleteContacts'] = delete_contacts unless delete_contacts.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_person_contact(resource_name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::Empty

Delete a contact person. Any non-contact data will not be deleted.

Parameters:

  • resource_name (String) —

    Required. The resource name of the contact to delete.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



454
455
456
457
458
459
460
461
462
 
# File 'lib/google/apis/people_v1/service.rb', line 454

def delete_person_contact(resource_name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+resourceName}:deleteContact', options)
  command.response_representation = Google::Apis::PeopleV1::Empty::Representation
  command.response_class = Google::Apis::PeopleV1::Empty
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_person_contact_photo(resource_name, person_fields: nil, sources: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::DeleteContactPhotoResponse

Delete a contact's photo.

Parameters:

  • resource_name (String) —

    Required. The resource name of the contact whose photo will be deleted.

  • person_fields (String) (defaults to: nil) —

    Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. 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

  • sources (Array<String>, String) (defaults to: nil) —

    Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/google/apis/people_v1/service.rb', line 496

def delete_person_contact_photo(resource_name, person_fields: nil, sources: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+resourceName}:deleteContactPhoto', options)
  command.response_representation = Google::Apis::PeopleV1::DeleteContactPhotoResponse::Representation
  command.response_class = Google::Apis::PeopleV1::DeleteContactPhotoResponse
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['personFields'] = person_fields unless person_fields.nil?
  command.query['sources'] = sources unless sources.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_contact_group(resource_name, max_members: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::ContactGroup

Get a specific contact group owned by the authenticated user by specifying a contact group resource name.

Parameters:

  • resource_name (String) —

    Required. The resource name of the contact group to get.

  • max_members (Fixnum) (defaults to: nil) —

    Optional. Specifies the maximum number of members to return. Defaults to 0 if not set, which will return zero members.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/google/apis/people_v1/service.rb', line 175

def get_contact_group(resource_name, max_members: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resourceName}', options)
  command.response_representation = Google::Apis::PeopleV1::ContactGroup::Representation
  command.response_class = Google::Apis::PeopleV1::ContactGroup
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['maxMembers'] = max_members unless max_members.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_people(person_fields: nil, request_mask_include_field: nil, resource_names: nil, sources: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::GetPeopleResponse

Provides information about a list of specific people by specifying a list of requested resource names. Use people/me to indicate the authenticated user. The request returns a 400 error if 'personFields' is not specified.

Parameters:

  • person_fields (String) (defaults to: nil) —

    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

  • request_mask_include_field (String) (defaults to: nil) —

    Required. Comma-separated list of person fields to be included in the response. Each path should start with person.: for example, person.names or person. photos.

  • resource_names (Array<String>, String) (defaults to: nil) —

    Required. The resource names of the people to provide information about. It's repeatable. The URL query parameter should be resourceNames=& resourceNames=&... - To get information about the authenticated user, specify people/me. - To get information about a google account, specify people/account_id`. - To get information about a contact, specify the resource name that identifies the contact as returned by [people.connections. list`](/people/api/rest/v1/people.connections/list). You can include up to 50 resource names in one request.

  • sources (Array<String>, String) (defaults to: nil) —

    Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'lib/google/apis/people_v1/service.rb', line 607

def get_people(person_fields: nil, request_mask_include_field: nil, resource_names: nil, sources: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/people:batchGet', options)
  command.response_representation = Google::Apis::PeopleV1::GetPeopleResponse::Representation
  command.response_class = Google::Apis::PeopleV1::GetPeopleResponse
  command.query['personFields'] = person_fields unless person_fields.nil?
  command.query['requestMask.includeField'] = request_mask_include_field unless request_mask_include_field.nil?
  command.query['resourceNames'] = resource_names unless resource_names.nil?
  command.query['sources'] = sources unless sources.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_person(resource_name, person_fields: nil, request_mask_include_field: nil, sources: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::Person

Provides information about a person by specifying a resource name. Use people/ me to indicate the authenticated user. The request returns a 400 error if ' personFields' is not specified.

Parameters:

  • resource_name (String) —

    Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify people/me. - To get information about a google account, specify people/account_id`. - To get information about a contact, specify the resource name that identifies the contact as returned by [people.connections.list`](/people/api/rest/v1/people. connections/list).

  • person_fields (String) (defaults to: nil) —

    Required. A field mask to restrict which fields on the 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

  • request_mask_include_field (String) (defaults to: nil) —

    Required. Comma-separated list of person fields to be included in the response. Each path should start with person.: for example, person.names or person. photos.

  • sources (Array<String>, String) (defaults to: nil) —

    Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_PROFILE and READ_SOURCE_TYPE_CONTACT if not set.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/google/apis/people_v1/service.rb', line 550

def get_person(resource_name, person_fields: nil, request_mask_include_field: nil, sources: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resourceName}', options)
  command.response_representation = Google::Apis::PeopleV1::Person::Representation
  command.response_class = Google::Apis::PeopleV1::Person
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['personFields'] = person_fields unless person_fields.nil?
  command.query['requestMask.includeField'] = request_mask_include_field unless request_mask_include_field.nil?
  command.query['sources'] = sources unless sources.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_contact_groups(page_size: nil, page_token: nil, sync_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::ListContactGroupsResponse

List all contact groups owned by the authenticated user. Members of the contact groups are not populated.

Parameters:

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.

  • page_token (String) (defaults to: nil) —

    Optional. The next_page_token value returned from a previous call to ListContactGroups. Requests the next page of resources.

  • sync_token (String) (defaults to: nil) —

    Optional. A sync token, returned by a previous call to contactgroups.list. Only resources changed since the sync token was created will be returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/google/apis/people_v1/service.rb', line 215

def list_contact_groups(page_size: nil, page_token: nil, sync_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/contactGroups', options)
  command.response_representation = Google::Apis::PeopleV1::ListContactGroupsResponse::Representation
  command.response_class = Google::Apis::PeopleV1::ListContactGroupsResponse
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['syncToken'] = sync_token unless sync_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_other_contacts(page_size: nil, page_token: nil, read_mask: nil, request_sync_token: nil, sync_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::ListOtherContactsResponse

List all "Other contacts", that is contacts that are not in a contact group. " Other contacts" are typically auto created contacts from interactions.

Parameters:

  • page_size (Fixnum) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • read_mask (String) (defaults to: nil) —

    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: * emailAddresses * names * phoneNumbers

  • request_sync_token (Boolean) (defaults to: nil) —

    Optional. Whether the response should include next_sync_token, which can be used to get all changes since the last request. For subsequent sync requests use the sync_token param instead. Initial sync requests that specify request_sync_token have an additional rate limit.

  • sync_token (String) (defaults to: nil) —

    Optional. A sync token, received from a previous ListOtherContacts call. Provide this to retrieve only the resources changed since the last request. Sync requests that specify sync_token have an additional rate limit. When syncing, all other parameters provided to ListOtherContacts must match the call that provided the sync token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/google/apis/people_v1/service.rb', line 373

def list_other_contacts(page_size: nil, page_token: nil, read_mask: nil, request_sync_token: nil, sync_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/otherContacts', options)
  command.response_representation = Google::Apis::PeopleV1::ListOtherContactsResponse::Representation
  command.response_class = Google::Apis::PeopleV1::ListOtherContactsResponse
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['requestSyncToken'] = request_sync_token unless request_sync_token.nil?
  command.query['syncToken'] = sync_token unless sync_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_person_connections(resource_name, page_size: nil, page_token: nil, person_fields: nil, request_mask_include_field: nil, request_sync_token: nil, sort_order: nil, sources: nil, sync_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::ListConnectionsResponse

Provides a list of the authenticated user's contacts. The request returns a 400 error if personFields is not specified. The request returns a 410 error if sync_token is specified and is expired. Sync tokens expire after 7 days to prevent data drift between clients and the server. To handle a sync token expired error, a request should be sent without sync_token to get all contacts.

Parameters:

  • resource_name (String) —

    Required. The resource name to return connections for. Only people/me is valid.

  • page_size (Fixnum) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

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

  • person_fields (String) (defaults to: nil) —

    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

  • request_mask_include_field (String) (defaults to: nil) —

    Required. Comma-separated list of person fields to be included in the response. Each path should start with person.: for example, person.names or person. photos.

  • request_sync_token (Boolean) (defaults to: nil) —

    Optional. Whether the response should include next_sync_token on the last page, which can be used to get all changes since the last request. For subsequent sync requests use the sync_token param instead. Initial full sync requests that specify request_sync_token and do not specify sync_token have an additional rate limit per user. Each client should generally only be doing a full sync once every few days per user and so should not hit this limit.

  • sort_order (String) (defaults to: nil) —

    Optional. The order in which the connections should be sorted. Defaults to LAST_MODIFIED_ASCENDING.

  • sources (Array<String>, String) (defaults to: nil) —

    Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.

  • sync_token (String) (defaults to: nil) —

    Optional. A sync token, received from a previous ListConnections call. Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to ListConnections except page_size and page_token must match the initial call that provided the sync token. Sync tokens expire after seven days, after which a full sync request without a sync_token should be made.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
 
# File 'lib/google/apis/people_v1/service.rb', line 912

def list_person_connections(resource_name, page_size: nil, page_token: nil, person_fields: nil, request_mask_include_field: nil, request_sync_token: nil, sort_order: nil, sources: nil, sync_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resourceName}/connections', options)
  command.response_representation = Google::Apis::PeopleV1::ListConnectionsResponse::Representation
  command.response_class = Google::Apis::PeopleV1::ListConnectionsResponse
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['personFields'] = person_fields unless person_fields.nil?
  command.query['requestMask.includeField'] = request_mask_include_field unless request_mask_include_field.nil?
  command.query['requestSyncToken'] = request_sync_token unless request_sync_token.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['sources'] = sources unless sources.nil?
  command.query['syncToken'] = sync_token unless sync_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_person_directory_people(merge_sources: nil, page_size: nil, page_token: nil, read_mask: nil, request_sync_token: nil, sources: nil, sync_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::ListDirectoryPeopleResponse

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

Parameters:

  • merge_sources (Array<String>, String) (defaults to: nil) —

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

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

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

  • read_mask (String) (defaults to: nil) —

    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

  • request_sync_token (Boolean) (defaults to: nil) —

    Optional. Whether the response should include next_sync_token, which can be used to get all changes since the last request. For subsequent sync requests use the sync_token param instead.

  • sources (Array<String>, String) (defaults to: nil) —

    Required. Directory sources to return.

  • sync_token (String) (defaults to: nil) —

    Optional. A sync token, received from a previous ListDirectoryPeople call. Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to ListDirectoryPeople must match the call that provided the sync token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/google/apis/people_v1/service.rb', line 669

def list_person_directory_people(merge_sources: nil, page_size: nil, page_token: nil, read_mask: nil, request_sync_token: nil, sources: nil, sync_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/people:listDirectoryPeople', options)
  command.response_representation = Google::Apis::PeopleV1::ListDirectoryPeopleResponse::Representation
  command.response_class = Google::Apis::PeopleV1::ListDirectoryPeopleResponse
  command.query['mergeSources'] = merge_sources unless merge_sources.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['requestSyncToken'] = request_sync_token unless request_sync_token.nil?
  command.query['sources'] = sources unless sources.nil?
  command.query['syncToken'] = sync_token unless sync_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#modify_contact_group_members(resource_name, modify_contact_group_members_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::ModifyContactGroupMembersResponse

Modify the members of a contact group owned by the authenticated user. The only system contact groups that can have members added are contactGroups/ myContacts and contactGroups/starred. Other system contact groups are deprecated and can only have contacts removed.

Parameters:

  • resource_name (String) —

    Required. The resource name of the contact group to modify.

  • modify_contact_group_members_request_object (Google::Apis::PeopleV1::ModifyContactGroupMembersRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/google/apis/people_v1/service.rb', line 285

def modify_contact_group_members(resource_name, modify_contact_group_members_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resourceName}/members:modify', options)
  command.request_representation = Google::Apis::PeopleV1::ModifyContactGroupMembersRequest::Representation
  command.request_object = modify_contact_group_members_request_object
  command.response_representation = Google::Apis::PeopleV1::ModifyContactGroupMembersResponse::Representation
  command.response_class = Google::Apis::PeopleV1::ModifyContactGroupMembersResponse
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_person_directory_people(merge_sources: nil, page_size: nil, page_token: nil, query: nil, read_mask: nil, sources: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::SearchDirectoryPeopleResponse

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

Parameters:

  • merge_sources (Array<String>, String) (defaults to: nil) —

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

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

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

  • query (String) (defaults to: nil) —

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

  • read_mask (String) (defaults to: nil) —

    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

  • sources (Array<String>, String) (defaults to: nil) —

    Required. Directory sources to return.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



728
729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/google/apis/people_v1/service.rb', line 728

def search_person_directory_people(merge_sources: nil, page_size: nil, page_token: nil, query: nil, read_mask: nil, sources: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/people:searchDirectoryPeople', options)
  command.response_representation = Google::Apis::PeopleV1::SearchDirectoryPeopleResponse::Representation
  command.response_class = Google::Apis::PeopleV1::SearchDirectoryPeopleResponse
  command.query['mergeSources'] = merge_sources unless merge_sources.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['query'] = query unless query.nil?
  command.query['readMask'] = read_mask unless read_mask.nil?
  command.query['sources'] = sources unless sources.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_contact_group(resource_name, update_contact_group_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::ContactGroup

Update the name of an existing contact group owned by the authenticated user.

Parameters:

  • resource_name (String) —

    The resource name for the contact group, assigned by the server. An ASCII string, in the form of contactGroups/contact_group_id``.

  • update_contact_group_request_object (Google::Apis::PeopleV1::UpdateContactGroupRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/google/apis/people_v1/service.rb', line 249

def update_contact_group(resource_name, update_contact_group_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1/{+resourceName}', options)
  command.request_representation = Google::Apis::PeopleV1::UpdateContactGroupRequest::Representation
  command.request_object = update_contact_group_request_object
  command.response_representation = Google::Apis::PeopleV1::ContactGroup::Representation
  command.response_class = Google::Apis::PeopleV1::ContactGroup
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_person_contact(resource_name, person_object = nil, person_fields: nil, sources: nil, update_person_fields: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::Person

Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the update_mask will be replaced. The server returns a 400 error if person.metadata.sources is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason "failedPrecondition" if person.metadata.sources.etag is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and merge their updates into the latest person. The server returns a 400 error if memberships are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names

Parameters:

  • resource_name (String) —

    The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of people/person_id``.

  • person_object (Google::Apis::PeopleV1::Person) (defaults to: nil)
  • person_fields (String) (defaults to: nil) —

    Optional. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. 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
  • sources (Array<String>, String) (defaults to: nil) —

    Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_PROFILE if not set.

  • update_person_fields (String) (defaults to: nil) —

    Required. A field mask to restrict which fields on the person are updated. Multiple fields can be specified by separating them with commas. All updated fields will be replaced. Valid values are: * addresses * biographies * birthdays * calendarUrls * clientData * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * relations * sipAddresses * urls * userDefined

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'lib/google/apis/people_v1/service.rb', line 797

def update_person_contact(resource_name, person_object = nil, person_fields: nil, sources: nil, update_person_fields: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+resourceName}:updateContact', options)
  command.request_representation = Google::Apis::PeopleV1::Person::Representation
  command.request_object = person_object
  command.response_representation = Google::Apis::PeopleV1::Person::Representation
  command.response_class = Google::Apis::PeopleV1::Person
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['personFields'] = person_fields unless person_fields.nil?
  command.query['sources'] = sources unless sources.nil?
  command.query['updatePersonFields'] = update_person_fields unless update_person_fields.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_person_contact_photo(resource_name, update_contact_photo_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PeopleV1::UpdateContactPhotoResponse

Update a contact's photo.

Parameters:

  • resource_name (String) —

    Required. Person resource name

  • update_contact_photo_request_object (Google::Apis::PeopleV1::UpdateContactPhotoRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



833
834
835
836
837
838
839
840
841
842
843
 
# File 'lib/google/apis/people_v1/service.rb', line 833

def update_person_contact_photo(resource_name, update_contact_photo_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+resourceName}:updateContactPhoto', options)
  command.request_representation = Google::Apis::PeopleV1::UpdateContactPhotoRequest::Representation
  command.request_object = update_contact_photo_request_object
  command.response_representation = Google::Apis::PeopleV1::UpdateContactPhotoResponse::Representation
  command.response_class = Google::Apis::PeopleV1::UpdateContactPhotoResponse
  command.params['resourceName'] = resource_name unless resource_name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end