--- title: "POST /v23/customers/{+customerId}/userLists:mutate" method: POST path: "/v23/customers/{+customerId}/userLists:mutate" tags: ["customers"] --- # POST /v23/customers/{+customerId}/userLists:mutate `POST /v23/customers/{+customerId}/userLists:mutate` Creates or updates user lists. Operation statuses are returned. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [DatabaseError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotAllowlistedError]() [NotEmptyError]() [OperationAccessDeniedError]() [QuotaError]() [RangeError]() [RequestError]() [StringFormatError]() [StringLengthError]() [UserListError]() ## Path parameters - `customerId` string, required ## Request body - GoogleAdsSearchads360V23ServicesMutateUserListsRequest — Request message for UserListService.MutateUserLists. - `validateOnly` boolean — If true, the request is validated but not executed. Only errors are returned, not results. - `operations` GoogleAdsSearchads360V23ServicesUserListOperation[] — Required. The list of operations to perform on individual user lists. - `create` GoogleAdsSearchads360V23ResourcesUserList — A user list. This is a list of users a customer may target. The unique key of a user list consists of the following fields: `id`. Note that the `name` must also be unique for user lists owned by a given customer, except in some cases where `access_reason` is set to `SHARED`. Violating the unique name constraint produces error: `UserListError.INVALID_NAME`. - `name` string — Name of this user list. Unique per user list, except in some cases where a user list of the same name has `access_reason` set to `SHARED`. - `sizeForSearch` string, int64 — Output only. Estimated number of users in this user list in the google.com domain. These are the users available for targeting in Search campaigns. This value is null if the number of users has not yet been determined. This field is read-only. - `sizeForDisplay` string, int64 — Output only. Estimated number of users in this user list, on the Google Display Network. This value is if the number of users has not yet been determined. This field is -only. - `accountUserListStatus` 'UNSPECIFIED' | 'UNKNOWN' | 'ENABLED' | 'DISABLED' — Indicates if this share is still enabled. When a UserList is shared with the user this field is set to ENABLED. Later the userList owner can decide to revoke the share and make it DISABLED. The default value of this field is set to ENABLED. - `closingReason` 'UNSPECIFIED' | 'UNKNOWN' | 'UNUSED' — Indicating the reason why this user list membership status is closed. It is only populated on lists that were automatically closed due to inactivity, and will be cleared once the list membership status becomes open. - `membershipLifeSpan` string, int64 — Number of days a user's cookie stays on your list since its most recent addition to the list. This field must be between 0 and 540 inclusive. However, for CRM based userlists, this field can be set to 10000 which means no expiration. Beginning on April 7, 2025, using a value of 10000 to indicate no expiration will no longer be supported. This field is ignored for logical_user_list and rule_based_user_list types. Membership to lists of these types depends on the rules defined by the lists. - `sizeRangeForDisplay` 'UNSPECIFIED' | 'UNKNOWN' | 'LESS_THAN_FIVE_HUNDRED' | 'LESS_THAN_ONE_THOUSAND' | 'ONE_THOUSAND_TO_TEN_THOUSAND' | 'TEN_THOUSAND_TO_FIFTY_THOUSAND' | 'FIFTY_THOUSAND_TO_ONE_HUNDRED_THOUSAND' | 'ONE_HUNDRED_THOUSAND_TO_THREE_HUNDRED_THOUSAND' | 'THREE_HUNDRED_THOUSAND_TO_FIVE_HUNDRED_THOUSAND' | 'FIVE_HUNDRED_THOUSAND_TO_ONE_MILLION' | 'ONE_MILLION_TO_TWO_MILLION' | 'TWO_MILLION_TO_THREE_MILLION' | 'THREE_MILLION_TO_FIVE_MILLION' | 'FIVE_MILLION_TO_TEN_MILLION' | 'TEN_MILLION_TO_TWENTY_MILLION' | 'TWENTY_MILLION_TO_THIRTY_MILLION' | 'THIRTY_MILLION_TO_FIFTY_MILLION' | 'OVER_FIFTY_MILLION' — Output only. Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only. - `sizeRangeForSearch` 'UNSPECIFIED' | 'UNKNOWN' | 'LESS_THAN_FIVE_HUNDRED' | 'LESS_THAN_ONE_THOUSAND' | 'ONE_THOUSAND_TO_TEN_THOUSAND' | 'TEN_THOUSAND_TO_FIFTY_THOUSAND' | 'FIFTY_THOUSAND_TO_ONE_HUNDRED_THOUSAND' | 'ONE_HUNDRED_THOUSAND_TO_THREE_HUNDRED_THOUSAND' | 'THREE_HUNDRED_THOUSAND_TO_FIVE_HUNDRED_THOUSAND' | 'FIVE_HUNDRED_THOUSAND_TO_ONE_MILLION' | 'ONE_MILLION_TO_TWO_MILLION' | 'TWO_MILLION_TO_THREE_MILLION' | 'THREE_MILLION_TO_FIVE_MILLION' | 'FIVE_MILLION_TO_TEN_MILLION' | 'TEN_MILLION_TO_TWENTY_MILLION' | 'TWENTY_MILLION_TO_THIRTY_MILLION' | 'THIRTY_MILLION_TO_FIFTY_MILLION' | 'OVER_FIFTY_MILLION' — Output only. Size range in terms of number of users of the UserList, for Search ads. This field is read-only. - `type` 'UNSPECIFIED' | 'UNKNOWN' | 'REMARKETING' | 'LOGICAL' | 'EXTERNAL_REMARKETING' | 'RULE_BASED' | 'SIMILAR' | 'CRM_BASED' | 'LOOKALIKE' — Output only. Type of this list. This field is read-only. - `membershipStatus` 'UNSPECIFIED' | 'UNKNOWN' | 'OPEN' | 'CLOSED' — Membership status of this user list. Indicates whether a user list is open or active. Only open user lists can accumulate more users and can be targeted to. - `basicUserList` GoogleAdsSearchads360V23CommonBasicUserListInfo - `actions` GoogleAdsSearchads360V23CommonUserListActionInfo[] — Actions associated with this user list. - `conversionAction` string — A conversion action that's not generated from remarketing. - `remarketingAction` string — A remarketing action. - `lookalikeUserList` GoogleAdsSearchads360V23CommonLookalikeUserListInfo — LookalikeUserlist, composed of users similar to those of a configurable seed (set of UserLists) - `expansionLevel` 'UNSPECIFIED' | 'UNKNOWN' | 'NARROW' | 'BALANCED' | 'BROAD' — Expansion level, reflecting the size of the lookalike audience - `seedUserListIds` string[] — Seed UserList ID from which this list is derived, provided by user. - `countryCodes` string[] — Countries targeted by the Lookalike. Two-letter country code as defined by ISO-3166 - `ruleBasedUserList` GoogleAdsSearchads360V23CommonRuleBasedUserListInfo — Representation of a userlist that is generated by a rule. - `flexibleRuleUserList` GoogleAdsSearchads360V23CommonFlexibleRuleUserListInfo — Flexible rule representation of visitors with one or multiple actions. The flexible user list is defined by two lists of operands – inclusive_operands and exclusive_operands; 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. - `exclusiveOperands` GoogleAdsSearchads360V23CommonFlexibleRuleOperandInfo[] — 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` GoogleAdsSearchads360V23CommonUserListRuleInfo — A client defined rule based on custom parameters sent by web sites or uploaded by the advertiser. - … - `lookbackWindowDays` string, int64 — Lookback window for this rule in days. From now until X days ago. - `inclusiveOperands` GoogleAdsSearchads360V23CommonFlexibleRuleOperandInfo[] — 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 inclusive_rule_operator. - `rule` GoogleAdsSearchads360V23CommonUserListRuleInfo — A client defined rule based on custom parameters sent by web sites or uploaded by the advertiser. - … - `lookbackWindowDays` string, int64 — Lookback window for this rule in days. From now until X days ago. - `inclusiveRuleOperator` 'UNSPECIFIED' | 'UNKNOWN' | 'AND' | 'OR' — Operator that defines how the inclusive operands are combined. - `prepopulationStatus` 'UNSPECIFIED' | 'UNKNOWN' | 'REQUESTED' | 'FINISHED' | 'FAILED' — 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. - `readOnly` boolean — Output only. An option that indicates if a user may edit a list. Depends on the list ownership and list type. For example, external remarketing user lists are not editable. This field is -only. - `matchRatePercentage` integer — Output only. Indicates match rate for Customer Match lists. The range of this field is [0-100]. This will be null for other list types or when it's not possible to calculate the match rate. This field is read-only. - `integrationCode` string — An ID from external system. It is used by user list sellers to correlate IDs on their systems. - `resourceName` string — Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}` - `accessReason` 'UNSPECIFIED' | 'UNKNOWN' | 'OWNED' | 'SHARED' | 'LICENSED' | 'SUBSCRIBED' | 'AFFILIATED' — Output only. Indicates the reason this account has been granted access to the list. The reason can be SHARED, OWNED, LICENSED or SUBSCRIBED. This field is read-only. - `description` string — Description of this user list. - `crmBasedUserList` GoogleAdsSearchads360V23CommonCrmBasedUserListInfo — UserList of CRM users provided by the advertiser. - `appId` 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. - `dataSourceType` 'UNSPECIFIED' | 'UNKNOWN' | 'FIRST_PARTY' | 'THIRD_PARTY_CREDIT_BUREAU' | 'THIRD_PARTY_VOTER_FILE' | 'THIRD_PARTY_PARTNER_DATA' — Data source of the list. Default value is FIRST_PARTY. Only customers on the allow-list can create third-party sourced CRM lists. - `uploadKeyType` 'UNSPECIFIED' | 'UNKNOWN' | 'CONTACT_INFO' | 'CRM_ID' | 'MOBILE_ADVERTISING_ID' — Matching key type of the list. Mixed data types are not allowed on the same list. This field is required for an ADD operation. - `logicalUserList` GoogleAdsSearchads360V23CommonLogicalUserListInfo — Represents a user list that is a custom combination of user lists. - `rules` GoogleAdsSearchads360V23CommonUserListLogicalRuleInfo[] — 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` 'UNSPECIFIED' | 'UNKNOWN' | 'ALL' | 'ANY' | 'NONE' — The logical operator of the rule. - `ruleOperands` GoogleAdsSearchads360V23CommonLogicalUserListOperandInfo[] — The list of operands of the rule. - `userList` string — Resource name of a user list as an operand. - `eligibleForDisplay` boolean — Output only. Indicates this user list is eligible for Google Display Network. This field is read-only. - `id` string, int64 — Output only. Id of the user list. - `eligibleForSearch` boolean — Indicates if this user list is eligible for Google Search Network. - `similarUserList` GoogleAdsSearchads360V23CommonSimilarUserListInfo — SimilarUserList is a list of users which are similar to users from another UserList. These lists are read-only and automatically created by Google. - `seedUserList` string — Seed UserList from which this list is derived. - `update` GoogleAdsSearchads360V23ResourcesUserList — A user list. This is a list of users a customer may target. The unique key of a user list consists of the following fields: `id`. Note that the `name` must also be unique for user lists owned by a given customer, except in some cases where `access_reason` is set to `SHARED`. Violating the unique name constraint produces error: `UserListError.INVALID_NAME`. - `name` string — Name of this user list. Unique per user list, except in some cases where a user list of the same name has `access_reason` set to `SHARED`. - `sizeForSearch` string, int64 — Output only. Estimated number of users in this user list in the google.com domain. These are the users available for targeting in Search campaigns. This value is null if the number of users has not yet been determined. This field is read-only. - `sizeForDisplay` string, int64 — Output only. Estimated number of users in this user list, on the Google Display Network. This value is if the number of users has not yet been determined. This field is -only. - `accountUserListStatus` 'UNSPECIFIED' | 'UNKNOWN' | 'ENABLED' | 'DISABLED' — Indicates if this share is still enabled. When a UserList is shared with the user this field is set to ENABLED. Later the userList owner can decide to revoke the share and make it DISABLED. The default value of this field is set to ENABLED. - `closingReason` 'UNSPECIFIED' | 'UNKNOWN' | 'UNUSED' — Indicating the reason why this user list membership status is closed. It is only populated on lists that were automatically closed due to inactivity, and will be cleared once the list membership status becomes open. - `membershipLifeSpan` string, int64 — Number of days a user's cookie stays on your list since its most recent addition to the list. This field must be between 0 and 540 inclusive. However, for CRM based userlists, this field can be set to 10000 which means no expiration. Beginning on April 7, 2025, using a value of 10000 to indicate no expiration will no longer be supported. This field is ignored for logical_user_list and rule_based_user_list types. Membership to lists of these types depends on the rules defined by the lists. - `sizeRangeForDisplay` 'UNSPECIFIED' | 'UNKNOWN' | 'LESS_THAN_FIVE_HUNDRED' | 'LESS_THAN_ONE_THOUSAND' | 'ONE_THOUSAND_TO_TEN_THOUSAND' | 'TEN_THOUSAND_TO_FIFTY_THOUSAND' | 'FIFTY_THOUSAND_TO_ONE_HUNDRED_THOUSAND' | 'ONE_HUNDRED_THOUSAND_TO_THREE_HUNDRED_THOUSAND' | 'THREE_HUNDRED_THOUSAND_TO_FIVE_HUNDRED_THOUSAND' | 'FIVE_HUNDRED_THOUSAND_TO_ONE_MILLION' | 'ONE_MILLION_TO_TWO_MILLION' | 'TWO_MILLION_TO_THREE_MILLION' | 'THREE_MILLION_TO_FIVE_MILLION' | 'FIVE_MILLION_TO_TEN_MILLION' | 'TEN_MILLION_TO_TWENTY_MILLION' | 'TWENTY_MILLION_TO_THIRTY_MILLION' | 'THIRTY_MILLION_TO_FIFTY_MILLION' | 'OVER_FIFTY_MILLION' — Output only. Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only. - `sizeRangeForSearch` 'UNSPECIFIED' | 'UNKNOWN' | 'LESS_THAN_FIVE_HUNDRED' | 'LESS_THAN_ONE_THOUSAND' | 'ONE_THOUSAND_TO_TEN_THOUSAND' | 'TEN_THOUSAND_TO_FIFTY_THOUSAND' | 'FIFTY_THOUSAND_TO_ONE_HUNDRED_THOUSAND' | 'ONE_HUNDRED_THOUSAND_TO_THREE_HUNDRED_THOUSAND' | 'THREE_HUNDRED_THOUSAND_TO_FIVE_HUNDRED_THOUSAND' | 'FIVE_HUNDRED_THOUSAND_TO_ONE_MILLION' | 'ONE_MILLION_TO_TWO_MILLION' | 'TWO_MILLION_TO_THREE_MILLION' | 'THREE_MILLION_TO_FIVE_MILLION' | 'FIVE_MILLION_TO_TEN_MILLION' | 'TEN_MILLION_TO_TWENTY_MILLION' | 'TWENTY_MILLION_TO_THIRTY_MILLION' | 'THIRTY_MILLION_TO_FIFTY_MILLION' | 'OVER_FIFTY_MILLION' — Output only. Size range in terms of number of users of the UserList, for Search ads. This field is read-only. - `type` 'UNSPECIFIED' | 'UNKNOWN' | 'REMARKETING' | 'LOGICAL' | 'EXTERNAL_REMARKETING' | 'RULE_BASED' | 'SIMILAR' | 'CRM_BASED' | 'LOOKALIKE' — Output only. Type of this list. This field is read-only. - `membershipStatus` 'UNSPECIFIED' | 'UNKNOWN' | 'OPEN' | 'CLOSED' — Membership status of this user list. Indicates whether a user list is open or active. Only open user lists can accumulate more users and can be targeted to. - `basicUserList` GoogleAdsSearchads360V23CommonBasicUserListInfo - `actions` GoogleAdsSearchads360V23CommonUserListActionInfo[] — Actions associated with this user list. - `conversionAction` string — A conversion action that's not generated from remarketing. - `remarketingAction` string — A remarketing action. - `lookalikeUserList` GoogleAdsSearchads360V23CommonLookalikeUserListInfo — LookalikeUserlist, composed of users similar to those of a configurable seed (set of UserLists) - `expansionLevel` 'UNSPECIFIED' | 'UNKNOWN' | 'NARROW' | 'BALANCED' | 'BROAD' — Expansion level, reflecting the size of the lookalike audience - `seedUserListIds` string[] — Seed UserList ID from which this list is derived, provided by user. - `countryCodes` string[] — Countries targeted by the Lookalike. Two-letter country code as defined by ISO-3166 - `ruleBasedUserList` GoogleAdsSearchads360V23CommonRuleBasedUserListInfo — Representation of a userlist that is generated by a rule. - `flexibleRuleUserList` GoogleAdsSearchads360V23CommonFlexibleRuleUserListInfo — Flexible rule representation of visitors with one or multiple actions. The flexible user list is defined by two lists of operands – inclusive_operands and exclusive_operands; 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. - `exclusiveOperands` GoogleAdsSearchads360V23CommonFlexibleRuleOperandInfo[] — 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` GoogleAdsSearchads360V23CommonUserListRuleInfo — A client defined rule based on custom parameters sent by web sites or uploaded by the advertiser. - … - `lookbackWindowDays` string, int64 — Lookback window for this rule in days. From now until X days ago. - `inclusiveOperands` GoogleAdsSearchads360V23CommonFlexibleRuleOperandInfo[] — 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 inclusive_rule_operator. - `rule` GoogleAdsSearchads360V23CommonUserListRuleInfo — A client defined rule based on custom parameters sent by web sites or uploaded by the advertiser. - … - `lookbackWindowDays` string, int64 — Lookback window for this rule in days. From now until X days ago. - `inclusiveRuleOperator` 'UNSPECIFIED' | 'UNKNOWN' | 'AND' | 'OR' — Operator that defines how the inclusive operands are combined. - `prepopulationStatus` 'UNSPECIFIED' | 'UNKNOWN' | 'REQUESTED' | 'FINISHED' | 'FAILED' — 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. - `readOnly` boolean — Output only. An option that indicates if a user may edit a list. Depends on the list ownership and list type. For example, external remarketing user lists are not editable. This field is -only. - `matchRatePercentage` integer — Output only. Indicates match rate for Customer Match lists. The range of this field is [0-100]. This will be null for other list types or when it's not possible to calculate the match rate. This field is read-only. - `integrationCode` string — An ID from external system. It is used by user list sellers to correlate IDs on their systems. - `resourceName` string — Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}` - `accessReason` 'UNSPECIFIED' | 'UNKNOWN' | 'OWNED' | 'SHARED' | 'LICENSED' | 'SUBSCRIBED' | 'AFFILIATED' — Output only. Indicates the reason this account has been granted access to the list. The reason can be SHARED, OWNED, LICENSED or SUBSCRIBED. This field is read-only. - `description` string — Description of this user list. - `crmBasedUserList` GoogleAdsSearchads360V23CommonCrmBasedUserListInfo — UserList of CRM users provided by the advertiser. - `appId` 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. - `dataSourceType` 'UNSPECIFIED' | 'UNKNOWN' | 'FIRST_PARTY' | 'THIRD_PARTY_CREDIT_BUREAU' | 'THIRD_PARTY_VOTER_FILE' | 'THIRD_PARTY_PARTNER_DATA' — Data source of the list. Default value is FIRST_PARTY. Only customers on the allow-list can create third-party sourced CRM lists. - `uploadKeyType` 'UNSPECIFIED' | 'UNKNOWN' | 'CONTACT_INFO' | 'CRM_ID' | 'MOBILE_ADVERTISING_ID' — Matching key type of the list. Mixed data types are not allowed on the same list. This field is required for an ADD operation. - `logicalUserList` GoogleAdsSearchads360V23CommonLogicalUserListInfo — Represents a user list that is a custom combination of user lists. - `rules` GoogleAdsSearchads360V23CommonUserListLogicalRuleInfo[] — 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` 'UNSPECIFIED' | 'UNKNOWN' | 'ALL' | 'ANY' | 'NONE' — The logical operator of the rule. - `ruleOperands` GoogleAdsSearchads360V23CommonLogicalUserListOperandInfo[] — The list of operands of the rule. - `userList` string — Resource name of a user list as an operand. - `eligibleForDisplay` boolean — Output only. Indicates this user list is eligible for Google Display Network. This field is read-only. - `id` string, int64 — Output only. Id of the user list. - `eligibleForSearch` boolean — Indicates if this user list is eligible for Google Search Network. - `similarUserList` GoogleAdsSearchads360V23CommonSimilarUserListInfo — SimilarUserList is a list of users which are similar to users from another UserList. These lists are read-only and automatically created by Google. - `seedUserList` string — Seed UserList from which this list is derived. - `updateMask` string, google-fieldmask — FieldMask that determines which resource fields are modified in an update. - `remove` string — Remove operation: A resource name for the removed user list is expected, in this format: `customers/{customer_id}/userLists/{user_list_id}` - `partialFailure` boolean — If true, successful operations will be carried out and invalid operations will return errors. If false, all operations will be carried out in one transaction if and only if they are all valid. Default is false. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/searchads360.md) · [All operations](https://skmtc.net/google/apis/searchads360/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/searchads360/versions/40d087435afd/schema)