Web Service: CustomTargetingService

Port type CustomTargetingServiceInterfaceSource code

1. createCustomTargetingKeys
   Source code
   Description:
   Creates new {@link CustomTargetingKey} objects.

   The following fields are required:

   • {@link CustomTargetingKey#name}
   • {@link CustomTargetingKey#type}
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   createCustomTargetingKeysRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type createCustomTargetingKeys

   Creates new {@link CustomTargetingKey} objects.

   The following fields are required:

   • {@link CustomTargetingKey#name}
   • {@link CustomTargetingKey#type}

   • keys - optional, unbounded; type CustomTargetingKey
     {@code CustomTargetingKey} represents a key used for custom targeting.
     • id - optional; type long
       The ID of the {@code CustomTargetingKey}. This value is readonly and is populated by Google.
     • name - optional; type string
       Name of the key. Keys can contain up to 10 characters each. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
     • displayName - optional; type string
       Descriptive name for the key.
     • type - optional; type CustomTargetingKey.Type - type string with restriction - enum { 'PREDEFINED', 'FREEFORM' }
       Indicates whether users will select from predefined values or create new targeting values, while specifying targeting criteria for a line item.
     • status - optional; type CustomTargetingKey.Status - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       Status of the {@code CustomTargetingKey}. This field is read-only. A key can be activated and deactivated by calling {@link CustomTargetingService#performCustomTargetingKeyAction}.
     • reportableType - optional; type ReportableType - type string with restriction - enum { 'UNKNOWN', 'ON', 'OFF', 'CUSTOM_DIMENSION' }
       Reportable state of a {@CustomTargetingKey} as defined in {@link ReportableType}.
   Output:
   createCustomTargetingKeysResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createCustomTargetingKeysResponse

   • rval - optional, unbounded; type CustomTargetingKey
     {@code CustomTargetingKey} represents a key used for custom targeting.
     • id - optional; type long
       The ID of the {@code CustomTargetingKey}. This value is readonly and is populated by Google.
     • name - optional; type string
       Name of the key. Keys can contain up to 10 characters each. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
     • displayName - optional; type string
       Descriptive name for the key.
     • type - optional; type CustomTargetingKey.Type - type string with restriction - enum { 'PREDEFINED', 'FREEFORM' }
       Indicates whether users will select from predefined values or create new targeting values, while specifying targeting criteria for a line item.
     • status - optional; type CustomTargetingKey.Status - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       Status of the {@code CustomTargetingKey}. This field is read-only. A key can be activated and deactivated by calling {@link CustomTargetingService#performCustomTargetingKeyAction}.
     • reportableType - optional; type ReportableType - type string with restriction - enum { 'UNKNOWN', 'ON', 'OFF', 'CUSTOM_DIMENSION' }
       Reportable state of a {@CustomTargetingKey} as defined in {@link ReportableType}.
   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. createCustomTargetingValues
   Source code
   Description:
   Creates new {@link CustomTargetingValue} objects.

   The following fields are required:

   • {@link CustomTargetingValue#customTargetingKeyId}
   • {@link CustomTargetingValue#name}
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   createCustomTargetingValuesRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type createCustomTargetingValues

   Creates new {@link CustomTargetingValue} objects.

   The following fields are required:

   • {@link CustomTargetingValue#customTargetingKeyId}
   • {@link CustomTargetingValue#name}

   • values - optional, unbounded; type CustomTargetingValue
     {@code CustomTargetingValue} represents a value used for custom targeting.
     • customTargetingKeyId - optional; type long
       The ID of the {@code CustomTargetingKey} for which this is the value.
     • id - optional; type long
       The ID of the {@code CustomTargetingValue}. This value is readonly and is populated by Google.
     • name - optional; type string
       Name of the value. Values can contain up to 40 characters each. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ]. Values are not data-specific; all values are treated as string. For example, instead of using "age>=18 AND <=34", try "18-34"
     • displayName - optional; type string
       Descriptive name for the value.
     • matchType - optional; type CustomTargetingValue.MatchType - type string with restriction - enum { 'EXACT', 'BROAD', 'PREFIX', 'BROAD_PREFIX', 'SUFFIX', 'CONTAINS', 'UNKNOWN' }
       The way in which the {@link CustomTargetingValue#name} strings will be matched.
     • status - optional; type CustomTargetingValue.Status - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       Status of the {@code CustomTargetingValue}. This field is read-only. A value can be activated and deactivated by calling {@link CustomTargetingService#performCustomTargetingValueAction}.
   Output:
   createCustomTargetingValuesResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type createCustomTargetingValuesResponse

   • rval - optional, unbounded; type CustomTargetingValue
     {@code CustomTargetingValue} represents a value used for custom targeting.
     • customTargetingKeyId - optional; type long
       The ID of the {@code CustomTargetingKey} for which this is the value.
     • id - optional; type long
       The ID of the {@code CustomTargetingValue}. This value is readonly and is populated by Google.
     • name - optional; type string
       Name of the value. Values can contain up to 40 characters each. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ]. Values are not data-specific; all values are treated as string. For example, instead of using "age>=18 AND <=34", try "18-34"
     • displayName - optional; type string
       Descriptive name for the value.
     • matchType - optional; type CustomTargetingValue.MatchType - type string with restriction - enum { 'EXACT', 'BROAD', 'PREFIX', 'BROAD_PREFIX', 'SUFFIX', 'CONTAINS', 'UNKNOWN' }
       The way in which the {@link CustomTargetingValue#name} strings will be matched.
     • status - optional; type CustomTargetingValue.Status - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       Status of the {@code CustomTargetingValue}. This field is read-only. A value can be activated and deactivated by calling {@link CustomTargetingService#performCustomTargetingValueAction}.
   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. getCustomTargetingKeysByStatement
   Source code
   Description:
   Gets a {@link CustomTargetingKeyPage} of {@link CustomTargetingKey} objects that satisfy the given {@link Statement#query}. The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link CustomTargetingKey#id}
   {@code name}	{@link CustomTargetingKey#name}
   {@code displayName}	{@link CustomTargetingKey#displayName}
   {@code type}	{@link CustomTargetingKey#type}

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

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

   PQL Property	Object Property
   {@code id}	{@link CustomTargetingKey#id}
   {@code name}	{@link CustomTargetingKey#name}
   {@code displayName}	{@link CustomTargetingKey#displayName}
   {@code type}	{@link CustomTargetingKey#type}

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

   • rval - optional; type CustomTargetingKeyPage
     Captures a page of {@link CustomTargetingKey} 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 CustomTargetingKey
       {@code CustomTargetingKey} represents a key used for custom targeting.
       • id - optional; type long
         The ID of the {@code CustomTargetingKey}. This value is readonly and is populated by Google.
       • name - optional; type string
         Name of the key. Keys can contain up to 10 characters each. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
       • displayName - optional; type string
         Descriptive name for the key.
       • type - optional; type CustomTargetingKey.Type - type string with restriction - enum { 'PREDEFINED', 'FREEFORM' }
         Indicates whether users will select from predefined values or create new targeting values, while specifying targeting criteria for a line item.
       • status - optional; type CustomTargetingKey.Status - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
         Status of the {@code CustomTargetingKey}. This field is read-only. A key can be activated and deactivated by calling {@link CustomTargetingService#performCustomTargetingKeyAction}.
       • reportableType - optional; type ReportableType - type string with restriction - enum { 'UNKNOWN', 'ON', 'OFF', 'CUSTOM_DIMENSION' }
         Reportable state of a {@CustomTargetingKey} as defined in {@link ReportableType}.
       The collection of custom targeting keys 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.
4. getCustomTargetingValuesByStatement
   Source code
   Description:
   Gets a {@link CustomTargetingValuePage} of {@link CustomTargetingValue} objects that satisfy the given {@link Statement#query}.

   The {@code WHERE} clause in the {@link Statement#query} must always contain {@link CustomTargetingValue#customTargetingKeyId} as one of its columns in a way that it is AND'ed with the rest of the query. So, if you want to retrieve values for a known set of key ids, valid {@link Statement#query} would look like:

   1. "WHERE customTargetingKeyId IN ('17','18','19')" retrieves all values that are associated with keys having ids 17, 18, 19.
   2. "WHERE customTargetingKeyId = '17' AND name = 'red'" retrieves values that are associated with keys having id 17 and value name is 'red'.

   The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link CustomTargetingValue#id}
   {@code customTargetingKeyId}	{@link CustomTargetingValue#customTargetingKeyId}
   {@code name}	{@link CustomTargetingValue#name}
   {@code displayName}	{@link CustomTargetingValue#displayName}
   {@code matchType}	{@link CustomTargetingValue#matchType}

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

   Gets a {@link CustomTargetingValuePage} of {@link CustomTargetingValue} objects that satisfy the given {@link Statement#query}.

   The {@code WHERE} clause in the {@link Statement#query} must always contain {@link CustomTargetingValue#customTargetingKeyId} as one of its columns in a way that it is AND'ed with the rest of the query. So, if you want to retrieve values for a known set of key ids, valid {@link Statement#query} would look like:

   1. "WHERE customTargetingKeyId IN ('17','18','19')" retrieves all values that are associated with keys having ids 17, 18, 19.
   2. "WHERE customTargetingKeyId = '17' AND name = 'red'" retrieves values that are associated with keys having id 17 and value name is 'red'.

   The following fields are supported for filtering:

   PQL Property	Object Property
   {@code id}	{@link CustomTargetingValue#id}
   {@code customTargetingKeyId}	{@link CustomTargetingValue#customTargetingKeyId}
   {@code name}	{@link CustomTargetingValue#name}
   {@code displayName}	{@link CustomTargetingValue#displayName}
   {@code matchType}	{@link CustomTargetingValue#matchType}

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

   • rval - optional; type CustomTargetingValuePage
     Captures a page of {@link CustomTargetingValue} 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 CustomTargetingValue
       {@code CustomTargetingValue} represents a value used for custom targeting.
       • customTargetingKeyId - optional; type long
         The ID of the {@code CustomTargetingKey} for which this is the value.
       • id - optional; type long
         The ID of the {@code CustomTargetingValue}. This value is readonly and is populated by Google.
       • name - optional; type string
         Name of the value. Values can contain up to 40 characters each. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ]. Values are not data-specific; all values are treated as string. For example, instead of using "age>=18 AND <=34", try "18-34"
       • displayName - optional; type string
         Descriptive name for the value.
       • matchType - optional; type CustomTargetingValue.MatchType - type string with restriction - enum { 'EXACT', 'BROAD', 'PREFIX', 'BROAD_PREFIX', 'SUFFIX', 'CONTAINS', 'UNKNOWN' }
         The way in which the {@link CustomTargetingValue#name} strings will be matched.
       • status - optional; type CustomTargetingValue.Status - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
         Status of the {@code CustomTargetingValue}. This field is read-only. A value can be activated and deactivated by calling {@link CustomTargetingService#performCustomTargetingValueAction}.
       The collection of custom targeting keys 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.
5. performCustomTargetingKeyAction
   Source code
   Description:
   Performs actions on {@link CustomTargetingKey} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performCustomTargetingKeyActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performCustomTargetingKeyAction

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

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

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

   Exception class for holding a list of service errors.

   Base class for exceptions.

   • message - optional; type string
     Error message.

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

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

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

   A fault element of type ApiException.
6. performCustomTargetingValueAction
   Source code
   Description:
   Performs actions on {@link CustomTargetingValue} objects that match the given {@link Statement#query}.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   performCustomTargetingValueActionRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type performCustomTargetingValueAction

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

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

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

   Updates the specified {@link CustomTargetingKey} objects.

   • keys - optional, unbounded; type CustomTargetingKey
     {@code CustomTargetingKey} represents a key used for custom targeting.
     • id - optional; type long
       The ID of the {@code CustomTargetingKey}. This value is readonly and is populated by Google.
     • name - optional; type string
       Name of the key. Keys can contain up to 10 characters each. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
     • displayName - optional; type string
       Descriptive name for the key.
     • type - optional; type CustomTargetingKey.Type - type string with restriction - enum { 'PREDEFINED', 'FREEFORM' }
       Indicates whether users will select from predefined values or create new targeting values, while specifying targeting criteria for a line item.
     • status - optional; type CustomTargetingKey.Status - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       Status of the {@code CustomTargetingKey}. This field is read-only. A key can be activated and deactivated by calling {@link CustomTargetingService#performCustomTargetingKeyAction}.
     • reportableType - optional; type ReportableType - type string with restriction - enum { 'UNKNOWN', 'ON', 'OFF', 'CUSTOM_DIMENSION' }
       Reportable state of a {@CustomTargetingKey} as defined in {@link ReportableType}.
   Output:
   updateCustomTargetingKeysResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateCustomTargetingKeysResponse

   • rval - optional, unbounded; type CustomTargetingKey
     {@code CustomTargetingKey} represents a key used for custom targeting.
     • id - optional; type long
       The ID of the {@code CustomTargetingKey}. This value is readonly and is populated by Google.
     • name - optional; type string
       Name of the key. Keys can contain up to 10 characters each. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
     • displayName - optional; type string
       Descriptive name for the key.
     • type - optional; type CustomTargetingKey.Type - type string with restriction - enum { 'PREDEFINED', 'FREEFORM' }
       Indicates whether users will select from predefined values or create new targeting values, while specifying targeting criteria for a line item.
     • status - optional; type CustomTargetingKey.Status - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       Status of the {@code CustomTargetingKey}. This field is read-only. A key can be activated and deactivated by calling {@link CustomTargetingService#performCustomTargetingKeyAction}.
     • reportableType - optional; type ReportableType - type string with restriction - enum { 'UNKNOWN', 'ON', 'OFF', 'CUSTOM_DIMENSION' }
       Reportable state of a {@CustomTargetingKey} as defined in {@link ReportableType}.
   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.
8. updateCustomTargetingValues
   Source code
   Description:
   Updates the specified {@link CustomTargetingValue} objects.
   Operation type:
   Request-response. The endpoint receives a message, and sends a correlated message.
   Input:
   updateCustomTargetingValuesRequest (wsdlsoap:header, use = literal, part = RequestHeader)Source code
   parameters type updateCustomTargetingValues

   Updates the specified {@link CustomTargetingValue} objects.

   • values - optional, unbounded; type CustomTargetingValue
     {@code CustomTargetingValue} represents a value used for custom targeting.
     • customTargetingKeyId - optional; type long
       The ID of the {@code CustomTargetingKey} for which this is the value.
     • id - optional; type long
       The ID of the {@code CustomTargetingValue}. This value is readonly and is populated by Google.
     • name - optional; type string
       Name of the value. Values can contain up to 40 characters each. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ]. Values are not data-specific; all values are treated as string. For example, instead of using "age>=18 AND <=34", try "18-34"
     • displayName - optional; type string
       Descriptive name for the value.
     • matchType - optional; type CustomTargetingValue.MatchType - type string with restriction - enum { 'EXACT', 'BROAD', 'PREFIX', 'BROAD_PREFIX', 'SUFFIX', 'CONTAINS', 'UNKNOWN' }
       The way in which the {@link CustomTargetingValue#name} strings will be matched.
     • status - optional; type CustomTargetingValue.Status - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       Status of the {@code CustomTargetingValue}. This field is read-only. A value can be activated and deactivated by calling {@link CustomTargetingService#performCustomTargetingValueAction}.
   Output:
   updateCustomTargetingValuesResponse (wsdlsoap:header, use = literal, part = ResponseHeader)Source code
   parameters type updateCustomTargetingValuesResponse

   • rval - optional, unbounded; type CustomTargetingValue
     {@code CustomTargetingValue} represents a value used for custom targeting.
     • customTargetingKeyId - optional; type long
       The ID of the {@code CustomTargetingKey} for which this is the value.
     • id - optional; type long
       The ID of the {@code CustomTargetingValue}. This value is readonly and is populated by Google.
     • name - optional; type string
       Name of the value. Values can contain up to 40 characters each. You can use alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ]. Values are not data-specific; all values are treated as string. For example, instead of using "age>=18 AND <=34", try "18-34"
     • displayName - optional; type string
       Descriptive name for the value.
     • matchType - optional; type CustomTargetingValue.MatchType - type string with restriction - enum { 'EXACT', 'BROAD', 'PREFIX', 'BROAD_PREFIX', 'SUFFIX', 'CONTAINS', 'UNKNOWN' }
       The way in which the {@link CustomTargetingValue#name} strings will be matched.
     • status - optional; type CustomTargetingValue.Status - type string with restriction - enum { 'ACTIVE', 'INACTIVE', 'UNKNOWN' }
       Status of the {@code CustomTargetingValue}. This field is read-only. A value can be activated and deactivated by calling {@link CustomTargetingService#performCustomTargetingValueAction}.
   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.