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

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/people_v1/service.rb

Overview

Google 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

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ PeopleServiceService

Returns a new instance of PeopleServiceService



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

def initialize
  super('https://people.googleapis.com/', '')
  @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.



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

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.



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

def quota_user
  @quota_user
end

Instance Method Details

#get_people(request_mask_include_field: nil, resource_names: nil, quota_user: nil, fields: 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.

Parameters:

  • request_mask_include_field (String) —

    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) —

    The resource name, such as one returned by people.connections.list, of one of the people to provide information about. You can include this parameter up to 50 times in one request.

  • quota_user (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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



79
80
81
82
83
84
85
86
87
88
 
# File 'generated/google/apis/people_v1/service.rb', line 79

def get_people(request_mask_include_field: nil, resource_names: nil, quota_user: nil, fields: 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['requestMask.includeField'] = request_mask_include_field unless request_mask_include_field.nil?
  command.query['resourceNames'] = resource_names unless resource_names.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_person(resource_name, request_mask_include_field: nil, quota_user: nil, fields: 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.

Parameters:

  • resource_name (String) —

    The resource name of the person to provide information about.

    • To get information about the authenticated user, specify people/me.
    • To get information about any user, specify the resource name that identifies the user, such as the resource names returned by people.connections.list.
  • request_mask_include_field (String) —

    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.

  • quota_user (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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



119
120
121
122
123
124
125
126
127
128
 
# File 'generated/google/apis/people_v1/service.rb', line 119

def get_person(resource_name, request_mask_include_field: nil, quota_user: nil, fields: 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['requestMask.includeField'] = request_mask_include_field unless request_mask_include_field.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

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

Provides a list of the authenticated user's contacts merged with any linked profiles.

Parameters:

  • resource_name (String) —

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

  • request_sync_token (Boolean) —

    Whether the response should include a sync token, which can be used to get all changes since the last request.

  • page_token (String) —

    The token of the page to be returned.

  • page_size (Fixnum) —

    The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100.

  • request_mask_include_field (String) —

    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.

  • sync_token (String) —

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

  • sort_order (String) —

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

  • quota_user (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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'generated/google/apis/people_v1/service.rb', line 169

def list_person_connections(resource_name, request_sync_token: nil, page_token: nil, page_size: nil, request_mask_include_field: nil, sync_token: nil, sort_order: nil, quota_user: nil, fields: 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['requestSyncToken'] = request_sync_token unless request_sync_token.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['requestMask.includeField'] = request_mask_include_field unless request_mask_include_field.nil?
  command.query['syncToken'] = sync_token unless sync_token.nil?
  command.query['sortOrder'] = sort_order unless sort_order.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end