Web Service: PlacementService

Port type PlacementServiceInterfaceSource code

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

   Creates new {@link Placement} objects.

   • placements - optional, unbounded; type Placement - extension of type SiteTargetingInfo
     A {@code Placement} groups related {@code AdUnit} objects.
     Deprecated container for information required for AdWords advertisers to place their ads.
     • id - optional; type long
       Uniquely identifies the {@code Placement}. This attribute is read-only and is assigned by Google when a placement is created.
     • name - optional; type string
       The name of the {@code Placement}. This value is required and has a maximum length of 255 characters.
     • description - optional; type string
       A description of the {@code Placement}. This value is optional and its maximum length is 65,535 characters.
     • placementCode - optional; type string
       A string used to uniquely identify the {@code Placement} for purposes of serving the ad. This attribute is read-only and is assigned by Google when a placement is created.
     • status - optional; type InventoryStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'ARCHIVED' }
       The status of the {@code Placement}. This attribute is read-only.
     • targetedAdUnitIds - optional, unbounded; type string
       The collection of {@code AdUnit} object IDs that constitute the {@code Placement}.
     • 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 placement was last modified.
   Output:
   createPlacementsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createPlacementsResponse

   • rval - optional, unbounded; type Placement - extension of type SiteTargetingInfo
     A {@code Placement} groups related {@code AdUnit} objects.
     Deprecated container for information required for AdWords advertisers to place their ads.
     • id - optional; type long
       Uniquely identifies the {@code Placement}. This attribute is read-only and is assigned by Google when a placement is created.
     • name - optional; type string
       The name of the {@code Placement}. This value is required and has a maximum length of 255 characters.
     • description - optional; type string
       A description of the {@code Placement}. This value is optional and its maximum length is 65,535 characters.
     • placementCode - optional; type string
       A string used to uniquely identify the {@code Placement} for purposes of serving the ad. This attribute is read-only and is assigned by Google when a placement is created.
     • status - optional; type InventoryStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'ARCHIVED' }
       The status of the {@code Placement}. This attribute is read-only.
     • targetedAdUnitIds - optional, unbounded; type string
       The collection of {@code AdUnit} object IDs that constitute the {@code Placement}.
     • 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 placement was last modified.
   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. getPlacementsByStatement
   Source code
   Description:
   Gets a {@link PlacementPage} of {@link Placement} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code description}	{@link Placement#description}
   {@code id}	{@link Placement#id}
   {@code name}	{@link Placement#name}
   {@code placementCode}	{@link Placement#placementCode}
   {@code status}	{@link Placement#status}
   {@code lastModifiedDateTime}	{@link Placement#lastModifiedDateTime}

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

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

   PQL Property	Object Property
   {@code description}	{@link Placement#description}
   {@code id}	{@link Placement#id}
   {@code name}	{@link Placement#name}
   {@code placementCode}	{@link Placement#placementCode}
   {@code status}	{@link Placement#status}
   {@code lastModifiedDateTime}	{@link Placement#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:
   getPlacementsByStatementResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type getPlacementsByStatementResponse

   • rval - optional; type PlacementPage
     Captures a page of {@link Placement} 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 Placement - extension of type SiteTargetingInfo
       A {@code Placement} groups related {@code AdUnit} objects.
       Deprecated container for information required for AdWords advertisers to place their ads.
       • id - optional; type long
         Uniquely identifies the {@code Placement}. This attribute is read-only and is assigned by Google when a placement is created.
       • name - optional; type string
         The name of the {@code Placement}. This value is required and has a maximum length of 255 characters.
       • description - optional; type string
         A description of the {@code Placement}. This value is optional and its maximum length is 65,535 characters.
       • placementCode - optional; type string
         A string used to uniquely identify the {@code Placement} for purposes of serving the ad. This attribute is read-only and is assigned by Google when a placement is created.
       • status - optional; type InventoryStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'ARCHIVED' }
         The status of the {@code Placement}. This attribute is read-only.
       • targetedAdUnitIds - optional, unbounded; type string
         The collection of {@code AdUnit} object IDs that constitute the {@code Placement}.
       • 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 placement was last modified.
       The collection of placements 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. performPlacementAction
   Source code
   Description:
   Performs actions on {@link Placement} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performPlacementActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performPlacementAction

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

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

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

   Updates the specified {@link Placement} objects.

   • placements - optional, unbounded; type Placement - extension of type SiteTargetingInfo
     A {@code Placement} groups related {@code AdUnit} objects.
     Deprecated container for information required for AdWords advertisers to place their ads.
     • id - optional; type long
       Uniquely identifies the {@code Placement}. This attribute is read-only and is assigned by Google when a placement is created.
     • name - optional; type string
       The name of the {@code Placement}. This value is required and has a maximum length of 255 characters.
     • description - optional; type string
       A description of the {@code Placement}. This value is optional and its maximum length is 65,535 characters.
     • placementCode - optional; type string
       A string used to uniquely identify the {@code Placement} for purposes of serving the ad. This attribute is read-only and is assigned by Google when a placement is created.
     • status - optional; type InventoryStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'ARCHIVED' }
       The status of the {@code Placement}. This attribute is read-only.
     • targetedAdUnitIds - optional, unbounded; type string
       The collection of {@code AdUnit} object IDs that constitute the {@code Placement}.
     • 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 placement was last modified.
   Output:
   updatePlacementsResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updatePlacementsResponse

   • rval - optional, unbounded; type Placement - extension of type SiteTargetingInfo
     A {@code Placement} groups related {@code AdUnit} objects.
     Deprecated container for information required for AdWords advertisers to place their ads.
     • id - optional; type long
       Uniquely identifies the {@code Placement}. This attribute is read-only and is assigned by Google when a placement is created.
     • name - optional; type string
       The name of the {@code Placement}. This value is required and has a maximum length of 255 characters.
     • description - optional; type string
       A description of the {@code Placement}. This value is optional and its maximum length is 65,535 characters.
     • placementCode - optional; type string
       A string used to uniquely identify the {@code Placement} for purposes of serving the ad. This attribute is read-only and is assigned by Google when a placement is created.
     • status - optional; type InventoryStatus - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'ARCHIVED' }
       The status of the {@code Placement}. This attribute is read-only.
     • targetedAdUnitIds - optional, unbounded; type string
       The collection of {@code AdUnit} object IDs that constitute the {@code Placement}.
     • 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 placement was last modified.
   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.