target.apidocs.com.google.api.services.people.v1.PeopleService.html Maven / Gradle / Ivy
PeopleService (People API v1-rev20210330-1.31.0)
com.google.api.services.people.v1
Class PeopleService
- java.lang.Object
-
- com.google.api.client.googleapis.services.AbstractGoogleClient
-
- com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient
-
- com.google.api.services.people.v1.PeopleService
-
public class PeopleService
extends AbstractGoogleJsonClient
Service definition for PeopleService (v1).
Provides access to information about profiles and contacts.
For more information about this service, see the
API Documentation
This service uses PeopleServiceRequestInitializer to initialize global parameters via its
PeopleService.Builder.
- Since:
- 1.3
- Author:
- Google, Inc.
-
-
Nested Class Summary
Nested Classes
Modifier and Type
Class and Description
static class PeopleService.Builder
Builder for PeopleService.
class PeopleService.ContactGroups
The "contactGroups" collection of methods.
class PeopleService.OtherContacts
The "otherContacts" collection of methods.
class PeopleService.People
The "people" collection of methods.
-
Field Summary
Fields
Modifier and Type
Field and Description
static StringDEFAULT_BASE_URL
The default encoded base URL of the service.
static StringDEFAULT_BATCH_PATH
The default encoded batch path of the service.
static StringDEFAULT_MTLS_ROOT_URL
The default encoded mTLS root URL of the service.
static StringDEFAULT_ROOT_URL
The default encoded root URL of the service.
static StringDEFAULT_SERVICE_PATH
The default encoded service path of the service.
-
Constructor Summary
Constructors
Constructor and Description
PeopleService(HttpTransport transport,
JsonFactory jsonFactory,
HttpRequestInitializer httpRequestInitializer)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
PeopleService.ContactGroupscontactGroups()
An accessor for creating requests from the ContactGroups collection.
protected voidinitialize(AbstractGoogleClientRequest<?> httpClientRequest)
PeopleService.OtherContactsotherContacts()
An accessor for creating requests from the OtherContacts collection.
PeopleService.Peoplepeople()
An accessor for creating requests from the People collection.
-
Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient
getJsonFactory, getObjectParser
-
Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClient
batch, batch, getApplicationName, getBaseUrl, getGoogleClientRequestInitializer, getRequestFactory, getRootUrl, getServicePath, getSuppressPatternChecks, getSuppressRequiredParameterChecks
-
-
Field Detail
-
DEFAULT_ROOT_URL
public static final String DEFAULT_ROOT_URL
The default encoded root URL of the service. This is determined when the library is generated
and normally should not be changed.
- Since:
- 1.7
- See Also:
- Constant Field Values
-
DEFAULT_MTLS_ROOT_URL
public static final String DEFAULT_MTLS_ROOT_URL
The default encoded mTLS root URL of the service. This is determined when the library is generated
and normally should not be changed.
- Since:
- 1.31
- See Also:
- Constant Field Values
-
DEFAULT_SERVICE_PATH
public static final String DEFAULT_SERVICE_PATH
The default encoded service path of the service. This is determined when the library is
generated and normally should not be changed.
- Since:
- 1.7
- See Also:
- Constant Field Values
-
DEFAULT_BATCH_PATH
public static final String DEFAULT_BATCH_PATH
The default encoded batch path of the service. This is determined when the library is
generated and normally should not be changed.
- Since:
- 1.23
- See Also:
- Constant Field Values
-
DEFAULT_BASE_URL
public static final String DEFAULT_BASE_URL
The default encoded base URL of the service. This is determined when the library is generated
and normally should not be changed.
- See Also:
- Constant Field Values
-
Constructor Detail
-
PeopleService
public PeopleService(HttpTransport transport,
JsonFactory jsonFactory,
HttpRequestInitializer httpRequestInitializer)
Constructor.
Use PeopleService.Builder if you need to specify any of the optional parameters.
- Parameters:
transport - HTTP transport, which should normally be:
- Google App Engine:
com.google.api.client.extensions.appengine.http.UrlFetchTransport
- Android:
newCompatibleTransport from
com.google.api.client.extensions.android.http.AndroidHttp
- Java:
GoogleNetHttpTransport
jsonFactory - JSON factory, which may be:
- Jackson:
com.google.api.client.json.jackson2.JacksonFactory
- Google GSON:
com.google.api.client.json.gson.GsonFactory
- Android Honeycomb or higher:
com.google.api.client.extensions.android.json.AndroidJsonFactory
httpRequestInitializer - HTTP request initializer or null for none- Since:
- 1.7
-
Method Detail
-
initialize
protected void initialize(AbstractGoogleClientRequest<?> httpClientRequest)
throws IOException
- Overrides:
initialize in class AbstractGoogleClient- Throws:
IOException
-
contactGroups
public PeopleService.ContactGroups contactGroups()
An accessor for creating requests from the ContactGroups collection.
The typical use is:
PeopleService people = new PeopleService(...);
PeopleService.ContactGroups.List request = people.contactGroups().list(parameters ...)
- Returns:
- the resource collection
-
otherContacts
public PeopleService.OtherContacts otherContacts()
An accessor for creating requests from the OtherContacts collection.
The typical use is:
PeopleService people = new PeopleService(...);
PeopleService.OtherContacts.List request = people.otherContacts().list(parameters ...)
- Returns:
- the resource collection
-
people
public PeopleService.People people()
An accessor for creating requests from the People collection.
The typical use is:
PeopleService people = new PeopleService(...);
PeopleService.People.List request = people.people().list(parameters ...)
- Returns:
- the resource collection
Copyright © 2011–2021 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy