Skip to content

Put Profile Object Type

customerprofiles_put_profile_object_type R Documentation

Defines a ProfileObjectType

Description

Defines a ProfileObjectType.

To add or remove tags on an existing ObjectType, see TagResource/untag_resource.

Usage

customerprofiles_put_profile_object_type(DomainName, ObjectTypeName,
  Description, TemplateId, ExpirationDays, EncryptionKey,
  AllowProfileCreation, SourceLastUpdatedTimestampFormat,
  MaxProfileObjectCount, Fields, Keys, Tags)

Arguments

DomainName

[required] The unique name of the domain.

ObjectTypeName

[required] The name of the profile object type.

Description

[required] Description of the profile object type.

TemplateId

A unique identifier for the object template. For some attributes in the request, the service will use the default value from the object template when TemplateId is present. If these attributes are present in the request, the service may return a BadRequestException. These attributes include: AllowProfileCreation, SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is set to true when TemplateId is set, the service may return a BadRequestException.

ExpirationDays

The number of days until the data in the object expires.

EncryptionKey

The customer-provided key to encrypt the profile object that will be created in this profile object type.

AllowProfileCreation

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

SourceLastUpdatedTimestampFormat

The format of your sourceLastUpdatedTimestamp that was previously set up.

MaxProfileObjectCount

The amount of profile object max count assigned to the object type

Fields

A map of the name and ObjectType field.

Keys

A list of unique keys that can be used to map data to the profile.

Tags

The tags used to organize, track, or control access for this resource.

Value

A list with the following syntax: 

list(
  ObjectTypeName = "string",
  Description = "string",
  TemplateId = "string",
  ExpirationDays = 123,
  EncryptionKey = "string",
  AllowProfileCreation = TRUE|FALSE,
  SourceLastUpdatedTimestampFormat = "string",
  MaxProfileObjectCount = 123,
  MaxAvailableProfileObjectCount = 123,
  Fields = list(
    list(
      Source = "string",
      Target = "string",
      ContentType = "STRING"|"NUMBER"|"PHONE_NUMBER"|"EMAIL_ADDRESS"|"NAME"
    )
  ),
  Keys = list(
    list(
      list(
        StandardIdentifiers = list(
          "PROFILE"|"ASSET"|"CASE"|"UNIQUE"|"SECONDARY"|"LOOKUP_ONLY"|"NEW_ONLY"|"ORDER"
        ),
        FieldNames = list(
          "string"
        )
      )
    )
  ),
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  LastUpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  Tags = list(
    "string"
  )
)

Request syntax

svc$put_profile_object_type(
  DomainName = "string",
  ObjectTypeName = "string",
  Description = "string",
  TemplateId = "string",
  ExpirationDays = 123,
  EncryptionKey = "string",
  AllowProfileCreation = TRUE|FALSE,
  SourceLastUpdatedTimestampFormat = "string",
  MaxProfileObjectCount = 123,
  Fields = list(
    list(
      Source = "string",
      Target = "string",
      ContentType = "STRING"|"NUMBER"|"PHONE_NUMBER"|"EMAIL_ADDRESS"|"NAME"
    )
  ),
  Keys = list(
    list(
      list(
        StandardIdentifiers = list(
          "PROFILE"|"ASSET"|"CASE"|"UNIQUE"|"SECONDARY"|"LOOKUP_ONLY"|"NEW_ONLY"|"ORDER"
        ),
        FieldNames = list(
          "string"
        )
      )
    )
  ),
  Tags = list(
    "string"
  )
)