SocialCommonUserMentionData

Posted on by Darth Autocrat

GoogleApi.ContentWarehouse.V1.Model.SocialCommonUserMentionData

Table of Contents ▼

Jump to a specific part of the page:

Description

Person metadata, for USER_MENTION segments. Should always contain at least one of user_gaia_id, user_id, email or user. The exact set of populated fields may differ depending on the context and the level in the serving stack; for example, emails will be elided on the viewing path. But as a general rule, a proto having any one of the four is valid, subject to the standard constraints of the applied annotations -- that is, communication between servers and clients will ignore jspb.ignore fields, and communication between servers and other servers (or between servers and storage) will ignore client_only fields. For more on the annotations, see the comments in social/common/segment_annotations.proto

Attributes List

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

View Attributes

Attributes

  1. email (type: String.t, default: nil)
    -
  2. user (type: GoogleApi.ContentWarehouse.V1.Model.SecurityCredentialsPrincipalProto, default: nil)
    - If the principal is backed by a gaia id, DO NOT use this field. Use user_gaia_id/user_id fields instead.
  3. userGaiaId (type: String.t, default: nil)
    - An unobfuscated gaia ID:
  4. userId (type: String.t, default: nil)
    - An obfuscated gaia ID:

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.SocialCommonUserMentionData{
email: String.t() | nil,
user: GoogleApi.ContentWarehouse.V1.Model.SecurityCredentialsPrincipalProto.t() | nil,
userGaiaId: String.t() | nil,
userId: String.t() | nil
}

Function

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

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