com.google.api.ads.adwords.jaxws.v201809.rm

Interface CustomAffinityServiceInterface

public interface CustomAffinityServiceInterface

A service which is used to manage custom affinity audience. This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

Modifier and Type	Method and Description
CustomAffinityPage	get(Selector serviceSelector) Provides the ability to get one or more custom affinity audience with the ability to filter based various criteria.
CustomAffinityReturnValue	mutate(List<CustomAffinityOperation> operations) Applies a list of mutate operations (i.e.
CustomAffinityTokenReturnValue	mutateToken(List<CustomAffinityTokenOperation> operations) Applies a list of mutate operations (i.e.
CustomAffinityPage	query(String query) Returns the list of CustomAffinity that match the query.

Method Detail

get

@RequestWrapper(localName="get",
                targetNamespace="https://adwords.google.com/api/adwords/rm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.rm.CustomAffinityServiceInterfaceget")
 @ResponseWrapper(localName="getResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/rm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.rm.CustomAffinityServiceInterfacegetResponse")
CustomAffinityPage get(Selector serviceSelector)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      throws ApiException

Provides the ability to get one or more custom affinity audience with the ability to filter based various criteria.

Parameters:

serviceSelector - a selector describing the subset of custom affinity audience for this customer.

serviceSelector -

Returns:

A page of custom affinity audience as described by the selector.

Throws:

ApiException

mutate

@RequestWrapper(localName="mutate",
                targetNamespace="https://adwords.google.com/api/adwords/rm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.rm.CustomAffinityServiceInterfacemutate")
 @ResponseWrapper(localName="mutateResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/rm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.rm.CustomAffinityServiceInterfacemutateResponse")
CustomAffinityReturnValue mutate(List<CustomAffinityOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException

Applies a list of mutate operations (i.e. add, set) to custom affinity audience:

Add - creates a custom affinity audience Set - updates a custom affinity audience

Notice that custom affinity tokens are not managed by this method. They are created/deleted by mutateToken method. But when a new custom affinity audience is added, its tokens are also added.

Parameters:

operations - the operations to apply

operations -

Returns:

a list of CustomAffinity objects

Throws:

ApiException

mutateToken

@RequestWrapper(localName="mutateToken",
                targetNamespace="https://adwords.google.com/api/adwords/rm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.rm.CustomAffinityServiceInterfacemutateToken")
 @ResponseWrapper(localName="mutateTokenResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/rm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.rm.CustomAffinityServiceInterfacemutateTokenResponse")
CustomAffinityTokenReturnValue mutateToken(List<CustomAffinityTokenOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws ApiException

Applies a list of mutate operations (i.e. add, remove) to custom affinity tokens:

Add - creates a custom affinity token Set - set operation for custom affinity token is not supported Remove - deletes a custom affinity token

Parameters:

operations - the operations to apply

operations -

Returns:

a list of CustomAffinityToken objects

Throws:

ApiException

query

@RequestWrapper(localName="query",
                targetNamespace="https://adwords.google.com/api/adwords/rm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.rm.CustomAffinityServiceInterfacequery")
 @ResponseWrapper(localName="queryResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/rm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.rm.CustomAffinityServiceInterfacequeryResponse")
CustomAffinityPage query(String query)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throws ApiException

Returns the list of CustomAffinity that match the query.

Parameters:

query - The SQL-like AWQL query string

query -

Returns:

A list of CustomAffinity

Throws:

ApiException - when the query is invalid or there are errors processing the request.

ApiException