How to Create Campaigns in PHP (V5)


We will release PHP samples in V5 to MSDN by May 2008. In the interim, we'll use this site to release PHP samples in V5.


The PHP example below shows how to create campaigns by using the Campaign Management Web service. This example assumes that you have already determined which account ID will be used for the campaigns; you must substitute your account ID for the $accountID variable that is assigned 489 in the following code.


Thanks,
Walter Poupore
Lead Programming Writer
Microsoft adCenter API


<?php


// This program requires the following PHP extensions:
//    php_soap.dll
//    php_openssl.dll



// To ensure that a cached WSDL is not being used,
// disable WSDL caching.
ini_set("soap.wsdl_cache_enabled", "0");


try
{


    $accountId = 489;  //Application-specific value.


    // Use either the sandbox or production URI.
    // This example is for the sandbox URI.
    $URI =
        "https://sandboxapi.adcenter.microsoft.com/api/advertiser/v5/";
    // The following commented-out line contains the production URI.
    //$URI = "https://adcenterapi.microsoft.com/api/advertiser/v5/";


    // The adCenter API namespace.
    $xmlns = "https://adcenter.microsoft.com/api/advertiser/v5";


    // The proxy for the Campaign Management Web service.
    $campaignProxy =
        $URI . "CampaignManagement/CampaignManagementService.svc?wsdl";


    // The name of the service operation that will be called.
    $action = "AddCampaigns";



    // The user name, password, and developer token are
    // expected to be passed in as command-line
    // arguments.
    // $argv[0] is the PHP file name.
    // $argv[1] is the user name.
    // $argv[2] is the password.
    // $argv[3] is the developer token.
    if ($argc !=4)
    {
        printf("Usage:\n");
        printf(
          "php file.php username password devtoken\n");
        exit(0);
    }
    $username = $argv[1];
    $password = $argv[2];
    $developerTokenValue = $argv[3];
    $applicationTokenValue="";


    // Assign the credentials to the classes
    // that are used by the SOAP headers.
    $userCredentials=new UserCredentials();
    $userCredentials->Username=$username;
    $userCredentials->Password=$password;
    $developerToken=new DeveloperToken();
    $developerToken->Value=$developerTokenValue;
    $applicationToken=new ApplicationToken();
    $applicationToken->Value=$applicationTokenValue;


    // Create the SOAP headers.
    $headerApplicationToken =
        new SoapHeader
        (
            $xmlns,
            'ApplicationToken',
            $applicationToken,
            false
        );
    $headerDeveloperToken =
        new SoapHeader
        (
            $xmlns,
            'DeveloperToken',
            $developerToken,
            false
        );
    $headerUserCredentials =
        new SoapHeader
        (
            $xmlns,
            'UserCredentials',
            $userCredentials,
            false
        );


    // Create the SOAP input header array.
    $inputHeaders = array
    (
        $headerApplicationToken,
        $headerDeveloperToken,
        $headerUserCredentials
    );


    // Create the SOAP client.
    $opts = array('trace' => true);
    $client = new SOAPClient($campaignProxy, $opts);


    // This example does not assign any values
    // for negative keywords.
    $negativeKeywords;


    // Create an array of campaigns.
    $campaigns[] = array
    (
        "BudgetType" => 'DailyBudgetWithMaximumMonthlySpend',
        "ConversionTrackingEnabled" => 'false',
        "DailyBudget" => 50,
        "DaylightSaving" => 'true',
        "Description" => 'Winter Clothing Products',
        "MonthlyBudget" => 5000,
        "Name" => 'Winter Clothing',
        "NegativeKeywords" => $negativeKeywords,
        "TimeZone" => 'PacificTimeUSCanadaTijuana'
    );   
    $campaigns[] = array
    (
        "BudgetType" => 'DailyBudgetWithMaximumMonthlySpend',
        "ConversionTrackingEnabled" => 'false',
        "DailyBudget" => 2000,
        "DaylightSaving" => 'true',
        "Description" => 'Athletic gear for winter',
        "MonthlyBudget" => 40000,
        "Name" => 'Winter Athletic Gear',
        "NegativeKeywords" => $negativeKeywords,
        "TimeZone" => 'EasternTimeUSCanada'
    );


    // Specify the parameters for the SOAP call.
    $params = array
    (
        'AccountId'=>$accountId,
        'Campaigns'=>$campaigns
    );
  
    // Execute the SOAP call.
    $result = $client->__soapCall
    (
        $action,
        array( $action.'Request' => $params ),
        null,
        $inputHeaders,
        $outputHeaders
    );
   
    print "$action succeeded with Tracking ID "
          . $outputHeaders['ApiCallTrackingData']->TrackingId
          . ".\n";


    // Retrieve the campaign IDs.
    if (isset(
        $result->CampaignIds->int
        ))
    {
        if (is_array($result->CampaignIds->int))
        {
            // An array of campaign IDs has been returned.
            $obj = $result->CampaignIds->int;
        }
        else
        {
            // A single campaign ID has been returned.
            $obj = $result->CampaignIds;
        }
        print "The following campaigns were returned by $action:\n";
        foreach ($obj as $campaignId)
        {
            print "Campaign ID: " . $campaignId . "\n";
        }
    }
}


catch (Exception $e)
{
    print "$action failed.\n";


    // Display the fault code and the fault string.
    print $e->faultcode . " " . $e->faultstring . ".\n";


    print "TrackingID: " .
        $e->detail->ApiFaultDetail->TrackingId . ".\n";


    // Process operation errors.
    if (isset(
        $e->detail->ApiFaultDetail->OperationErrors->OperationError
        ))
    {
        if (is_array(
            $e->detail->ApiFaultDetail->OperationErrors->OperationError
            ))
        {
            // An array of operation errors has been returned.
            $obj =
                $e->detail->ApiFaultDetail->OperationErrors->OperationError;
        }
        else
        {
            // A single operation error has been returned.
            $obj = $e->detail->ApiFaultDetail->OperationErrors;
        }
        foreach ($obj as $operationError)
        {
            print "Operation error " .
                $operationError->Code . " encountered. ";
            print $operationError->Message . "\n";
        }
    }


    // Process batch errors.
    if (isset(
        $e->detail->ApiFaultDetail->BatchErrors->BatchError
        ))
    {
        if (is_array(
            $e->detail->ApiFaultDetail->BatchErrors->BatchError
            ))
        {
            // An array of batch errors has been returned.
            $obj = $e->detail->ApiFaultDetail->BatchErrors->BatchError;
        }
        else
        {
            // A single batch error has been returned.
            $obj = $e->detail->ApiFaultDetail->BatchErrors;
        }
        foreach ($obj as $batchError)
        {
            print "Campaign index " . $batchError->Index . "\n";
            print "Batch error " .
                $batchError->Code . " encountered. ";
            print $batchError->Message . "\n";
        }
    }
}


// Definitions for classes that are used by the SOAP headers.
class ApplicationToken
{
    public $Value;
}
class DeveloperToken
{
    public $Value;
}
class UserCredentials
{
    public $Password;
    public $Username;
}


?>

Comments (0)

Skip to main content