Web Service: AudienceSegmentService

Port type AudienceSegmentServiceInterfaceSource code

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

   Creates new {@link FirstPartyAudienceSegment} objects.

   • segments - optional, unbounded; type FirstPartyAudienceSegment - extension of type AudienceSegment
     A {@link FirstPartyAudienceSegment} is an {@link AudienceSegment} owned by the publisher network.
     An {@link AudienceSegment} represents audience segment object.
     • id - optional; type long
       Id of the {@link AudienceSegment}. This attribute is readonly and is populated by Google.
     • name - optional; type string
       Name of the {@link AudienceSegment}. This attribute is required and has a maximum length of 255 characters.
     • categoryIds - optional, unbounded; type long
       The ids of the categories this segment belongs to. This field is optional, it may be empty.
     • description - optional; type string
       Description of the {@link AudienceSegment}. This attribute is optional and has a maximum length of 8192 characters.
     • status - optional; type AudienceSegment.Status - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE', 'UNUSED' }
       Status of the {@link AudienceSegment}. This controls whether the given segment is available for targeting or not. During creation this attribute is optional and defaults to {@code ACTIVE}. This attribute is readonly for updates.
     • size - optional; type long
       Number of unique identifiers in the {@link AudienceSegment}. This attribute is readonly and is populated by Google.
     • mobileWebSize - optional; type long
       Number of unique identifiers in the {@link AudienceSegment} for mobile web. This attribute is read-only.
     • idfaSize - optional; type long
       Number of unique IDFA identifiers in the {@link AudienceSegment}. This attribute is read-only.
     • adIdSize - optional; type long
       Number of unique AdID identifiers in the {@link AudienceSegment}. This attribute is read-only.
     • ppidSize - optional; type long
       Number of unique PPID (publisher provided identifiers) in the {@link AudienceSegment}. This attribute is read-only.
     • dataProvider - optional; type AudienceSegmentDataProvider
       Data provider that owns this segment. For a {@link FirstPartyAudienceSegment}, it would be the publisher network. For a {@link SharedAudienceSegment} or a {@link ThirdPartyAudienceSegment}, it would be the entity that provides that {@link AudienceSegment}.
       • name - optional; type string
         Name of the data provider. This attribute is readonly and is assigned by Google.
       Owner data provider of this segment. This attribute is readonly and is assigned by Google.
     • type - optional; type AudienceSegment.Type - type string with restriction - enum { 'FIRST_PARTY', 'SHARED', 'THIRD_PARTY', 'UNKNOWN' }
       Type of the segment. This attribute is readonly and is assigned by Google.
   Output:
   createAudienceSegmentsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createAudienceSegmentsResponse

   • rval - optional, unbounded; type FirstPartyAudienceSegment - extension of type AudienceSegment
     A {@link FirstPartyAudienceSegment} is an {@link AudienceSegment} owned by the publisher network.
     An {@link AudienceSegment} represents audience segment object.
     • id - optional; type long
       Id of the {@link AudienceSegment}. This attribute is readonly and is populated by Google.
     • name - optional; type string
       Name of the {@link AudienceSegment}. This attribute is required and has a maximum length of 255 characters.
     • categoryIds - optional, unbounded; type long
       The ids of the categories this segment belongs to. This field is optional, it may be empty.
     • description - optional; type string
       Description of the {@link AudienceSegment}. This attribute is optional and has a maximum length of 8192 characters.
     • status - optional; type AudienceSegment.Status - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE', 'UNUSED' }
       Status of the {@link AudienceSegment}. This controls whether the given segment is available for targeting or not. During creation this attribute is optional and defaults to {@code ACTIVE}. This attribute is readonly for updates.
     • size - optional; type long
       Number of unique identifiers in the {@link AudienceSegment}. This attribute is readonly and is populated by Google.
     • mobileWebSize - optional; type long
       Number of unique identifiers in the {@link AudienceSegment} for mobile web. This attribute is read-only.
     • idfaSize - optional; type long
       Number of unique IDFA identifiers in the {@link AudienceSegment}. This attribute is read-only.
     • adIdSize - optional; type long
       Number of unique AdID identifiers in the {@link AudienceSegment}. This attribute is read-only.
     • ppidSize - optional; type long
       Number of unique PPID (publisher provided identifiers) in the {@link AudienceSegment}. This attribute is read-only.
     • dataProvider - optional; type AudienceSegmentDataProvider
       Data provider that owns this segment. For a {@link FirstPartyAudienceSegment}, it would be the publisher network. For a {@link SharedAudienceSegment} or a {@link ThirdPartyAudienceSegment}, it would be the entity that provides that {@link AudienceSegment}.
       • name - optional; type string
         Name of the data provider. This attribute is readonly and is assigned by Google.
       Owner data provider of this segment. This attribute is readonly and is assigned by Google.
     • type - optional; type AudienceSegment.Type - type string with restriction - enum { 'FIRST_PARTY', 'SHARED', 'THIRD_PARTY', 'UNKNOWN' }
       Type of the segment. This attribute is readonly and is assigned by Google.
   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. getAudienceSegmentsByStatement
   Source code
   Description:
   Gets an {@link AudienceSegmentPage} of {@link AudienceSegment} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link AudienceSegment#id}
   {@code name}	{@link AudienceSegment#name}
   {@code status}	{@link AudienceSegment#status}
   {@code type}	{@link AudienceSegment#type}
   {@code size}	{@link AudienceSegment#size}
   {@code dataProviderName}	{@link AudienceSegmentDataProvider#name}
   {@code segmentType}	{@link AudienceSegment#type}
   {@code approvalStatus}	{@link ThirdPartyAudienceSegment#approvalStatus}
   {@code cost}	{@link ThirdPartyAudienceSegment#cost}
   {@code startDateTime}	{@link ThirdPartyAudienceSegment#startDateTime}
   {@code endDateTime}	{@link ThirdPartyAudienceSegment#endDateTime}

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

   Gets an {@link AudienceSegmentPage} of {@link AudienceSegment} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link AudienceSegment#id}
   {@code name}	{@link AudienceSegment#name}
   {@code status}	{@link AudienceSegment#status}
   {@code type}	{@link AudienceSegment#type}
   {@code size}	{@link AudienceSegment#size}
   {@code dataProviderName}	{@link AudienceSegmentDataProvider#name}
   {@code segmentType}	{@link AudienceSegment#type}
   {@code approvalStatus}	{@link ThirdPartyAudienceSegment#approvalStatus}
   {@code cost}	{@link ThirdPartyAudienceSegment#cost}
   {@code startDateTime}	{@link ThirdPartyAudienceSegment#startDateTime}
   {@code endDateTime}	{@link ThirdPartyAudienceSegment#endDateTime}

   • 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:
   getAudienceSegmentsByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getAudienceSegmentsByStatementResponse

   • rval - optional; type AudienceSegmentPage
     Represents a page of {@link AudienceSegment} 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 AudienceSegment
       The collection of audience segments contained within this page.
       An {@link AudienceSegment} represents audience segment object.
       • id - optional; type long
         Id of the {@link AudienceSegment}. This attribute is readonly and is populated by Google.
       • name - optional; type string
         Name of the {@link AudienceSegment}. This attribute is required and has a maximum length of 255 characters.
       • categoryIds - optional, unbounded; type long
         The ids of the categories this segment belongs to. This field is optional, it may be empty.
       • description - optional; type string
         Description of the {@link AudienceSegment}. This attribute is optional and has a maximum length of 8192 characters.
       • status - optional; type AudienceSegment.Status - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE', 'UNUSED' }
         Status of the {@link AudienceSegment}. This controls whether the given segment is available for targeting or not. During creation this attribute is optional and defaults to {@code ACTIVE}. This attribute is readonly for updates.
       • size - optional; type long
         Number of unique identifiers in the {@link AudienceSegment}. This attribute is readonly and is populated by Google.
       • mobileWebSize - optional; type long
         Number of unique identifiers in the {@link AudienceSegment} for mobile web. This attribute is read-only.
       • idfaSize - optional; type long
         Number of unique IDFA identifiers in the {@link AudienceSegment}. This attribute is read-only.
       • adIdSize - optional; type long
         Number of unique AdID identifiers in the {@link AudienceSegment}. This attribute is read-only.
       • ppidSize - optional; type long
         Number of unique PPID (publisher provided identifiers) in the {@link AudienceSegment}. This attribute is read-only.
       • dataProvider - optional; type AudienceSegmentDataProvider
         Data provider that owns this segment. For a {@link FirstPartyAudienceSegment}, it would be the publisher network. For a {@link SharedAudienceSegment} or a {@link ThirdPartyAudienceSegment}, it would be the entity that provides that {@link AudienceSegment}.
         • name - optional; type string
           Name of the data provider. This attribute is readonly and is assigned by Google.
         Owner data provider of this segment. This attribute is readonly and is assigned by Google.
       • type - optional; type AudienceSegment.Type - type string with restriction - enum { 'FIRST_PARTY', 'SHARED', 'THIRD_PARTY', 'UNKNOWN' }
         Type of the segment. This attribute is readonly and is assigned by Google.
   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. performAudienceSegmentAction
   Source code
   Description:
   Performs the given {@link AudienceSegmentAction} on the set of segments identified by the given statement.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performAudienceSegmentActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performAudienceSegmentAction

   Performs the given {@link AudienceSegmentAction} on the set of segments identified by the given statement.

   • action - optional; type AudienceSegmentAction
     Action that can be performed on {@link AudienceSegment} 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:
   performAudienceSegmentActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type performAudienceSegmentActionResponse

   • 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.
4. updateAudienceSegments
   Source code
   Description:
   Updates the given {@link FirstPartyAudienceSegment} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   updateAudienceSegmentsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type updateAudienceSegments

   Updates the given {@link FirstPartyAudienceSegment} objects.

   • segments - optional, unbounded; type FirstPartyAudienceSegment - extension of type AudienceSegment
     A {@link FirstPartyAudienceSegment} is an {@link AudienceSegment} owned by the publisher network.
     An {@link AudienceSegment} represents audience segment object.
     • id - optional; type long
       Id of the {@link AudienceSegment}. This attribute is readonly and is populated by Google.
     • name - optional; type string
       Name of the {@link AudienceSegment}. This attribute is required and has a maximum length of 255 characters.
     • categoryIds - optional, unbounded; type long
       The ids of the categories this segment belongs to. This field is optional, it may be empty.
     • description - optional; type string
       Description of the {@link AudienceSegment}. This attribute is optional and has a maximum length of 8192 characters.
     • status - optional; type AudienceSegment.Status - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE', 'UNUSED' }
       Status of the {@link AudienceSegment}. This controls whether the given segment is available for targeting or not. During creation this attribute is optional and defaults to {@code ACTIVE}. This attribute is readonly for updates.
     • size - optional; type long
       Number of unique identifiers in the {@link AudienceSegment}. This attribute is readonly and is populated by Google.
     • mobileWebSize - optional; type long
       Number of unique identifiers in the {@link AudienceSegment} for mobile web. This attribute is read-only.
     • idfaSize - optional; type long
       Number of unique IDFA identifiers in the {@link AudienceSegment}. This attribute is read-only.
     • adIdSize - optional; type long
       Number of unique AdID identifiers in the {@link AudienceSegment}. This attribute is read-only.
     • ppidSize - optional; type long
       Number of unique PPID (publisher provided identifiers) in the {@link AudienceSegment}. This attribute is read-only.
     • dataProvider - optional; type AudienceSegmentDataProvider
       Data provider that owns this segment. For a {@link FirstPartyAudienceSegment}, it would be the publisher network. For a {@link SharedAudienceSegment} or a {@link ThirdPartyAudienceSegment}, it would be the entity that provides that {@link AudienceSegment}.
       • name - optional; type string
         Name of the data provider. This attribute is readonly and is assigned by Google.
       Owner data provider of this segment. This attribute is readonly and is assigned by Google.
     • type - optional; type AudienceSegment.Type - type string with restriction - enum { 'FIRST_PARTY', 'SHARED', 'THIRD_PARTY', 'UNKNOWN' }
       Type of the segment. This attribute is readonly and is assigned by Google.
   Output:
   updateAudienceSegmentsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateAudienceSegmentsResponse

   • rval - optional, unbounded; type FirstPartyAudienceSegment - extension of type AudienceSegment
     A {@link FirstPartyAudienceSegment} is an {@link AudienceSegment} owned by the publisher network.
     An {@link AudienceSegment} represents audience segment object.
     • id - optional; type long
       Id of the {@link AudienceSegment}. This attribute is readonly and is populated by Google.
     • name - optional; type string
       Name of the {@link AudienceSegment}. This attribute is required and has a maximum length of 255 characters.
     • categoryIds - optional, unbounded; type long
       The ids of the categories this segment belongs to. This field is optional, it may be empty.
     • description - optional; type string
       Description of the {@link AudienceSegment}. This attribute is optional and has a maximum length of 8192 characters.
     • status - optional; type AudienceSegment.Status - type string with restriction - enum { 'UNKNOWN', 'ACTIVE', 'INACTIVE', 'UNUSED' }
       Status of the {@link AudienceSegment}. This controls whether the given segment is available for targeting or not. During creation this attribute is optional and defaults to {@code ACTIVE}. This attribute is readonly for updates.
     • size - optional; type long
       Number of unique identifiers in the {@link AudienceSegment}. This attribute is readonly and is populated by Google.
     • mobileWebSize - optional; type long
       Number of unique identifiers in the {@link AudienceSegment} for mobile web. This attribute is read-only.
     • idfaSize - optional; type long
       Number of unique IDFA identifiers in the {@link AudienceSegment}. This attribute is read-only.
     • adIdSize - optional; type long
       Number of unique AdID identifiers in the {@link AudienceSegment}. This attribute is read-only.
     • ppidSize - optional; type long
       Number of unique PPID (publisher provided identifiers) in the {@link AudienceSegment}. This attribute is read-only.
     • dataProvider - optional; type AudienceSegmentDataProvider
       Data provider that owns this segment. For a {@link FirstPartyAudienceSegment}, it would be the publisher network. For a {@link SharedAudienceSegment} or a {@link ThirdPartyAudienceSegment}, it would be the entity that provides that {@link AudienceSegment}.
       • name - optional; type string
         Name of the data provider. This attribute is readonly and is assigned by Google.
       Owner data provider of this segment. This attribute is readonly and is assigned by Google.
     • type - optional; type AudienceSegment.Type - type string with restriction - enum { 'FIRST_PARTY', 'SHARED', 'THIRD_PARTY', 'UNKNOWN' }
       Type of the segment. This attribute is readonly and is assigned by Google.
   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.