UserService (v202505)

Provides operations for creating, updating and retrieving User objects.

A user is assigned one of several different roles. Each Role type has a unique ID that is used to identify that role in an organization. Role types and their IDs can be retrieved by invoking getAllRoles.

---

Production WSDL

https://ads.google.com/apis/ads/publisher/v202505/UserService?wsdl

Namespace

https://www.google.com/apis/ads/publisher/v202505

Operations

• createUsers
• getAllRoles
• getCurrentUser
• getUsersByStatement
• performUserAction
• updateUsers

Errors

• ApiVersionError
• AuthenticationError
• CollectionSizeError
• CommonError
• CustomFieldValueError
• EntityLimitReachedError
• FeatureError
• InternalApiError
• InvalidEmailError
• NotNullError
• ParseError
• PermissionError
• PublisherQueryLanguageContextError
• PublisherQueryLanguageSyntaxError
• QuotaError
• RequiredCollectionError
• RequiredError
• ServerError
• StatementError
• StringFormatError
• StringLengthError
• TeamError
• TimeZoneError
• TokenError
• TypeError
• UniqueError

createUsers

Creates new User objects.

Parameters

Field	Type	Description
users	User[]

Response

Field	Type	Description
rval	User[]

getAllRoles

Returns the Role objects that are defined for the users of the network.

Parameters

Field	Type	Description

Response

Field	Type	Description
rval	Role[]

getCurrentUser

Returns the current User.

Parameters

Field	Type	Description

Response

Field	Type	Description
rval	User

getUsersByStatement

Gets a UserPage of User objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
email	User.email
id	User.id
name	User.name
roleId	User.roleId
rolename	User.roleName
status	ACTIVE if User.isActive is true; INACTIVE otherwise

Parameters

Field	Type	Description
filterStatement	Statement

Response

Field	Type	Description
rval	UserPage

performUserAction

Performs actions on User objects that match the given Statement.query.

Parameters

Field	Type	Description
userAction	UserAction ActivateUsers DeactivateUsers
filterStatement	Statement

Response

Field	Type	Description
rval	UpdateResult

updateUsers

Updates the specified User objects.

Parameters

Field	Type	Description
users	User[]

Response

Field	Type	Description
rval	User[]

Errors

Error	Reasons
ApiVersionError	Errors related to the usage of API versions. Enumerations UPDATE_TO_NEWER_VERSION Indicates that the operation is not allowed in the version the request was made in. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
AuthenticationError	An error for an exception that occurred when authenticating. Enumerations AMBIGUOUS_SOAP_REQUEST_HEADER The SOAP message contains a request header with an ambiguous definition of the authentication header fields. This means either the authToken and oAuthToken fields were both null or both were specified. Exactly one value should be specified with each request. INVALID_EMAIL The login provided is invalid. AUTHENTICATION_FAILED Tried to authenticate with provided information, but failed. INVALID_OAUTH_SIGNATURE The OAuth provided is invalid. INVALID_SERVICE The specified service to use was not recognized. MISSING_SOAP_REQUEST_HEADER The SOAP message is missing a request header with an authToken and optional networkCode. MISSING_AUTHENTICATION_HTTP_HEADER The HTTP request is missing a request header with an authToken MISSING_AUTHENTICATION The request is missing an authToken NETWORK_API_ACCESS_DISABLED The network does not have API access enabled. NO_NETWORKS_TO_ACCESS The user is not associated with any network. NETWORK_NOT_FOUND No network for the given networkCode was found. NETWORK_CODE_REQUIRED The user has access to more than one network, but did not provide a networkCode. CONNECTION_ERROR An error happened on the server side during connection to authentication service. GOOGLE_ACCOUNT_ALREADY_ASSOCIATED_WITH_NETWORK The user tried to create a test network using an account that already is associated with a network. UNDER_INVESTIGATION The account is blocked and under investigation by the collections team. Please contact Google for more information. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
CollectionSizeError	Error for the size of the collection being too large Enumerations TOO_LARGE UNKNOWN The value returned if the actual value is not exposed by the requested API version.
CommonError	A place for common errors that can be used across services. Enumerations NOT_FOUND Indicates that an attempt was made to retrieve an entity that does not exist. ALREADY_EXISTS Indicates that an attempt was made to create an entity that already exists. NOT_APPLICABLE Indicates that a value is not applicable for given use case. DUPLICATE_OBJECT Indicates that two elements in the collection were identical. CANNOT_UPDATE Indicates that an attempt was made to change an immutable field. UNSUPPORTED_OPERATION Indicates that the requested operation is not supported. CONCURRENT_MODIFICATION Indicates that another request attempted to update the same data in the same network at about the same time. Please wait and try the request again. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
CustomFieldValueError	Errors specific to editing custom field values Enumerations CUSTOM_FIELD_NOT_FOUND An attempt was made to modify or create a CustomFieldValue for a CustomField that does not exist. CUSTOM_FIELD_INACTIVE An attempt was made to create a new value for a custom field that is inactive. CUSTOM_FIELD_OPTION_NOT_FOUND An attempt was made to modify or create a CustomFieldValue corresponding to a CustomFieldOption that could not be found. INVALID_ENTITY_TYPE An attempt was made to modify or create a CustomFieldValue with an association to an entity of the wrong type for its field. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
EntityLimitReachedError	An error that occurs when creating an entity if the limit on the number of allowed entities for a network has already been reached. Enumerations CUSTOM_TARGETING_VALUES_LIMIT_REACHED The number of custom targeting values exceeds the max number allowed in the network. AD_EXCLUSION_RULES_LIMIT_REACHED The number of ad exclusion rules exceeds the max number allowed in the network. FIRST_PARTY_AUDIENCE_SEGMENTS_LIMIT_REACHED The number of first party audience segments exceeds the max number allowed in the network. PLACEMENTS_LIMIT_REACHED The number of active placements exceeds the max number allowed in the network. LINE_ITEMS_LIMIT_REACHED The number of line items excceeds the max number allowed in the network. ACTIVE_LINE_ITEMS_LIMIT_REACHED The number of active line items exceeds the max number allowed in the network. DAI_ENCODING_PROFILES_LIMIT_REACHED The number of not-archived encoding profiles exceeds the max number allowed in the network. TRAFFIC_FORECAST_SEGMENTS_LIMIT_REACHED The number of traffic forecast segments exceeds the max number allowed in the network. FORECAST_ADJUSTMENTS_LIMIT_REACHED The number of forecast adjustments exceeds the max number allowed in the network. ACTIVE_EXPERIMENTS_LIMIT_REACHED The number of active experiments exceeds the max number allowed in the network. SITES_LIMIT_REACHED The number of sites exceeds the max number allowed in the network. USER_TEAMS_LIMIT_REACHED The number of teams on the user exceeds the max number allowed. ACTIVE_TARGETING_PRESETS_LIMIT_REACHED The count of active targeting presets exceeds the limit. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
FeatureError	Errors related to feature management. If you attempt using a feature that is not available to the current network you'll receive a FeatureError with the missing feature as the trigger. Enumerations MISSING_FEATURE A feature is being used that is not enabled on the current network. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
InternalApiError	Indicates that a server-side error has occured. InternalApiErrors are generally not the result of an invalid request or message sent by the client. Enumerations UNEXPECTED_INTERNAL_API_ERROR API encountered an unexpected internal error. TRANSIENT_ERROR A temporary error occurred during the request. Please retry. UNKNOWN The cause of the error is not known or only defined in newer versions. DOWNTIME The API is currently unavailable for a planned downtime. ERROR_GENERATING_RESPONSE Mutate succeeded but server was unable to build response. Client should not retry mutate.
InvalidEmailError	Caused by supplying a value for an email attribute that is not a valid email address. Enumerations INVALID_FORMAT The value is not a valid email address. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
NotNullError	Caused by supplying a null value for an attribute that cannot be null. Enumerations ARG1_NULL Assuming that a method will not have more than 3 arguments, if it does, return NULL ARG2_NULL ARG3_NULL NULL UNKNOWN The value returned if the actual value is not exposed by the requested API version.
ParseError	Lists errors related to parsing. Enumerations UNPARSABLE Indicates an error in parsing an attribute. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
PermissionError	Errors related to incorrect permission. Enumerations PERMISSION_DENIED User does not have the required permission for the request. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
PublisherQueryLanguageContextError	An error that occurs while executing a PQL query contained in a Statement object. Enumerations UNEXECUTABLE Indicates that there was an error executing the PQL. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
PublisherQueryLanguageSyntaxError	An error that occurs while parsing a PQL query contained in a Statement object. Enumerations UNPARSABLE Indicates that there was a PQL syntax error. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
QuotaError	Describes a client-side error on which a user is attempting to perform an action to which they have no quota remaining. Enumerations EXCEEDED_QUOTA The number of requests made per second is too high and has exceeded the allowable limit. The recommended approach to handle this error is to wait about 5 seconds and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time. Another way to mitigate this error is to limit requests to 8 per second for Ad Manager 360 accounts, or 2 per second for Ad Manager accounts. Once again this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error. UNKNOWN The value returned if the actual value is not exposed by the requested API version. REPORT_JOB_LIMIT This user has exceeded the allowed number of new report requests per hour (this includes both reports run via the UI and reports run via ReportService.runReportJob). The recommended approach to handle this error is to wait about 10 minutes and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time. Another way to mitigate this error is to limit the number of new report requests to 250 per hour per user. Once again, this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error. SEGMENT_POPULATION_LIMIT This network has exceeded the allowed number of identifiers uploaded within a 24 hour period. The recommended approach to handle this error is to wait 30 minutes and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time.
RequiredCollectionError	A list of all errors to be used for validating sizes of collections. Enumerations REQUIRED A required collection is missing. TOO_LARGE Collection size is too large. TOO_SMALL Collection size is too small. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
RequiredError	Errors due to missing required field. Enumerations REQUIRED Missing required field.
ServerError	Errors related to the server. Enumerations SERVER_ERROR Indicates that an unexpected error occured. SERVER_BUSY Indicates that the server is currently experiencing a high load. Please wait and try your request again. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
StatementError	An error that occurs while parsing Statement objects. Enumerations VARIABLE_NOT_BOUND_TO_VALUE A bind variable has not been bound to a value. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
StringFormatError	A list of error code for reporting invalid content of input strings. Enumerations UNKNOWN ILLEGAL_CHARS The input string value contains disallowed characters. INVALID_FORMAT The input string value is invalid for the associated field.
StringLengthError	Errors for Strings which do not meet given length constraints. Enumerations TOO_LONG TOO_SHORT UNKNOWN The value returned if the actual value is not exposed by the requested API version.
TeamError	Errors related to a Team. Enumerations ENTITY_NOT_ON_USERS_TEAMS User cannot use this entity because it is not on any of the user's teams. AD_UNITS_NOT_ON_ORDER_TEAMS The targeted or excluded ad unit must be on the order's teams. PLACEMENTS_NOT_ON_ORDER_TEAMS The targeted placement must be on the order's teams. MISSING_USERS_TEAM Entity cannot be created because it is not on any of the user's teams. ALL_TEAM_ASSOCIATION_NOT_ALLOWED A team that gives access to all entities of a given type cannot be associated with an entity of that type. INVALID_TEAM_ASSIGNMENT The assignment of team to entities is invalid. CANNOT_UPDATE_INACTIVE_TEAM Cannot modify or create a team with an inactive status. UNKNOWN The value returned if the actual value is not exposed by the requested API version.
TimeZoneError	Errors related to timezones. Enumerations INVALID_TIMEZONE_ID Indicates that the timezone ID provided is not supported. TIMEZONE_ID_IN_WRONG_FORMAT Indicates that the timezone ID provided is in the wrong format. The timezone ID must be in tz database format (e.g. "America/Los_Angeles"). UNKNOWN The value returned if the actual value is not exposed by the requested API version.
TokenError	An error for an exception that occurred when using a token. Enumerations INVALID EXPIRED UNKNOWN The value returned if the actual value is not exposed by the requested API version.
TypeError	An error for a field which is an invalid type.
UniqueError	An error for a field which must satisfy a uniqueness constraint