Newer Version Available

This content describes an older version of this product. View Latest

Audience

Represents an audience that is defined by criteria and can be assigned and used for targeting in a community. This object is available in API version 44.0 and later.

Supported Calls

describeSObjects(), query(), retrieve(), update()

Fields

Field Details
AudienceName
Type
string
Properties
Filter, Group, Sort, Update
Description
Name of the audience.
ContainerId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the community or org that contains the audience.
Description
Type
string
Properties
Filter, Group, Nillable, Sort, Update
Description
Description of the audience.
DeveloperName
Type
string
Properties
Filter, Group, Sort, Update
Description
The unique name of the audience in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated, but you can supply your own value if you create the record using the API.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.

Note

FormulaFilterName
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Formula filter for the criteria used to define the audience. Valid values are:
  • AllCriteriaMatch—Similar to the logical function AND, all the conditions that are used to define the audience are met.
  • AnyCriterionMatches—Similar to the logical function OR, at least one condition that is used to determine the audience is met.
Language
Type
picklist
Properties
Filter, Group, Nillable, Sort, Update
Description
Language of the audience. Valid values are:
  • Chinese (Simplified): zh_CN
  • Chinese (Traditional): zh_TW
  • Danish: da
  • Dutch: nl_NL
  • English: en_US
  • Finnish: fi
  • French: fr
  • German: de
  • Italian: it
  • Japanese: ja
  • Korean: ko
  • Norwegian: no
  • Portuguese (Brazil): pt_BR
  • Russian: ru
  • Spanish: es
  • Spanish (Mexico): es_MX
  • Swedish: sv
  • Thai: th
MasterLabel
Type
string
Properties
Filter, Group, Sort, Update
Description
Master label for the audience. This internal name doesn’t get translated.