/**
* Test getting the operation index referenced in an expression.
* @param string $expression the OGNL expression to evaluate
* @param mixed $expected the expected operation index
* @covers OgnlUtils::GetOperationIndex
* @dataProvider OperationIndexProvider
*/
public function testGetOperationIndex($expression, $expected)
{
$index = OgnlUtils::GetOperationIndex($expression);
$this->assertEquals($expected, $index);
}
/**
* Runs the example.
* @param AdWordsUser $user the user to run the example with
* @param string $adGroupId the ID of the ad group to add keywords to
*/
function AddKeywordsInBulkExample(AdWordsUser $user, $adGroupId)
{
// Get the service, which loads the required classes.
$mutateJobService = $user->GetService('MutateJobService', ADWORDS_VERSION);
// Generate operations.
$numKeywords = 100;
$operations = array();
for ($i = 0; $i < $numKeywords; $i++) {
$keyword = new Keyword();
// Randomly add invalid characters to keywords.
if (rand(0, 9) == 0) {
$keyword->text = 'keyword!!!' . uniqid();
} else {
$keyword->text = 'keyword' . uniqid();
}
$keyword->matchType = 'BROAD';
$adGroupCriterion = new BiddableAdGroupCriterion();
$adGroupCriterion->adGroupId = $adGroupId;
$adGroupCriterion->criterion = $keyword;
$operation = new AdGroupCriterionOperation();
$operation->operator = 'ADD';
$operation->operand = $adGroupCriterion;
$operations[] = $operation;
}
// You can specify up to 3 job IDs that must successfully complete before
// this job can be processed. We won't set any in this example.
$policy = new BulkMutateJobPolicy();
$policy->prerequisiteJobIds = array();
// Call mutate to create a new job.
printf("Creating job with %d operations.\n", sizeof($operations));
$job = $mutateJobService->mutate($operations, $policy);
printf("Job with ID '%s' was created.\n", $job->id);
// Create a selector for retrieving the job status and later its results.
$selector = new BulkMutateJobSelector();
$selector->jobIds[] = $job->id;
$selector->includeStats = TRUE;
$selector->includeHistory = TRUE;
$numRetries = 0;
$maxRetries = 100;
$retryInterval = 10;
do {
sleep($retryInterval);
$jobs = $mutateJobService->get($selector);
$job = $jobs[0];
switch ($job->status) {
case 'PENDING':
printf("The job has been pending for approximately %s.\n", strftime('%M:%S', time() - strtotime($job->history[0]->dateTime)));
break;
case 'PROCESSING':
printf("The job is processing and approximately %d%% complete.\n", $job->stats->progressPercent);
break;
case 'COMPLETED':
printf("The job is complete and took approximately %d seconds to " . "process.\n", $job->stats->processingTimeMillis / 100);
break;
case 'FAILED':
printf("The job failed with reason '%s'.\n", ChoiceUtils::GetValue($job->failureReason));
break;
}
$numRetries++;
} while (($job->status == 'PENDING' || $job->status == 'PROCESSING') && $numRetries < $maxRetries);
if ($job->status == 'COMPLETED') {
// Retrieve the results of the job.
$jobResult = ChoiceUtils::GetValue($mutateJobService->getResult($selector));
// Sort the keywords into groups based on the results.
$lost = array();
$skipped = array();
$failed = array();
$errors = array();
$genericErrors = array();
// Examines the errors to determine which keywords failed to be applied.
foreach ($jobResult->errors as $error) {
$index = OgnlUtils::GetOperationIndex($error->fieldPath);
if (isset($index)) {
$keywordText = $operations[$index]->operand->criterion->text;
switch ($error->reason) {
case 'LOST_RESULT':
$lost[] = $keywordText;
break;
case 'UNPROCESSED_RESULT':
case 'BATCH_FAILURE':
$skipped[] = $keywordText;
break;
default:
if (!in_array($keywordText, $failed)) {
$failed[] = $keywordText;
}
$errors[$keywordText][] = $error;
}
} else {
$genericErrors[] = $error;
}
}
// Examine the results to determine which keywords were added successfully.
$succeeded = array();
for ($i = 0; $i < sizeof($jobResult->results); $i++) {
$operation = $operations[$i];
$result = ChoiceUtils::GetValue($jobResult->results[$i]);
if ($result instanceof AdGroupCriterion) {
$succeeded[] = $result->criterion->text;
}
}
// Display the results of the job.
printf("%d keywords were added successfully: %s\n", sizeof($succeeded), implode(', ', $succeeded));
printf("%d keywords were skipped and should be retried: %s\n", sizeof($skipped), implode(', ', $skipped));
printf("%d keywords were not added due to errors:\n", sizeof($failed));
foreach ($failed as $keywordText) {
$errorStrings = array();
foreach ($errors[$keywordText] as $error) {
$errorStrings[] = $error->errorString;
}
printf("- %s: %s\n", $keywordText, implode(', ', $errorStrings));
}
printf("%d generic errors were encountered:\n", sizeof($genericErrors));
foreach ($genericErrors as $error) {
printf("- %s\n", $error->errorString);
}
}
}
