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]()

mutate(customerId, body=None, x__xgafv=None)

Args:
customerId: string, Required. The ID of the customer whose user lists are being modified. (required)
body: object, The request body.
The object takes the form of:

{ # Request message for UserListService.MutateUserLists.
"operations": [ # Required. The list of operations to perform on individual user lists.
{ # A single operation (create, update) on a user list.
"create": { # 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`. # Create operation: No resource name is expected for the new user list.
"accessReason": "A String", # 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.
"accountUserListStatus": "A String", # 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.
"basicUserList": { # User list targeting as a collection of conversion or remarketing actions.
"actions": [ # Actions associated with this user list.
{ # Represents an action type used for building remarketing user lists.
"conversionAction": "A String", # A conversion action that's not generated from remarketing.
"remarketingAction": "A String", # A remarketing action.
},
],
},
"closingReason": "A String", # 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.
"crmBasedUserList": { # UserList of CRM users provided by the advertiser. # User list of CRM users provided by the advertiser.
"appId": "A 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": "A String", # Data source of the list. Default value is FIRST_PARTY. Only customers on the allow-list can create third-party sourced CRM lists.
"uploadKeyType": "A String", # Matching key type of the list. Mixed data types are not allowed on the same list. This field is required for an ADD operation.
},
"description": "A String", # Description of this user list.
"eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network. This field is read-only.
"eligibleForSearch": True or False, # Indicates if this user list is eligible for Google Search Network.
"id": "A String", # Output only. Id of the user list.
"integrationCode": "A String", # An ID from external system. It is used by user list sellers to correlate IDs on their systems.
"logicalUserList": { # Represents a user list that is a custom combination of user lists. # User list that is a custom combination of user lists.
"rules": [ # 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.
{ # A user list logical rule. A rule has a logical operator (and/or/not) and a list of user lists as operands.
"operator": "A String", # The logical operator of the rule.
"ruleOperands": [ # The list of operands of the rule.
{ # Operand of logical user list that consists of a user list.
"userList": "A String", # Resource name of a user list as an operand.
},
],
},
],
},
"lookalikeUserList": { # LookalikeUserlist, composed of users similar to those of a configurable seed (set of UserLists) # Immutable. Lookalike User List.
"countryCodes": [ # Countries targeted by the Lookalike. Two-letter country code as defined by ISO-3166
"A String",
],
"expansionLevel": "A String", # Expansion level, reflecting the size of the lookalike audience
"seedUserListIds": [ # Seed UserList ID from which this list is derived, provided by user.
"A String",
],
},
"matchRatePercentage": 42, # 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.
"membershipLifeSpan": "A String", # 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.
"membershipStatus": "A String", # 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.
"name": "A 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`.
"readOnly": True or False, # 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.
"resourceName": "A String", # Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}`
"ruleBasedUserList": { # Representation of a userlist that is generated by a rule. # User list generated by a rule.
"flexibleRuleUserList": { # 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. # 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": [ # 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.
{ # Flexible rule that wraps the common rule and a lookback window.
"lookbackWindowDays": "A String", # Lookback window for this rule in days. From now until X days ago.
"rule": { # A client defined rule based on custom parameters sent by web sites or uploaded by the advertiser. # List of rule item groups that defines this rule. Rule item groups are grouped together.
"ruleItemGroups": [ # List of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
{ # A group of rule items.
"ruleItems": [ # Rule items that will be grouped together based on rule_type.
{ # An atomic rule item.
"dateRuleItem": { # A rule item composed of a date operation. # An atomic rule item composed of a date operation.
"offsetInDays": "A String", # 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.
"operator": "A String", # Date comparison operator. This field is required and must be populated when creating new date rule item.
"value": "A 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.
},
"name": "A 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.
"numberRuleItem": { # A rule item composed of a number operation. # An atomic rule item composed of a number operation.
"operator": "A String", # Number comparison operator. This field is required and must be populated when creating a new number rule item.
"value": 3.14, # Number value to be compared with the variable. This field is required and must be populated when creating a new number rule item.
},
"stringRuleItem": { # A rule item composed of a string operation. # An atomic rule item composed of a string operation.
"operator": "A String", # String comparison operator. This field is required and must be populated when creating a new string rule item.
"value": "A 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.
},
},
],
},
],
"ruleType": "A String", # 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.
},
},
],
"inclusiveOperands": [ # 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.
{ # Flexible rule that wraps the common rule and a lookback window.
"lookbackWindowDays": "A String", # Lookback window for this rule in days. From now until X days ago.
"rule": { # A client defined rule based on custom parameters sent by web sites or uploaded by the advertiser. # List of rule item groups that defines this rule. Rule item groups are grouped together.
"ruleItemGroups": [ # List of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
{ # A group of rule items.
"ruleItems": [ # Rule items that will be grouped together based on rule_type.
{ # An atomic rule item.
"dateRuleItem": { # A rule item composed of a date operation. # An atomic rule item composed of a date operation.
"offsetInDays": "A String", # 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.
"operator": "A String", # Date comparison operator. This field is required and must be populated when creating new date rule item.
"value": "A 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.
},
"name": "A 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.
"numberRuleItem": { # A rule item composed of a number operation. # An atomic rule item composed of a number operation.
"operator": "A String", # Number comparison operator. This field is required and must be populated when creating a new number rule item.
"value": 3.14, # Number value to be compared with the variable. This field is required and must be populated when creating a new number rule item.
},
"stringRuleItem": { # A rule item composed of a string operation. # An atomic rule item composed of a string operation.
"operator": "A String", # String comparison operator. This field is required and must be populated when creating a new string rule item.
"value": "A 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.
},
},
],
},
],
"ruleType": "A String", # 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.
},
},
],
"inclusiveRuleOperator": "A String", # Operator that defines how the inclusive operands are combined.
},
"prepopulationStatus": "A String", # 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.
},
"similarUserList": { # SimilarUserList is a list of users which are similar to users from another UserList. These lists are read-only and automatically created by Google. # Output only. User list which are similar to users from another UserList. These lists are readonly and automatically created by google.
"seedUserList": "A String", # Seed UserList from which this list is derived.
},
"sizeForDisplay": "A String", # 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.
"sizeForSearch": "A String", # 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.
"sizeRangeForDisplay": "A String", # Output only. Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only.
"sizeRangeForSearch": "A String", # Output only. Size range in terms of number of users of the UserList, for Search ads. This field is read-only.
"type": "A String", # Output only. Type of this list. This field is read-only.
},
"remove": "A String", # Remove operation: A resource name for the removed user list is expected, in this format: `customers/{customer_id}/userLists/{user_list_id}`
"update": { # 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`. # Update operation: The user list is expected to have a valid resource name.
"accessReason": "A String", # 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.
"accountUserListStatus": "A String", # 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.
"basicUserList": { # User list targeting as a collection of conversion or remarketing actions.
"actions": [ # Actions associated with this user list.
{ # Represents an action type used for building remarketing user lists.
"conversionAction": "A String", # A conversion action that's not generated from remarketing.
"remarketingAction": "A String", # A remarketing action.
},
],
},
"closingReason": "A String", # 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.
"crmBasedUserList": { # UserList of CRM users provided by the advertiser. # User list of CRM users provided by the advertiser.
"appId": "A 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": "A String", # Data source of the list. Default value is FIRST_PARTY. Only customers on the allow-list can create third-party sourced CRM lists.
"uploadKeyType": "A String", # Matching key type of the list. Mixed data types are not allowed on the same list. This field is required for an ADD operation.
},
"description": "A String", # Description of this user list.
"eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network. This field is read-only.
"eligibleForSearch": True or False, # Indicates if this user list is eligible for Google Search Network.
"id": "A String", # Output only. Id of the user list.
"integrationCode": "A String", # An ID from external system. It is used by user list sellers to correlate IDs on their systems.
"logicalUserList": { # Represents a user list that is a custom combination of user lists. # User list that is a custom combination of user lists.
"rules": [ # 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.
{ # A user list logical rule. A rule has a logical operator (and/or/not) and a list of user lists as operands.
"operator": "A String", # The logical operator of the rule.
"ruleOperands": [ # The list of operands of the rule.
{ # Operand of logical user list that consists of a user list.
"userList": "A String", # Resource name of a user list as an operand.
},
],
},
],
},
"lookalikeUserList": { # LookalikeUserlist, composed of users similar to those of a configurable seed (set of UserLists) # Immutable. Lookalike User List.
"countryCodes": [ # Countries targeted by the Lookalike. Two-letter country code as defined by ISO-3166
"A String",
],
"expansionLevel": "A String", # Expansion level, reflecting the size of the lookalike audience
"seedUserListIds": [ # Seed UserList ID from which this list is derived, provided by user.
"A String",
],
},
"matchRatePercentage": 42, # 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.
"membershipLifeSpan": "A String", # 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.
"membershipStatus": "A String", # 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.
"name": "A 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`.
"readOnly": True or False, # 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.
"resourceName": "A String", # Immutable. The resource name of the user list. User list resource names have the form: `customers/{customer_id}/userLists/{user_list_id}`
"ruleBasedUserList": { # Representation of a userlist that is generated by a rule. # User list generated by a rule.
"flexibleRuleUserList": { # 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. # 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": [ # 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.
{ # Flexible rule that wraps the common rule and a lookback window.
"lookbackWindowDays": "A String", # Lookback window for this rule in days. From now until X days ago.
"rule": { # A client defined rule based on custom parameters sent by web sites or uploaded by the advertiser. # List of rule item groups that defines this rule. Rule item groups are grouped together.
"ruleItemGroups": [ # List of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
{ # A group of rule items.
"ruleItems": [ # Rule items that will be grouped together based on rule_type.
{ # An atomic rule item.
"dateRuleItem": { # A rule item composed of a date operation. # An atomic rule item composed of a date operation.
"offsetInDays": "A String", # 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.
"operator": "A String", # Date comparison operator. This field is required and must be populated when creating new date rule item.
"value": "A 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.
},
"name": "A 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.
"numberRuleItem": { # A rule item composed of a number operation. # An atomic rule item composed of a number operation.
"operator": "A String", # Number comparison operator. This field is required and must be populated when creating a new number rule item.
"value": 3.14, # Number value to be compared with the variable. This field is required and must be populated when creating a new number rule item.
},
"stringRuleItem": { # A rule item composed of a string operation. # An atomic rule item composed of a string operation.
"operator": "A String", # String comparison operator. This field is required and must be populated when creating a new string rule item.
"value": "A 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.
},
},
],
},
],
"ruleType": "A String", # 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.
},
},
],
"inclusiveOperands": [ # 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.
{ # Flexible rule that wraps the common rule and a lookback window.
"lookbackWindowDays": "A String", # Lookback window for this rule in days. From now until X days ago.
"rule": { # A client defined rule based on custom parameters sent by web sites or uploaded by the advertiser. # List of rule item groups that defines this rule. Rule item groups are grouped together.
"ruleItemGroups": [ # List of rule item groups that defines this rule. Rule item groups are grouped together based on rule_type.
{ # A group of rule items.
"ruleItems": [ # Rule items that will be grouped together based on rule_type.
{ # An atomic rule item.
"dateRuleItem": { # A rule item composed of a date operation. # An atomic rule item composed of a date operation.
"offsetInDays": "A String", # 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.
"operator": "A String", # Date comparison operator. This field is required and must be populated when creating new date rule item.
"value": "A 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.
},
"name": "A 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.
"numberRuleItem": { # A rule item composed of a number operation. # An atomic rule item composed of a number operation.
"operator": "A String", # Number comparison operator. This field is required and must be populated when creating a new number rule item.
"value": 3.14, # Number value to be compared with the variable. This field is required and must be populated when creating a new number rule item.
},
"stringRuleItem": { # A rule item composed of a string operation. # An atomic rule item composed of a string operation.
"operator": "A String", # String comparison operator. This field is required and must be populated when creating a new string rule item.
"value": "A 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.
},
},
],
},
],
"ruleType": "A String", # 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.
},
},
],
"inclusiveRuleOperator": "A String", # Operator that defines how the inclusive operands are combined.
},
"prepopulationStatus": "A String", # 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.
},
"similarUserList": { # SimilarUserList is a list of users which are similar to users from another UserList. These lists are read-only and automatically created by Google. # Output only. User list which are similar to users from another UserList. These lists are readonly and automatically created by google.
"seedUserList": "A String", # Seed UserList from which this list is derived.
},
"sizeForDisplay": "A String", # 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.
"sizeForSearch": "A String", # 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.
"sizeRangeForDisplay": "A String", # Output only. Size range in terms of number of users of the UserList, on the Google Display Network. This field is read-only.
"sizeRangeForSearch": "A String", # Output only. Size range in terms of number of users of the UserList, for Search ads. This field is read-only.
"type": "A String", # Output only. Type of this list. This field is read-only.
},
"updateMask": "A String", # FieldMask that determines which resource fields are modified in an update.
},
],
"partialFailure": True or False, # 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.
"validateOnly": True or False, # If true, the request is validated but not executed. Only errors are returned, not results.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response message for user list mutate.
"partialFailureError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Errors that pertain to operation failures in the partial failure mode. Returned only when partial_failure = true and all errors occur inside the operations. If any errors occur outside the operations (for example, auth errors), we return an RPC level error.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"results": [ # All results for the mutate.
{ # The result for the user list mutate.
"resourceName": "A String", # Returned for successful operations.
},
],
}

Search Ads 360 Reporting API . customers . userLists

Instance Methods

Method Details