Google::Ads::AdWords::v201109::MutateJobService::MutateJobServiceInterfacePort - SOAP Interface for the MutateJobService Web Service


Back to Top


NAME

Google::Ads::AdWords::v201109::MutateJobService::MutateJobServiceInterfacePort - SOAP Interface for the MutateJobService Web Service

Back to Top


SYNOPSIS

 use Google::Ads::AdWords::v201109::MutateJobService::MutateJobServiceInterfacePort;
 my $interface = Google::Ads::AdWords::v201109::MutateJobService::MutateJobServiceInterfacePort->new();
 my $response;
 $response = $interface->get();
 $response = $interface->getResult();
 $response = $interface->mutate();

Back to Top


DESCRIPTION

SOAP Interface for the MutateJobService web service located at https://adwords.google.com/api/adwords/cm/v201109/MutateJobService.

Back to Top


SERVICE MutateJobService

Port MutateJobServiceInterfacePort

Back to Top


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

Query the status of existing jobs, both simple and bulk API.<br/> Use a {@link JobSelector} to query and return a list which may contain both {@link BulkMutateJob} and/or {@link SimpleMutateJob}. <p>This method will limit the number of returned results to the most recent 100 jobs. You should use a selector which will return a reasonable number of jobs in the result.

Returns a Google::Ads::AdWords::v201109::MutateJobService::getResponse object.

 $response = $interface->get( {
    selector =>  $a_reference_to, # see Google::Ads::AdWords::v201109::JobSelector
  },,
 );

getResult

Query mutation results, of a {@code COMPLETED} job.<br/> Use a {@link JobSelector} to query and return either a {@link BulkMutateResult} or a {@link SimpleMutateResult}.

Returns a Google::Ads::AdWords::v201109::MutateJobService::getResultResponse object.

 $response = $interface->getResult( {
    selector =>  $a_reference_to, # see Google::Ads::AdWords::v201109::JobSelector
  },,
 );

mutate

Simplified way of submitting a mutation job. The provided list of operations, if valid, will create a new job with a unique id, which will be returned. This id can later be used in invocations of {@link #get} and {@link #getResult}. policy can optionally be specified. <p>When this method returns with success, the job will be in {@code PROCESSING} or {@code PENDING} state and no further action is needed for the job to get executed.<br/> You should not use the returned {@link BulkMutateJobId} with bulk API {@link BulkMutateJobService#mutate} method.</p>

Returns a Google::Ads::AdWords::v201109::MutateJobService::mutateResponse object.

 $response = $interface->mutate( {
    operations =>  $a_reference_to, # see Google::Ads::AdWords::v201109::Operation
    policy =>  $a_reference_to, # see Google::Ads::AdWords::v201109::BulkMutateJobPolicy
  },,
 );

Back to Top


AUTHOR

Generated by SOAP::WSDL on Thu Oct 20 15:12:10 2011

Back to Top

 Google::Ads::AdWords::v201109::MutateJobService::MutateJobServiceInterfacePort - SOAP Interface for the MutateJobService Web Service