Web Service: LineItemCreativeAssociationService

Port type LineItemCreativeAssociationServiceInterfaceSource code

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

   Creates new {@link LineItemCreativeAssociation} objects

   • lineItemCreativeAssociations - optional, unbounded; type LineItemCreativeAssociation
     A {@code LineItemCreativeAssociation} associates a {@link Creative} or {@link CreativeSet} with a {@link LineItem} so that the creative can be served in ad units targeted by the line item.
     • lineItemId - optional; type long
       The ID of the {@link LineItem} to which the {@link Creative} should be associated. This attribute is required.
     • creativeId - optional; type long
       The ID of the {@link Creative} being associated with a {@link LineItem}.

       This attribute is required if this is an association between a line item and a creative.
       This attribute is ignored if this is an association between a line item and a creative set.

       If this is an association between a line item and a creative, when retrieving the line item creative association, the {@link #creativeId} will be the creative's ID.
       If this is an association between a line item and a creative set, when retrieving the line item creative association, the {@link #creativeId} will be the ID of the {@link CreativeSet#masterCreativeId master creative}.

     • creativeSetId - optional; type long
       The ID of the {@link CreativeSet} being associated with a {@link LineItem}. This attribute is required if this is an association between a line item and a creative set.

       This field will be {@code null} when retrieving associations between line items and creatives not belonging to a set.

     • manualCreativeRotationWeight - optional; type double
       The weight of the {@link Creative}. This value is only used if the line item's {@code creativeRotationType} is set to {@link CreativeRotationType#MANUAL}. This attribute is optional and defaults to 10.
     • sequentialCreativeRotationIndex - optional; type int
       The sequential rotation index of the {@link Creative}. This value is used only if the associated line item's {@link LineItem#creativeRotationType} is set to {@link CreativeRotationType#SEQUENTIAL}. This attribute is optional and defaults to 1.
     • startDateTime - optional; type DateTime
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
       Overrides the value set for {@link LineItem#startDateTime}. This value is optional and is only valid for Ad Manager 360 networks. If unset, the {@link LineItem#startDateTime} will be used.
     • startDateTimeType - optional; type StartDateTimeType - type string with restriction - enum { 'USE_START_DATE_TIME', 'IMMEDIATELY', 'ONE_HOUR_FROM_NOW', 'UNKNOWN' }
       Specifies whether to start serving to the {@code LineItemCreativeAssociation} right away, in an hour, etc. This attribute is optional and defaults to {@link StartDateTimeType#USE_START_DATE_TIME}.
     • endDateTime - optional; type DateTime
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
       Overrides {@link LineItem#endDateTime}. This value is optional and is only valid for Ad Manager 360 networks. If unset, the {@link LineItem#endDateTime} will be used.
     • destinationUrl - optional; type string
       Overrides the value set for {@link HasDestinationUrlCreative#destinationUrl}. This value is optional and is only valid for Ad Manager 360 networks.
     • sizes - optional, unbounded; type Size
       Overrides the value set for {@link Creative#size}, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size. This value is optional.
       Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.

       For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.

       • width - optional; type int
         The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • height - optional; type int
         The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • isAspectRatio - optional; type boolean
         Whether this size represents an aspect ratio.
     • status - optional; type LineItemCreativeAssociation.Status - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       The status of the association. This attribute is read-only.
     • stats - optional; type LineItemCreativeAssociationStats
       Contains trafficking statistics for the association. This attribute is readonly and is populated by Google. This will be {@code null} in case there are no statistics for the association yet.
       Contains statistics such as impressions, clicks delivered and cost for {@link LineItemCreativeAssociation} objects.
       • stats - optional; type Stats
         A {@link Stats} object that holds delivered impressions and clicks statistics.
         {@code Stats} contains trafficking statistics for {@link LineItem} and {@link LineItemCreativeAssociation} objects
         • impressionsDelivered - optional; type long
           The number of impressions delivered.
         • clicksDelivered - optional; type long
           The number of clicks delivered.
         • videoCompletionsDelivered - optional; type long
           The number of video completions delivered.
         • videoStartsDelivered - optional; type long
           The number of video starts delivered.
         • viewableImpressionsDelivered - optional; type long
           The number of viewable impressions delivered.
       • creativeSetStats - optional, unbounded; type Long_StatsMapEntry
         A map containing {@link Stats} objects for each creative belonging to a creative set, {@code null} for non creative set associations.
         This represents an entry in a map with a key of type Long and value of type Stats.
         • key - optional; type long
         • value - optional; type Stats
           {@code Stats} contains trafficking statistics for {@link LineItem} and {@link LineItemCreativeAssociation} objects
           • impressionsDelivered - optional; type long
             The number of impressions delivered.
           • clicksDelivered - optional; type long
             The number of clicks delivered.
           • videoCompletionsDelivered - optional; type long
             The number of video completions delivered.
           • videoStartsDelivered - optional; type long
             The number of video starts delivered.
           • viewableImpressionsDelivered - optional; type long
             The number of viewable impressions delivered.
     • lastModifiedDateTime - optional; type DateTime
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
       The date and time this association was last modified.
     • targetingName - optional; type string
       Specifies {@link CreativeTargeting} for this line item creative association.

       This attribute is optional. It should match the creative targeting specified on the corresponding {@link CreativePlaceholder} in the {@link LineItem} that is being associated with the {@link Creative}.

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

   • rval - optional, unbounded; type LineItemCreativeAssociation
     A {@code LineItemCreativeAssociation} associates a {@link Creative} or {@link CreativeSet} with a {@link LineItem} so that the creative can be served in ad units targeted by the line item.
     • lineItemId - optional; type long
       The ID of the {@link LineItem} to which the {@link Creative} should be associated. This attribute is required.
     • creativeId - optional; type long
       The ID of the {@link Creative} being associated with a {@link LineItem}.

       This attribute is required if this is an association between a line item and a creative.
       This attribute is ignored if this is an association between a line item and a creative set.

       If this is an association between a line item and a creative, when retrieving the line item creative association, the {@link #creativeId} will be the creative's ID.
       If this is an association between a line item and a creative set, when retrieving the line item creative association, the {@link #creativeId} will be the ID of the {@link CreativeSet#masterCreativeId master creative}.

     • creativeSetId - optional; type long
       The ID of the {@link CreativeSet} being associated with a {@link LineItem}. This attribute is required if this is an association between a line item and a creative set.

       This field will be {@code null} when retrieving associations between line items and creatives not belonging to a set.

     • manualCreativeRotationWeight - optional; type double
       The weight of the {@link Creative}. This value is only used if the line item's {@code creativeRotationType} is set to {@link CreativeRotationType#MANUAL}. This attribute is optional and defaults to 10.
     • sequentialCreativeRotationIndex - optional; type int
       The sequential rotation index of the {@link Creative}. This value is used only if the associated line item's {@link LineItem#creativeRotationType} is set to {@link CreativeRotationType#SEQUENTIAL}. This attribute is optional and defaults to 1.
     • startDateTime - optional; type DateTime
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
       Overrides the value set for {@link LineItem#startDateTime}. This value is optional and is only valid for Ad Manager 360 networks. If unset, the {@link LineItem#startDateTime} will be used.
     • startDateTimeType - optional; type StartDateTimeType - type string with restriction - enum { 'USE_START_DATE_TIME', 'IMMEDIATELY', 'ONE_HOUR_FROM_NOW', 'UNKNOWN' }
       Specifies whether to start serving to the {@code LineItemCreativeAssociation} right away, in an hour, etc. This attribute is optional and defaults to {@link StartDateTimeType#USE_START_DATE_TIME}.
     • endDateTime - optional; type DateTime
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
       Overrides {@link LineItem#endDateTime}. This value is optional and is only valid for Ad Manager 360 networks. If unset, the {@link LineItem#endDateTime} will be used.
     • destinationUrl - optional; type string
       Overrides the value set for {@link HasDestinationUrlCreative#destinationUrl}. This value is optional and is only valid for Ad Manager 360 networks.
     • sizes - optional, unbounded; type Size
       Overrides the value set for {@link Creative#size}, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size. This value is optional.
       Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.

       For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.

       • width - optional; type int
         The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • height - optional; type int
         The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • isAspectRatio - optional; type boolean
         Whether this size represents an aspect ratio.
     • status - optional; type LineItemCreativeAssociation.Status - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       The status of the association. This attribute is read-only.
     • stats - optional; type LineItemCreativeAssociationStats
       Contains trafficking statistics for the association. This attribute is readonly and is populated by Google. This will be {@code null} in case there are no statistics for the association yet.
       Contains statistics such as impressions, clicks delivered and cost for {@link LineItemCreativeAssociation} objects.
       • stats - optional; type Stats
         A {@link Stats} object that holds delivered impressions and clicks statistics.
         {@code Stats} contains trafficking statistics for {@link LineItem} and {@link LineItemCreativeAssociation} objects
         • impressionsDelivered - optional; type long
           The number of impressions delivered.
         • clicksDelivered - optional; type long
           The number of clicks delivered.
         • videoCompletionsDelivered - optional; type long
           The number of video completions delivered.
         • videoStartsDelivered - optional; type long
           The number of video starts delivered.
         • viewableImpressionsDelivered - optional; type long
           The number of viewable impressions delivered.
       • creativeSetStats - optional, unbounded; type Long_StatsMapEntry
         A map containing {@link Stats} objects for each creative belonging to a creative set, {@code null} for non creative set associations.
         This represents an entry in a map with a key of type Long and value of type Stats.
         • key - optional; type long
         • value - optional; type Stats
           {@code Stats} contains trafficking statistics for {@link LineItem} and {@link LineItemCreativeAssociation} objects
           • impressionsDelivered - optional; type long
             The number of impressions delivered.
           • clicksDelivered - optional; type long
             The number of clicks delivered.
           • videoCompletionsDelivered - optional; type long
             The number of video completions delivered.
           • videoStartsDelivered - optional; type long
             The number of video starts delivered.
           • viewableImpressionsDelivered - optional; type long
             The number of viewable impressions delivered.
     • lastModifiedDateTime - optional; type DateTime
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
       The date and time this association was last modified.
     • targetingName - optional; type string
       Specifies {@link CreativeTargeting} for this line item creative association.

       This attribute is optional. It should match the creative targeting specified on the corresponding {@link CreativePlaceholder} in the {@link LineItem} that is being associated with the {@link Creative}.

   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. getLineItemCreativeAssociationsByStatement
   Source code
   Description:
   Gets a {@link LineItemCreativeAssociationPage} of {@link LineItemCreativeAssociation} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code creativeId}	{@link LineItemCreativeAssociation#creativeId}
   {@code manualCreativeRotationWeight}	{@link LineItemCreativeAssociation#manualCreativeRotationWeight}
   {@code destinationUrl}	{@link LineItemCreativeAssociation#destinationUrl}
   {@code lineItemId}	{@link LineItemCreativeAssociation#lineItemId}
   {@code status}	{@link LineItemCreativeAssociation#status}
   {@code lastModifiedDateTime}	{@link LineItemCreativeAssociation#lastModifiedDateTime}

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

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

   PQL Property	Object Property
   {@code creativeId}	{@link LineItemCreativeAssociation#creativeId}
   {@code manualCreativeRotationWeight}	{@link LineItemCreativeAssociation#manualCreativeRotationWeight}
   {@code destinationUrl}	{@link LineItemCreativeAssociation#destinationUrl}
   {@code lineItemId}	{@link LineItemCreativeAssociation#lineItemId}
   {@code status}	{@link LineItemCreativeAssociation#status}
   {@code lastModifiedDateTime}	{@link LineItemCreativeAssociation#lastModifiedDateTime}

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

   • rval - optional; type LineItemCreativeAssociationPage
     Captures a page of {@link LineItemCreativeAssociation} 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 LineItemCreativeAssociation
       A {@code LineItemCreativeAssociation} associates a {@link Creative} or {@link CreativeSet} with a {@link LineItem} so that the creative can be served in ad units targeted by the line item.
       • lineItemId - optional; type long
         The ID of the {@link LineItem} to which the {@link Creative} should be associated. This attribute is required.
       • creativeId - optional; type long
         The ID of the {@link Creative} being associated with a {@link LineItem}.

         This attribute is required if this is an association between a line item and a creative.
         This attribute is ignored if this is an association between a line item and a creative set.

         If this is an association between a line item and a creative, when retrieving the line item creative association, the {@link #creativeId} will be the creative's ID.
         If this is an association between a line item and a creative set, when retrieving the line item creative association, the {@link #creativeId} will be the ID of the {@link CreativeSet#masterCreativeId master creative}.

       • creativeSetId - optional; type long
         The ID of the {@link CreativeSet} being associated with a {@link LineItem}. This attribute is required if this is an association between a line item and a creative set.

         This field will be {@code null} when retrieving associations between line items and creatives not belonging to a set.

       • manualCreativeRotationWeight - optional; type double
         The weight of the {@link Creative}. This value is only used if the line item's {@code creativeRotationType} is set to {@link CreativeRotationType#MANUAL}. This attribute is optional and defaults to 10.
       • sequentialCreativeRotationIndex - optional; type int
         The sequential rotation index of the {@link Creative}. This value is used only if the associated line item's {@link LineItem#creativeRotationType} is set to {@link CreativeRotationType#SEQUENTIAL}. This attribute is optional and defaults to 1.
       • startDateTime - optional; type DateTime
         Represents a date combined with the time of day.
         • date - optional; type Date
           Represents a date.
           • year - optional; type int
             Year (e.g., 2009)
           • month - optional; type int
             Month (1..12)
           • day - optional; type int
             Day (1..31)
         • hour - optional; type int
         • minute - optional; type int
         • second - optional; type int
         • timeZoneId - optional; type string
         Overrides the value set for {@link LineItem#startDateTime}. This value is optional and is only valid for Ad Manager 360 networks. If unset, the {@link LineItem#startDateTime} will be used.
       • startDateTimeType - optional; type StartDateTimeType - type string with restriction - enum { 'USE_START_DATE_TIME', 'IMMEDIATELY', 'ONE_HOUR_FROM_NOW', 'UNKNOWN' }
         Specifies whether to start serving to the {@code LineItemCreativeAssociation} right away, in an hour, etc. This attribute is optional and defaults to {@link StartDateTimeType#USE_START_DATE_TIME}.
       • endDateTime - optional; type DateTime
         Represents a date combined with the time of day.
         • date - optional; type Date
           Represents a date.
           • year - optional; type int
             Year (e.g., 2009)
           • month - optional; type int
             Month (1..12)
           • day - optional; type int
             Day (1..31)
         • hour - optional; type int
         • minute - optional; type int
         • second - optional; type int
         • timeZoneId - optional; type string
         Overrides {@link LineItem#endDateTime}. This value is optional and is only valid for Ad Manager 360 networks. If unset, the {@link LineItem#endDateTime} will be used.
       • destinationUrl - optional; type string
         Overrides the value set for {@link HasDestinationUrlCreative#destinationUrl}. This value is optional and is only valid for Ad Manager 360 networks.
       • sizes - optional, unbounded; type Size
         Overrides the value set for {@link Creative#size}, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size. This value is optional.
         Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.

         For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.

         • width - optional; type int
           The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
         • height - optional; type int
           The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
         • isAspectRatio - optional; type boolean
           Whether this size represents an aspect ratio.
       • status - optional; type LineItemCreativeAssociation.Status - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
         The status of the association. This attribute is read-only.
       • stats - optional; type LineItemCreativeAssociationStats
         Contains trafficking statistics for the association. This attribute is readonly and is populated by Google. This will be {@code null} in case there are no statistics for the association yet.
         Contains statistics such as impressions, clicks delivered and cost for {@link LineItemCreativeAssociation} objects.
         • stats - optional; type Stats
           A {@link Stats} object that holds delivered impressions and clicks statistics.
           {@code Stats} contains trafficking statistics for {@link LineItem} and {@link LineItemCreativeAssociation} objects
           • impressionsDelivered - optional; type long
             The number of impressions delivered.
           • clicksDelivered - optional; type long
             The number of clicks delivered.
           • videoCompletionsDelivered - optional; type long
             The number of video completions delivered.
           • videoStartsDelivered - optional; type long
             The number of video starts delivered.
           • viewableImpressionsDelivered - optional; type long
             The number of viewable impressions delivered.
         • creativeSetStats - optional, unbounded; type Long_StatsMapEntry
           A map containing {@link Stats} objects for each creative belonging to a creative set, {@code null} for non creative set associations.
           This represents an entry in a map with a key of type Long and value of type Stats.
           • key - optional; type long
           • value - optional; type Stats
             {@code Stats} contains trafficking statistics for {@link LineItem} and {@link LineItemCreativeAssociation} objects
             • impressionsDelivered - optional; type long
               The number of impressions delivered.
             • clicksDelivered - optional; type long
               The number of clicks delivered.
             • videoCompletionsDelivered - optional; type long
               The number of video completions delivered.
             • videoStartsDelivered - optional; type long
               The number of video starts delivered.
             • viewableImpressionsDelivered - optional; type long
               The number of viewable impressions delivered.
       • lastModifiedDateTime - optional; type DateTime
         Represents a date combined with the time of day.
         • date - optional; type Date
           Represents a date.
           • year - optional; type int
             Year (e.g., 2009)
           • month - optional; type int
             Month (1..12)
           • day - optional; type int
             Day (1..31)
         • hour - optional; type int
         • minute - optional; type int
         • second - optional; type int
         • timeZoneId - optional; type string
         The date and time this association was last modified.
       • targetingName - optional; type string
         Specifies {@link CreativeTargeting} for this line item creative association.

         This attribute is optional. It should match the creative targeting specified on the corresponding {@link CreativePlaceholder} in the {@link LineItem} that is being associated with the {@link Creative}.

       The collection of line item creative associations 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.
3. getPreviewUrl
   Source code
   Description:
   Returns an insite preview URL that references the specified site URL with the specified creative from the association served to it. For Creative Set previewing you may specify the master creative Id.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getPreviewUrlRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getPreviewUrl

   Returns an insite preview URL that references the specified site URL with the specified creative from the association served to it. For Creative Set previewing you may specify the master creative Id.

   • lineItemId - optional; type long
   • creativeId - optional; type long
   • siteUrl - optional; type string
   Output:
   getPreviewUrlResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getPreviewUrlResponse

   • rval - optional; type string
   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. getPreviewUrlsForNativeStyles
   Source code
   Description:
   Returns a list of URLs that reference the specified site URL with the specified creative from the association served to it. For Creative Set previewing you may specify the master creative Id. Each URL corresponds to one available native style for previewing the specified creative.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   getPreviewUrlsForNativeStylesRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type getPreviewUrlsForNativeStyles

   Returns a list of URLs that reference the specified site URL with the specified creative from the association served to it. For Creative Set previewing you may specify the master creative Id. Each URL corresponds to one available native style for previewing the specified creative.

   • lineItemId - optional; type long
   • creativeId - optional; type long
   • siteUrl - optional; type string
   Output:
   getPreviewUrlsForNativeStylesResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getPreviewUrlsForNativeStylesResponse

   • rval - optional, unbounded; type CreativeNativeStylePreview
     Represents the {@link NativeStyle} of a {@link Creative} and its corresponding preview URL.
     • nativeStyleId - optional; type long
       The id of the {@link NativeStyle}.
     • previewUrl - optional; type string
       The URL for previewing this creative using this particular {@link NativeStyle}
   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. performLineItemCreativeAssociationAction
   Source code
   Description:
   Performs actions on {@link LineItemCreativeAssociation} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performLineItemCreativeAssociationActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performLineItemCreativeAssociationAction

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

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

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

   Updates the specified {@link LineItemCreativeAssociation} objects

   • lineItemCreativeAssociations - optional, unbounded; type LineItemCreativeAssociation
     A {@code LineItemCreativeAssociation} associates a {@link Creative} or {@link CreativeSet} with a {@link LineItem} so that the creative can be served in ad units targeted by the line item.
     • lineItemId - optional; type long
       The ID of the {@link LineItem} to which the {@link Creative} should be associated. This attribute is required.
     • creativeId - optional; type long
       The ID of the {@link Creative} being associated with a {@link LineItem}.

       This attribute is required if this is an association between a line item and a creative.
       This attribute is ignored if this is an association between a line item and a creative set.

       If this is an association between a line item and a creative, when retrieving the line item creative association, the {@link #creativeId} will be the creative's ID.
       If this is an association between a line item and a creative set, when retrieving the line item creative association, the {@link #creativeId} will be the ID of the {@link CreativeSet#masterCreativeId master creative}.

     • creativeSetId - optional; type long
       The ID of the {@link CreativeSet} being associated with a {@link LineItem}. This attribute is required if this is an association between a line item and a creative set.

       This field will be {@code null} when retrieving associations between line items and creatives not belonging to a set.

     • manualCreativeRotationWeight - optional; type double
       The weight of the {@link Creative}. This value is only used if the line item's {@code creativeRotationType} is set to {@link CreativeRotationType#MANUAL}. This attribute is optional and defaults to 10.
     • sequentialCreativeRotationIndex - optional; type int
       The sequential rotation index of the {@link Creative}. This value is used only if the associated line item's {@link LineItem#creativeRotationType} is set to {@link CreativeRotationType#SEQUENTIAL}. This attribute is optional and defaults to 1.
     • startDateTime - optional; type DateTime
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
       Overrides the value set for {@link LineItem#startDateTime}. This value is optional and is only valid for Ad Manager 360 networks. If unset, the {@link LineItem#startDateTime} will be used.
     • startDateTimeType - optional; type StartDateTimeType - type string with restriction - enum { 'USE_START_DATE_TIME', 'IMMEDIATELY', 'ONE_HOUR_FROM_NOW', 'UNKNOWN' }
       Specifies whether to start serving to the {@code LineItemCreativeAssociation} right away, in an hour, etc. This attribute is optional and defaults to {@link StartDateTimeType#USE_START_DATE_TIME}.
     • endDateTime - optional; type DateTime
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
       Overrides {@link LineItem#endDateTime}. This value is optional and is only valid for Ad Manager 360 networks. If unset, the {@link LineItem#endDateTime} will be used.
     • destinationUrl - optional; type string
       Overrides the value set for {@link HasDestinationUrlCreative#destinationUrl}. This value is optional and is only valid for Ad Manager 360 networks.
     • sizes - optional, unbounded; type Size
       Overrides the value set for {@link Creative#size}, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size. This value is optional.
       Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.

       For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.

       • width - optional; type int
         The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • height - optional; type int
         The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • isAspectRatio - optional; type boolean
         Whether this size represents an aspect ratio.
     • status - optional; type LineItemCreativeAssociation.Status - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       The status of the association. This attribute is read-only.
     • stats - optional; type LineItemCreativeAssociationStats
       Contains trafficking statistics for the association. This attribute is readonly and is populated by Google. This will be {@code null} in case there are no statistics for the association yet.
       Contains statistics such as impressions, clicks delivered and cost for {@link LineItemCreativeAssociation} objects.
       • stats - optional; type Stats
         A {@link Stats} object that holds delivered impressions and clicks statistics.
         {@code Stats} contains trafficking statistics for {@link LineItem} and {@link LineItemCreativeAssociation} objects
         • impressionsDelivered - optional; type long
           The number of impressions delivered.
         • clicksDelivered - optional; type long
           The number of clicks delivered.
         • videoCompletionsDelivered - optional; type long
           The number of video completions delivered.
         • videoStartsDelivered - optional; type long
           The number of video starts delivered.
         • viewableImpressionsDelivered - optional; type long
           The number of viewable impressions delivered.
       • creativeSetStats - optional, unbounded; type Long_StatsMapEntry
         A map containing {@link Stats} objects for each creative belonging to a creative set, {@code null} for non creative set associations.
         This represents an entry in a map with a key of type Long and value of type Stats.
         • key - optional; type long
         • value - optional; type Stats
           {@code Stats} contains trafficking statistics for {@link LineItem} and {@link LineItemCreativeAssociation} objects
           • impressionsDelivered - optional; type long
             The number of impressions delivered.
           • clicksDelivered - optional; type long
             The number of clicks delivered.
           • videoCompletionsDelivered - optional; type long
             The number of video completions delivered.
           • videoStartsDelivered - optional; type long
             The number of video starts delivered.
           • viewableImpressionsDelivered - optional; type long
             The number of viewable impressions delivered.
     • lastModifiedDateTime - optional; type DateTime
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
       The date and time this association was last modified.
     • targetingName - optional; type string
       Specifies {@link CreativeTargeting} for this line item creative association.

       This attribute is optional. It should match the creative targeting specified on the corresponding {@link CreativePlaceholder} in the {@link LineItem} that is being associated with the {@link Creative}.

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

   • rval - optional, unbounded; type LineItemCreativeAssociation
     A {@code LineItemCreativeAssociation} associates a {@link Creative} or {@link CreativeSet} with a {@link LineItem} so that the creative can be served in ad units targeted by the line item.
     • lineItemId - optional; type long
       The ID of the {@link LineItem} to which the {@link Creative} should be associated. This attribute is required.
     • creativeId - optional; type long
       The ID of the {@link Creative} being associated with a {@link LineItem}.

       This attribute is required if this is an association between a line item and a creative.
       This attribute is ignored if this is an association between a line item and a creative set.

       If this is an association between a line item and a creative, when retrieving the line item creative association, the {@link #creativeId} will be the creative's ID.
       If this is an association between a line item and a creative set, when retrieving the line item creative association, the {@link #creativeId} will be the ID of the {@link CreativeSet#masterCreativeId master creative}.

     • creativeSetId - optional; type long
       The ID of the {@link CreativeSet} being associated with a {@link LineItem}. This attribute is required if this is an association between a line item and a creative set.

       This field will be {@code null} when retrieving associations between line items and creatives not belonging to a set.

     • manualCreativeRotationWeight - optional; type double
       The weight of the {@link Creative}. This value is only used if the line item's {@code creativeRotationType} is set to {@link CreativeRotationType#MANUAL}. This attribute is optional and defaults to 10.
     • sequentialCreativeRotationIndex - optional; type int
       The sequential rotation index of the {@link Creative}. This value is used only if the associated line item's {@link LineItem#creativeRotationType} is set to {@link CreativeRotationType#SEQUENTIAL}. This attribute is optional and defaults to 1.
     • startDateTime - optional; type DateTime
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
       Overrides the value set for {@link LineItem#startDateTime}. This value is optional and is only valid for Ad Manager 360 networks. If unset, the {@link LineItem#startDateTime} will be used.
     • startDateTimeType - optional; type StartDateTimeType - type string with restriction - enum { 'USE_START_DATE_TIME', 'IMMEDIATELY', 'ONE_HOUR_FROM_NOW', 'UNKNOWN' }
       Specifies whether to start serving to the {@code LineItemCreativeAssociation} right away, in an hour, etc. This attribute is optional and defaults to {@link StartDateTimeType#USE_START_DATE_TIME}.
     • endDateTime - optional; type DateTime
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
       Overrides {@link LineItem#endDateTime}. This value is optional and is only valid for Ad Manager 360 networks. If unset, the {@link LineItem#endDateTime} will be used.
     • destinationUrl - optional; type string
       Overrides the value set for {@link HasDestinationUrlCreative#destinationUrl}. This value is optional and is only valid for Ad Manager 360 networks.
     • sizes - optional, unbounded; type Size
       Overrides the value set for {@link Creative#size}, which allows the creative to be served to ad units that would otherwise not be compatible for its actual size. This value is optional.
       Represents the dimensions of an {@link AdUnit}, {@link LineItem} or {@link Creative}.

       For interstitial size (out-of-page), native, ignored and fluid size, {@link Size} must be 1x1.

       • width - optional; type int
         The width of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • height - optional; type int
         The height of the {@link AdUnit}, {@link LineItem} or {@link Creative}.
       • isAspectRatio - optional; type boolean
         Whether this size represents an aspect ratio.
     • status - optional; type LineItemCreativeAssociation.Status - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       The status of the association. This attribute is read-only.
     • stats - optional; type LineItemCreativeAssociationStats
       Contains trafficking statistics for the association. This attribute is readonly and is populated by Google. This will be {@code null} in case there are no statistics for the association yet.
       Contains statistics such as impressions, clicks delivered and cost for {@link LineItemCreativeAssociation} objects.
       • stats - optional; type Stats
         A {@link Stats} object that holds delivered impressions and clicks statistics.
         {@code Stats} contains trafficking statistics for {@link LineItem} and {@link LineItemCreativeAssociation} objects
         • impressionsDelivered - optional; type long
           The number of impressions delivered.
         • clicksDelivered - optional; type long
           The number of clicks delivered.
         • videoCompletionsDelivered - optional; type long
           The number of video completions delivered.
         • videoStartsDelivered - optional; type long
           The number of video starts delivered.
         • viewableImpressionsDelivered - optional; type long
           The number of viewable impressions delivered.
       • creativeSetStats - optional, unbounded; type Long_StatsMapEntry
         A map containing {@link Stats} objects for each creative belonging to a creative set, {@code null} for non creative set associations.
         This represents an entry in a map with a key of type Long and value of type Stats.
         • key - optional; type long
         • value - optional; type Stats
           {@code Stats} contains trafficking statistics for {@link LineItem} and {@link LineItemCreativeAssociation} objects
           • impressionsDelivered - optional; type long
             The number of impressions delivered.
           • clicksDelivered - optional; type long
             The number of clicks delivered.
           • videoCompletionsDelivered - optional; type long
             The number of video completions delivered.
           • videoStartsDelivered - optional; type long
             The number of video starts delivered.
           • viewableImpressionsDelivered - optional; type long
             The number of viewable impressions delivered.
     • lastModifiedDateTime - optional; type DateTime
       Represents a date combined with the time of day.
       • date - optional; type Date
         Represents a date.
         • year - optional; type int
           Year (e.g., 2009)
         • month - optional; type int
           Month (1..12)
         • day - optional; type int
           Day (1..31)
       • hour - optional; type int
       • minute - optional; type int
       • second - optional; type int
       • timeZoneId - optional; type string
       The date and time this association was last modified.
     • targetingName - optional; type string
       Specifies {@link CreativeTargeting} for this line item creative association.

       This attribute is optional. It should match the creative targeting specified on the corresponding {@link CreativePlaceholder} in the {@link LineItem} that is being associated with the {@link Creative}.

   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.