AppsPeopleOzExternalMergedpeopleapiName

Posted on by Darth Emmett

GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiName

Table of Contents ▼

Jump to a specific part of the page:

Description

See go/people-api-howto:names for an overview of name usage in PeopleAPI. The unstructured_name field contains a free form name value. The given_name, middle_name, family_name, etc, fields contain the structured name. For CONTACT mutates, (i.e. when Name.metadata.container is CONTACT), it is recommended for clients to set either the unstructured_name or the set of structured name fields, not both. When only the unstructured_name is set, it is parsed to produce a best-guess set of structured name values for the given_name, family_name, etc. When only the structured name fields are set, the various values are combined to produce an unstructured_name. * When both are set, the unstructured_name is saved as-is and the structured name fields are saved as-is. This may be confusing as they might not "match". For PROFILE mutates, (i.e. when Name.metadata.container is PROFILE), it is required for clients to use the structured name fields as the unstructured field value is ignored on write. The unstructured name fields are generated for convenience on read. For DEVICE_CONTACTS, see b/156020778.

Attributes List

This module has the following attributes (case-insensitive ascending order):

View Attributes

Attributes

  1. displayName (type: String.t, default: nil)
    - Read-only. A name synthesized based on unstructured_name and the structured name fields. Example: "John Smith" If a language code is passed in the side channel using http://cs/symbol:framework.rpc.DeprecatedPropagatedLanguageCode.value or http://cs/symbol:google.rpc.context.OriginContext.accept_language and the name does not have honorific_prefix, middle_name, or honorific_suffix set, the language code will be used to format display_name. If include_account_locale is set on the MergePersonSourceOptions and a language code is not passed in the side channel. The language code from go/uls will be used as the language code for formatting display_name.
  2. displayNameLastFirst (type: String.t, default: nil)
    - Read-only. A name synthesized based on unstructured_name and the structured name fields with the last name first. Example: "Smith, John"
  3. displayNameSource (type: GoogleApi.ContentWarehouse.V1.Model.SocialGraphApiProtoDisplayNameSource, default: nil)
    - Read-only. The source of the display name.
  4. familyName (type: String.t, default: nil)
    -
  5. formattedName (type: String.t, default: nil)
    - DEPRECATED(b/70571931). Use unstructured_name instead.
  6. givenName (type: String.t, default: nil)
    -
  7. honorificPrefix (type: String.t, default: nil)
    -
  8. honorificSuffix (type: String.t, default: nil)
    -
  9. metadata (type: GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata, default: nil)
    -
  10. middleName (type: String.t, default: nil)
    -
  11. pronunciations (type: GoogleApi.ContentWarehouse.V1.Model.SocialGraphApiProtoPronunciations, default: nil)
    - This field is stored in contact annotations and merged at read-time. It is available with CONTACT_ANNOTATION container type at read time.
  12. shortDisplayName (type: String.t, default: nil)
    - NOTE: this is currently NOT IMPLEMENTED due to changed priorities. Clients usually rely on "first name" instead, when a short name is needed. Read-only. A possibly shorter version of the user's name. - The purpose of this field is to address the needs of UIs where a full display name might be too large to fit. Instead of relying on first_name, which might not be present, short_display_name is preferred. - This is only available for PROFILE and DOMAIN_PROFILE container types. - About the actual content in this field: will be the first name when it's visible to the requester, or the same as display_name, otherwise. A sample scenario where the first name may not be visible is when the limited profile is returned. For more info, see: http://shortn/_9iV7TJ33la
  13. unstructuredName (type: String.t, default: nil)
    - The free form name value. For contact mutates it is recommended for clients to set either the unstructured_name or the set of structured name fields, not both.
  14. yomiFamilyName (type: String.t, default: nil)
    -
  15. yomiFullName (type: String.t, default: nil)
    -
  16. yomiGivenName (type: String.t, default: nil)
    -
  17. yomiHonorificPrefix (type: String.t, default: nil)
    -
  18. yomiHonorificSuffix (type: String.t, default: nil)
    -
  19. yomiMiddleName (type: String.t, default: nil)
    -

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiName{
displayName: String.t() | nil,
displayNameLastFirst: String.t() | nil,
displayNameSource: GoogleApi.ContentWarehouse.V1.Model.SocialGraphApiProtoDisplayNameSource.t() | nil,
familyName: String.t() | nil,
formattedName: String.t() | nil,
givenName: String.t() | nil,
honorificPrefix: String.t() | nil,
honorificSuffix: String.t() | nil,
metadata: GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.t() | nil,
middleName: String.t() | nil,
pronunciations: GoogleApi.ContentWarehouse.V1.Model.SocialGraphApiProtoPronunciations.t() | nil,
shortDisplayName: String.t() | nil,
unstructuredName: String.t() | nil,
yomiFamilyName: String.t() | nil,
yomiFullName: String.t() | nil,
yomiGivenName: String.t() | nil,
yomiHonorificPrefix: String.t() | nil,
yomiHonorificSuffix: String.t() | nil,
yomiMiddleName: String.t() | nil
}

Function

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

Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiName