NAME

Google::Ads::AdWords::v201609::AdwordsUserListService::AdwordsUserListServiceInterfacePort - SOAP Interface for the AdwordsUserListService Web Service

SYNOPSIS

 use Google::Ads::AdWords::v201609::AdwordsUserListService::AdwordsUserListServiceInterfacePort;
 my $interface = Google::Ads::AdWords::v201609::AdwordsUserListService::AdwordsUserListServiceInterfacePort->new();

 my $response;
 $response = $interface->get();
 $response = $interface->mutate();
 $response = $interface->mutateMembers();
 $response = $interface->query();

DESCRIPTION

SOAP Interface for the AdwordsUserListService web service located at https://adwords.google.com/api/adwords/rm/v201609/AdwordsUserListService.

SERVICE AdwordsUserListService

Port AdwordsUserListServiceInterfacePort

METHODS

General methods

new

Constructor.

All arguments are forwarded to SOAP::WSDL::Client.

SOAP Service methods

Method synopsis is displayed with hash refs as parameters.

The commented class names in the method's parameters denote that objects of the corresponding class can be passed instead of the marked hash ref.

You may pass any combination of objects, hash and list refs to these methods, as long as you meet the structure.

List items (i.e. multiple occurences) are not displayed in the synopsis. You may generally pass a list ref of hash refs (or objects) instead of a hash ref - this may result in invalid XML if used improperly, though. Note that SOAP::WSDL always expects list references at maximum depth position.

XML attributes are not displayed in this synopsis and cannot be set using hash refs. See the respective class' documentation for additional information.

get

Returns the list of user lists that meet the selector criteria. @param serviceSelector the selector specifying the {@link UserList}s to return. @return a list of UserList entities which meet the selector criteria. @throws ApiException if problems occurred while fetching UserList information.

Returns a Google::Ads::AdWords::v201609::AdwordsUserListService::getResponse object.

 $response = $interface->get( {
    serviceSelector =>  $a_reference_to, # see Google::Ads::AdWords::v201609::Selector
  },,
 );

mutate

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 @param operations the operations to apply @return a list of UserList objects

Returns a Google::Ads::AdWords::v201609::AdwordsUserListService::mutateResponse object.

 $response = $interface->mutate( {
    operations =>  $a_reference_to, # see Google::Ads::AdWords::v201609::UserListOperation
  },,
 );

mutateMembers

Mutate members of user lists by either adding or removing their lists of members. The following {@link Operator}s are supported: ADD and REMOVE. <p>Note that operations cannot have same user list id but different operators. @param operations the mutate members operations to apply @return a list of UserList objects @throws ApiException when there are one or more errors with the request

Returns a Google::Ads::AdWords::v201609::AdwordsUserListService::mutateMembersResponse object.

 $response = $interface->mutateMembers( {
    operations =>  $a_reference_to, # see Google::Ads::AdWords::v201609::MutateMembersOperation
  },,
 );

query

Returns the list of user lists that match the query. @param query The SQL-like AWQL query string @return A list of UserList @throws ApiException when the query is invalid or there are errors processing the request.

Returns a Google::Ads::AdWords::v201609::AdwordsUserListService::queryResponse object.

 $response = $interface->query( {
    query =>  $some_value, # string
  },,
 );

AUTHOR

Generated by SOAP::WSDL on Fri Sep 30 15:12:04 2016

cpanm Google::Ads::AdWords::Client

perl -MCPAN -e shell
install Google::Ads::AdWords::Client