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

Interface AdwordsUserListServiceInterface

public interface AdwordsUserListServiceInterface

Service which is used to manage user lists. 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
UserListPage	get(Selector serviceSelector) Returns the list of user lists that meet the selector criteria.
UserListReturnValue	mutate(List<UserListOperation> operations) Applies a list of mutate operations (i.e.
MutateMembersReturnValue	mutateMembers(List<MutateMembersOperation> operations) Mutate members of user lists by either adding or removing their lists of members.
UserListPage	query(String query) Returns the list of user lists 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.AdwordsUserListServiceInterfaceget")
 @ResponseWrapper(localName="getResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/rm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.rm.AdwordsUserListServiceInterfacegetResponse")
UserListPage get(Selector serviceSelector)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException

Returns the list of user lists that meet the selector criteria.

Parameters:

serviceSelector - the selector specifying the UserLists to return.

serviceSelector -

Returns:

a list of UserList entities which meet the selector criteria.

Throws:

ApiException - if problems occurred while fetching UserList information.

ApiException

mutate

@RequestWrapper(localName="mutate",
                targetNamespace="https://adwords.google.com/api/adwords/rm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.rm.AdwordsUserListServiceInterfacemutate")
 @ResponseWrapper(localName="mutateResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/rm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.rm.AdwordsUserListServiceInterfacemutateResponse")
UserListReturnValue mutate(List<UserListOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        throws ApiException

Applies a list of mutate operations (i.e. add, set): Add - creates a set of user lists Set - updates a set of user lists Remove - not supported

Parameters:

operations - the operations to apply

operations -

Returns:

a list of UserList objects

Throws:

ApiException

mutateMembers

@RequestWrapper(localName="mutateMembers",
                targetNamespace="https://adwords.google.com/api/adwords/rm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.rm.AdwordsUserListServiceInterfacemutateMembers")
 @ResponseWrapper(localName="mutateMembersResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/rm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.rm.AdwordsUserListServiceInterfacemutateMembersResponse")
MutateMembersReturnValue mutateMembers(List<MutateMembersOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throws ApiException

Mutate members of user lists by either adding or removing their lists of members. The following Operators are supported: ADD and REMOVE. The SET operator is not supported.

Note that operations cannot have same user list id but different operators.

Parameters:

operations - the mutate members operations to apply

operations -

Returns:

a list of UserList objects

Throws:

ApiException - when there are one or more errors with the request

ApiException

query

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

Returns the list of user lists that match the query.

Parameters:

query - The SQL-like AWQL query string

query -

Returns:

A list of UserList

Throws:

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

ApiException