Web Service: CustomFieldService

Port type CustomFieldServiceInterfaceSource code

1. createCustomFieldOptions
   Source code
   Description:
   Creates new {@link CustomFieldOption} objects.

   The following fields are required:

   • {@link CustomFieldOption#displayName}
   • {@link CustomFieldOption#customFieldId}
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   createCustomFieldOptionsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type createCustomFieldOptions

   Creates new {@link CustomFieldOption} objects.

   The following fields are required:

   • {@link CustomFieldOption#displayName}
   • {@link CustomFieldOption#customFieldId}

   • customFieldOptions - optional, unbounded; type CustomFieldOption
     An option represents a permitted value for a custom field that has a {@link CustomField#dataType} of {@link CustomFieldDataType#DROP_DOWN}.
     • id - optional; type long
       Unique ID of this option. This value is readonly and is assigned by Google.
     • customFieldId - optional; type long
       The id of the custom field this option belongs to.
     • displayName - optional; type string
       The display name of this option.
   Output:
   createCustomFieldOptionsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createCustomFieldOptionsResponse

   • rval - optional, unbounded; type CustomFieldOption
     An option represents a permitted value for a custom field that has a {@link CustomField#dataType} of {@link CustomFieldDataType#DROP_DOWN}.
     • id - optional; type long
       Unique ID of this option. This value is readonly and is assigned by Google.
     • customFieldId - optional; type long
       The id of the custom field this option belongs to.
     • displayName - optional; type string
       The display name of this option.
   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. createCustomFields
   Source code
   Description:
   Creates new {@link CustomField} objects.

   The following fields are required:

   • {@link CustomField#name}
   • {@link CustomField#entityType}
   • {@link CustomField#dataType}
   • {@link CustomField#visibility}
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   createCustomFieldsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type createCustomFields

   Creates new {@link CustomField} objects.

   The following fields are required:

   • {@link CustomField#name}
   • {@link CustomField#entityType}
   • {@link CustomField#dataType}
   • {@link CustomField#visibility}

   • customFields - optional, unbounded; type CustomField
     An additional, user-created field on an entity.
     • id - optional; type long
       Unique ID of the {@code CustomField}. This value is readonly and is assigned by Google.
     • name - optional; type string
       Name of the {@code CustomField}. This is value is required to create a custom field. The max length is 127 characters.
     • description - optional; type string
       A description of the custom field. This value is optional. The maximum length is 511 characters
     • isActive - optional; type boolean
       Specifies whether or not the custom fields is active. This attribute is read-only.
     • entityType - optional; type CustomFieldEntityType - type string with restriction - enum { 'LINE_ITEM', 'ORDER', 'CREATIVE', 'PROPOSAL', 'PROPOSAL_LINE_ITEM', 'UNKNOWN' }
       The type of entity that this custom field is associated with. This attribute is read-only if there exists a {@link CustomFieldValue} for this field.
     • dataType - optional; type CustomFieldDataType - type string with restriction - enum { 'STRING', 'NUMBER', 'TOGGLE', 'DROP_DOWN', 'UNKNOWN' }
       The type of data this custom field contains. This attribute is read-only if there exists a {@link CustomFieldValue} for this field.
     • visibility - optional; type CustomFieldVisibility - type string with restriction - enum { 'UNKNOWN', 'API_ONLY', 'READ_ONLY', 'FULL' }
       How visible/accessible this field is in the UI.
   Output:
   createCustomFieldsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createCustomFieldsResponse

   • rval - optional, unbounded; type CustomField
     An additional, user-created field on an entity.
     • id - optional; type long
       Unique ID of the {@code CustomField}. This value is readonly and is assigned by Google.
     • name - optional; type string
       Name of the {@code CustomField}. This is value is required to create a custom field. The max length is 127 characters.
     • description - optional; type string
       A description of the custom field. This value is optional. The maximum length is 511 characters
     • isActive - optional; type boolean
       Specifies whether or not the custom fields is active. This attribute is read-only.
     • entityType - optional; type CustomFieldEntityType - type string with restriction - enum { 'LINE_ITEM', 'ORDER', 'CREATIVE', 'PROPOSAL', 'PROPOSAL_LINE_ITEM', 'UNKNOWN' }
       The type of entity that this custom field is associated with. This attribute is read-only if there exists a {@link CustomFieldValue} for this field.
     • dataType - optional; type CustomFieldDataType - type string with restriction - enum { 'STRING', 'NUMBER', 'TOGGLE', 'DROP_DOWN', 'UNKNOWN' }
       The type of data this custom field contains. This attribute is read-only if there exists a {@link CustomFieldValue} for this field.
     • visibility - optional; type CustomFieldVisibility - type string with restriction - enum { 'UNKNOWN', 'API_ONLY', 'READ_ONLY', 'FULL' }
       How visible/accessible this field is 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. getCustomFieldOption
   Source code
   Description:
   Returns the {@link CustomFieldOption} uniquely identified by the given ID.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getCustomFieldOptionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getCustomFieldOption

   Returns the {@link CustomFieldOption} uniquely identified by the given ID.

   • customFieldOptionId - optional; type long
   Output:
   getCustomFieldOptionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getCustomFieldOptionResponse

   • rval - optional; type CustomFieldOption
     An option represents a permitted value for a custom field that has a {@link CustomField#dataType} of {@link CustomFieldDataType#DROP_DOWN}.
     • id - optional; type long
       Unique ID of this option. This value is readonly and is assigned by Google.
     • customFieldId - optional; type long
       The id of the custom field this option belongs to.
     • displayName - optional; type string
       The display name of this option.
   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. getCustomFieldsByStatement
   Source code
   Description:
   Gets a {@link CustomFieldPage} of {@link CustomField} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link CustomField#id}
   {@code entityType}	{@link CustomField#entityType}
   {@code name}	{@link CustomField#name}
   {@code isActive}	{@link CustomField#isActive}
   {@code visibility}	{@link CustomField#visibility}

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

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

   PQL Property	Object Property
   {@code id}	{@link CustomField#id}
   {@code entityType}	{@link CustomField#entityType}
   {@code name}	{@link CustomField#name}
   {@code isActive}	{@link CustomField#isActive}
   {@code visibility}	{@link CustomField#visibility}

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

   • rval - optional; type CustomFieldPage
     Captures a page of {@link CustomField} 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 CustomField
       An additional, user-created field on an entity.
       • id - optional; type long
         Unique ID of the {@code CustomField}. This value is readonly and is assigned by Google.
       • name - optional; type string
         Name of the {@code CustomField}. This is value is required to create a custom field. The max length is 127 characters.
       • description - optional; type string
         A description of the custom field. This value is optional. The maximum length is 511 characters
       • isActive - optional; type boolean
         Specifies whether or not the custom fields is active. This attribute is read-only.
       • entityType - optional; type CustomFieldEntityType - type string with restriction - enum { 'LINE_ITEM', 'ORDER', 'CREATIVE', 'PROPOSAL', 'PROPOSAL_LINE_ITEM', 'UNKNOWN' }
         The type of entity that this custom field is associated with. This attribute is read-only if there exists a {@link CustomFieldValue} for this field.
       • dataType - optional; type CustomFieldDataType - type string with restriction - enum { 'STRING', 'NUMBER', 'TOGGLE', 'DROP_DOWN', 'UNKNOWN' }
         The type of data this custom field contains. This attribute is read-only if there exists a {@link CustomFieldValue} for this field.
       • visibility - optional; type CustomFieldVisibility - type string with restriction - enum { 'UNKNOWN', 'API_ONLY', 'READ_ONLY', 'FULL' }
         How visible/accessible this field is in the UI.
       The collection of custom fields 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. performCustomFieldAction
   Source code
   Description:
   Performs actions on {@link CustomField} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performCustomFieldActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performCustomFieldAction

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

   • customFieldAction - optional; type CustomFieldAction
     Represents the actions that can be performed on {@link CustomField} 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:
   performCustomFieldActionResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type performCustomFieldActionResponse

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

   Updates the specified {@link CustomFieldOption} objects.

   • customFieldOptions - optional, unbounded; type CustomFieldOption
     An option represents a permitted value for a custom field that has a {@link CustomField#dataType} of {@link CustomFieldDataType#DROP_DOWN}.
     • id - optional; type long
       Unique ID of this option. This value is readonly and is assigned by Google.
     • customFieldId - optional; type long
       The id of the custom field this option belongs to.
     • displayName - optional; type string
       The display name of this option.
   Output:
   updateCustomFieldOptionsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateCustomFieldOptionsResponse

   • rval - optional, unbounded; type CustomFieldOption
     An option represents a permitted value for a custom field that has a {@link CustomField#dataType} of {@link CustomFieldDataType#DROP_DOWN}.
     • id - optional; type long
       Unique ID of this option. This value is readonly and is assigned by Google.
     • customFieldId - optional; type long
       The id of the custom field this option belongs to.
     • displayName - optional; type string
       The display name of this option.
   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.
7. updateCustomFields
   Source code
   Description:
   Updates the specified {@link CustomField} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   updateCustomFieldsRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type updateCustomFields

   Updates the specified {@link CustomField} objects.

   • customFields - optional, unbounded; type CustomField
     An additional, user-created field on an entity.
     • id - optional; type long
       Unique ID of the {@code CustomField}. This value is readonly and is assigned by Google.
     • name - optional; type string
       Name of the {@code CustomField}. This is value is required to create a custom field. The max length is 127 characters.
     • description - optional; type string
       A description of the custom field. This value is optional. The maximum length is 511 characters
     • isActive - optional; type boolean
       Specifies whether or not the custom fields is active. This attribute is read-only.
     • entityType - optional; type CustomFieldEntityType - type string with restriction - enum { 'LINE_ITEM', 'ORDER', 'CREATIVE', 'PROPOSAL', 'PROPOSAL_LINE_ITEM', 'UNKNOWN' }
       The type of entity that this custom field is associated with. This attribute is read-only if there exists a {@link CustomFieldValue} for this field.
     • dataType - optional; type CustomFieldDataType - type string with restriction - enum { 'STRING', 'NUMBER', 'TOGGLE', 'DROP_DOWN', 'UNKNOWN' }
       The type of data this custom field contains. This attribute is read-only if there exists a {@link CustomFieldValue} for this field.
     • visibility - optional; type CustomFieldVisibility - type string with restriction - enum { 'UNKNOWN', 'API_ONLY', 'READ_ONLY', 'FULL' }
       How visible/accessible this field is in the UI.
   Output:
   updateCustomFieldsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateCustomFieldsResponse

   • rval - optional, unbounded; type CustomField
     An additional, user-created field on an entity.
     • id - optional; type long
       Unique ID of the {@code CustomField}. This value is readonly and is assigned by Google.
     • name - optional; type string
       Name of the {@code CustomField}. This is value is required to create a custom field. The max length is 127 characters.
     • description - optional; type string
       A description of the custom field. This value is optional. The maximum length is 511 characters
     • isActive - optional; type boolean
       Specifies whether or not the custom fields is active. This attribute is read-only.
     • entityType - optional; type CustomFieldEntityType - type string with restriction - enum { 'LINE_ITEM', 'ORDER', 'CREATIVE', 'PROPOSAL', 'PROPOSAL_LINE_ITEM', 'UNKNOWN' }
       The type of entity that this custom field is associated with. This attribute is read-only if there exists a {@link CustomFieldValue} for this field.
     • dataType - optional; type CustomFieldDataType - type string with restriction - enum { 'STRING', 'NUMBER', 'TOGGLE', 'DROP_DOWN', 'UNKNOWN' }
       The type of data this custom field contains. This attribute is read-only if there exists a {@link CustomFieldValue} for this field.
     • visibility - optional; type CustomFieldVisibility - type string with restriction - enum { 'UNKNOWN', 'API_ONLY', 'READ_ONLY', 'FULL' }
       How visible/accessible this field is 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.