UserList

{
  "uploadKeyType": enum (CustomerMatchUploadKeyType),
  "dataSourceType": enum (UserListCrmDataSourceType),
  "appId": string
}

enum (CustomerMatchUploadKeyType)

Matching key type of the list. Mixed data types are not allowed on the same list. This field is required for an ADD operation.

enum (UserListCrmDataSourceType)

Data source of the list. Default value is FIRST_PARTY. Only customers on the allow-list can create third-party sourced CRM lists.

string

A string that uniquely identifies a mobile application from which the data was collected. For iOS, the ID string is the 9 digit string that appears at the end of an App Store URL (for example, "476943146" for "Flood-It! 2" whose App Store link is http://itunes.apple.com/us/app/flood-it!-2/id476943146). For Android, the ID string is the application's package name (for example, "com.labpixies.colordrips" for "Color Drips" given Google Play link https://play.google.com/store/apps/details?id=com.labpixies.colordrips). Required when creating CrmBasedUserList for uploading mobile advertising IDs.

{
  "seedUserList": string
}

string

Seed UserList from which this list is derived.

{
  "prepopulationStatus": enum (UserListPrepopulationStatus),
  "flexibleRuleUserList": {
    object (FlexibleRuleUserListInfo)
  }
}

enum (UserListPrepopulationStatus)

The status of pre-population. The field is default to NONE if not set which means the previous users will not be considered. If set to REQUESTED, past site visitors or app users who match the list definition will be included in the list (works on the Display Network only). This will only add past users from within the last 30 days, depending on the list's membership duration and the date when the remarketing tag is added. The status will be updated to FINISHED once request is processed, or FAILED if the request fails.

object (FlexibleRuleUserListInfo)

Flexible rule representation of visitors with one or multiple actions. The flexible user list is defined by two lists of operands – inclusiveOperands and exclusiveOperands; each operand represents a set of users based on actions they took in a given timeframe. These lists of operands are combined with the AND_NOT operator, so that users represented by the inclusive operands are included in the user list, minus the users represented by the exclusive operands.

{
  "inclusiveRuleOperator": enum (UserListFlexibleRuleOperator),
  "inclusiveOperands": [
    {
      object (FlexibleRuleOperandInfo)
    }
  ],
  "exclusiveOperands": [
    {
      object (FlexibleRuleOperandInfo)
    }
  ]
}

enum (UserListFlexibleRuleOperator)

Operator that defines how the inclusive operands are combined.

object (FlexibleRuleOperandInfo)

Rules representing users that should be included in the user list. These are located on the left side of the AND_NOT operator, and joined together by either AND/OR as specified by the inclusiveRuleOperator.

object (FlexibleRuleOperandInfo)

Rules representing users that should be excluded from the user list. These are located on the right side of the AND_NOT operator, and joined together by OR.

{
  "rule": {
    object (UserListRuleInfo)
  },
  "lookbackWindowDays": string
}

object (UserListRuleInfo)

List of rule item groups that defines this rule. Rule item groups are grouped together.

string (int64 format)

Lookback window for this rule in days. From now until X days ago.

{
  "ruleType": enum (UserListRuleType),
  "ruleItemGroups": [
    {
      object (UserListRuleItemGroupInfo)
    }
  ]
}

enum (UserListRuleType)

Rule type is used to determine how to group rule items.

The default is OR of ANDs (disjunctive normal form). That is, rule items will be ANDed together within rule item groups and the groups themselves will be ORed together.

OR of ANDs is the only supported type for FlexibleRuleUserList.

object (UserListRuleItemGroupInfo)

List of rule item groups that defines this rule. Rule item groups are grouped together based on ruleType.

{
  "ruleItems": [
    {
      object (UserListRuleItemInfo)
    }
  ]
}

object (UserListRuleItemInfo)

Rule items that will be grouped together based on ruleType.

{
  "name": string,

  // Union field rule_item can be only one of the following:
  "numberRuleItem": {
    object (UserListNumberRuleItemInfo)
  },
  "stringRuleItem": {
    object (UserListStringRuleItemInfo)
  },
  "dateRuleItem": {
    object (UserListDateRuleItemInfo)
  }
  // End of list of possible types for union field rule_item.
}

string

Rule variable name. It should match the corresponding key name fired by the pixel. A name must begin with US-ascii letters or underscore or UTF8 code that is greater than 127 and consist of US-ascii letters or digits or underscore or UTF8 code that is greater than 127. For websites, there are two built-in variable URL (name = 'url__') and referrer URL (name = 'ref_url__'). This field must be populated when creating a new rule item.

object (UserListNumberRuleItemInfo)

An atomic rule item composed of a number operation.

object (UserListStringRuleItemInfo)

An atomic rule item composed of a string operation.

object (UserListDateRuleItemInfo)

An atomic rule item composed of a date operation.

{
  "operator": enum (UserListNumberRuleItemOperator),
  "value": number
}

enum (UserListNumberRuleItemOperator)

Number comparison operator. This field is required and must be populated when creating a new number rule item.

number

Number value to be compared with the variable. This field is required and must be populated when creating a new number rule item.

{
  "operator": enum (UserListStringRuleItemOperator),
  "value": string
}

enum (UserListStringRuleItemOperator)

String comparison operator. This field is required and must be populated when creating a new string rule item.

string

The right hand side of the string rule item. For URLs or referrer URLs, the value can not contain illegal URL chars such as newlines, quotes, tabs, or parentheses. This field is required and must be populated when creating a new string rule item.

{
  "operator": enum (UserListDateRuleItemOperator),
  "value": string,
  "offsetInDays": string
}

enum (UserListDateRuleItemOperator)

Date comparison operator. This field is required and must be populated when creating new date rule item.

string

String representing date value to be compared with the rule variable. Supported date format is YYYY-MM-DD. Times are reported in the customer's time zone.

string (int64 format)

The relative date value of the right hand side denoted by number of days offset from now. The value field will override this field when both are present.

{
  "rules": [
    {
      object (UserListLogicalRuleInfo)
    }
  ]
}

object (UserListLogicalRuleInfo)

Logical list rules that define this user list. The rules are defined as a logical operator (ALL/ANY/NONE) and a list of user lists. All the rules are ANDed when they are evaluated.

Required for creating a logical user list.

{
  "operator": enum (UserListLogicalRuleOperator),
  "ruleOperands": [
    {
      object (LogicalUserListOperandInfo)
    }
  ]
}

enum (UserListLogicalRuleOperator)

The logical operator of the rule.

object (LogicalUserListOperandInfo)

The list of operands of the rule.

{
  "userList": string
}

string

Resource name of a user list as an operand.

{
  "actions": [
    {
      object (UserListActionInfo)
    }
  ]
}

object (UserListActionInfo)

Actions associated with this user list.

{

  // Union field user_list_action can be only one of the following:
  "conversionAction": string,
  "remarketingAction": string
  // End of list of possible types for union field user_list_action.
}

string

A conversion action that's not generated from remarketing.

string

A remarketing action.

{
  "seedUserListIds": [
    string
  ],
  "expansionLevel": enum (LookalikeExpansionLevel),
  "countryCodes": [
    string
  ]
}

string (int64 format)

Seed UserList ID from which this list is derived, provided by user.

enum (LookalikeExpansionLevel)

Expansion level, reflecting the size of the lookalike audience

string

Countries targeted by the Lookalike. Two-letter country code as defined by ISO-3166