vendor/bundle/ruby/2.6.0/gems/google-api-client-0.38.0/generated/google/apis/people_v1/service.rb
# Provides a list of the authenticated user's contacts merged with any
# connected profiles.
# The request throws a 400 error if 'personFields' is not specified.
# @param [String] resource_name
#   Required. The resource name to return connections for. Only `people/me` is
#   valid.
# @param [Fixnum] page_size
#   Optional. The number of connections to include in the response. Valid values
#   are
#   between 1 and 2000, inclusive. Defaults to 100 if not set or set to 0.
# @param [String] page_token
#   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.
# @param [String] person_fields
#   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
#   * coverPhotos
#   * emailAddresses
#   * events
#   * genders
#   * imClients
#   * interests
#   * locales
#   * memberships
#   * metadata
#   * names
#   * nicknames
#   * occupations
#   * organizations
#   * phoneNumbers
#   * photos
#   * relations
#   * residences
#   * sipAddresses
#   * skills
#   * urls
#   * userDefined
# @param [String] request_mask_include_field
#   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`.
# @param [Boolean] request_sync_token
#   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.
# @param [String] sort_order
#   Optional. The order in which the connections should be sorted. Defaults to
#   `LAST_MODIFIED_ASCENDING`.
# @param [String] sync_token
#   Optional. A sync token, received from a previous `ListConnections` 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 `ListConnections`
#   must match the call that provided the sync token.
# @param [String] fields
#   Selector specifying which fields to include in a partial response.
# @param [String] quota_user
#   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.
# @param [Google::Apis::RequestOptions] options
#   Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::PeopleV1::ListConnectionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::PeopleV1::ListConnectionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
Provides a list of the authenticated user's contacts merged with any
connected profiles.
The request throws a 400 error if 'personFields' is not specified.
Provides a list of the authenticated user ' s contacts merged with any connected profiles . The request throws a 400 error if ' personFields ' is not specified .
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, 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['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
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 , 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 [ '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
Provides a list of the authenticated user's contacts merged with any
connected profiles.
Provides a list of the authenticated user ' s contacts merged with any connected profiles .
None
Google::Apis::PeopleV1::ListConnectionsResponse
[Google::Apis::ServerError] An error occurred on the server and the request can be retried
[ 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 :: ClientError ] The request is invalid and should not be retried without modification
[Google::Apis::AuthorizationError] Authorization is required
[ Google :: Apis :: AuthorizationError ] Authorization is required
resource_name
page_size
page_token
person_fields
request_mask_include_field
request_sync_token
sort_order
sync_token
fields
quota_user
options
block
options Request-specific options
options Request - specific options
]
Result & error if block supplied
Result & error if block supplied
result
parsed result object
parsed result object
err
error object if request failed
error object if request failed