Web Service: SuggestedAdUnitService

Port type SuggestedAdUnitServiceInterfaceSource code

1. getSuggestedAdUnitsByStatement
   Source code
   Description:
   Gets a {@link SuggestedAdUnitPage} of {@link SuggestedAdUnit} objects that satisfy the filter query. There is a system-enforced limit of 1000 on the number of suggested ad units that are suggested at any one time.

   PQL Property	Object Property
   {@code id}	{@link SuggestedAdUnit#id}
   {@code numRequests}	{@link SuggestedAdUnit#numRequests}

   Note: After API version 201311, the {@code id} field will only be numerical.

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

   Gets a {@link SuggestedAdUnitPage} of {@link SuggestedAdUnit} objects that satisfy the filter query. There is a system-enforced limit of 1000 on the number of suggested ad units that are suggested at any one time.

   PQL Property	Object Property
   {@code id}	{@link SuggestedAdUnit#id}
   {@code numRequests}	{@link SuggestedAdUnit#numRequests}

   Note: After API version 201311, the {@code id} field will only be numerical.

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

   • rval - optional; type SuggestedAdUnitPage
     Contains a page of {@link SuggestedAdUnit} 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 SuggestedAdUnit
       A {@code SuggestedAdUnit} represents a suggestion for a new ad unit, based on an ad tag that has been served at least ten times in the past week, but which does not correspond to a defined ad unit. This type is read-only.
       • id - optional; type string
         The unique ID of the suggested ad unit. After API version 201311 this field will be a numerical ID. Earlier versions will return a string value which is the complete path to the suggested ad unit with path elements separated by '/' characters. This attribute is read-only and is populated by Google.
       • numRequests - optional; type long
         Returns the number of times the ad tag corresponding to this suggested ad unit has been served in the previous week. Suggested ad units are only created when they have been served at least ten times in that period. This attribute is read-only and is populated by Google.
       • path - optional, unbounded; type string
         The hierarchical path from the {@link #parentPath last existing ad unit} after this and all suggested parent ad units have been created. Each path element is a separate ad unit code in the returned list. This attribute is read-only and is populated by Google.
       • parentPath - optional, unbounded; type AdUnitParent
         The summary of a parent {@link AdUnit}.
         • id - optional; type string
           The ID of the parent {@code AdUnit}. This value is readonly and is populated by Google.
         • name - optional; type string
           The name of the parent {@code AdUnit}. This value is readonly and is populated by Google.
         • adUnitCode - optional; type string
           A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is read-only and is assigned by Google when an ad unit is created.
         The existing hierarchical path leading up to, and including, the parent of the first suggested ad unit in the ad unit hierarchy. The {@code parentPath} and the {@code path} make up the full path of the suggested ad unit after it is approved. This attribute is read-only and is populated by Google.

         Note: The ad unit code for each of the parent ad units will not be provided.

       • targetWindow - optional; type AdUnit.TargetWindow - type string with restriction - enum { 'TOP', 'BLANK' }
         The {@code target} attribute of the underlying ad tag, as defined in the {@link AdUnit}. This attribute is read-only and is populated by Google.
       • targetPlatform - optional; type TargetPlatform - type string with restriction - enum { 'WEB', 'MOBILE', 'ANY' }
         The target platform for the browser that clicked the underlying ad tag. This attribute is read-only and is populated by Google.
       • suggestedAdUnitSizes - optional, unbounded; type AdUnitSize
         An {@code AdUnitSize} represents the size of an ad in an ad unit. This also represents the environment and companions of a particular ad in an ad unit. In most cases, it is a simple size with just a width and a height (sometimes representing an aspect ratio).
         • size - optional; type Size
           The permissible creative size that can be served inside this ad unit.
           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.
         • environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }
           The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
         • companions - optional, unbounded; type AdUnitSize
           An {@code AdUnitSize} represents the size of an ad in an ad unit. This also represents the environment and companions of a particular ad in an ad unit. In most cases, it is a simple size with just a width and a height (sometimes representing an aspect ratio).
           • size - optional; type Size
             The permissible creative size that can be served inside this ad unit.
             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.
           • environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }
             The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
           • companions - optional, unbounded; type AdUnitSize
             An {@code AdUnitSize} represents the size of an ad in an ad unit. This also represents the environment and companions of a particular ad in an ad unit. In most cases, it is a simple size with just a width and a height (sometimes representing an aspect ratio).
             • size - optional; type Size
               The permissible creative size that can be served inside this ad unit.
               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.
             • environmentType - optional; type EnvironmentType - type string with restriction - enum { 'BROWSER', 'VIDEO_PLAYER' }
               The environment type of the ad unit size. The default value is {@link EnvironmentType#BROWSER}.
             • companions - optional, unbounded; type AdUnitSize... is recursive
               The companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error.
             • fullDisplayString - optional; type string
               The full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
             • isAudio - optional; type boolean
               Whether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
             The companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error.
           • fullDisplayString - optional; type string
             The full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
           • isAudio - optional; type boolean
             Whether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
           The companions for this ad unit size. Companions are only valid if the environment is {@link EnvironmentType#VIDEO_PLAYER}. If the environment is {@link EnvironmentType#BROWSER} including companions results in an error.
         • fullDisplayString - optional; type string
           The full (including companion sizes, if applicable) display string of the size, e.g. {@code "300x250"} or {@code "300x250v (180x150)"}
         • isAudio - optional; type boolean
           Whether the inventory size is audio. If set to true, {@code Size} will be set to {@code "1x1"} and {@code EnvironmentType} will be set to {@link EnvironmentType#VIDEO_PLAYER} regardless of user input.
         The target sizes associated with this {@code SuggestedAdUnit}. This attribute is read-only and is populated by Google.
       The collection of suggested ad units 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.
2. performSuggestedAdUnitAction
   Source code
   Description:
   Performs actions on {@link SuggestedAdUnit} objects that match the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link SuggestedAdUnit#id}
   {@code numRequests}	{@link SuggestedAdUnit#numRequests}

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

   Performs actions on {@link SuggestedAdUnit} objects that match the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link SuggestedAdUnit#id}
   {@code numRequests}	{@link SuggestedAdUnit#numRequests}

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

   • rval - optional; type SuggestedAdUnitUpdateResult
     Represents the result of performing an action on {@link SuggestedAdUnit} objects.
     • newAdUnitIds - optional, unbounded; type string
       The ids of the {@link AdUnit} objects that were created in response to a performSuggestedAdUnitAction call.
     • 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.