GoogleApi.Admin.Directory_v1.Model.SchemaFieldSpec (google_api_admin v0.35.0) View Source

You can use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, their hire dates, or whatever else fits your business needs. For more information, see Custom User Fields.


  • displayName (type: String.t, default: nil) - Display Name of the field.
  • etag (type: String.t, default: nil) - The ETag of the field.
  • fieldId (type: String.t, default: nil) - The unique identifier of the field (Read-only)
  • fieldName (type: String.t, default: nil) - The name of the field.
  • fieldType (type: String.t, default: nil) - The type of the field.
  • indexed (type: boolean(), default: true) - Boolean specifying whether the field is indexed or not. Default: true.
  • kind (type: String.t, default: admin#directory#schema#fieldspec) - The kind of resource this is. For schema fields this is always admin#directory#schema#fieldspec.
  • multiValued (type: boolean(), default: nil) - A boolean specifying whether this is a multi-valued field or not. Default: false.
  • numericIndexingSpec (type: GoogleApi.Admin.Directory_v1.Model.SchemaFieldSpecNumericIndexingSpec.t, default: nil) - Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.
  • readAccessType (type: String.t, default: ALL_DOMAIN_USERS) - Specifies who can view values of this field. See Retrieve users as a non-administrator for more information. Note: It may take up to 24 hours for changes to this field to be reflected.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.Admin.Directory_v1.Model.SchemaFieldSpec{
  displayName: String.t() | nil,
  etag: String.t() | nil,
  fieldId: String.t() | nil,
  fieldName: String.t() | nil,
  fieldType: String.t() | nil,
  indexed: boolean() | nil,
  kind: String.t() | nil,
  multiValued: boolean() | nil,
    | nil,
  readAccessType: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.