Web Service: OrderService

Port type OrderServiceInterfaceSource code

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

   Creates new {@link Order} objects.

   • orders - optional, unbounded; type Order
     An {@code Order} represents a grouping of individual {@link LineItem} objects, each of which fulfill an ad request from a particular advertiser.
     • id - optional; type long
       The unique ID of the {@code Order}. This value is readonly and is assigned by Google.
     • name - optional; type string
       The name of the {@code Order}. This value is required to create an order and has a maximum length of 255 characters.
     • 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
       The date and time at which the {@code Order} and its associated line items are eligible to begin serving. This attribute is readonly and is derived from the line item of the order which has the earliest {@link LineItem#startDateTime}.
     • 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
       The date and time at which the {@code Order} and its associated line items stop being served. This attribute is readonly and is derived from the line item of the order which has the latest {@link LineItem#endDateTime}.
     • unlimitedEndDateTime - optional; type boolean
       Specifies whether or not the {@code Order} has an unlimited end date. This attribute is readonly and is {@code true} if any of the order's line items has {@link LineItem#unlimitedEndDateTime} set to {@code true}.
     • status - optional; type OrderStatus - type string with restriction - enum { 'DRAFT', 'PENDING_APPROVAL', 'APPROVED', 'DISAPPROVED', 'PAUSED', 'CANCELED', 'DELETED', 'UNKNOWN' }
       The status of the {@code Order}. This attribute is read-only.
     • isArchived - optional; type boolean
       The archival status of the {@code Order}. This attribute is readonly.
     • notes - optional; type string
       Provides any additional notes that may annotate the {@code Order}. This attribute is optional and has a maximum length of 65,535 characters.
     • externalOrderId - optional; type int
       An arbitrary ID to associate to the {@code Order}, which can be used as a key to an external system. This value is optional.
     • poNumber - optional; type string
       The purchase order number for the {@code Order}. This value is optional and has a maximum length of 63 characters.
     • currencyCode - optional; type string
       The ISO currency code for the currency used by the {@code Order}. This value is read-only and is the network's currency code.
     • advertiserId - optional; type long
       The unique ID of the {@link Company}, which is of type {@link Company.Type#ADVERTISER}, to which this order belongs. This attribute is required.
     • advertiserContactIds - optional, unbounded; type long
       List of IDs for advertiser contacts of the order.
     • agencyId - optional; type long
       The unique ID of the {@link Company}, which is of type {@link Company.Type#AGENCY}, with which this order is associated. This attribute is optional.
     • agencyContactIds - optional, unbounded; type long
       List of IDs for agency contacts of the order.
     • creatorId - optional; type long
       The unique ID of the {@link User} who created the {@code Order} on behalf of the advertiser. This value is readonly and is assigned by Google.
     • traffickerId - optional; type long
       The unique ID of the {@link User} responsible for trafficking the {@code Order}. This value is required for creating an order.
     • secondaryTraffickerIds - optional, unbounded; type long
       The IDs of the secondary traffickers associated with the order. This value is optional.
     • salespersonId - optional; type long
       The unique ID of the {@link User} responsible for the sales of the {@code Order}. This value is optional.
     • secondarySalespersonIds - optional, unbounded; type long
       The IDs of the secondary salespeople associated with the order. This value is optional.
     • totalImpressionsDelivered - optional; type long
       Total impressions delivered for all line items of this {@code Order}. This value is read-only and is assigned by Google.
     • totalClicksDelivered - optional; type long
       Total clicks delivered for all line items of this {@code Order}. This value is read-only and is assigned by Google.
     • totalViewableImpressionsDelivered - optional; type long
       Total viewable impressions delivered for all line items of this {@code Order}. This value is read-only and is assigned by Google. Starting in v201705, this will be {@code null} when the order does not have line items trafficked against a viewable impressions goal.
     • totalBudget - optional; type Money
       Represents a money amount.
       • currencyCode - optional; type string
         Three letter currency code in string format.
       • microAmount - optional; type long
         Money values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
       Total budget for all line items of this {@code Order}. This value is a readonly field assigned by Google and is calculated from the associated {@link LineItem#costPerUnit} values.
     • appliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       The set of labels applied directly to this order.
     • effectiveAppliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.
     • lastModifiedByApp - optional; type string
       The application which modified this order. This attribute is read only and is assigned by Google.
     • isProgrammatic - optional; type boolean
       Specifies whether or not the {@code Order} is a programmatic order. This value is optional and defaults to false.
     • appliedTeamIds - optional, unbounded; type long
       The IDs of all teams that this order is on directly.
     • 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 order was last modified.
     • customFieldValues - optional, unbounded; type BaseCustomFieldValue
       The value of a {@link CustomField} for a particular entity.
       • customFieldId - optional; type long
         Id of the {@code CustomField} to which this value belongs. This attribute is required.
       The values of the custom fields associated with this order.
   Output:
   createOrdersResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createOrdersResponse

   • rval - optional, unbounded; type Order
     An {@code Order} represents a grouping of individual {@link LineItem} objects, each of which fulfill an ad request from a particular advertiser.
     • id - optional; type long
       The unique ID of the {@code Order}. This value is readonly and is assigned by Google.
     • name - optional; type string
       The name of the {@code Order}. This value is required to create an order and has a maximum length of 255 characters.
     • 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
       The date and time at which the {@code Order} and its associated line items are eligible to begin serving. This attribute is readonly and is derived from the line item of the order which has the earliest {@link LineItem#startDateTime}.
     • 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
       The date and time at which the {@code Order} and its associated line items stop being served. This attribute is readonly and is derived from the line item of the order which has the latest {@link LineItem#endDateTime}.
     • unlimitedEndDateTime - optional; type boolean
       Specifies whether or not the {@code Order} has an unlimited end date. This attribute is readonly and is {@code true} if any of the order's line items has {@link LineItem#unlimitedEndDateTime} set to {@code true}.
     • status - optional; type OrderStatus - type string with restriction - enum { 'DRAFT', 'PENDING_APPROVAL', 'APPROVED', 'DISAPPROVED', 'PAUSED', 'CANCELED', 'DELETED', 'UNKNOWN' }
       The status of the {@code Order}. This attribute is read-only.
     • isArchived - optional; type boolean
       The archival status of the {@code Order}. This attribute is readonly.
     • notes - optional; type string
       Provides any additional notes that may annotate the {@code Order}. This attribute is optional and has a maximum length of 65,535 characters.
     • externalOrderId - optional; type int
       An arbitrary ID to associate to the {@code Order}, which can be used as a key to an external system. This value is optional.
     • poNumber - optional; type string
       The purchase order number for the {@code Order}. This value is optional and has a maximum length of 63 characters.
     • currencyCode - optional; type string
       The ISO currency code for the currency used by the {@code Order}. This value is read-only and is the network's currency code.
     • advertiserId - optional; type long
       The unique ID of the {@link Company}, which is of type {@link Company.Type#ADVERTISER}, to which this order belongs. This attribute is required.
     • advertiserContactIds - optional, unbounded; type long
       List of IDs for advertiser contacts of the order.
     • agencyId - optional; type long
       The unique ID of the {@link Company}, which is of type {@link Company.Type#AGENCY}, with which this order is associated. This attribute is optional.
     • agencyContactIds - optional, unbounded; type long
       List of IDs for agency contacts of the order.
     • creatorId - optional; type long
       The unique ID of the {@link User} who created the {@code Order} on behalf of the advertiser. This value is readonly and is assigned by Google.
     • traffickerId - optional; type long
       The unique ID of the {@link User} responsible for trafficking the {@code Order}. This value is required for creating an order.
     • secondaryTraffickerIds - optional, unbounded; type long
       The IDs of the secondary traffickers associated with the order. This value is optional.
     • salespersonId - optional; type long
       The unique ID of the {@link User} responsible for the sales of the {@code Order}. This value is optional.
     • secondarySalespersonIds - optional, unbounded; type long
       The IDs of the secondary salespeople associated with the order. This value is optional.
     • totalImpressionsDelivered - optional; type long
       Total impressions delivered for all line items of this {@code Order}. This value is read-only and is assigned by Google.
     • totalClicksDelivered - optional; type long
       Total clicks delivered for all line items of this {@code Order}. This value is read-only and is assigned by Google.
     • totalViewableImpressionsDelivered - optional; type long
       Total viewable impressions delivered for all line items of this {@code Order}. This value is read-only and is assigned by Google. Starting in v201705, this will be {@code null} when the order does not have line items trafficked against a viewable impressions goal.
     • totalBudget - optional; type Money
       Represents a money amount.
       • currencyCode - optional; type string
         Three letter currency code in string format.
       • microAmount - optional; type long
         Money values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
       Total budget for all line items of this {@code Order}. This value is a readonly field assigned by Google and is calculated from the associated {@link LineItem#costPerUnit} values.
     • appliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       The set of labels applied directly to this order.
     • effectiveAppliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.
     • lastModifiedByApp - optional; type string
       The application which modified this order. This attribute is read only and is assigned by Google.
     • isProgrammatic - optional; type boolean
       Specifies whether or not the {@code Order} is a programmatic order. This value is optional and defaults to false.
     • appliedTeamIds - optional, unbounded; type long
       The IDs of all teams that this order is on directly.
     • 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 order was last modified.
     • customFieldValues - optional, unbounded; type BaseCustomFieldValue
       The value of a {@link CustomField} for a particular entity.
       • customFieldId - optional; type long
         Id of the {@code CustomField} to which this value belongs. This attribute is required.
       The values of the custom fields associated with this order.
   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. getOrdersByStatement
   Source code
   Description:
   Gets an {@link OrderPage} of {@link Order} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code advertiserId}	{@link Order#advertiserId}
   {@code endDateTime}	{@link Order#endDateTime}
   {@code id}	{@link Order#id}
   {@code name}	{@link Order#name}
   {@code salespersonId}	{@link Order#salespersonId}
   {@code startDateTime}	{@link Order#startDateTime}
   {@code status}	{@link Order#status}
   {@code traffickerId}	{@link Order#traffickerId}
   {@code lastModifiedDateTime}	{@link Order#lastModifiedDateTime}

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

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

   PQL Property	Object Property
   {@code advertiserId}	{@link Order#advertiserId}
   {@code endDateTime}	{@link Order#endDateTime}
   {@code id}	{@link Order#id}
   {@code name}	{@link Order#name}
   {@code salespersonId}	{@link Order#salespersonId}
   {@code startDateTime}	{@link Order#startDateTime}
   {@code status}	{@link Order#status}
   {@code traffickerId}	{@link Order#traffickerId}
   {@code lastModifiedDateTime}	{@link Order#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:
   getOrdersByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getOrdersByStatementResponse

   • rval - optional; type OrderPage
     Captures a page of {@link Order} 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 Order
       An {@code Order} represents a grouping of individual {@link LineItem} objects, each of which fulfill an ad request from a particular advertiser.
       • id - optional; type long
         The unique ID of the {@code Order}. This value is readonly and is assigned by Google.
       • name - optional; type string
         The name of the {@code Order}. This value is required to create an order and has a maximum length of 255 characters.
       • 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
         The date and time at which the {@code Order} and its associated line items are eligible to begin serving. This attribute is readonly and is derived from the line item of the order which has the earliest {@link LineItem#startDateTime}.
       • 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
         The date and time at which the {@code Order} and its associated line items stop being served. This attribute is readonly and is derived from the line item of the order which has the latest {@link LineItem#endDateTime}.
       • unlimitedEndDateTime - optional; type boolean
         Specifies whether or not the {@code Order} has an unlimited end date. This attribute is readonly and is {@code true} if any of the order's line items has {@link LineItem#unlimitedEndDateTime} set to {@code true}.
       • status - optional; type OrderStatus - type string with restriction - enum { 'DRAFT', 'PENDING_APPROVAL', 'APPROVED', 'DISAPPROVED', 'PAUSED', 'CANCELED', 'DELETED', 'UNKNOWN' }
         The status of the {@code Order}. This attribute is read-only.
       • isArchived - optional; type boolean
         The archival status of the {@code Order}. This attribute is readonly.
       • notes - optional; type string
         Provides any additional notes that may annotate the {@code Order}. This attribute is optional and has a maximum length of 65,535 characters.
       • externalOrderId - optional; type int
         An arbitrary ID to associate to the {@code Order}, which can be used as a key to an external system. This value is optional.
       • poNumber - optional; type string
         The purchase order number for the {@code Order}. This value is optional and has a maximum length of 63 characters.
       • currencyCode - optional; type string
         The ISO currency code for the currency used by the {@code Order}. This value is read-only and is the network's currency code.
       • advertiserId - optional; type long
         The unique ID of the {@link Company}, which is of type {@link Company.Type#ADVERTISER}, to which this order belongs. This attribute is required.
       • advertiserContactIds - optional, unbounded; type long
         List of IDs for advertiser contacts of the order.
       • agencyId - optional; type long
         The unique ID of the {@link Company}, which is of type {@link Company.Type#AGENCY}, with which this order is associated. This attribute is optional.
       • agencyContactIds - optional, unbounded; type long
         List of IDs for agency contacts of the order.
       • creatorId - optional; type long
         The unique ID of the {@link User} who created the {@code Order} on behalf of the advertiser. This value is readonly and is assigned by Google.
       • traffickerId - optional; type long
         The unique ID of the {@link User} responsible for trafficking the {@code Order}. This value is required for creating an order.
       • secondaryTraffickerIds - optional, unbounded; type long
         The IDs of the secondary traffickers associated with the order. This value is optional.
       • salespersonId - optional; type long
         The unique ID of the {@link User} responsible for the sales of the {@code Order}. This value is optional.
       • secondarySalespersonIds - optional, unbounded; type long
         The IDs of the secondary salespeople associated with the order. This value is optional.
       • totalImpressionsDelivered - optional; type long
         Total impressions delivered for all line items of this {@code Order}. This value is read-only and is assigned by Google.
       • totalClicksDelivered - optional; type long
         Total clicks delivered for all line items of this {@code Order}. This value is read-only and is assigned by Google.
       • totalViewableImpressionsDelivered - optional; type long
         Total viewable impressions delivered for all line items of this {@code Order}. This value is read-only and is assigned by Google. Starting in v201705, this will be {@code null} when the order does not have line items trafficked against a viewable impressions goal.
       • totalBudget - optional; type Money
         Represents a money amount.
         • currencyCode - optional; type string
           Three letter currency code in string format.
         • microAmount - optional; type long
           Money values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
         Total budget for all line items of this {@code Order}. This value is a readonly field assigned by Google and is calculated from the associated {@link LineItem#costPerUnit} values.
       • appliedLabels - optional, unbounded; type AppliedLabel
         Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
         • labelId - optional; type long
           The ID of a created {@link Label}.
         • isNegated - optional; type boolean
           {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
         The set of labels applied directly to this order.
       • effectiveAppliedLabels - optional, unbounded; type AppliedLabel
         Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
         • labelId - optional; type long
           The ID of a created {@link Label}.
         • isNegated - optional; type boolean
           {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
         Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.
       • lastModifiedByApp - optional; type string
         The application which modified this order. This attribute is read only and is assigned by Google.
       • isProgrammatic - optional; type boolean
         Specifies whether or not the {@code Order} is a programmatic order. This value is optional and defaults to false.
       • appliedTeamIds - optional, unbounded; type long
         The IDs of all teams that this order is on directly.
       • 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 order was last modified.
       • customFieldValues - optional, unbounded; type BaseCustomFieldValue
         The value of a {@link CustomField} for a particular entity.
         • customFieldId - optional; type long
           Id of the {@code CustomField} to which this value belongs. This attribute is required.
         The values of the custom fields associated with this order.
       The collection of orders 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. performOrderAction
   Source code
   Description:
   Performs actions on {@link Order} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performOrderActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performOrderAction

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

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

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

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

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

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

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

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

   Updates the specified {@link Order} objects.

   • orders - optional, unbounded; type Order
     An {@code Order} represents a grouping of individual {@link LineItem} objects, each of which fulfill an ad request from a particular advertiser.
     • id - optional; type long
       The unique ID of the {@code Order}. This value is readonly and is assigned by Google.
     • name - optional; type string
       The name of the {@code Order}. This value is required to create an order and has a maximum length of 255 characters.
     • 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
       The date and time at which the {@code Order} and its associated line items are eligible to begin serving. This attribute is readonly and is derived from the line item of the order which has the earliest {@link LineItem#startDateTime}.
     • 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
       The date and time at which the {@code Order} and its associated line items stop being served. This attribute is readonly and is derived from the line item of the order which has the latest {@link LineItem#endDateTime}.
     • unlimitedEndDateTime - optional; type boolean
       Specifies whether or not the {@code Order} has an unlimited end date. This attribute is readonly and is {@code true} if any of the order's line items has {@link LineItem#unlimitedEndDateTime} set to {@code true}.
     • status - optional; type OrderStatus - type string with restriction - enum { 'DRAFT', 'PENDING_APPROVAL', 'APPROVED', 'DISAPPROVED', 'PAUSED', 'CANCELED', 'DELETED', 'UNKNOWN' }
       The status of the {@code Order}. This attribute is read-only.
     • isArchived - optional; type boolean
       The archival status of the {@code Order}. This attribute is readonly.
     • notes - optional; type string
       Provides any additional notes that may annotate the {@code Order}. This attribute is optional and has a maximum length of 65,535 characters.
     • externalOrderId - optional; type int
       An arbitrary ID to associate to the {@code Order}, which can be used as a key to an external system. This value is optional.
     • poNumber - optional; type string
       The purchase order number for the {@code Order}. This value is optional and has a maximum length of 63 characters.
     • currencyCode - optional; type string
       The ISO currency code for the currency used by the {@code Order}. This value is read-only and is the network's currency code.
     • advertiserId - optional; type long
       The unique ID of the {@link Company}, which is of type {@link Company.Type#ADVERTISER}, to which this order belongs. This attribute is required.
     • advertiserContactIds - optional, unbounded; type long
       List of IDs for advertiser contacts of the order.
     • agencyId - optional; type long
       The unique ID of the {@link Company}, which is of type {@link Company.Type#AGENCY}, with which this order is associated. This attribute is optional.
     • agencyContactIds - optional, unbounded; type long
       List of IDs for agency contacts of the order.
     • creatorId - optional; type long
       The unique ID of the {@link User} who created the {@code Order} on behalf of the advertiser. This value is readonly and is assigned by Google.
     • traffickerId - optional; type long
       The unique ID of the {@link User} responsible for trafficking the {@code Order}. This value is required for creating an order.
     • secondaryTraffickerIds - optional, unbounded; type long
       The IDs of the secondary traffickers associated with the order. This value is optional.
     • salespersonId - optional; type long
       The unique ID of the {@link User} responsible for the sales of the {@code Order}. This value is optional.
     • secondarySalespersonIds - optional, unbounded; type long
       The IDs of the secondary salespeople associated with the order. This value is optional.
     • totalImpressionsDelivered - optional; type long
       Total impressions delivered for all line items of this {@code Order}. This value is read-only and is assigned by Google.
     • totalClicksDelivered - optional; type long
       Total clicks delivered for all line items of this {@code Order}. This value is read-only and is assigned by Google.
     • totalViewableImpressionsDelivered - optional; type long
       Total viewable impressions delivered for all line items of this {@code Order}. This value is read-only and is assigned by Google. Starting in v201705, this will be {@code null} when the order does not have line items trafficked against a viewable impressions goal.
     • totalBudget - optional; type Money
       Represents a money amount.
       • currencyCode - optional; type string
         Three letter currency code in string format.
       • microAmount - optional; type long
         Money values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
       Total budget for all line items of this {@code Order}. This value is a readonly field assigned by Google and is calculated from the associated {@link LineItem#costPerUnit} values.
     • appliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       The set of labels applied directly to this order.
     • effectiveAppliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.
     • lastModifiedByApp - optional; type string
       The application which modified this order. This attribute is read only and is assigned by Google.
     • isProgrammatic - optional; type boolean
       Specifies whether or not the {@code Order} is a programmatic order. This value is optional and defaults to false.
     • appliedTeamIds - optional, unbounded; type long
       The IDs of all teams that this order is on directly.
     • 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 order was last modified.
     • customFieldValues - optional, unbounded; type BaseCustomFieldValue
       The value of a {@link CustomField} for a particular entity.
       • customFieldId - optional; type long
         Id of the {@code CustomField} to which this value belongs. This attribute is required.
       The values of the custom fields associated with this order.
   Output:
   updateOrdersResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateOrdersResponse

   • rval - optional, unbounded; type Order
     An {@code Order} represents a grouping of individual {@link LineItem} objects, each of which fulfill an ad request from a particular advertiser.
     • id - optional; type long
       The unique ID of the {@code Order}. This value is readonly and is assigned by Google.
     • name - optional; type string
       The name of the {@code Order}. This value is required to create an order and has a maximum length of 255 characters.
     • 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
       The date and time at which the {@code Order} and its associated line items are eligible to begin serving. This attribute is readonly and is derived from the line item of the order which has the earliest {@link LineItem#startDateTime}.
     • 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
       The date and time at which the {@code Order} and its associated line items stop being served. This attribute is readonly and is derived from the line item of the order which has the latest {@link LineItem#endDateTime}.
     • unlimitedEndDateTime - optional; type boolean
       Specifies whether or not the {@code Order} has an unlimited end date. This attribute is readonly and is {@code true} if any of the order's line items has {@link LineItem#unlimitedEndDateTime} set to {@code true}.
     • status - optional; type OrderStatus - type string with restriction - enum { 'DRAFT', 'PENDING_APPROVAL', 'APPROVED', 'DISAPPROVED', 'PAUSED', 'CANCELED', 'DELETED', 'UNKNOWN' }
       The status of the {@code Order}. This attribute is read-only.
     • isArchived - optional; type boolean
       The archival status of the {@code Order}. This attribute is readonly.
     • notes - optional; type string
       Provides any additional notes that may annotate the {@code Order}. This attribute is optional and has a maximum length of 65,535 characters.
     • externalOrderId - optional; type int
       An arbitrary ID to associate to the {@code Order}, which can be used as a key to an external system. This value is optional.
     • poNumber - optional; type string
       The purchase order number for the {@code Order}. This value is optional and has a maximum length of 63 characters.
     • currencyCode - optional; type string
       The ISO currency code for the currency used by the {@code Order}. This value is read-only and is the network's currency code.
     • advertiserId - optional; type long
       The unique ID of the {@link Company}, which is of type {@link Company.Type#ADVERTISER}, to which this order belongs. This attribute is required.
     • advertiserContactIds - optional, unbounded; type long
       List of IDs for advertiser contacts of the order.
     • agencyId - optional; type long
       The unique ID of the {@link Company}, which is of type {@link Company.Type#AGENCY}, with which this order is associated. This attribute is optional.
     • agencyContactIds - optional, unbounded; type long
       List of IDs for agency contacts of the order.
     • creatorId - optional; type long
       The unique ID of the {@link User} who created the {@code Order} on behalf of the advertiser. This value is readonly and is assigned by Google.
     • traffickerId - optional; type long
       The unique ID of the {@link User} responsible for trafficking the {@code Order}. This value is required for creating an order.
     • secondaryTraffickerIds - optional, unbounded; type long
       The IDs of the secondary traffickers associated with the order. This value is optional.
     • salespersonId - optional; type long
       The unique ID of the {@link User} responsible for the sales of the {@code Order}. This value is optional.
     • secondarySalespersonIds - optional, unbounded; type long
       The IDs of the secondary salespeople associated with the order. This value is optional.
     • totalImpressionsDelivered - optional; type long
       Total impressions delivered for all line items of this {@code Order}. This value is read-only and is assigned by Google.
     • totalClicksDelivered - optional; type long
       Total clicks delivered for all line items of this {@code Order}. This value is read-only and is assigned by Google.
     • totalViewableImpressionsDelivered - optional; type long
       Total viewable impressions delivered for all line items of this {@code Order}. This value is read-only and is assigned by Google. Starting in v201705, this will be {@code null} when the order does not have line items trafficked against a viewable impressions goal.
     • totalBudget - optional; type Money
       Represents a money amount.
       • currencyCode - optional; type string
         Three letter currency code in string format.
       • microAmount - optional; type long
         Money values are always specified in terms of micros which are a millionth of the fundamental currency unit. For US dollars, $1 is 1,000,000 micros.
       Total budget for all line items of this {@code Order}. This value is a readonly field assigned by Google and is calculated from the associated {@link LineItem#costPerUnit} values.
     • appliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       The set of labels applied directly to this order.
     • effectiveAppliedLabels - optional, unbounded; type AppliedLabel
       Represents a {@link Label} that can be applied to an entity. To negate an inherited label, create an {@code AppliedLabel} with {@code labelId} as the inherited label's ID and {@code isNegated} set to true.
       • labelId - optional; type long
         The ID of a created {@link Label}.
       • isNegated - optional; type boolean
         {@code isNegated} should be set to {@code true} to negate the effects of {@code labelId}.
       Contains the set of labels applied directly to the order as well as those inherited from the company that owns the order. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.
     • lastModifiedByApp - optional; type string
       The application which modified this order. This attribute is read only and is assigned by Google.
     • isProgrammatic - optional; type boolean
       Specifies whether or not the {@code Order} is a programmatic order. This value is optional and defaults to false.
     • appliedTeamIds - optional, unbounded; type long
       The IDs of all teams that this order is on directly.
     • 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 order was last modified.
     • customFieldValues - optional, unbounded; type BaseCustomFieldValue
       The value of a {@link CustomField} for a particular entity.
       • customFieldId - optional; type long
         Id of the {@code CustomField} to which this value belongs. This attribute is required.
       The values of the custom fields associated with this order.
   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.