Documentation ¶
Overview ¶
Package people provides access to the People API.
See https://developers.google.com/people/
Usage example:
import "google.golang.org/api/people/v1" ... peopleService, err := people.New(oauthHttpClient)
Index ¶
- Constants
- type Address
- type AgeRangeType
- type BatchGetContactGroupsResponse
- type Biography
- type Birthday
- type BraggingRights
- type ContactGroup
- type ContactGroupMembership
- type ContactGroupMetadata
- type ContactGroupResponse
- type ContactGroupsBatchGetCall
- func (c *ContactGroupsBatchGetCall) Context(ctx context.Context) *ContactGroupsBatchGetCall
- func (c *ContactGroupsBatchGetCall) Do(opts ...googleapi.CallOption) (*BatchGetContactGroupsResponse, error)
- func (c *ContactGroupsBatchGetCall) Fields(s ...googleapi.Field) *ContactGroupsBatchGetCall
- func (c *ContactGroupsBatchGetCall) Header() http.Header
- func (c *ContactGroupsBatchGetCall) IfNoneMatch(entityTag string) *ContactGroupsBatchGetCall
- func (c *ContactGroupsBatchGetCall) MaxMembers(maxMembers int64) *ContactGroupsBatchGetCall
- func (c *ContactGroupsBatchGetCall) ResourceNames(resourceNames ...string) *ContactGroupsBatchGetCall
- type ContactGroupsCreateCall
- func (c *ContactGroupsCreateCall) Context(ctx context.Context) *ContactGroupsCreateCall
- func (c *ContactGroupsCreateCall) Do(opts ...googleapi.CallOption) (*ContactGroup, error)
- func (c *ContactGroupsCreateCall) Fields(s ...googleapi.Field) *ContactGroupsCreateCall
- func (c *ContactGroupsCreateCall) Header() http.Header
- type ContactGroupsDeleteCall
- func (c *ContactGroupsDeleteCall) Context(ctx context.Context) *ContactGroupsDeleteCall
- func (c *ContactGroupsDeleteCall) DeleteContacts(deleteContacts bool) *ContactGroupsDeleteCall
- func (c *ContactGroupsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ContactGroupsDeleteCall) Fields(s ...googleapi.Field) *ContactGroupsDeleteCall
- func (c *ContactGroupsDeleteCall) Header() http.Header
- type ContactGroupsGetCall
- func (c *ContactGroupsGetCall) Context(ctx context.Context) *ContactGroupsGetCall
- func (c *ContactGroupsGetCall) Do(opts ...googleapi.CallOption) (*ContactGroup, error)
- func (c *ContactGroupsGetCall) Fields(s ...googleapi.Field) *ContactGroupsGetCall
- func (c *ContactGroupsGetCall) Header() http.Header
- func (c *ContactGroupsGetCall) IfNoneMatch(entityTag string) *ContactGroupsGetCall
- func (c *ContactGroupsGetCall) MaxMembers(maxMembers int64) *ContactGroupsGetCall
- type ContactGroupsListCall
- func (c *ContactGroupsListCall) Context(ctx context.Context) *ContactGroupsListCall
- func (c *ContactGroupsListCall) Do(opts ...googleapi.CallOption) (*ListContactGroupsResponse, error)
- func (c *ContactGroupsListCall) Fields(s ...googleapi.Field) *ContactGroupsListCall
- func (c *ContactGroupsListCall) Header() http.Header
- func (c *ContactGroupsListCall) IfNoneMatch(entityTag string) *ContactGroupsListCall
- func (c *ContactGroupsListCall) PageSize(pageSize int64) *ContactGroupsListCall
- func (c *ContactGroupsListCall) PageToken(pageToken string) *ContactGroupsListCall
- func (c *ContactGroupsListCall) Pages(ctx context.Context, f func(*ListContactGroupsResponse) error) error
- func (c *ContactGroupsListCall) SyncToken(syncToken string) *ContactGroupsListCall
- type ContactGroupsMembersModifyCall
- func (c *ContactGroupsMembersModifyCall) Context(ctx context.Context) *ContactGroupsMembersModifyCall
- func (c *ContactGroupsMembersModifyCall) Do(opts ...googleapi.CallOption) (*ModifyContactGroupMembersResponse, error)
- func (c *ContactGroupsMembersModifyCall) Fields(s ...googleapi.Field) *ContactGroupsMembersModifyCall
- func (c *ContactGroupsMembersModifyCall) Header() http.Header
- type ContactGroupsMembersService
- type ContactGroupsService
- func (r *ContactGroupsService) BatchGet() *ContactGroupsBatchGetCall
- func (r *ContactGroupsService) Create(createcontactgrouprequest *CreateContactGroupRequest) *ContactGroupsCreateCall
- func (r *ContactGroupsService) Delete(resourceName string) *ContactGroupsDeleteCall
- func (r *ContactGroupsService) Get(resourceName string) *ContactGroupsGetCall
- func (r *ContactGroupsService) List() *ContactGroupsListCall
- func (r *ContactGroupsService) Update(resourceName string, updatecontactgrouprequest *UpdateContactGroupRequest) *ContactGroupsUpdateCall
- type ContactGroupsUpdateCall
- func (c *ContactGroupsUpdateCall) Context(ctx context.Context) *ContactGroupsUpdateCall
- func (c *ContactGroupsUpdateCall) Do(opts ...googleapi.CallOption) (*ContactGroup, error)
- func (c *ContactGroupsUpdateCall) Fields(s ...googleapi.Field) *ContactGroupsUpdateCall
- func (c *ContactGroupsUpdateCall) Header() http.Header
- type CoverPhoto
- type CreateContactGroupRequest
- type Date
- type DomainMembership
- type EmailAddress
- type Empty
- type Event
- type FieldMetadata
- type Gender
- type GetPeopleResponse
- type ImClient
- type Interest
- type ListConnectionsResponse
- type ListContactGroupsResponse
- type Locale
- type Membership
- type ModifyContactGroupMembersRequest
- type ModifyContactGroupMembersResponse
- type Name
- type Nickname
- type Occupation
- type Organization
- type PeopleConnectionsListCall
- func (c *PeopleConnectionsListCall) Context(ctx context.Context) *PeopleConnectionsListCall
- func (c *PeopleConnectionsListCall) Do(opts ...googleapi.CallOption) (*ListConnectionsResponse, error)
- func (c *PeopleConnectionsListCall) Fields(s ...googleapi.Field) *PeopleConnectionsListCall
- func (c *PeopleConnectionsListCall) Header() http.Header
- func (c *PeopleConnectionsListCall) IfNoneMatch(entityTag string) *PeopleConnectionsListCall
- func (c *PeopleConnectionsListCall) PageSize(pageSize int64) *PeopleConnectionsListCall
- func (c *PeopleConnectionsListCall) PageToken(pageToken string) *PeopleConnectionsListCall
- func (c *PeopleConnectionsListCall) Pages(ctx context.Context, f func(*ListConnectionsResponse) error) error
- func (c *PeopleConnectionsListCall) PersonFields(personFields string) *PeopleConnectionsListCall
- func (c *PeopleConnectionsListCall) RequestMaskIncludeField(requestMaskIncludeField string) *PeopleConnectionsListCall
- func (c *PeopleConnectionsListCall) RequestSyncToken(requestSyncToken bool) *PeopleConnectionsListCall
- func (c *PeopleConnectionsListCall) SortOrder(sortOrder string) *PeopleConnectionsListCall
- func (c *PeopleConnectionsListCall) SyncToken(syncToken string) *PeopleConnectionsListCall
- type PeopleConnectionsService
- type PeopleCreateContactCall
- func (c *PeopleCreateContactCall) Context(ctx context.Context) *PeopleCreateContactCall
- func (c *PeopleCreateContactCall) Do(opts ...googleapi.CallOption) (*Person, error)
- func (c *PeopleCreateContactCall) Fields(s ...googleapi.Field) *PeopleCreateContactCall
- func (c *PeopleCreateContactCall) Header() http.Header
- func (c *PeopleCreateContactCall) Parent(parent string) *PeopleCreateContactCall
- type PeopleDeleteContactCall
- func (c *PeopleDeleteContactCall) Context(ctx context.Context) *PeopleDeleteContactCall
- func (c *PeopleDeleteContactCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *PeopleDeleteContactCall) Fields(s ...googleapi.Field) *PeopleDeleteContactCall
- func (c *PeopleDeleteContactCall) Header() http.Header
- type PeopleGetBatchGetCall
- func (c *PeopleGetBatchGetCall) Context(ctx context.Context) *PeopleGetBatchGetCall
- func (c *PeopleGetBatchGetCall) Do(opts ...googleapi.CallOption) (*GetPeopleResponse, error)
- func (c *PeopleGetBatchGetCall) Fields(s ...googleapi.Field) *PeopleGetBatchGetCall
- func (c *PeopleGetBatchGetCall) Header() http.Header
- func (c *PeopleGetBatchGetCall) IfNoneMatch(entityTag string) *PeopleGetBatchGetCall
- func (c *PeopleGetBatchGetCall) PersonFields(personFields string) *PeopleGetBatchGetCall
- func (c *PeopleGetBatchGetCall) RequestMaskIncludeField(requestMaskIncludeField string) *PeopleGetBatchGetCall
- func (c *PeopleGetBatchGetCall) ResourceNames(resourceNames ...string) *PeopleGetBatchGetCall
- type PeopleGetCall
- func (c *PeopleGetCall) Context(ctx context.Context) *PeopleGetCall
- func (c *PeopleGetCall) Do(opts ...googleapi.CallOption) (*Person, error)
- func (c *PeopleGetCall) Fields(s ...googleapi.Field) *PeopleGetCall
- func (c *PeopleGetCall) Header() http.Header
- func (c *PeopleGetCall) IfNoneMatch(entityTag string) *PeopleGetCall
- func (c *PeopleGetCall) PersonFields(personFields string) *PeopleGetCall
- func (c *PeopleGetCall) RequestMaskIncludeField(requestMaskIncludeField string) *PeopleGetCall
- type PeopleService
- func (r *PeopleService) CreateContact(person *Person) *PeopleCreateContactCall
- func (r *PeopleService) DeleteContact(resourceName string) *PeopleDeleteContactCall
- func (r *PeopleService) Get(resourceName string) *PeopleGetCall
- func (r *PeopleService) GetBatchGet() *PeopleGetBatchGetCall
- func (r *PeopleService) UpdateContact(resourceName string, person *Person) *PeopleUpdateContactCall
- type PeopleUpdateContactCall
- func (c *PeopleUpdateContactCall) Context(ctx context.Context) *PeopleUpdateContactCall
- func (c *PeopleUpdateContactCall) Do(opts ...googleapi.CallOption) (*Person, error)
- func (c *PeopleUpdateContactCall) Fields(s ...googleapi.Field) *PeopleUpdateContactCall
- func (c *PeopleUpdateContactCall) Header() http.Header
- func (c *PeopleUpdateContactCall) UpdatePersonFields(updatePersonFields string) *PeopleUpdateContactCall
- type Person
- type PersonMetadata
- type PersonResponse
- type PhoneNumber
- type Photo
- type ProfileMetadata
- type Relation
- type RelationshipInterest
- type RelationshipStatus
- type Residence
- type Service
- type SipAddress
- type Skill
- type Source
- type Status
- type Tagline
- type UpdateContactGroupRequest
- type Url
- type UserDefined
Constants ¶
const ( // Manage your contacts ContactsScope = "https://www.googleapis.com/auth/contacts" // View your contacts ContactsReadonlyScope = "https://www.googleapis.com/auth/contacts.readonly" // Know the list of people in your circles, your age range, and language PlusLoginScope = "https://www.googleapis.com/auth/plus.login" // View your street addresses UserAddressesReadScope = "https://www.googleapis.com/auth/user.addresses.read" // View your complete date of birth UserBirthdayReadScope = "https://www.googleapis.com/auth/user.birthday.read" // View your email addresses UserEmailsReadScope = "https://www.googleapis.com/auth/user.emails.read" // View your phone numbers UserPhonenumbersReadScope = "https://www.googleapis.com/auth/user.phonenumbers.read" // View your email address UserinfoEmailScope = "https://www.googleapis.com/auth/userinfo.email" // View your basic profile info UserinfoProfileScope = "https://www.googleapis.com/auth/userinfo.profile" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Address ¶
type Address struct { // City: The city of the address. City string `json:"city,omitempty"` // Country: The country of the address. Country string `json:"country,omitempty"` // CountryCode: The [ISO 3166-1 // alpha-2](http://www.iso.org/iso/country_codes.htm) country // code of the address. CountryCode string `json:"countryCode,omitempty"` // ExtendedAddress: The extended address of the address; for example, // the apartment number. ExtendedAddress string `json:"extendedAddress,omitempty"` // FormattedType: The read-only type of the address translated and // formatted in the viewer's // account locale or the `Accept-Language` HTTP header locale. FormattedType string `json:"formattedType,omitempty"` // FormattedValue: The unstructured value of the address. If this is not // set by the user it // will be automatically constructed from structured values. FormattedValue string `json:"formattedValue,omitempty"` // Metadata: Metadata about the address. Metadata *FieldMetadata `json:"metadata,omitempty"` // PoBox: The P.O. box of the address. PoBox string `json:"poBox,omitempty"` // PostalCode: The postal code of the address. PostalCode string `json:"postalCode,omitempty"` // Region: The region of the address; for example, the state or // province. Region string `json:"region,omitempty"` // StreetAddress: The street address. StreetAddress string `json:"streetAddress,omitempty"` // Type: The type of the address. The type can be custom or one of these // predefined // values: // // * `home` // * `work` // * `other` Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "City") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "City") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Address: A person's physical address. May be a P.O. box or street address. All fields are optional.
func (*Address) MarshalJSON ¶
type AgeRangeType ¶
type AgeRangeType struct { // AgeRange: The age range. // // Possible values: // "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. AgeRange string `json:"ageRange,omitempty"` // Metadata: Metadata about the age range. Metadata *FieldMetadata `json:"metadata,omitempty"` // ForceSendFields is a list of field names (e.g. "AgeRange") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "AgeRange") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
AgeRangeType: A person's age range.
func (*AgeRangeType) MarshalJSON ¶
func (s *AgeRangeType) MarshalJSON() ([]byte, error)
type BatchGetContactGroupsResponse ¶
type BatchGetContactGroupsResponse struct { // Responses: The list of responses for each requested contact group // resource. Responses []*ContactGroupResponse `json:"responses,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Responses") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Responses") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BatchGetContactGroupsResponse: The response to a batch get contact groups request.
func (*BatchGetContactGroupsResponse) MarshalJSON ¶
func (s *BatchGetContactGroupsResponse) MarshalJSON() ([]byte, error)
type Biography ¶
type Biography struct { // ContentType: The content type of the biography. // // Possible values: // "CONTENT_TYPE_UNSPECIFIED" - Unspecified. // "TEXT_PLAIN" - Plain text. // "TEXT_HTML" - HTML text. ContentType string `json:"contentType,omitempty"` // Metadata: Metadata about the biography. Metadata *FieldMetadata `json:"metadata,omitempty"` // Value: The short biography. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "ContentType") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ContentType") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Biography: A person's short biography.
func (*Biography) MarshalJSON ¶
type Birthday ¶
type Birthday struct { // Date: The date of the birthday. Date *Date `json:"date,omitempty"` // Metadata: Metadata about the birthday. Metadata *FieldMetadata `json:"metadata,omitempty"` // Text: A free-form string representing the user's birthday. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "Date") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Date") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Birthday: A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
func (*Birthday) MarshalJSON ¶
type BraggingRights ¶
type BraggingRights struct { // Metadata: Metadata about the bragging rights. Metadata *FieldMetadata `json:"metadata,omitempty"` // Value: The bragging rights; for example, `climbed mount everest`. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Metadata") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Metadata") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
BraggingRights: A person's bragging rights.
func (*BraggingRights) MarshalJSON ¶
func (s *BraggingRights) MarshalJSON() ([]byte, error)
type ContactGroup ¶
type ContactGroup struct { // Etag: The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) // of the // resource. Used for web cache validation. Etag string `json:"etag,omitempty"` // FormattedName: The read-only name translated and formatted in the // viewer's account locale // or the `Accept-Language` HTTP header locale for system groups // names. // Group names set by the owner are the same as name. FormattedName string `json:"formattedName,omitempty"` // GroupType: The read-only contact group type. // // Possible values: // "GROUP_TYPE_UNSPECIFIED" - Unspecified. // "USER_CONTACT_GROUP" - User defined contact group. // "SYSTEM_CONTACT_GROUP" - System defined contact group. GroupType string `json:"groupType,omitempty"` // MemberCount: The total number of contacts in the group irrespective // of max members in // specified in the request. MemberCount int64 `json:"memberCount,omitempty"` // MemberResourceNames: The list of contact person resource names that // are members of the contact // group. The field is not populated for LIST requests and can only be // updated // through // the // [ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/memb // ers/modify). MemberResourceNames []string `json:"memberResourceNames,omitempty"` // Metadata: Metadata about the contact group. Metadata *ContactGroupMetadata `json:"metadata,omitempty"` // Name: The contact group name set by the group owner or a system // provided name // for system groups. Name string `json:"name,omitempty"` // ResourceName: The resource name for the contact group, assigned by // the server. An ASCII // string, in the form of `contactGroups/`<var>contact_group_id</var>. ResourceName string `json:"resourceName,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Etag") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Etag") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ContactGroup: A contact group.
func (*ContactGroup) MarshalJSON ¶
func (s *ContactGroup) MarshalJSON() ([]byte, error)
type ContactGroupMembership ¶
type ContactGroupMembership struct { // ContactGroupId: The contact group ID for the contact group // membership. The contact group // ID can be custom or one of these predefined values: // // * `myContacts` // * `starred` // * A numerical ID for user-created groups. ContactGroupId string `json:"contactGroupId,omitempty"` // ForceSendFields is a list of field names (e.g. "ContactGroupId") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ContactGroupId") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
ContactGroupMembership: A Google contact group membership.
func (*ContactGroupMembership) MarshalJSON ¶
func (s *ContactGroupMembership) MarshalJSON() ([]byte, error)
type ContactGroupMetadata ¶
type ContactGroupMetadata struct { // Deleted: True if the contact group resource has been deleted. // Populated only // for // [`ListContactGroups`](/people/api/rest/v1/contactgroups/list) // requests // that include a sync token. Deleted bool `json:"deleted,omitempty"` // UpdateTime: The time the group was last updated. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "Deleted") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Deleted") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ContactGroupMetadata: The read-only metadata about a contact group.
func (*ContactGroupMetadata) MarshalJSON ¶
func (s *ContactGroupMetadata) MarshalJSON() ([]byte, error)
type ContactGroupResponse ¶
type ContactGroupResponse struct { // ContactGroup: The contact group. ContactGroup *ContactGroup `json:"contactGroup,omitempty"` // RequestedResourceName: The original requested resource name. RequestedResourceName string `json:"requestedResourceName,omitempty"` // Status: The status of the response. Status *Status `json:"status,omitempty"` // ForceSendFields is a list of field names (e.g. "ContactGroup") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ContactGroup") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ContactGroupResponse: The response for a specific contact group.
func (*ContactGroupResponse) MarshalJSON ¶
func (s *ContactGroupResponse) MarshalJSON() ([]byte, error)
type ContactGroupsBatchGetCall ¶
type ContactGroupsBatchGetCall struct {
// contains filtered or unexported fields
}
func (*ContactGroupsBatchGetCall) Context ¶
func (c *ContactGroupsBatchGetCall) Context(ctx context.Context) *ContactGroupsBatchGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ContactGroupsBatchGetCall) Do ¶
func (c *ContactGroupsBatchGetCall) Do(opts ...googleapi.CallOption) (*BatchGetContactGroupsResponse, error)
Do executes the "people.contactGroups.batchGet" call. Exactly one of *BatchGetContactGroupsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BatchGetContactGroupsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ContactGroupsBatchGetCall) Fields ¶
func (c *ContactGroupsBatchGetCall) Fields(s ...googleapi.Field) *ContactGroupsBatchGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ContactGroupsBatchGetCall) Header ¶
func (c *ContactGroupsBatchGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ContactGroupsBatchGetCall) IfNoneMatch ¶
func (c *ContactGroupsBatchGetCall) IfNoneMatch(entityTag string) *ContactGroupsBatchGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ContactGroupsBatchGetCall) MaxMembers ¶
func (c *ContactGroupsBatchGetCall) MaxMembers(maxMembers int64) *ContactGroupsBatchGetCall
MaxMembers sets the optional parameter "maxMembers": Specifies the maximum number of members to return for each group.
func (*ContactGroupsBatchGetCall) ResourceNames ¶
func (c *ContactGroupsBatchGetCall) ResourceNames(resourceNames ...string) *ContactGroupsBatchGetCall
ResourceNames sets the optional parameter "resourceNames": The resource names of the contact groups to get.
type ContactGroupsCreateCall ¶
type ContactGroupsCreateCall struct {
// contains filtered or unexported fields
}
func (*ContactGroupsCreateCall) Context ¶
func (c *ContactGroupsCreateCall) Context(ctx context.Context) *ContactGroupsCreateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ContactGroupsCreateCall) Do ¶
func (c *ContactGroupsCreateCall) Do(opts ...googleapi.CallOption) (*ContactGroup, error)
Do executes the "people.contactGroups.create" call. Exactly one of *ContactGroup or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ContactGroup.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ContactGroupsCreateCall) Fields ¶
func (c *ContactGroupsCreateCall) Fields(s ...googleapi.Field) *ContactGroupsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ContactGroupsCreateCall) Header ¶
func (c *ContactGroupsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ContactGroupsDeleteCall ¶
type ContactGroupsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ContactGroupsDeleteCall) Context ¶
func (c *ContactGroupsDeleteCall) Context(ctx context.Context) *ContactGroupsDeleteCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ContactGroupsDeleteCall) DeleteContacts ¶
func (c *ContactGroupsDeleteCall) DeleteContacts(deleteContacts bool) *ContactGroupsDeleteCall
DeleteContacts sets the optional parameter "deleteContacts": Set to true to also delete the contacts in the specified group.
func (*ContactGroupsDeleteCall) Do ¶
func (c *ContactGroupsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "people.contactGroups.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ContactGroupsDeleteCall) Fields ¶
func (c *ContactGroupsDeleteCall) Fields(s ...googleapi.Field) *ContactGroupsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ContactGroupsDeleteCall) Header ¶
func (c *ContactGroupsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ContactGroupsGetCall ¶
type ContactGroupsGetCall struct {
// contains filtered or unexported fields
}
func (*ContactGroupsGetCall) Context ¶
func (c *ContactGroupsGetCall) Context(ctx context.Context) *ContactGroupsGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ContactGroupsGetCall) Do ¶
func (c *ContactGroupsGetCall) Do(opts ...googleapi.CallOption) (*ContactGroup, error)
Do executes the "people.contactGroups.get" call. Exactly one of *ContactGroup or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ContactGroup.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ContactGroupsGetCall) Fields ¶
func (c *ContactGroupsGetCall) Fields(s ...googleapi.Field) *ContactGroupsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ContactGroupsGetCall) Header ¶
func (c *ContactGroupsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ContactGroupsGetCall) IfNoneMatch ¶
func (c *ContactGroupsGetCall) IfNoneMatch(entityTag string) *ContactGroupsGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ContactGroupsGetCall) MaxMembers ¶
func (c *ContactGroupsGetCall) MaxMembers(maxMembers int64) *ContactGroupsGetCall
MaxMembers sets the optional parameter "maxMembers": Specifies the maximum number of members to return.
type ContactGroupsListCall ¶
type ContactGroupsListCall struct {
// contains filtered or unexported fields
}
func (*ContactGroupsListCall) Context ¶
func (c *ContactGroupsListCall) Context(ctx context.Context) *ContactGroupsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ContactGroupsListCall) Do ¶
func (c *ContactGroupsListCall) Do(opts ...googleapi.CallOption) (*ListContactGroupsResponse, error)
Do executes the "people.contactGroups.list" call. Exactly one of *ListContactGroupsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListContactGroupsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ContactGroupsListCall) Fields ¶
func (c *ContactGroupsListCall) Fields(s ...googleapi.Field) *ContactGroupsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ContactGroupsListCall) Header ¶
func (c *ContactGroupsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ContactGroupsListCall) IfNoneMatch ¶
func (c *ContactGroupsListCall) IfNoneMatch(entityTag string) *ContactGroupsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*ContactGroupsListCall) PageSize ¶
func (c *ContactGroupsListCall) PageSize(pageSize int64) *ContactGroupsListCall
PageSize sets the optional parameter "pageSize": The maximum number of resources to return.
func (*ContactGroupsListCall) PageToken ¶
func (c *ContactGroupsListCall) PageToken(pageToken string) *ContactGroupsListCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Reques ts the next page of resources.
func (*ContactGroupsListCall) Pages ¶
func (c *ContactGroupsListCall) Pages(ctx context.Context, f func(*ListContactGroupsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (*ContactGroupsListCall) SyncToken ¶
func (c *ContactGroupsListCall) SyncToken(syncToken string) *ContactGroupsListCall
SyncToken sets the optional parameter "syncToken": A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned.
type ContactGroupsMembersModifyCall ¶
type ContactGroupsMembersModifyCall struct {
// contains filtered or unexported fields
}
func (*ContactGroupsMembersModifyCall) Context ¶
func (c *ContactGroupsMembersModifyCall) Context(ctx context.Context) *ContactGroupsMembersModifyCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ContactGroupsMembersModifyCall) Do ¶
func (c *ContactGroupsMembersModifyCall) Do(opts ...googleapi.CallOption) (*ModifyContactGroupMembersResponse, error)
Do executes the "people.contactGroups.members.modify" call. Exactly one of *ModifyContactGroupMembersResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ModifyContactGroupMembersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ContactGroupsMembersModifyCall) Fields ¶
func (c *ContactGroupsMembersModifyCall) Fields(s ...googleapi.Field) *ContactGroupsMembersModifyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ContactGroupsMembersModifyCall) Header ¶
func (c *ContactGroupsMembersModifyCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ContactGroupsMembersService ¶
type ContactGroupsMembersService struct {
// contains filtered or unexported fields
}
func NewContactGroupsMembersService ¶
func NewContactGroupsMembersService(s *Service) *ContactGroupsMembersService
func (*ContactGroupsMembersService) Modify ¶
func (r *ContactGroupsMembersService) Modify(resourceName string, modifycontactgroupmembersrequest *ModifyContactGroupMembersRequest) *ContactGroupsMembersModifyCall
Modify: Modify the members of a contact group owned by the authenticated user.
type ContactGroupsService ¶
type ContactGroupsService struct { Members *ContactGroupsMembersService // contains filtered or unexported fields }
func NewContactGroupsService ¶
func NewContactGroupsService(s *Service) *ContactGroupsService
func (*ContactGroupsService) BatchGet ¶
func (r *ContactGroupsService) BatchGet() *ContactGroupsBatchGetCall
BatchGet: Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
func (*ContactGroupsService) Create ¶
func (r *ContactGroupsService) Create(createcontactgrouprequest *CreateContactGroupRequest) *ContactGroupsCreateCall
Create: Create a new contact group owned by the authenticated user.
func (*ContactGroupsService) Delete ¶
func (r *ContactGroupsService) Delete(resourceName string) *ContactGroupsDeleteCall
Delete: Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.
func (*ContactGroupsService) Get ¶
func (r *ContactGroupsService) Get(resourceName string) *ContactGroupsGetCall
Get: Get a specific contact group owned by the authenticated user by specifying a contact group resource name.
func (*ContactGroupsService) List ¶
func (r *ContactGroupsService) List() *ContactGroupsListCall
List: List all contact groups owned by the authenticated user. Members of the contact groups are not populated.
func (*ContactGroupsService) Update ¶
func (r *ContactGroupsService) Update(resourceName string, updatecontactgrouprequest *UpdateContactGroupRequest) *ContactGroupsUpdateCall
Update: Update the name of an existing contact group owned by the authenticated user.
type ContactGroupsUpdateCall ¶
type ContactGroupsUpdateCall struct {
// contains filtered or unexported fields
}
func (*ContactGroupsUpdateCall) Context ¶
func (c *ContactGroupsUpdateCall) Context(ctx context.Context) *ContactGroupsUpdateCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*ContactGroupsUpdateCall) Do ¶
func (c *ContactGroupsUpdateCall) Do(opts ...googleapi.CallOption) (*ContactGroup, error)
Do executes the "people.contactGroups.update" call. Exactly one of *ContactGroup or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ContactGroup.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*ContactGroupsUpdateCall) Fields ¶
func (c *ContactGroupsUpdateCall) Fields(s ...googleapi.Field) *ContactGroupsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ContactGroupsUpdateCall) Header ¶
func (c *ContactGroupsUpdateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type CoverPhoto ¶
type CoverPhoto struct { // Default: True if the cover photo is the default cover photo; // false if the cover photo is a user-provided cover photo. Default bool `json:"default,omitempty"` // Metadata: Metadata about the cover photo. Metadata *FieldMetadata `json:"metadata,omitempty"` // Url: The URL of the cover photo. Url string `json:"url,omitempty"` // ForceSendFields is a list of field names (e.g. "Default") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Default") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CoverPhoto: A person's read-only cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
func (*CoverPhoto) MarshalJSON ¶
func (s *CoverPhoto) MarshalJSON() ([]byte, error)
type CreateContactGroupRequest ¶
type CreateContactGroupRequest struct { // ContactGroup: The contact group to create. ContactGroup *ContactGroup `json:"contactGroup,omitempty"` // ForceSendFields is a list of field names (e.g. "ContactGroup") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ContactGroup") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
CreateContactGroupRequest: A request to create a new contact group.
func (*CreateContactGroupRequest) MarshalJSON ¶
func (s *CreateContactGroupRequest) MarshalJSON() ([]byte, error)
type Date ¶
type Date struct { // Day: Day of month. Must be from 1 to 31 and valid for the year and // month, or 0 // if specifying a year/month where the day is not significant. Day int64 `json:"day,omitempty"` // Month: Month of year. Must be from 1 to 12, or 0 if specifying a date // without a // month. Month int64 `json:"month,omitempty"` // Year: Year of date. Must be from 1 to 9999, or 0 if specifying a date // without // a year. Year int64 `json:"year,omitempty"` // ForceSendFields is a list of field names (e.g. "Day") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Day") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Date: Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date.
func (*Date) MarshalJSON ¶
type DomainMembership ¶
type DomainMembership struct { // InViewerDomain: True if the person is in the viewer's Google Apps // domain. InViewerDomain bool `json:"inViewerDomain,omitempty"` // ForceSendFields is a list of field names (e.g. "InViewerDomain") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "InViewerDomain") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
DomainMembership: A Google Apps Domain membership.
func (*DomainMembership) MarshalJSON ¶
func (s *DomainMembership) MarshalJSON() ([]byte, error)
type EmailAddress ¶
type EmailAddress struct { // DisplayName: The display name of the email. DisplayName string `json:"displayName,omitempty"` // FormattedType: The read-only type of the email address translated and // formatted in the // viewer's account locale or the `Accept-Language` HTTP header locale. FormattedType string `json:"formattedType,omitempty"` // Metadata: Metadata about the email address. Metadata *FieldMetadata `json:"metadata,omitempty"` // Type: The type of the email address. The type can be custom or one of // these // predefined values: // // * `home` // * `work` // * `other` Type string `json:"type,omitempty"` // Value: The email address. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "DisplayName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DisplayName") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
EmailAddress: A person's email address.
func (*EmailAddress) MarshalJSON ¶
func (s *EmailAddress) MarshalJSON() ([]byte, error)
type Empty ¶
type Empty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
service Foo { rpc Bar(google.protobuf.Empty) returns
(google.protobuf.Empty);
}
The JSON representation for `Empty` is empty JSON object `{}`.
type Event ¶
type Event struct { // Date: The date of the event. Date *Date `json:"date,omitempty"` // FormattedType: The read-only type of the event translated and // formatted in the // viewer's account locale or the `Accept-Language` HTTP header locale. FormattedType string `json:"formattedType,omitempty"` // Metadata: Metadata about the event. Metadata *FieldMetadata `json:"metadata,omitempty"` // Type: The type of the event. The type can be custom or one of these // predefined // values: // // * `anniversary` // * `other` Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Date") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Date") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Event: An event related to the person.
func (*Event) MarshalJSON ¶
type FieldMetadata ¶
type FieldMetadata struct { // Primary: True if the field is the primary field; false if the field // is a secondary // field. Primary bool `json:"primary,omitempty"` // Source: The source of the field. Source *Source `json:"source,omitempty"` // Verified: True if the field is verified; false if the field is // unverified. A // verified field is typically a name, email address, phone number, // or // website that has been confirmed to be owned by the person. Verified bool `json:"verified,omitempty"` // ForceSendFields is a list of field names (e.g. "Primary") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Primary") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
FieldMetadata: Metadata about a field.
func (*FieldMetadata) MarshalJSON ¶
func (s *FieldMetadata) MarshalJSON() ([]byte, error)
type Gender ¶
type Gender struct { // FormattedValue: The read-only value of the gender translated and // formatted in the viewer's // account locale or the `Accept-Language` HTTP header locale. FormattedValue string `json:"formattedValue,omitempty"` // Metadata: Metadata about the gender. Metadata *FieldMetadata `json:"metadata,omitempty"` // Value: The gender for the person. The gender can be custom or one of // these // predefined values: // // * `male` // * `female` // * `other` // * `unknown` Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "FormattedValue") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FormattedValue") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
Gender: A person's gender.
func (*Gender) MarshalJSON ¶
type GetPeopleResponse ¶
type GetPeopleResponse struct { // Responses: The response for each requested resource name. Responses []*PersonResponse `json:"responses,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Responses") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Responses") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*GetPeopleResponse) MarshalJSON ¶
func (s *GetPeopleResponse) MarshalJSON() ([]byte, error)
type ImClient ¶
type ImClient struct { // FormattedProtocol: The read-only protocol of the IM client formatted // in the viewer's account // locale or the `Accept-Language` HTTP header locale. FormattedProtocol string `json:"formattedProtocol,omitempty"` // FormattedType: The read-only type of the IM client translated and // formatted in the // viewer's account locale or the `Accept-Language` HTTP header locale. FormattedType string `json:"formattedType,omitempty"` // Metadata: Metadata about the IM client. Metadata *FieldMetadata `json:"metadata,omitempty"` // Protocol: The protocol of the IM client. The protocol can be custom // or one of these // predefined values: // // * `aim` // * `msn` // * `yahoo` // * `skype` // * `qq` // * `googleTalk` // * `icq` // * `jabber` // * `netMeeting` Protocol string `json:"protocol,omitempty"` // Type: The type of the IM client. The type can be custom or one of // these // predefined values: // // * `home` // * `work` // * `other` Type string `json:"type,omitempty"` // Username: The user name used in the IM client. Username string `json:"username,omitempty"` // ForceSendFields is a list of field names (e.g. "FormattedProtocol") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FormattedProtocol") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
ImClient: A person's instant messaging client.
func (*ImClient) MarshalJSON ¶
type Interest ¶
type Interest struct { // Metadata: Metadata about the interest. Metadata *FieldMetadata `json:"metadata,omitempty"` // Value: The interest; for example, `stargazing`. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Metadata") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Metadata") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Interest: One of the person's interests.
func (*Interest) MarshalJSON ¶
type ListConnectionsResponse ¶
type ListConnectionsResponse struct { // Connections: The list of people that the requestor is connected to. Connections []*Person `json:"connections,omitempty"` // NextPageToken: The token that can be used to retrieve the next page // of results. NextPageToken string `json:"nextPageToken,omitempty"` // NextSyncToken: The token that can be used to retrieve changes since // the last request. NextSyncToken string `json:"nextSyncToken,omitempty"` // TotalItems: The total number of items in the list without pagination. TotalItems int64 `json:"totalItems,omitempty"` // TotalPeople: **DEPRECATED** (Please use totalItems) // The total number of people in the list without pagination. TotalPeople int64 `json:"totalPeople,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Connections") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Connections") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
func (*ListConnectionsResponse) MarshalJSON ¶
func (s *ListConnectionsResponse) MarshalJSON() ([]byte, error)
type ListContactGroupsResponse ¶
type ListContactGroupsResponse struct { // ContactGroups: The list of contact groups. Members of the contact // groups are not // populated. ContactGroups []*ContactGroup `json:"contactGroups,omitempty"` // NextPageToken: The token that can be used to retrieve the next page // of results. NextPageToken string `json:"nextPageToken,omitempty"` // NextSyncToken: The token that can be used to retrieve changes since // the last request. NextSyncToken string `json:"nextSyncToken,omitempty"` // TotalItems: The total number of items in the list without pagination. TotalItems int64 `json:"totalItems,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "ContactGroups") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ContactGroups") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListContactGroupsResponse: The response to a list contact groups request.
func (*ListContactGroupsResponse) MarshalJSON ¶
func (s *ListContactGroupsResponse) MarshalJSON() ([]byte, error)
type Locale ¶
type Locale struct { // Metadata: Metadata about the locale. Metadata *FieldMetadata `json:"metadata,omitempty"` // Value: The well-formed [IETF BCP // 47](https://tools.ietf.org/html/bcp47) // language tag representing the locale. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Metadata") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Metadata") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Locale: A person's locale preference.
func (*Locale) MarshalJSON ¶
type Membership ¶
type Membership struct { // ContactGroupMembership: The contact group membership. ContactGroupMembership *ContactGroupMembership `json:"contactGroupMembership,omitempty"` // DomainMembership: The domain membership. DomainMembership *DomainMembership `json:"domainMembership,omitempty"` // Metadata: Metadata about the membership. Metadata *FieldMetadata `json:"metadata,omitempty"` // ForceSendFields is a list of field names (e.g. // "ContactGroupMembership") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ContactGroupMembership") // to include in API requests with the JSON null value. By default, // fields with empty values are omitted from API requests. However, any // field with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
Membership: A person's read-only membership in a group.
func (*Membership) MarshalJSON ¶
func (s *Membership) MarshalJSON() ([]byte, error)
type ModifyContactGroupMembersRequest ¶
type ModifyContactGroupMembersRequest struct { // ResourceNamesToAdd: The resource names of the contact people to add // in the form of in the form // `people/`<var>person_id</var>. ResourceNamesToAdd []string `json:"resourceNamesToAdd,omitempty"` // ResourceNamesToRemove: The resource names of the contact people to // remove in the form of in the // form of `people/`<var>person_id</var>. ResourceNamesToRemove []string `json:"resourceNamesToRemove,omitempty"` // ForceSendFields is a list of field names (e.g. "ResourceNamesToAdd") // to unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ResourceNamesToAdd") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
ModifyContactGroupMembersRequest: A request to modify an existing contact group's members. Contacts can be removed from any group but they can only be added to a user group or myContacts or starred system groups.
func (*ModifyContactGroupMembersRequest) MarshalJSON ¶
func (s *ModifyContactGroupMembersRequest) MarshalJSON() ([]byte, error)
type ModifyContactGroupMembersResponse ¶
type ModifyContactGroupMembersResponse struct { // NotFoundResourceNames: The contact people resource names that were // not found. NotFoundResourceNames []string `json:"notFoundResourceNames,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. // "NotFoundResourceNames") to unconditionally include in API requests. // By default, fields with empty values are omitted from API requests. // However, any non-pointer, non-interface field appearing in // ForceSendFields will be sent to the server regardless of whether the // field is empty or not. This may be used to include empty fields in // Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NotFoundResourceNames") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
ModifyContactGroupMembersResponse: The response to a modify contact group members request.
func (*ModifyContactGroupMembersResponse) MarshalJSON ¶
func (s *ModifyContactGroupMembersResponse) MarshalJSON() ([]byte, error)
type Name ¶
type Name struct { // DisplayName: The read-only display name formatted according to the // locale specified by // the viewer's account or the `Accept-Language` HTTP header. DisplayName string `json:"displayName,omitempty"` // DisplayNameLastFirst: The read-only display name with the last name // first formatted according to // the locale specified by the viewer's account or the // `Accept-Language` HTTP header. DisplayNameLastFirst string `json:"displayNameLastFirst,omitempty"` // FamilyName: The family name. FamilyName string `json:"familyName,omitempty"` // GivenName: The given name. GivenName string `json:"givenName,omitempty"` // HonorificPrefix: The honorific prefixes, such as `Mrs.` or `Dr.` HonorificPrefix string `json:"honorificPrefix,omitempty"` // HonorificSuffix: The honorific suffixes, such as `Jr.` HonorificSuffix string `json:"honorificSuffix,omitempty"` // Metadata: Metadata about the name. Metadata *FieldMetadata `json:"metadata,omitempty"` // MiddleName: The middle name(s). MiddleName string `json:"middleName,omitempty"` // PhoneticFamilyName: The family name spelled as it sounds. PhoneticFamilyName string `json:"phoneticFamilyName,omitempty"` // PhoneticFullName: The full name spelled as it sounds. PhoneticFullName string `json:"phoneticFullName,omitempty"` // PhoneticGivenName: The given name spelled as it sounds. PhoneticGivenName string `json:"phoneticGivenName,omitempty"` // PhoneticHonorificPrefix: The honorific prefixes spelled as they // sound. PhoneticHonorificPrefix string `json:"phoneticHonorificPrefix,omitempty"` // PhoneticHonorificSuffix: The honorific suffixes spelled as they // sound. PhoneticHonorificSuffix string `json:"phoneticHonorificSuffix,omitempty"` // PhoneticMiddleName: The middle name(s) spelled as they sound. PhoneticMiddleName string `json:"phoneticMiddleName,omitempty"` // ForceSendFields is a list of field names (e.g. "DisplayName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "DisplayName") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Name: A person's name. If the name is a mononym, the family name is empty.
func (*Name) MarshalJSON ¶
type Nickname ¶
type Nickname struct { // Metadata: Metadata about the nickname. Metadata *FieldMetadata `json:"metadata,omitempty"` // Type: The type of the nickname. // // Possible values: // "DEFAULT" - Generic nickname. // "MAIDEN_NAME" - Maiden name or birth family name. Used when the // person's family name has // changed as a result of marriage. // "INITIALS" - Initials. // "GPLUS" - Google+ profile nickname. // "OTHER_NAME" - A professional affiliation or other name; for // example, `Dr. Smith.` Type string `json:"type,omitempty"` // Value: The nickname. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Metadata") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Metadata") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Nickname: A person's nickname.
func (*Nickname) MarshalJSON ¶
type Occupation ¶
type Occupation struct { // Metadata: Metadata about the occupation. Metadata *FieldMetadata `json:"metadata,omitempty"` // Value: The occupation; for example, `carpenter`. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Metadata") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Metadata") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Occupation: A person's occupation.
func (*Occupation) MarshalJSON ¶
func (s *Occupation) MarshalJSON() ([]byte, error)
type Organization ¶
type Organization struct { // Current: True if the organization is the person's current // organization; // false if the organization is a past organization. Current bool `json:"current,omitempty"` // Department: The person's department at the organization. Department string `json:"department,omitempty"` // Domain: The domain name associated with the organization; for // example, `google.com`. Domain string `json:"domain,omitempty"` // EndDate: The end date when the person left the organization. EndDate *Date `json:"endDate,omitempty"` // FormattedType: The read-only type of the organization translated and // formatted in the // viewer's account locale or the `Accept-Language` HTTP header locale. FormattedType string `json:"formattedType,omitempty"` // JobDescription: The person's job description at the organization. JobDescription string `json:"jobDescription,omitempty"` // Location: The location of the organization office the person works // at. Location string `json:"location,omitempty"` // Metadata: Metadata about the organization. Metadata *FieldMetadata `json:"metadata,omitempty"` // Name: The name of the organization. Name string `json:"name,omitempty"` // PhoneticName: The phonetic name of the organization. PhoneticName string `json:"phoneticName,omitempty"` // StartDate: The start date when the person joined the organization. StartDate *Date `json:"startDate,omitempty"` // Symbol: The symbol associated with the organization; for example, a // stock ticker // symbol, abbreviation, or acronym. Symbol string `json:"symbol,omitempty"` // Title: The person's job title at the organization. Title string `json:"title,omitempty"` // Type: The type of the organization. The type can be custom or one of // these // predefined values: // // * `work` // * `school` Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Current") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Current") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Organization: A person's past or current organization. Overlapping date ranges are permitted.
func (*Organization) MarshalJSON ¶
func (s *Organization) MarshalJSON() ([]byte, error)
type PeopleConnectionsListCall ¶
type PeopleConnectionsListCall struct {
// contains filtered or unexported fields
}
func (*PeopleConnectionsListCall) Context ¶
func (c *PeopleConnectionsListCall) Context(ctx context.Context) *PeopleConnectionsListCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PeopleConnectionsListCall) Do ¶
func (c *PeopleConnectionsListCall) Do(opts ...googleapi.CallOption) (*ListConnectionsResponse, error)
Do executes the "people.people.connections.list" call. Exactly one of *ListConnectionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListConnectionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*PeopleConnectionsListCall) Fields ¶
func (c *PeopleConnectionsListCall) Fields(s ...googleapi.Field) *PeopleConnectionsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PeopleConnectionsListCall) Header ¶
func (c *PeopleConnectionsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*PeopleConnectionsListCall) IfNoneMatch ¶
func (c *PeopleConnectionsListCall) IfNoneMatch(entityTag string) *PeopleConnectionsListCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*PeopleConnectionsListCall) PageSize ¶
func (c *PeopleConnectionsListCall) PageSize(pageSize int64) *PeopleConnectionsListCall
PageSize sets the optional parameter "pageSize": The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100.
func (*PeopleConnectionsListCall) PageToken ¶
func (c *PeopleConnectionsListCall) PageToken(pageToken string) *PeopleConnectionsListCall
PageToken sets the optional parameter "pageToken": The token of the page to be returned.
func (*PeopleConnectionsListCall) Pages ¶
func (c *PeopleConnectionsListCall) Pages(ctx context.Context, f func(*ListConnectionsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (*PeopleConnectionsListCall) PersonFields ¶
func (c *PeopleConnectionsListCall) PersonFields(personFields string) *PeopleConnectionsListCall
PersonFields sets the optional parameter "personFields": **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 * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined
func (*PeopleConnectionsListCall) RequestMaskIncludeField ¶
func (c *PeopleConnectionsListCall) RequestMaskIncludeField(requestMaskIncludeField string) *PeopleConnectionsListCall
RequestMaskIncludeField sets the optional parameter "requestMask.includeField": **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`.
func (*PeopleConnectionsListCall) RequestSyncToken ¶
func (c *PeopleConnectionsListCall) RequestSyncToken(requestSyncToken bool) *PeopleConnectionsListCall
RequestSyncToken sets the optional parameter "requestSyncToken": Whether the response should include a 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.
func (*PeopleConnectionsListCall) SortOrder ¶
func (c *PeopleConnectionsListCall) SortOrder(sortOrder string) *PeopleConnectionsListCall
SortOrder sets the optional parameter "sortOrder": The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.
Possible values:
"LAST_MODIFIED_ASCENDING" "FIRST_NAME_ASCENDING" "LAST_NAME_ASCENDING"
func (*PeopleConnectionsListCall) SyncToken ¶
func (c *PeopleConnectionsListCall) SyncToken(syncToken string) *PeopleConnectionsListCall
SyncToken sets the optional parameter "syncToken": A sync token returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created will be returned. Sync requests that specify `sync_token` have an additional rate limit.
type PeopleConnectionsService ¶
type PeopleConnectionsService struct {
// contains filtered or unexported fields
}
func NewPeopleConnectionsService ¶
func NewPeopleConnectionsService(s *Service) *PeopleConnectionsService
func (*PeopleConnectionsService) List ¶
func (r *PeopleConnectionsService) List(resourceName string) *PeopleConnectionsListCall
List: Provides a list of the authenticated user's contacts merged with any connected profiles. <br> The request throws a 400 error if 'personFields' is not specified.
type PeopleCreateContactCall ¶
type PeopleCreateContactCall struct {
// contains filtered or unexported fields
}
func (*PeopleCreateContactCall) Context ¶
func (c *PeopleCreateContactCall) Context(ctx context.Context) *PeopleCreateContactCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PeopleCreateContactCall) Do ¶
func (c *PeopleCreateContactCall) Do(opts ...googleapi.CallOption) (*Person, error)
Do executes the "people.people.createContact" call. Exactly one of *Person or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Person.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*PeopleCreateContactCall) Fields ¶
func (c *PeopleCreateContactCall) Fields(s ...googleapi.Field) *PeopleCreateContactCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PeopleCreateContactCall) Header ¶
func (c *PeopleCreateContactCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*PeopleCreateContactCall) Parent ¶
func (c *PeopleCreateContactCall) Parent(parent string) *PeopleCreateContactCall
Parent sets the optional parameter "parent": The resource name of the owning person resource.
type PeopleDeleteContactCall ¶
type PeopleDeleteContactCall struct {
// contains filtered or unexported fields
}
func (*PeopleDeleteContactCall) Context ¶
func (c *PeopleDeleteContactCall) Context(ctx context.Context) *PeopleDeleteContactCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PeopleDeleteContactCall) Do ¶
func (c *PeopleDeleteContactCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "people.people.deleteContact" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*PeopleDeleteContactCall) Fields ¶
func (c *PeopleDeleteContactCall) Fields(s ...googleapi.Field) *PeopleDeleteContactCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PeopleDeleteContactCall) Header ¶
func (c *PeopleDeleteContactCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type PeopleGetBatchGetCall ¶
type PeopleGetBatchGetCall struct {
// contains filtered or unexported fields
}
func (*PeopleGetBatchGetCall) Context ¶
func (c *PeopleGetBatchGetCall) Context(ctx context.Context) *PeopleGetBatchGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PeopleGetBatchGetCall) Do ¶
func (c *PeopleGetBatchGetCall) Do(opts ...googleapi.CallOption) (*GetPeopleResponse, error)
Do executes the "people.people.getBatchGet" call. Exactly one of *GetPeopleResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GetPeopleResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*PeopleGetBatchGetCall) Fields ¶
func (c *PeopleGetBatchGetCall) Fields(s ...googleapi.Field) *PeopleGetBatchGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PeopleGetBatchGetCall) Header ¶
func (c *PeopleGetBatchGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*PeopleGetBatchGetCall) IfNoneMatch ¶
func (c *PeopleGetBatchGetCall) IfNoneMatch(entityTag string) *PeopleGetBatchGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*PeopleGetBatchGetCall) PersonFields ¶
func (c *PeopleGetBatchGetCall) PersonFields(personFields string) *PeopleGetBatchGetCall
PersonFields sets the optional parameter "personFields": **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 * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined
func (*PeopleGetBatchGetCall) RequestMaskIncludeField ¶
func (c *PeopleGetBatchGetCall) RequestMaskIncludeField(requestMaskIncludeField string) *PeopleGetBatchGetCall
RequestMaskIncludeField sets the optional parameter "requestMask.includeField": **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`.
func (*PeopleGetBatchGetCall) ResourceNames ¶
func (c *PeopleGetBatchGetCall) ResourceNames(resourceNames ...string) *PeopleGetBatchGetCall
ResourceNames sets the optional parameter "resourceNames": The resource names of the people to provide information about.
- To get information about the authenticated user, specify `people/me`.
- To get information about a google account, specify `people/`<var>account_id</var>.
- 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.
type PeopleGetCall ¶
type PeopleGetCall struct {
// contains filtered or unexported fields
}
func (*PeopleGetCall) Context ¶
func (c *PeopleGetCall) Context(ctx context.Context) *PeopleGetCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PeopleGetCall) Do ¶
func (c *PeopleGetCall) Do(opts ...googleapi.CallOption) (*Person, error)
Do executes the "people.people.get" call. Exactly one of *Person or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Person.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*PeopleGetCall) Fields ¶
func (c *PeopleGetCall) Fields(s ...googleapi.Field) *PeopleGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PeopleGetCall) Header ¶
func (c *PeopleGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*PeopleGetCall) IfNoneMatch ¶
func (c *PeopleGetCall) IfNoneMatch(entityTag string) *PeopleGetCall
IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.
func (*PeopleGetCall) PersonFields ¶
func (c *PeopleGetCall) PersonFields(personFields string) *PeopleGetCall
PersonFields sets the optional parameter "personFields": **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 * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined
func (*PeopleGetCall) RequestMaskIncludeField ¶
func (c *PeopleGetCall) RequestMaskIncludeField(requestMaskIncludeField string) *PeopleGetCall
RequestMaskIncludeField sets the optional parameter "requestMask.includeField": **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`.
type PeopleService ¶
type PeopleService struct { Connections *PeopleConnectionsService // contains filtered or unexported fields }
func NewPeopleService ¶
func NewPeopleService(s *Service) *PeopleService
func (*PeopleService) CreateContact ¶
func (r *PeopleService) CreateContact(person *Person) *PeopleCreateContactCall
CreateContact: Create a new contact and return the person resource for that contact.
func (*PeopleService) DeleteContact ¶
func (r *PeopleService) DeleteContact(resourceName string) *PeopleDeleteContactCall
DeleteContact: Delete a contact person. Any non-contact data will not be deleted.
func (*PeopleService) Get ¶
func (r *PeopleService) Get(resourceName string) *PeopleGetCall
Get: Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. <br> The request throws a 400 error if 'personFields' is not specified.
func (*PeopleService) GetBatchGet ¶
func (r *PeopleService) GetBatchGet() *PeopleGetBatchGetCall
GetBatchGet: Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. <br> The request throws a 400 error if 'personFields' is not specified.
func (*PeopleService) UpdateContact ¶
func (r *PeopleService) UpdateContact(resourceName string, person *Person) *PeopleUpdateContactCall
UpdateContact: Update contact data for an existing contact person. Any non-contact data will not be modified.
The request throws a 400 error if `updatePersonFields` is not specified. <br> The request throws a 400 error if `person.metadata.sources` is not specified for the contact to be updated. <br> The request throws a 412 error 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 re-apply their updates to the latest person.
type PeopleUpdateContactCall ¶
type PeopleUpdateContactCall struct {
// contains filtered or unexported fields
}
func (*PeopleUpdateContactCall) Context ¶
func (c *PeopleUpdateContactCall) Context(ctx context.Context) *PeopleUpdateContactCall
Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.
func (*PeopleUpdateContactCall) Do ¶
func (c *PeopleUpdateContactCall) Do(opts ...googleapi.CallOption) (*Person, error)
Do executes the "people.people.updateContact" call. Exactly one of *Person or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Person.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (*PeopleUpdateContactCall) Fields ¶
func (c *PeopleUpdateContactCall) Fields(s ...googleapi.Field) *PeopleUpdateContactCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*PeopleUpdateContactCall) Header ¶
func (c *PeopleUpdateContactCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*PeopleUpdateContactCall) UpdatePersonFields ¶
func (c *PeopleUpdateContactCall) UpdatePersonFields(updatePersonFields string) *PeopleUpdateContactCall
UpdatePersonFields sets the optional parameter "updatePersonFields": **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 * emailAddresses * events * genders * imClients * interests * locales * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined
type Person ¶
type Person struct { // Addresses: The person's street addresses. Addresses []*Address `json:"addresses,omitempty"` // AgeRange: **DEPRECATED** (Please use `person.ageRanges` // instead)** // // The person's read-only age range. // // Possible values: // "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. AgeRange string `json:"ageRange,omitempty"` // AgeRanges: The person's read-only age ranges. AgeRanges []*AgeRangeType `json:"ageRanges,omitempty"` // Biographies: The person's biographies. Biographies []*Biography `json:"biographies,omitempty"` // Birthdays: The person's birthdays. Birthdays []*Birthday `json:"birthdays,omitempty"` // BraggingRights: The person's bragging rights. BraggingRights []*BraggingRights `json:"braggingRights,omitempty"` // CoverPhotos: The person's read-only cover photos. CoverPhotos []*CoverPhoto `json:"coverPhotos,omitempty"` // EmailAddresses: The person's email addresses. EmailAddresses []*EmailAddress `json:"emailAddresses,omitempty"` // Etag: The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) // of the // resource. Used for web cache validation. Etag string `json:"etag,omitempty"` // Events: The person's events. Events []*Event `json:"events,omitempty"` // Genders: The person's genders. Genders []*Gender `json:"genders,omitempty"` // ImClients: The person's instant messaging clients. ImClients []*ImClient `json:"imClients,omitempty"` // Interests: The person's interests. Interests []*Interest `json:"interests,omitempty"` // Locales: The person's locale preferences. Locales []*Locale `json:"locales,omitempty"` // Memberships: The person's read-only group memberships. Memberships []*Membership `json:"memberships,omitempty"` // Metadata: Read-only metadata about the person. Metadata *PersonMetadata `json:"metadata,omitempty"` // Names: The person's names. Names []*Name `json:"names,omitempty"` // Nicknames: The person's nicknames. Nicknames []*Nickname `json:"nicknames,omitempty"` // Occupations: The person's occupations. Occupations []*Occupation `json:"occupations,omitempty"` // Organizations: The person's past or current organizations. Organizations []*Organization `json:"organizations,omitempty"` // PhoneNumbers: The person's phone numbers. PhoneNumbers []*PhoneNumber `json:"phoneNumbers,omitempty"` // Photos: The person's read-only photos. Photos []*Photo `json:"photos,omitempty"` // Relations: The person's relations. Relations []*Relation `json:"relations,omitempty"` // RelationshipInterests: The person's read-only relationship interests. RelationshipInterests []*RelationshipInterest `json:"relationshipInterests,omitempty"` // RelationshipStatuses: The person's read-only relationship statuses. RelationshipStatuses []*RelationshipStatus `json:"relationshipStatuses,omitempty"` // Residences: The person's residences. Residences []*Residence `json:"residences,omitempty"` // ResourceName: 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/`<var>person_id</var>. ResourceName string `json:"resourceName,omitempty"` // SipAddresses: The person's SIP addresses. SipAddresses []*SipAddress `json:"sipAddresses,omitempty"` // Skills: The person's skills. Skills []*Skill `json:"skills,omitempty"` // Taglines: The person's read-only taglines. Taglines []*Tagline `json:"taglines,omitempty"` // Urls: The person's associated URLs. Urls []*Url `json:"urls,omitempty"` // UserDefined: The person's user defined data. UserDefined []*UserDefined `json:"userDefined,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Addresses") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Addresses") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Person: Information about a person merged from various data sources such as the authenticated user's contacts and profile data.
Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
func (*Person) MarshalJSON ¶
type PersonMetadata ¶
type PersonMetadata struct { // Deleted: True if the person resource has been deleted. Populated only // for // [`connections.list`](/people/api/rest/v1/people.connections/list) // requests // that include a sync token. Deleted bool `json:"deleted,omitempty"` // LinkedPeopleResourceNames: Resource names of people linked to this // resource. LinkedPeopleResourceNames []string `json:"linkedPeopleResourceNames,omitempty"` // ObjectType: **DEPRECATED** (Please // use // `person.metadata.sources.profileMetadata.objectType` instead) // // The type of the person object. // // Possible values: // "OBJECT_TYPE_UNSPECIFIED" - Unspecified. // "PERSON" - Person. // "PAGE" - [Google+ Page.](http://www.google.com/+/brands/) ObjectType string `json:"objectType,omitempty"` // PreviousResourceNames: Any former resource names this person has had. // Populated only // for // [`connections.list`](/people/api/rest/v1/people.connections/list) // requests // that include a sync token. // // The resource name may change when adding or removing fields that link // a // contact and profile such as a verified email, verified phone number, // or // profile URL. PreviousResourceNames []string `json:"previousResourceNames,omitempty"` // Sources: The sources of data for the person. Sources []*Source `json:"sources,omitempty"` // ForceSendFields is a list of field names (e.g. "Deleted") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Deleted") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
PersonMetadata: The read-only metadata about a person.
func (*PersonMetadata) MarshalJSON ¶
func (s *PersonMetadata) MarshalJSON() ([]byte, error)
type PersonResponse ¶
type PersonResponse struct { // HttpStatusCode: **DEPRECATED** (Please use status instead) // // [HTTP 1.1 status // code] // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html). HttpStatusCode int64 `json:"httpStatusCode,omitempty"` // Person: The person. Person *Person `json:"person,omitempty"` // RequestedResourceName: The original requested resource name. May be // different than the resource // name on the returned person. // // The resource name can change when adding or removing fields that link // a // contact and profile such as a verified email, verified phone number, // or a // profile URL. RequestedResourceName string `json:"requestedResourceName,omitempty"` // Status: The status of the response. Status *Status `json:"status,omitempty"` // ForceSendFields is a list of field names (e.g. "HttpStatusCode") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "HttpStatusCode") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
PersonResponse: The response for a single person
func (*PersonResponse) MarshalJSON ¶
func (s *PersonResponse) MarshalJSON() ([]byte, error)
type PhoneNumber ¶
type PhoneNumber struct { // CanonicalForm: The read-only canonicalized [ITU-T // E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008. // pdf) // form of the phone number. CanonicalForm string `json:"canonicalForm,omitempty"` // FormattedType: The read-only type of the phone number translated and // formatted in the // viewer's account locale or the `Accept-Language` HTTP header locale. FormattedType string `json:"formattedType,omitempty"` // Metadata: Metadata about the phone number. Metadata *FieldMetadata `json:"metadata,omitempty"` // Type: The type of the phone number. The type can be custom or one of // these // predefined values: // // * `home` // * `work` // * `mobile` // * `homeFax` // * `workFax` // * `otherFax` // * `pager` // * `workMobile` // * `workPager` // * `main` // * `googleVoice` // * `other` Type string `json:"type,omitempty"` // Value: The phone number. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "CanonicalForm") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "CanonicalForm") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
PhoneNumber: A person's phone number.
func (*PhoneNumber) MarshalJSON ¶
func (s *PhoneNumber) MarshalJSON() ([]byte, error)
type Photo ¶
type Photo struct { // Default: True if the photo is a default photo; // false if the photo is a user-provided photo. Default bool `json:"default,omitempty"` // Metadata: Metadata about the photo. Metadata *FieldMetadata `json:"metadata,omitempty"` // Url: The URL of the photo. You can change the desired size by // appending a query // parameter `sz=`<var>size</var> at the end of the url. // Example: // `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/A // AAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50` Url string `json:"url,omitempty"` // ForceSendFields is a list of field names (e.g. "Default") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Default") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Photo: A person's read-only photo. A picture shown next to the person's name to help others recognize the person.
func (*Photo) MarshalJSON ¶
type ProfileMetadata ¶
type ProfileMetadata struct { // ObjectType: The profile object type. // // Possible values: // "OBJECT_TYPE_UNSPECIFIED" - Unspecified. // "PERSON" - Person. // "PAGE" - [Google+ Page.](http://www.google.com/+/brands/) ObjectType string `json:"objectType,omitempty"` // UserTypes: The user types. // // Possible values: // "USER_TYPE_UNKNOWN" - The user type is not known. // "GOOGLE_USER" - The user is a Google user. // "GPLUS_USER" - The user is a Google+ user. // "GOOGLE_APPS_USER" - The user is a Google Apps for Work user. UserTypes []string `json:"userTypes,omitempty"` // ForceSendFields is a list of field names (e.g. "ObjectType") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ObjectType") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ProfileMetadata: The read-only metadata about a profile.
func (*ProfileMetadata) MarshalJSON ¶
func (s *ProfileMetadata) MarshalJSON() ([]byte, error)
type Relation ¶
type Relation struct { // FormattedType: The type of the relation translated and formatted in // the viewer's account // locale or the locale specified in the Accept-Language HTTP header. FormattedType string `json:"formattedType,omitempty"` // Metadata: Metadata about the relation. Metadata *FieldMetadata `json:"metadata,omitempty"` // Person: The name of the other person this relation refers to. Person string `json:"person,omitempty"` // Type: The person's relation to the other person. The type can be // custom or one of // these predefined values: // // * `spouse` // * `child` // * `mother` // * `father` // * `parent` // * `brother` // * `sister` // * `friend` // * `relative` // * `domesticPartner` // * `manager` // * `assistant` // * `referredBy` // * `partner` Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "FormattedType") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FormattedType") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Relation: A person's relation to another person.
func (*Relation) MarshalJSON ¶
type RelationshipInterest ¶
type RelationshipInterest struct { // FormattedValue: The value of the relationship interest translated and // formatted in the // viewer's account locale or the locale specified in the // Accept-Language // HTTP header. FormattedValue string `json:"formattedValue,omitempty"` // Metadata: Metadata about the relationship interest. Metadata *FieldMetadata `json:"metadata,omitempty"` // Value: The kind of relationship the person is looking for. The value // can be custom // or one of these predefined values: // // * `friend` // * `date` // * `relationship` // * `networking` Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "FormattedValue") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FormattedValue") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
RelationshipInterest: A person's read-only relationship interest .
func (*RelationshipInterest) MarshalJSON ¶
func (s *RelationshipInterest) MarshalJSON() ([]byte, error)
type RelationshipStatus ¶
type RelationshipStatus struct { // FormattedValue: The read-only value of the relationship status // translated and formatted in // the viewer's account locale or the `Accept-Language` HTTP header // locale. FormattedValue string `json:"formattedValue,omitempty"` // Metadata: Metadata about the relationship status. Metadata *FieldMetadata `json:"metadata,omitempty"` // Value: The relationship status. The value can be custom or one of // these // predefined values: // // * `single` // * `inARelationship` // * `engaged` // * `married` // * `itsComplicated` // * `openRelationship` // * `widowed` // * `inDomesticPartnership` // * `inCivilUnion` Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "FormattedValue") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FormattedValue") to // include in API requests with the JSON null value. By default, fields // with empty values are omitted from API requests. However, any field // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. NullFields []string `json:"-"` }
RelationshipStatus: A person's read-only relationship status.
func (*RelationshipStatus) MarshalJSON ¶
func (s *RelationshipStatus) MarshalJSON() ([]byte, error)
type Residence ¶
type Residence struct { // Current: True if the residence is the person's current // residence; // false if the residence is a past residence. Current bool `json:"current,omitempty"` // Metadata: Metadata about the residence. Metadata *FieldMetadata `json:"metadata,omitempty"` // Value: The address of the residence. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Current") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Current") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Residence: A person's past or current residence.
func (*Residence) MarshalJSON ¶
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment ContactGroups *ContactGroupsService People *PeopleService // contains filtered or unexported fields }
type SipAddress ¶
type SipAddress struct { // FormattedType: The read-only type of the SIP address translated and // formatted in the // viewer's account locale or the `Accept-Language` HTTP header locale. FormattedType string `json:"formattedType,omitempty"` // Metadata: Metadata about the SIP address. Metadata *FieldMetadata `json:"metadata,omitempty"` // Type: The type of the SIP address. The type can be custom or or one // of these // predefined values: // // * `home` // * `work` // * `mobile` // * `other` Type string `json:"type,omitempty"` // Value: The SIP address in the // [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP // URI // format. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "FormattedType") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FormattedType") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
SipAddress: A person's SIP address. Session Initial Protocol addresses are used for VoIP communications to make voice or video calls over the internet.
func (*SipAddress) MarshalJSON ¶
func (s *SipAddress) MarshalJSON() ([]byte, error)
type Skill ¶
type Skill struct { // Metadata: Metadata about the skill. Metadata *FieldMetadata `json:"metadata,omitempty"` // Value: The skill; for example, `underwater basket weaving`. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Metadata") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Metadata") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Skill: A skill that the person has.
func (*Skill) MarshalJSON ¶
type Source ¶
type Source struct { // Etag: **Only populated in `person.metadata.sources`.** // // The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of // the // source. Used for web cache validation. Etag string `json:"etag,omitempty"` // Id: The unique identifier within the source type generated by the // server. Id string `json:"id,omitempty"` // ProfileMetadata: **Only populated in // `person.metadata.sources`.** // // Metadata about a source of type PROFILE. ProfileMetadata *ProfileMetadata `json:"profileMetadata,omitempty"` // Type: The source type. // // Possible values: // "SOURCE_TYPE_UNSPECIFIED" - Unspecified. // "ACCOUNT" - [Google Account](https://accounts.google.com). // "PROFILE" - [Google profile](https://profiles.google.com). You can // view the // profile at https://profiles.google.com/<var>id</var> // where // <var>id</var> is the source id. // "DOMAIN_PROFILE" - [Google Apps domain // profile](https://admin.google.com). // "CONTACT" - [Google contact](https://contacts.google.com). You can // view the // contact at https://contact.google.com/<var>id</var> where // <var>id</var> // is the source id. Type string `json:"type,omitempty"` // UpdateTime: **Only populated in `person.metadata.sources`.** // // Last update timestamp of this source. UpdateTime string `json:"updateTime,omitempty"` // ForceSendFields is a list of field names (e.g. "Etag") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Etag") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Source: The source of a field.
func (*Source) MarshalJSON ¶
type Status ¶
type Status struct { // Code: The status code, which should be an enum value of // google.rpc.Code. Code int64 `json:"code,omitempty"` // Details: A list of messages that carry the error details. There is a // common set of // message types for APIs to use. Details []googleapi.RawMessage `json:"details,omitempty"` // Message: A developer-facing error message, which should be in // English. Any // user-facing error message should be localized and sent in // the // google.rpc.Status.details field, or localized by the client. Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Code") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be:
- Simple to use and understand for most users - Flexible enough to meet unexpected needs
Overview ¶
The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions.
Language mapping ¶
The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.
Other uses ¶
The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.
Example uses of this error model include:
- Partial errors. If a service needs to return partial errors to the client,
it may embed the `Status` in the normal response to indicate the
partial
errors.
- Workflow errors. A typical workflow has multiple steps. Each step may
have a `Status` message for error reporting.
- Batch operations. If a client uses batch request and batch response, the
`Status` message should be used directly inside batch response,
one for
each error sub-response.
- Asynchronous operations. If an API call embeds asynchronous operation
results in its response, the status of those operations should
be
represented directly using the `Status` message.
- Logging. If some API errors are stored in logs, the message `Status` could
be used directly after any stripping needed for security/privacy
reasons.
func (*Status) MarshalJSON ¶
type Tagline ¶
type Tagline struct { // Metadata: Metadata about the tagline. Metadata *FieldMetadata `json:"metadata,omitempty"` // Value: The tagline. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Metadata") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Metadata") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Tagline: A read-only brief one-line description of the person.
func (*Tagline) MarshalJSON ¶
type UpdateContactGroupRequest ¶
type UpdateContactGroupRequest struct { // ContactGroup: The contact group to update. ContactGroup *ContactGroup `json:"contactGroup,omitempty"` // ForceSendFields is a list of field names (e.g. "ContactGroup") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "ContactGroup") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
UpdateContactGroupRequest: A request to update an existing user contact group. All updated fields will be replaced.
func (*UpdateContactGroupRequest) MarshalJSON ¶
func (s *UpdateContactGroupRequest) MarshalJSON() ([]byte, error)
type Url ¶
type Url struct { // FormattedType: The read-only type of the URL translated and formatted // in the viewer's // account locale or the `Accept-Language` HTTP header locale. FormattedType string `json:"formattedType,omitempty"` // Metadata: Metadata about the URL. Metadata *FieldMetadata `json:"metadata,omitempty"` // Type: The type of the URL. The type can be custom or one of these // predefined // values: // // * `home` // * `work` // * `blog` // * `profile` // * `homePage` // * `ftp` // * `reservations` // * `appInstallPage`: website for a Google+ application. // * `other` Type string `json:"type,omitempty"` // Value: The URL. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "FormattedType") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "FormattedType") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
Url: A person's associated URLs.
func (*Url) MarshalJSON ¶
type UserDefined ¶
type UserDefined struct { // Key: The end user specified key of the user defined data. Key string `json:"key,omitempty"` // Metadata: Metadata about the user defined data. Metadata *FieldMetadata `json:"metadata,omitempty"` // Value: The end user specified value of the user defined data. Value string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Key") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "Key") to include in API // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
UserDefined: Arbitrary user data that is populated by the end users.
func (*UserDefined) MarshalJSON ¶
func (s *UserDefined) MarshalJSON() ([]byte, error)