View Source GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRelation (google_api_content_warehouse v0.3.0)

Relation stores the related person between the contact or profile and a third person. See go/relation-vs-relationship for relation vs relationship explanation. This field currently includes RelationshipToMe data in fields value and canonical_value for ContainerType CONTACT_ANNOTATION. This will be moved to RelationshipToMe in b/221081499.

Attributes

canonicalValue (type: String.t, default: nil) - Canonicalized value of the relation from this person to the user. This is currently used for data from contact annotations. Possible canonical values are based from http://google3/googledata/quality/aliases/relationship_en.config.
formattedType (type: String.t, default: nil) - The type translated and formatted in the request locale. See go/people-api-howto/localization for details on how to usage.
metadata (type: GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t, default: nil) -
relationDetails (type: GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRelationRelationDetails.t, default: nil) - The person whose email matches the Relation.value field, if it is a valid email address. This field is read-only and ignored on update.
type (type: String.t, default: nil) - The relation type. The type can be free form or one of these predefined values: spouse child mother father parent brother sister friend relative domesticPartner manager assistant referredBy partner
value (type: String.t, default: nil) - The person this relation applies to. Custom value provided by the user.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRelation{
    canonicalValue: String.t() | nil,
    formattedType: String.t() | nil,
    metadata:
      GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t()
      | nil,
    relationDetails:
      GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiRelationRelationDetails.t()
      | nil,
    type: String.t() | nil,
    value: String.t() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.