REST Resource: projects.locations.tagTemplates.fields

Resource: TagTemplateField

The template for an individual field within a tag template.

JSON representation
{
  "name": string,
  "displayName": string,
  "type": {
    object (FieldType)
  },
  "isRequired": boolean,
  "description": string,
  "order": integer
}
Fields
name

string

Output only. The resource name of the tag template field in URL format. Example:

projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE}/fields/{FIELD}

Note: The tag template field itself might not be stored in the location specified in its name.

The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 64 characters.

displayName

string

The display name for this field. Defaults to an empty string.

The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.

type

object (FieldType)

Required. The type of value this tag field can contain.

isRequired

boolean

If true, this field is required. Defaults to false.

description

string

The description for this field. Defaults to an empty string.

order

integer

The order of this field with respect to other fields in this tag template.

For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order and field orders within a tag don't have to be sequential.

FieldType

JSON representation
{

  // Union field type_decl can be only one of the following:
  "primitiveType": enum (PrimitiveType),
  "enumType": {
    object (EnumType)
  }
  // End of list of possible types for union field type_decl.
}
Fields
Union field type_decl. Required. type_decl can be only one of the following:
primitiveType

enum (PrimitiveType)

Primitive types, such as string, boolean, etc.

enumType

object (EnumType)

An enum type.

PrimitiveType

Enums
PRIMITIVE_TYPE_UNSPECIFIED The default invalid value for a type.
DOUBLE A double precision number.
STRING An UTF-8 string.
BOOL A boolean value.
TIMESTAMP A timestamp.
RICHTEXT A Richtext description.

EnumType

JSON representation
{
  "allowedValues": [
    {
      object (EnumValue)
    }
  ]
}
Fields
allowedValues[]

object (EnumValue)

The set of allowed values for this enum.

This set must not be empty and can include up to 100 allowed values. The display names of the values in this set must not be empty and must be case-insensitively unique within this set.

The order of items in this set is preserved. This field can be used to create, remove, and reorder enum values. To rename enum values, use the enumValues.rename method.

EnumValue

JSON representation
{
  "displayName": string
}
Fields
displayName

string

Required. The display name of the enum value. Must not be an empty string.

The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters.

Methods

create

Creates a field in a tag template.

delete

Deletes a field in a tag template and all uses of this field from the tags based on this template.

patch

Updates a field in a tag template.

rename

Renames a field in a tag template.