Web Service: UserService

Port type UserServiceInterfaceSource code

1. createUsers
   Source code
   Description:
   Creates new {@link User} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   createUsersRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type createUsers

   Creates new {@link User} objects.

   • users - optional, unbounded; type User - extension of type UserRecord
     Represents a user of the system.

     Users may be assigned at most one {@link Role} per network. Each role provides a user with permissions to perform specific operations. Without a role, they will not be able to perform any actions.

     The {@code UserRecord} represents the base class from which a {@code User} is derived.
     • id - optional; type long
       The unique ID of the {@code User}. This attribute is readonly and is assigned by Google.
     • name - optional; type string
       The name of the {@code User}. It has a maximum length of 128 characters.
     • email - optional; type string
       The email or login of the {@code User}. In order to create a new user, you must already have a Google Account.
     • roleId - optional; type long
       The unique role ID of the {@code User}. Roles that are created by Google will have negative IDs.
     • roleName - optional; type string
       The name of the role assigned to the {@code User}. This attribute is readonly.
     • isActive - optional; type boolean
       Specifies whether or not the {@code User} is active. An inactive user cannot log in to the system or perform any operations. This attribute is read-only.
     • externalId - optional; type string
       An identifier for the {@code User} that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters.
     • isServiceAccount - optional; type boolean
       Whether the user is an OAuth2 service account user. This attribute is read-only. Service account users can only be added through the UI.
     • ordersUiLocalTimeZoneId - optional; type string
       The long format timezone id (e.g. "America/Los_Angeles") used in the orders and line items UI for this {@code User}. Set this to {@code null} to indicate that no such value is defined for the {@code User} - UI then defaults to using the Network's timezone.

       This setting only affects the UI for this user and does not in particular affect the timezone of any dates and times returned in API responses.

   Output:
   createUsersResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createUsersResponse

   • rval - optional, unbounded; type User - extension of type UserRecord
     Represents a user of the system.

     Users may be assigned at most one {@link Role} per network. Each role provides a user with permissions to perform specific operations. Without a role, they will not be able to perform any actions.

     The {@code UserRecord} represents the base class from which a {@code User} is derived.
     • id - optional; type long
       The unique ID of the {@code User}. This attribute is readonly and is assigned by Google.
     • name - optional; type string
       The name of the {@code User}. It has a maximum length of 128 characters.
     • email - optional; type string
       The email or login of the {@code User}. In order to create a new user, you must already have a Google Account.
     • roleId - optional; type long
       The unique role ID of the {@code User}. Roles that are created by Google will have negative IDs.
     • roleName - optional; type string
       The name of the role assigned to the {@code User}. This attribute is readonly.
     • isActive - optional; type boolean
       Specifies whether or not the {@code User} is active. An inactive user cannot log in to the system or perform any operations. This attribute is read-only.
     • externalId - optional; type string
       An identifier for the {@code User} that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters.
     • isServiceAccount - optional; type boolean
       Whether the user is an OAuth2 service account user. This attribute is read-only. Service account users can only be added through the UI.
     • ordersUiLocalTimeZoneId - optional; type string
       The long format timezone id (e.g. "America/Los_Angeles") used in the orders and line items UI for this {@code User}. Set this to {@code null} to indicate that no such value is defined for the {@code User} - UI then defaults to using the Network's timezone.

       This setting only affects the UI for this user and does not in particular affect the timezone of any dates and times returned in API responses.

   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
2. getAllRoles
   Source code
   Description:
   Returns the {@link Role} objects that are defined for the users of the network.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getAllRolesRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getAllRoles

   Returns the {@link Role} objects that are defined for the users of the network.
   Output:
   getAllRolesResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getAllRolesResponse

   • rval - optional, unbounded; type Role
     Each {@code Role} provides a user with permissions to perform specific operations in the system.
     • id - optional; type long
       The unique ID of the role. This value is readonly and is assigned by Google. Roles that are created by Google will have negative IDs.
     • name - optional; type string
       The name of the role. This value is readonly and is assigned by Google.
     • description - optional; type string
       The description of the role. This value is readonly and is assigned by Google.
     • status - optional; type RoleStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       The status of the {@link Role}. This field is read-only and can have the values {@link RoleStatus#ACTIVE} (default) or {@link RoleStatus#INACTIVE}, which determines the visibility of the role in the UI.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
3. getCurrentUser
   Source code
   Description:
   Returns the current {@link User}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getCurrentUserRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getCurrentUser

   Returns the current {@link User}.
   Output:
   getCurrentUserResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getCurrentUserResponse

   • rval - optional; type User - extension of type UserRecord
     Represents a user of the system.

     Users may be assigned at most one {@link Role} per network. Each role provides a user with permissions to perform specific operations. Without a role, they will not be able to perform any actions.

     The {@code UserRecord} represents the base class from which a {@code User} is derived.
     • id - optional; type long
       The unique ID of the {@code User}. This attribute is readonly and is assigned by Google.
     • name - optional; type string
       The name of the {@code User}. It has a maximum length of 128 characters.
     • email - optional; type string
       The email or login of the {@code User}. In order to create a new user, you must already have a Google Account.
     • roleId - optional; type long
       The unique role ID of the {@code User}. Roles that are created by Google will have negative IDs.
     • roleName - optional; type string
       The name of the role assigned to the {@code User}. This attribute is readonly.
     • isActive - optional; type boolean
       Specifies whether or not the {@code User} is active. An inactive user cannot log in to the system or perform any operations. This attribute is read-only.
     • externalId - optional; type string
       An identifier for the {@code User} that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters.
     • isServiceAccount - optional; type boolean
       Whether the user is an OAuth2 service account user. This attribute is read-only. Service account users can only be added through the UI.
     • ordersUiLocalTimeZoneId - optional; type string
       The long format timezone id (e.g. "America/Los_Angeles") used in the orders and line items UI for this {@code User}. Set this to {@code null} to indicate that no such value is defined for the {@code User} - UI then defaults to using the Network's timezone.

       This setting only affects the UI for this user and does not in particular affect the timezone of any dates and times returned in API responses.

   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
4. getUsersByStatement
   Source code
   Description:
   Gets a {@link UserPage} of {@link User} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code email}	{@link User#email}
   {@code id}	{@link User#id}
   {@code name}	{@link User#name}
   {@code roleId}	{@link User#roleId}
   {@code rolename}	{@link User#roleName}
   {@code status}	{@code ACTIVE} if {@link User#isActive} is true; {@code INACTIVE} otherwise

   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getUsersByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getUsersByStatement

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

   PQL Property	Object Property
   {@code email}	{@link User#email}
   {@code id}	{@link User#id}
   {@code name}	{@link User#name}
   {@code roleId}	{@link User#roleId}
   {@code rolename}	{@link User#roleName}
   {@code status}	{@code ACTIVE} if {@link User#isActive} is true; {@code INACTIVE} otherwise

   • filterStatement - optional; type Statement
     Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.

     An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

     Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

     An example of such a query might be {@code "WHERE id = :idValue"}.

     Statements also support use of the LIKE keyword. This provides wildcard string matching.

     An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.

     The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
     • query - optional; type string
       Holds the query in PQL syntax. The syntax is:
       [WHERE {[AND | OR] ...}]
[ORDER BY [ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
       

       
            := {< | <= | > | >= | = | != }

     := {< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
       

     • values - optional, unbounded; type String_ValueMapEntry
       Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.

       In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.

       This represents an entry in a map with a key of type String and value of type Value.
       • key - optional; type string
       • value - optional; type Value
         {@code Value} represents a value.
   Output:
   getUsersByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getUsersByStatementResponse

   • rval - optional; type UserPage
     Captures a page of {@link User} objects
     • totalResultSetSize - optional; type int
       The size of the total result set to which this page belongs.
     • startIndex - optional; type int
       The absolute index in the total result set on which this page begins.
     • results - optional, unbounded; type User - extension of type UserRecord
       Represents a user of the system.

       Users may be assigned at most one {@link Role} per network. Each role provides a user with permissions to perform specific operations. Without a role, they will not be able to perform any actions.

       The {@code UserRecord} represents the base class from which a {@code User} is derived.
       • id - optional; type long
         The unique ID of the {@code User}. This attribute is readonly and is assigned by Google.
       • name - optional; type string
         The name of the {@code User}. It has a maximum length of 128 characters.
       • email - optional; type string
         The email or login of the {@code User}. In order to create a new user, you must already have a Google Account.
       • roleId - optional; type long
         The unique role ID of the {@code User}. Roles that are created by Google will have negative IDs.
       • roleName - optional; type string
         The name of the role assigned to the {@code User}. This attribute is readonly.
       • isActive - optional; type boolean
         Specifies whether or not the {@code User} is active. An inactive user cannot log in to the system or perform any operations. This attribute is read-only.
       • externalId - optional; type string
         An identifier for the {@code User} that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters.
       • isServiceAccount - optional; type boolean
         Whether the user is an OAuth2 service account user. This attribute is read-only. Service account users can only be added through the UI.
       • ordersUiLocalTimeZoneId - optional; type string
         The long format timezone id (e.g. "America/Los_Angeles") used in the orders and line items UI for this {@code User}. Set this to {@code null} to indicate that no such value is defined for the {@code User} - UI then defaults to using the Network's timezone.

         This setting only affects the UI for this user and does not in particular affect the timezone of any dates and times returned in API responses.

       The collection of users contained within this page.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
5. performUserAction
   Source code
   Description:
   Performs actions on {@link User} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performUserActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performUserAction

   Performs actions on {@link User} objects that match the given {@link Statement#query}.

   • userAction - optional; type UserAction
     Represents the actions that can be performed on {@link User} objects.
     • filterStatement - optional; type Statement
       Captures the {@code WHERE}, {@code ORDER BY} and {@code LIMIT} clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.

       An example query text might be {@code "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30"}.

       Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

       An example of such a query might be {@code "WHERE id = :idValue"}.

       Statements also support use of the LIKE keyword. This provides wildcard string matching.

       An example of such a query might be {@code "WHERE name LIKE '%searchString%'"}.

       The value for the variable idValue must then be set with an object of type {@link Value}, e.g., {@link NumberValue}, {@link TextValue} or {@link BooleanValue}.
       • query - optional; type string
         Holds the query in PQL syntax. The syntax is:
         [WHERE {[AND | OR] ...}]
[ORDER BY [ASC | DESC]]
[LIMIT {[,] } | { OFFSET }]
         

         
              := {< | <= | > | >= | = | != }

     := {< | <= | > | >= | = | != }
:= IN
:= IS NULL
:= LIKE
:= :
         

       • values - optional, unbounded; type String_ValueMapEntry
         Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.

         In the example {@code "WHERE status = :bindStatus ORDER BY id LIMIT 30"}, the bind variable, represented by {@code :bindStatus} is named {@code bindStatus}, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type {@link TextValue}. The final result, for example, would be an entry of {@code "bindStatus" => StringParam("ACTIVE")}.

         This represents an entry in a map with a key of type String and value of type Value.
         • key - optional; type string
         • value - optional; type Value
           {@code Value} represents a value.
   Output:
   performUserActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type performUserActionResponse

   • rval - optional; type UpdateResult
     Represents the result of performing an action on objects.
     • numChanges - optional; type int
       The number of objects that were changed as a result of performing the action.
   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.
6. updateUsers
   Source code
   Description:
   Updates the specified {@link User} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   updateUsersRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type updateUsers

   Updates the specified {@link User} objects.

   • users - optional, unbounded; type User - extension of type UserRecord
     Represents a user of the system.

     Users may be assigned at most one {@link Role} per network. Each role provides a user with permissions to perform specific operations. Without a role, they will not be able to perform any actions.

     The {@code UserRecord} represents the base class from which a {@code User} is derived.
     • id - optional; type long
       The unique ID of the {@code User}. This attribute is readonly and is assigned by Google.
     • name - optional; type string
       The name of the {@code User}. It has a maximum length of 128 characters.
     • email - optional; type string
       The email or login of the {@code User}. In order to create a new user, you must already have a Google Account.
     • roleId - optional; type long
       The unique role ID of the {@code User}. Roles that are created by Google will have negative IDs.
     • roleName - optional; type string
       The name of the role assigned to the {@code User}. This attribute is readonly.
     • isActive - optional; type boolean
       Specifies whether or not the {@code User} is active. An inactive user cannot log in to the system or perform any operations. This attribute is read-only.
     • externalId - optional; type string
       An identifier for the {@code User} that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters.
     • isServiceAccount - optional; type boolean
       Whether the user is an OAuth2 service account user. This attribute is read-only. Service account users can only be added through the UI.
     • ordersUiLocalTimeZoneId - optional; type string
       The long format timezone id (e.g. "America/Los_Angeles") used in the orders and line items UI for this {@code User}. Set this to {@code null} to indicate that no such value is defined for the {@code User} - UI then defaults to using the Network's timezone.

       This setting only affects the UI for this user and does not in particular affect the timezone of any dates and times returned in API responses.

   Output:
   updateUsersResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateUsersResponse

   • rval - optional, unbounded; type User - extension of type UserRecord
     Represents a user of the system.

     Users may be assigned at most one {@link Role} per network. Each role provides a user with permissions to perform specific operations. Without a role, they will not be able to perform any actions.

     The {@code UserRecord} represents the base class from which a {@code User} is derived.
     • id - optional; type long
       The unique ID of the {@code User}. This attribute is readonly and is assigned by Google.
     • name - optional; type string
       The name of the {@code User}. It has a maximum length of 128 characters.
     • email - optional; type string
       The email or login of the {@code User}. In order to create a new user, you must already have a Google Account.
     • roleId - optional; type long
       The unique role ID of the {@code User}. Roles that are created by Google will have negative IDs.
     • roleName - optional; type string
       The name of the role assigned to the {@code User}. This attribute is readonly.
     • isActive - optional; type boolean
       Specifies whether or not the {@code User} is active. An inactive user cannot log in to the system or perform any operations. This attribute is read-only.
     • externalId - optional; type string
       An identifier for the {@code User} that is meaningful to the publisher. This attribute is optional and has a maximum length of 255 characters.
     • isServiceAccount - optional; type boolean
       Whether the user is an OAuth2 service account user. This attribute is read-only. Service account users can only be added through the UI.
     • ordersUiLocalTimeZoneId - optional; type string
       The long format timezone id (e.g. "America/Los_Angeles") used in the orders and line items UI for this {@code User}. Set this to {@code null} to indicate that no such value is defined for the {@code User} - UI then defaults to using the Network's timezone.

       This setting only affects the UI for this user and does not in particular affect the timezone of any dates and times returned in API responses.

   Fault:
   ApiException (wsdlsoap:fault, use = literal)Source code
   ApiException type ApiExceptionFault

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

   • errors - optional, unbounded; type ApiError
     The API error base class that provides details about an error that occurred while processing a service request.

     The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

     • fieldPath - optional; type string
       The OGNL field path to identify cause of error.
     • fieldPathElements - optional, unbounded; type FieldPathElement
       A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.
       A segment of a field path. Each dot in a field path defines a new segment.
       • field - optional; type string
         The name of a field in lower camelcase. (e.g. "biddingStrategy")
       • index - optional; type int
         For list fields, this is a 0-indexed position in the list. Null for non-list fields.
     • trigger - optional; type string
       The data that caused the error.
     • errorString - optional; type string
       A simple string representation of the error and reason.
     List of errors.

   A fault element of type ApiException.