Module

googleapis.people

Module googleapis.people

Client

Address
AgeRangeType
BatchGetResponse
Biography
Birthday
BraggingRights
CalendarUrl
ClientData
ConnectionConfig
ConnectionsResponse
ContactGroup
ContactGroupBatch
ContactGroupList
ContactGroupMetadata
ContactListOptions
CoverPhoto
Date
EmailAddress
Event
ExternalId
FieldMetaData
FileAs
Gender
GroupClientData
ImClient
Interest
Locale
Location
Membership
MetaDataSource
MiscKeyword
Name
Nickname
Occupation
Organization
OtherContactListResponse
Person
PersonMetadata
PersonResponse
PhoneNumber
Photo
Relation
SearchResponse
SipAddress
Skill
Url
UserDefined

AgeRange
ContentType
FieldMask
GroupType
OtherContactFieldMask

REFRESH_URL

ballerinax/googleapis.people

2.3.0

Overview

Ballerina connector for Google People API connects the Google People API via Ballerina language with ease. It provides capability to perform operations related to contacts and contact groups in Google Contacts.

This module supports Google People API v1.0.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the Google People API connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

Import the ballerinax/googleapis.people module into the Ballerina project.

Copy

Step 2: Create a new connector instance

Enter the credentials in the Google People API client configuration, and create the Google People API client by passing the configuration.

Copy

Step 3: Invoke connector operation

  1. Create a contact via the createContact method by passing a Person record and FieldMask[] as parameters.

    Copy

  2. Use bal run command to compile and run the Ballerina program.

You can find more samples here

Clients

googleapis.people: Client

Isolated

Ballerina Google People API connector provides the capability to access Google People API. This connector lets you to read and manage the authenticated user's contacts and contact groups.

Constructor

Initializes the connector. During initialization you can pass either http:BearerTokenConfig if you have a bearer token or http:OAuth2RefreshTokenGrantConfig if you have Oauth tokens. Create a Google account and obtain tokens following this guide. Configure the OAuth2 tokens to have the required permissions.

init (ConnectionConfig config)

listOtherContacts

Isolated FunctionRemote Function
function listOtherContacts(OtherContactFieldMask[] readMasks, ContactListOptions? options) returns stream<PersonResponse>|error

Fetch all from "Other Contacts".

Parameters
Return Type
  • stream<PersonResponse>|error - Stream of PersonResponse will have information specified by Read Masks on success else an error

createContact

Isolated FunctionRemote Function
function createContact(Person person, FieldMask[] personFields) returns PersonResponse|error

Create a contact.

Parameters
  • person Person - Record of type of CreatePerson
  • personFields FieldMask[] - Restrict which fields on the person are returned
Return Type
  • PersonResponse|error - PersonResponse will have information specified by Person Fields on success else an error

getContact

Isolated FunctionRemote Function
function getContact(string resourceName, FieldMask[] personFields) returns PersonResponse|error

Fetch a contact.

Parameters
  • resourceName string - Contact resource name
  • personFields FieldMask[] - Restrict which fields on the person are returned
Return Type
  • PersonResponse|error - PersonResponse will have information specified by Person Fields on success else an error

searchContacts

Isolated FunctionRemote Function
function searchContacts(string query, FieldMask[] readMasks) returns PersonResponse[]|error

Search a contacts.

Parameters
  • query string - String to be searched
  • readMasks FieldMask[] - Restrict which fields on the person are returned
Return Type
  • PersonResponse[]|error - PersonResponse[] will have information specified by Person Fields on success else an error

updateContactPhoto

Isolated FunctionRemote Function
function updateContactPhoto(string resourceName, string imagePath) returns error?

Update contact photo for a contact.

Parameters
  • resourceName string - Contact resource name
  • imagePath string - Path to image from root directory
Return Type
  • error? - Nil on success, else an 'error'

deleteContactPhoto

Isolated FunctionRemote Function
function deleteContactPhoto(string resourceName) returns error?

Delete a contact photo.

Parameters
  • resourceName string - Contact resource name
Return Type
  • error? - Nil on success, else an 'error'

getBatchContacts

Isolated FunctionRemote Function
function getBatchContacts(string[] resourceNames, FieldMask[] personFields) returns PersonResponse[]|error

Get Batch contacts.

Parameters
  • resourceNames string[] - String array of contact resource names
  • personFields FieldMask[] - Restrict which fields on the person are returned
Return Type
  • PersonResponse[]|error - PersonResponse[] will have information specified by Person Fields on success, else an error

updateContact

Isolated FunctionRemote Function
function updateContact(string resourceName, Person person, FieldMask[] updatePersonFields, FieldMask[]? personFields) returns PersonResponse|error

Update a contact.

Parameters
  • resourceName string - Contact resource name
  • person Person - Person/Contact details
  • updatePersonFields FieldMask[] - Restrict which fields on the person are returned
  • personFields FieldMask[]? (default ()) - Restrict which fields on the person are returned
Return Type
  • PersonResponse|error - PersonResponse will have information specified by Person Fields on success else an error

deleteContact

Isolated FunctionRemote Function
function deleteContact(string resourceName) returns error?

Delete a Contact.

Parameters
  • resourceName string - Contact resource name
Return Type
  • error? - Nil on success, else an error

listContacts

Isolated FunctionRemote Function
function listContacts(FieldMask[] personFields, ContactListOptions? options) returns stream<PersonResponse>|error

Get Peoples

Parameters
  • personFields FieldMask[] - Restrict which fields on the person are returned
Return Type
  • stream<PersonResponse>|error - stream<PersonResponse> will have information specified by Person Fields on success or else an error

createContactGroup

Isolated FunctionRemote Function
function createContactGroup(string contactGroupName) returns ContactGroup|error

Create a ContactGroup.

Parameters
  • contactGroupName string - Name of the ContactGroup to be created
Return Type

getBatchContactGroup

Isolated FunctionRemote Function
function getBatchContactGroup(string[] resourceNames) returns ContactGroup[]|error

Get Batch contact groups.

Parameters
  • resourceNames string[] - An array of strings with names of Contact Groups
Return Type

listContactGroup

Isolated FunctionRemote Function
function listContactGroup() returns ContactGroup[]|error

Fetch ContactGroups of authenticated user.

Return Type

getContactGroup

Isolated FunctionRemote Function
function getContactGroup(string resourceName, int maxMembers) returns ContactGroup|error

Fetch a ContactGroup.

Parameters
  • resourceName string - Name of the ContactGroup to be created
  • maxMembers int - maximum number of members returned in contact group
Return Type

updateContactGroup

Isolated FunctionRemote Function
function updateContactGroup(string resourceName, string updateName) returns ContactGroup|error

Update a ContactGroup.

Parameters
  • resourceName string - Name of the ContactGroup to be created
  • updateName string - Name to be updated
Return Type

deleteContactGroup

Isolated FunctionRemote Function
function deleteContactGroup(string resourceName) returns error?

Delete a Contact Group.

Parameters
  • resourceName string - Contact Group resource name
Return Type
  • error? - Nil on success, else an error

modifyContactGroup

Isolated FunctionRemote Function
function modifyContactGroup(string contactGroupResourceName, string[]? resourceNameToAdd, string[]? resourceNameToRemove) returns error?

Modify a contacts in Contact Group.

Parameters
  • contactGroupResourceName string - Contact Group resource name
  • resourceNameToAdd string[]? (default ()) - Contact resource name to add
  • resourceNameToRemove string[]? (default ()) - Contact resource name to remove
Return Type
  • error? - Nil on success, else an error

Records

googleapis.people: Address

Define a Address.

Fields
  • formattedValue string? - Unstructured value of address
  • formattedType string? - Type of address formatted
  • poBox string? - Post box Number of address
  • streetAddress string? - Street address
  • extendedAddress string? - Extended address of address
  • city string? - City of address
  • region string? - Region of address
  • postalCode string? - Postal code of address
  • country string? - Country of address
  • countryCode string? - Country code of address

googleapis.people: AgeRangeType

Define an Age Range.

Fields

googleapis.people: BatchGetResponse

Define a BatchGetResponse.

Fields
  • responses json[] - Array of PersonResponse

googleapis.people: Biography

Define an Biography.

Fields
  • value string? - Age range value

googleapis.people: Birthday

Define an Birthday.

Fields
  • text string? - String representing user's birthday
  • date Date? - Date of BirthDay

googleapis.people: BraggingRights

Define an BraggingRights.

Fields

googleapis.people: CalendarUrl

Define a Calendar Url.

Fields
  • formattedType string? - Type of calendar URL formatted

googleapis.people: ClientData

Define an Arbitrary client data that is populated by clients.

Fields
  • key string? - Client specified key of client data
  • value string? - Client specified value of client data

googleapis.people: ConnectionConfig

Closed record

Client configuration details.

Fields

googleapis.people: ConnectionsResponse

Define a people connection response.

Fields
  • connections PersonResponse[] - Array of PersonResponse of authenticated user
  • nextPageToken string? - Next page token
  • nextSyncToken string? - Next sync token
  • totalPeople int? - Total contacts
  • totalItems int? - Total pages

googleapis.people: ContactGroup

Define an ContactGroup.

Fields
  • resourceName string - Resource name
  • etag string? - Entity tag of resource
  • name string? - Contact group name set by group owner or a system
  • formattedName string? - Name in formatted
  • memberResourceNames string[]? - List of contact person names that are members of contact group
  • memberCount int? - Total number of contacts

googleapis.people: ContactGroupBatch

Define a contact group batch result.

Fields
  • responses json[] - Array of contact group responses

googleapis.people: ContactGroupList

Define a Contact Group List.

Fields
  • totalItems int - Total contacts
  • nextSyncToken string - Next sync token

googleapis.people: ContactGroupMetadata

Define an ContactGroupMetadata.

Fields
  • updateTime string? - Time of update
  • deleted boolean? - Whether deleted is true

googleapis.people: ContactListOptions

Define a Stream response of a Connection/Person.

Fields
  • pageToken string?(default ()) - Page token
  • requestSyncToken boolean?(default ()) - Whether request is needed
  • syncToken string?(default ()) - Sync token

googleapis.people: CoverPhoto

Define an Cover photo.

Fields
  • url string? - URL of cover photo

googleapis.people: Date

Define a Date entity.

Fields
  • year int? - Year of date
  • month int? - Month of date
  • day int? - Day of date

googleapis.people: EmailAddress

Define an Email Address.

Fields
  • value string? - Value of email address
  • formattedType string? - Type of email address formatted
  • displayName string? - Display name of email

googleapis.people: Event

Define an Event.

Fields
  • date Date? - Date of event
  • formattedType string? - Type of event formatted

googleapis.people: ExternalId

Define an External entity.

Fields
  • value string? - Value of external ID
  • formattedType string? - Type of External entity formatted

googleapis.people: FieldMetaData

Define an FieldMetaData.

Fields
  • primary boolean? - True if field is primary field
  • verified boolean? - True if field is verified

googleapis.people: FileAs

Define a name that should be used to sort person in a list.

Fields
  • value string? - Value of file-as

googleapis.people: Gender

Define an Gender.

Fields
  • value string? - Gender for person
  • formattedValue string? - Type of Gender formatted
  • addressMeAs string? - Type that should be used to address person

googleapis.people: GroupClientData

Define a Contact Group Client Data.

Fields
  • key string? - Client specified key of client data.
  • value string? - Client specified value of client data

googleapis.people: ImClient

Define an Instant Messaging client.

Fields
  • metadata FieldMetaData? - Metadata about Instant Messaging client
  • username string? - Username used in Instant Messaging client
  • formattedType string? - Type that should be used to address person
  • protocol string? - Protocol of Instant Messaging client
  • formattedProtocol string? - Protocol of Instant Messaging client formatted

googleapis.people: Interest

Define an Interest.

Fields
  • value string? - Name of Interest

googleapis.people: Locale

Define an Locale.

Fields
  • value string? - IETF BCP 47 language tag representing locale

googleapis.people: Location

Define an Location.

Fields
  • value string? - Value of location
  • current string? - Whether location is current location
  • buildingId string? - Building identifier
  • floor string? - Floor name identifier
  • floorSection string? - Floor section in a floor
  • deskCode string? - Desk location.

googleapis.people: Membership

Define a Membership.

Fields
  • contactGroupMembership json? - Group membership
  • domainMembership string? - Domain membership

googleapis.people: MetaDataSource

Define an MetaDataSource.

Fields
  • id string? - Identifier within source

googleapis.people: MiscKeyword

Define a miscellaneous keyword.

Fields
  • value string? - Value of miscellaneous keyword
  • formattedType string? - Type of miscellaneous keyword formatted

googleapis.people: Name

Define a Name.

Fields
  • displayName string? - Display name formatted
  • displayNameLastFirst string? - Display name with last name
  • unstructuredName string? - Free form name value
  • familyName string? - Family name
  • givenName string? - Given name
  • middleName string? - Middle name
  • honorificPrefix string? - Honorific prefixes, such as Mrs. or Dr
  • honorificSuffix string? - Honorific suffixes, such as Jr.
  • phoneticFullName string? - Full name spelled as it sounds
  • phoneticFamilyName string? - Family name spelled as it sounds
  • phoneticGivenName string? - Given name spelled as it sounds
  • phoneticMiddleName string? - Middle name spelled as it sounds
  • phoneticHonorificPrefix string? - Honorific prefixes spelled as they sound
  • phoneticHonorificSuffix string? - Honorific suffixes spelled as they sound

googleapis.people: Nickname

Define an Nickname.

Fields
  • value string? - Value of nick name

googleapis.people: Occupation

Define an Occupation.

Fields
  • value string? - Value of occupation

googleapis.people: Organization

Define an Organization.

Fields
  • formattedType string? - Type organization formatted
  • startDate Date? - Start date in organization
  • endDate Date? - End date in organization
  • current string? - Whether it is current organization
  • name string? - Name of organization
  • phoneticName string? - Phonetic name of organization
  • department string? - Department at organization
  • title string? - Job title at organization
  • jobDescription string? - Job description in organization
  • symbol string? - Symbol of organization.
  • domain string? - Domain name of organization
  • location string? - Location of organization

googleapis.people: OtherContactListResponse

Define a OtherContact List Response.

Fields
  • nextPageToken string? - Next page token
  • nextSyncToken string? - Next sync token

googleapis.people: Person

Define a Create Person Payload.

Fields
  • addresses Address[]? - Person's addresses
  • biographies Biography[]? - Person's biographies
  • birthdays Birthday[]? - Person's birthdays
  • events Event[]? - Person's events
  • fileAses FileAs[]? - Person's file-ases
  • genders Gender[]? - Person's genders
  • imClients ImClient[]? - Person's instant messaging clients
  • interests Interest[]? - Person's interests
  • locales Locale[]? - Person's locale preferences
  • locations Location[]? - Person's locations
  • memberships Membership[]? - Person's group memberships
  • miscKeywords MiscKeyword[]? - Person's miscellaneous keywords
  • names Name[]? - Person's names
  • nicknames Nickname[]? - Person's nicknames
  • relations Relation[]? - Person's relations
  • sipAddresses SipAddress[]? - Person's sipAddresses
  • skills Skill[]? - Person's skills
  • urls Url[]? - Person's URLs

googleapis.people: PersonMetadata

Define a Person's meta data.

Fields
  • 'sources json[]? -
  • previousResourceNames string[]? - Previous resource name if changed
  • linkedPeopleResourceNames string[]? - Resource names of linked contacts
  • deleted boolean? - Show status whether deleted
  • objectType string? - Type of person object

googleapis.people: PersonResponse

Define a Person.

Fields
  • resourceName string - String of resource name
  • etag string? - ETag of resource
  • photos Photo[]? - Person's photos

googleapis.people: PhoneNumber

Define a PhoneNumber.

Fields
  • canonicalForm string? - Canonicalized ITU-T E.164 form of phone number
  • formattedType string? - Phone number formatted

googleapis.people: Photo

Define a Photo.

Fields

googleapis.people: Relation

Define a Relation.

Fields
  • person string? - Name of relation
  • formattedType string? - Type of relation formatted

googleapis.people: SearchResponse

Define a SearchResponse.

Fields
  • results json[] - Array of results

googleapis.people: SipAddress

Define a SIP address.

Fields
  • value string? - Name of SIP address
  • formattedType string? - Type of SIP address formatted

googleapis.people: Skill

Define a Skill.

Fields

googleapis.people: Url

Define an Url.

Fields
  • formattedType string? - Type of url formatted

googleapis.people: UserDefined

Define a Arbitrary user data.

Fields
  • key string? - User specified key of user defined data
  • value string? - User specified value of user defined data

Enums

googleapis.people: AgeRange

Define an age range.

Members

AGE_RANGE_UNSPECIFIED - Unspecified
LESS_THAN_EIGHTEEN - Younger than eighteen
EIGHTEEN_TO_TWENTY - Between eighteen and twenty
TWENTY_ONE_OR_OLDER - Twenty-one and older

googleapis.people: ContentType

Define biography type of content.

Members

CONTENT_TYPE_UNSPECIFIED - Unspecified
TEXT_PLAIN - Plain text
TEXT_HTML - HTML text

googleapis.people: FieldMask

Define a Fields returned when specified.

Members

ADDRESS - Contact's street addresses
AGE_RANGE - Contact's age ranges
BIOGRAPHY - Contact's biographies
BIRTHDAY - Contact's birthdays
CALENDER_URL - Contact's calendar URLs
CLIENT_DATA - Contact's client data
COVER_PHOTO - Contact's cover photos
EMAIL_ADDRESS - Contact's email addresses
EVENT - Contact's events
EXTERNAL_ID - Contact's external IDs
GENDER - Contact's genders
IM_CLIENT - Contact's instant messaging clients
INTEREST - Contact's interests
LOCALE - Contact's locale preferences
LOCATION - Contact's locations
MEMBERSHIP - Contact's group memberships
META_DATA - Metadata about person
MISC_KEYWORD - Contact's miscellaneous keywords
NAME - Contact's names
NICK_NAME - Contact's nicknames
OCCUPATION - Contact's occupations
ORGANIZATION - Contact's organizations
PHONE_NUMBER - Contact's phoneNumbers
PHOTO - Contact's photos
RELATION - Contact's relations
SIP_ADDRESS - Contact's sipAddresses
SKILL - Contact's skills
URL - Person's URLs
USER_DEFINED - User defined data

googleapis.people: GroupType

Define an contact group type.

Members

GROUP_TYPE_UNSPECIFIED - Unspecified
USER_CONTACT_GROUP - User defined contact group
SYSTEM_CONTACT_GROUP - System defined contact group

googleapis.people: OtherContactFieldMask

Define a OtherContacts Fields returned when specified.

Members

OTHER_CONTACT_EMAIL_ADDRESS - OtherContact's email addresses
OTHER_CONTACT_NAME - OtherContact's names
OTHER_CONTACT_PHONE_NUMBER - OtherContact's phoneNumbers

Constants

googleapis.people: REFRESH_URL

string "https://www.googleapis.com/oauth2/v4/token"

Holds the value for URL of refresh token end point

Other versions

2.3.0

2.2.02.1.02.0.01.0.1
See more...

Terms of service

Privacy policy

Cookie policy

2023 WSO2