Web Service: LineItemTemplateService
Port LineItemTemplateServiceInterfacePort Port typeSource code
- getLineItemTemplatesByStatementDetailSource code
Operations
- getLineItemTemplatesByStatementDescription:Gets a {@link LineItemTemplatePage} of {@link LineItemTemplate} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:
PQL Property Object Property {@code id} {@link LineItemTemplate#id} Operation type:Request-response. The endpoint receives a message, and sends a correlated message.Input:getLineItemTemplatesByStatementRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source codeparameters type getLineItemTemplatesByStatementGets a {@link LineItemTemplatePage} of {@link LineItemTemplate} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:PQL Property Object Property {@code id} {@link LineItemTemplate#id} - filterStatement - optional; type StatementCaptures 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 stringHolds 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_ValueMapEntryHolds 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.
- query - optional; type string
Output:getLineItemTemplatesByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source codeparameters type getLineItemTemplatesByStatementResponse- rval - optional; type LineItemTemplatePageCaptures a page of {@link LineItemTemplate} objects.
- totalResultSetSize - optional; type intThe size of the total result set to which this page belongs.
- startIndex - optional; type intThe absolute index in the total result set on which this page begins.
- results - optional, unbounded; type LineItemTemplateRepresents the template that populates the fields of a new line item being created.
- id - optional; type longUniquely identifies the {@code LineItemTemplate}. This attribute is read-only and is assigned by Google when a template is created.
- name - optional; type stringThe name of the {@code LineItemTemplate}. This attribute is required.
- isDefault - optional; type booleanWhether or not the {@code LineItemTemplate} represents the default choices for creating a {@code LineItem}. Only one default {@code LineItemTemplate} is allowed per {@code Network}. This attribute is readonly.
- lineItemName - optional; type stringThe default {@link LineItem#name name} of a new {@code LineItem}. This attribute is optional and has a maximum length of 127 characters.
- enabledForSameAdvertiserException - optional; type booleanThe default value for the {@link LineItem#enabledForSameAdvertiserException} field of a new {@code LineItem}. This attribute is required.
- notes - optional; type stringThe default {@link LineItem#notes notes} for a new {@code LineItem}. This attribute is optional and has a maximum length of 65,535 characters.
- lineItemType - optional; type LineItemType - type string with restriction - enum { 'SPONSORSHIP', 'STANDARD', 'NETWORK', 'BULK', 'PRICE_PRIORITY', 'HOUSE', 'LEGACY_DFP', 'CLICK_TRACKING', 'ADSENSE', 'AD_EXCHANGE', 'BUMPER', 'ADMOB', 'PREFERRED_DEAL', 'UNKNOWN' }The default {@link LineItem#lineItemType type} of a new {@code LineItem}. This attribute is required.
- deliveryRateType - optional; type DeliveryRateType - type string with restriction - enum { 'EVENLY', 'FRONTLOADED', 'AS_FAST_AS_POSSIBLE' }The default {@link LineItem#deliveryRateType delivery strategy} for a new {@code LineItem}. This attribute is required.
- roadblockingType - optional; type RoadblockingType - type string with restriction - enum { 'ONLY_ONE', 'ONE_OR_MORE', 'AS_MANY_AS_POSSIBLE', 'ALL_ROADBLOCK', 'CREATIVE_SET' }The default {@link LineItem#roadblockingType roadblocking strategy} for a new {@code LineItem}. This attribute is required.
- creativeRotationType - optional; type CreativeRotationType - type string with restriction - enum { 'EVEN', 'OPTIMIZED', 'MANUAL', 'SEQUENTIAL' }The default {@link LineItem#creativeRotationType creative rotation strategy} for a new {@code LineItem}. This attribute is required.
The collection of line item templates contained within this page. - id - optional; type long
- totalResultSetSize - optional; type int
Fault:ApiException (wsdlsoap:fault, use = literal)Source codeApiException type ApiExceptionFaultException class for holding a list of service errors.Base class for exceptions.- message - optional; type stringError message.
- errors - optional, unbounded; type ApiErrorThe 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 stringThe OGNL field path to identify cause of error.
- fieldPathElements - optional, unbounded; type FieldPathElementA 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 stringThe name of a field in lower camelcase. (e.g. "biddingStrategy")
- index - optional; type intFor list fields, this is a 0-indexed position in the list. Null for non-list fields.
- field - optional; type string
- trigger - optional; type stringThe data that caused the error.
- errorString - optional; type stringA simple string representation of the error and reason.
List of errors. - fieldPath - optional; type string
A fault element of type ApiException. - filterStatement - optional; type Statement
Port type LineItemTemplateServiceInterfaceSource code
WSDL source code
About wsdl-viewer.xsl
Author: tomi vanek
Download athttp://tomi.vanek.sk/xml/wsdl-viewer.xsl.
The transformation was inspired by the article
Uche Ogbuji: WSDL processing with XSLT