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/v202405/UserService?wsdl
- Namespace
-
https://www.google.com/apis/ads/publisher/v202405
- Operations
- 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
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
getAllRoles
Returns the Role objects that are defined for the users of the network.
Parameters
Field | Type | Description |
---|
Response
Field | Type | Description |
---|---|---|
rval
|
|
getCurrentUser
Returns the current User.
Parameters
Field | Type | Description |
---|
Response
Field | Type | Description |
---|---|---|
rval
|
|
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
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
performUserAction
Performs actions on User objects that match the given Statement.query.
Parameters
Field | Type | Description |
---|---|---|
userAction
|
|
|
filterStatement
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
updateUsers
Updates the specified User objects.
Parameters
Field | Type | Description |
---|---|---|
users
|
|
Response
Field | Type | Description |
---|---|---|
rval
|
|
Errors
Error | Reasons |
---|---|
ApiVersionError
|
Errors related to the usage of API versions.
Enumerations
|
AuthenticationError
|
An error for an exception that occurred when authenticating.
Enumerations
|
CollectionSizeError
|
Error for the size of the collection being too large
Enumerations
|
CommonError
|
A place for common errors that can be used across services.
Enumerations
|
CustomFieldValueError
|
Errors specific to editing custom field values
Enumerations
|
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
|
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
|
InternalApiError
|
Indicates that a server-side error has occured. InternalApiError s
are generally not the result of an invalid request or message sent by the
client.
Enumerations
|
InvalidEmailError
|
Caused by supplying a value for an email attribute that is not a valid
email address.
Enumerations
|
NotNullError
|
Caused by supplying a null value for an attribute that cannot be null.
Enumerations
|
ParseError
|
Lists errors related to parsing.
Enumerations
|
PermissionError
|
Errors related to incorrect permission.
Enumerations
|
PublisherQueryLanguageContextError
|
An error that occurs while executing a PQL query contained in
a Statement object.
Enumerations
|
PublisherQueryLanguageSyntaxError
|
An error that occurs while parsing a PQL query contained in a
Statement object.
Enumerations
|
QuotaError
|
Describes a client-side error on which a user is attempting
to perform an action to which they have no quota remaining.
Enumerations
|
RequiredCollectionError
|
A list of all errors to be used for validating sizes of collections.
Enumerations
|
RequiredError
|
Errors due to missing required field.
Enumerations
|
ServerError
|
Errors related to the server.
Enumerations
|
StatementError
|
An error that occurs while parsing Statement objects.
Enumerations
|
StringFormatError
|
A list of error code for reporting invalid content of input strings.
Enumerations
|
StringLengthError
|
Errors for Strings which do not meet given length constraints.
Enumerations
|
TeamError
|
Errors related to a Team.
Enumerations
|
TimeZoneError
|
Errors related to timezones.
Enumerations
|
TokenError
|
An error for an exception that occurred when using a token.
Enumerations
|
TypeError
|
An error for a field which is an invalid type. |
UniqueError
|
An error for a field which must satisfy a uniqueness constraint |