How to Create Ad Groups 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 following PHP example shows how to create ad groups by using the Campaign Management Web service. This example assumes that you have already determined which campaign ID will be used for the ad groups; you must substitute your campaign ID for the $campaignID variable that is assigned 136164 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
{


    $campaignId = 136164;  //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 = "AddAdGroups";   



    // 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;


    // Use 1 November 2008 as the start date for the ad groups.
    $startDay = 1;
    $startMonth = 11;
    $startYear = 2008;


    // Use 31 December 2009 as the end date for the ad groups.
    $endDay = 31;
    $endMonth = 12;
    $endYear = 2009;


    // Create an array of ad groups.
    $adGroups[] = array
    (
        "Name"              => 'Hand wear',
        "AdDistribution"    => 'Search',
        "LanguageAndRegion" => 'EnglishUnitedStates',
        "StartDate"         => array
                              (
                                   'Day'   => $startDay,
                                   'Month' => $startMonth,
                                   'Year'  => $startYear
                               ),
        "EndDate"           => array
                               (
                                   'Day'   => $endDay,
                                   'Month' => $endMonth,
                                   'Year'  => $endYear
                               ),
        "NegativeKeywords"  => $negativeKeywords
    );


    $adGroups[] = array
    (
        "Name"              => 'Headwear',
        "AdDistribution"    => 'Search',
        "LanguageAndRegion" => 'EnglishUnitedStates',
        "StartDate"         => array
                              (
                                   'Day'   => $startDay,
                                   'Month' => $startMonth,
                                   'Year'  => $startYear
                               ),
        "EndDate"           => array
                               (
                                   'Day'   => $endDay,
                                   'Month' => $endMonth,
                                   'Year'  => $endYear
                               ),
        "NegativeKeywords"  => $negativeKeywords
    );


    // Specify the parameters for the SOAP call.
    $params = array
    (
        'CampaignId'=>$campaignId,
        'AdGroups'=>$adGroups
    );
   
    // 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 ad group IDs.
    if (isset(
        $result->AdGroupIds->int
        ))
    {
        if (is_array($result->AdGroupIds->int))
        {
            // An array of ad group IDs has been returned.
            $obj = $result->AdGroupIds->int;
        }
        else
        {
            // A single ad group ID has been returned.
            $obj = $result->AdGroupIds;
        }
        print "The following ad groups were returned by $action:\n";
        foreach ($obj as $adGroupId)
        {
            print "Ad group ID: " . $adGroupId . "\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 "Ad group 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