NAME

Google::Ads::AdWords::v201809::CustomAffinityService::CustomAffinityServiceInterfacePort - SOAP Interface for the CustomAffinityService Web Service

SYNOPSIS

 use Google::Ads::AdWords::v201809::CustomAffinityService::CustomAffinityServiceInterfacePort;
 my $interface = Google::Ads::AdWords::v201809::CustomAffinityService::CustomAffinityServiceInterfacePort->new();

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

DESCRIPTION

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

SERVICE CustomAffinityService

Port CustomAffinityServiceInterfacePort

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

Provides the ability to get one or more custom affinity audience with the ability to filter based various criteria. @param serviceSelector a selector describing the subset of custom affinity audience for this customer. @return A page of custom affinity audience as described by the selector.

Returns a Google::Ads::AdWords::v201809::CustomAffinityService::getResponse object.

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

mutate

Applies a list of mutate operations (i.e. add, set) to custom affinity audience: <p> Add - creates a custom affinity audience Set - updates a custom affinity audience <p> Notice that custom affinity tokens are not managed by this method. They are created/deleted by <code>mutateToken</code> method. But when a new custom affinity audience is added, its tokens are also added. @param operations the operations to apply @return a list of CustomAffinity objects

Returns a Google::Ads::AdWords::v201809::CustomAffinityService::mutateResponse object.

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

mutateToken

Applies a list of mutate operations (i.e. add, remove) to custom affinity tokens: <p> Add - creates a custom affinity token Set - set operation for custom affinity token is not supported Remove - deletes a custom affinity token @param operations the operations to apply @return a list of CustomAffinityToken objects

Returns a Google::Ads::AdWords::v201809::CustomAffinityService::mutateTokenResponse object.

 $response = $interface->mutateToken( {
    operations =>  $a_reference_to, # see Google::Ads::AdWords::v201809::CustomAffinityTokenOperation
  },,
 );

query

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

Returns a Google::Ads::AdWords::v201809::CustomAffinityService::queryResponse object.

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

AUTHOR

Generated by SOAP::WSDL on Thu Sep 20 11:05:51 2018