Home » createPayoutGroup

createPayoutGroup

Description

Creates a new Payout

To create payout set the required values in the Payout object.
This Payout object can be set in the PubPayout field of the createPayoutGroup call.

 

Attributes

 

FieldTypeRequired
pubPayoutPayoutGroupFalse

PayoutGroup

 

FieldTypeDescriptionRequiredAccepted Value
statusstringDisplays whether the payout is active, inactive or archived. falseAccepted values are "A" for active, "I" for inactive and "R" for archived.
payoutSchemeTypestringPayouts can be set as Advanced or Default. falseAccepted values are "advanced" and "default".
payoutsPayouts[ ]Calculates the profit earned by the advertiser or ad network and how much of its earnings are given to the publisher.false
payoutGroupKeypayoutGroupKeyGroups the payout as defaults or advanced payouts.false

Samples

 

Java

import javax.xml.namespace.QName;
import org.apache.axis2.AxisFault;
import com.zedo.zapi.ZEDOAPIStub;

public class CreatePayoutGroupTest {

    public static void main(String[] args) {
        CreatePayoutGroupTest.createPayoutGroupTest();
    }
    
    private static void createPayoutGroupTest() {
        
        try {
                 
            ZEDOAPIStub stub = new ZEDOAPIStub("http://api.zedo.com/v8/?wsdl&java");

                stub._getServiceClient().addStringHeader(new QName("http://api.zedo.com", "user", "zedoapi"),     "example@example.com");
                stub._getServiceClient().addStringHeader(new QName("http://api.zedo.com", "password", "zedoapi"),     "password");
            stub._getServiceClient().addStringHeader(new QName("http://api.zedo.com", "network", "zedoapi"),  "809");
            
            ZEDOAPIStub.PayoutGroup pp = new ZEDOAPIStub.PayoutGroup();

            pp.setStatus("R"); // status ignore but must be set
            pp.setPayoutSchemeType("advanced");
            
            ZEDOAPIStub.PayoutGroupKey pgKey = new ZEDOAPIStub.PayoutGroupKey();
              pgKey.setPublisherId(-3);
              pgKey.setAdvertiserId(476080);
              pgKey.setCampaignId(476081);
              pgKey.setChannelId(425276);
              pgKey.setDimensionId(1);
            pp.setPayoutGroupKey(pgKey);
            
            ZEDOAPIStub.Payout[] p = new ZEDOAPIStub.Payout[3];
            p[0] = new ZEDOAPIStub.Payout();
            p[0].setStartDate("2008-11-18");
            p[0].setEndDate("2008-11-19");
            p[0].setStatus("A");            
             ZEDOAPIStub.PayoutGeo[] pGeo = new ZEDOAPIStub.PayoutGeo[2]; 
             pGeo[0] = new ZEDOAPIStub.PayoutGeo();
             pGeo[0].setGeoId(6);
             pGeo[0].setStatus("A");
             //pGeo[0].setCpm(13);
             pGeo[0].setCpc(333.9);
             //pGeo[0].setRevShare(12);
             pGeo[0].setDuration(20);
             pGeo[1] = new ZEDOAPIStub.PayoutGeo();
             pGeo[1].setGeoId(1);
             pGeo[1].setStatus("A");
             pGeo[1].setCpm(23.3);
             //pGeo[1].setCpc(12.23);
             pGeo[1].setRevShare(12);
             pGeo[1].setDuration(30);
            p[0].setPayoutGeos(pGeo);
         
            p[1] = new ZEDOAPIStub.Payout();
            p[1].setStartDate("2008-12-10");
            p[1].setEndDate("2008-12-13");
            p[1].setStatus("A");            
             ZEDOAPIStub.PayoutGeo[] pGeo2 = new ZEDOAPIStub.PayoutGeo[3]; 
             pGeo2[0] = new ZEDOAPIStub.PayoutGeo();
             pGeo2[0].setGeoId(2);
             pGeo2[0].setStatus("A");
             pGeo2[0].setCpm(13);
             pGeo2[0].setCpc(12);
             //pGeo2[0].setRevShare(12);
             pGeo2[0].setDuration(20);
             pGeo2[1] = new ZEDOAPIStub.PayoutGeo();
             pGeo2[1].setGeoId(1);
             pGeo2[1].setStatus("A");
             pGeo2[1].setCpm(23.3);
             //pGeo2[1].setCpc(12.23);
             //pGeo2[1].setRevShare(12.3);
             pGeo2[1].setDuration(40);
             pGeo2[2] = new ZEDOAPIStub.PayoutGeo();
             pGeo2[2].setGeoId(4);
             pGeo2[2].setStatus("A");
             pGeo2[2].setCpm(23.3);
             //pGeo2[2].setCpc(12.23);
             pGeo2[2].setRevShare(12);
             pGeo2[2].setDuration(70);
            p[1].setPayoutGeos(pGeo2);
            
            p[2] = new ZEDOAPIStub.Payout();
            p[2].setStartDate("2008-11-29");
            p[2].setEndDate("2008-12-05");
            p[2].setStatus("A");            
             ZEDOAPIStub.PayoutGeo[] pGeo3 = new ZEDOAPIStub.PayoutGeo[1]; 
             pGeo3[0] = new ZEDOAPIStub.PayoutGeo();
             pGeo3[0].setGeoId(1);
             pGeo3[0].setStatus("A");
             pGeo3[0].setCpm(13);
             pGeo3[0].setCpc(12);
             //pGeo3[0].setRevShare(12);
             pGeo3[0].setDuration(20);
            p[2].setPayoutGeos(pGeo3);
            
            pp.setPayouts(p);

            ZEDOAPIStub.CreatePayoutGroup cpp = new ZEDOAPIStub.CreatePayoutGroup();
            cpp.setPubPayout(pp);
            ZEDOAPIStub.CreatePayoutGroupResponse cppr = stub.createPayoutGroup(cpp);
   
            System.out.println("CREATE_PAYOUT_GROUP COMPLETE!");
            ZEDOAPIStub.PayoutGroupKey pgk =  cppr.get_return().getPayoutGroupKey();
            System.out.println("PLEASE: " + "\n" + " PayoutGroupKey: ");
            System.out.println(" AdvertiserId: " + pgk.getAdvertiserId());
            System.out.println(" CampaignId: " + pgk.getCampaignId());
            System.out.println(" ChannelId: " + pgk.getChannelId());
            System.out.println(" Dimension: " + pgk.getDimensionId());
            System.out.println(" PublisherId: " + pgk.getPublisherId());

        } catch (Exception e) {
            System.err.println("ERROR: CREATE_PAYOUT_GROUP FAILED!");
            System.err.println("Exception: " + e.getMessage());
            if (e instanceof AxisFault) {
                AxisFault af = (AxisFault) e;
                System.err.println("AxisFault's detail: " + af.getDetail());
                af.printStackTrace();
            } else {
                e.printStackTrace();
            }
        }
    }
}

PHP

 include_once './zlib/ZEDOAPI.php';
        
        /**
         *Create Client Stub
         */
        $config = Array();
        $config['location'] = 'http://api.zedo.com/v8/?wsdl&php';       //URL of the SOAP server to send the request to
        $config['exceptions'] = true;                                                                                                   //Enable Exception Handling
        
        $stub = new ZEDOAPI($config);
        
        $header = Array();
        $header[0] = new SoapHeader('http://api.zedo.com','user', 'example@example.com');
        $header[1] = new SoapHeader('http://api.zedo.com','password', 'password');
        $header[2] = new SoapHeader('http://api.zedo.com','network','525');
        $header[3] = new SoapHeader('http://api.zedo.com','callinfo','zapiCall');
        
        $stub->__setSoapHeaders($header);
        
        /**
         *Define Call Parameters 
         */
        $payoutGroup = new PayoutGroup();
        
        $payouts = new Payout();
        $payouts->startDate="2012-12-27";
        $payouts->endDate="3000-01-01";
        $payouts->status="A";
        $payoutGeos = Array();
        $payoutGeos[0] = new PayoutGeo();
        $payoutGeos[0]->geoId=1;
        $payoutGeos[0]->status="A";
        $payoutGeos[0]->cpc=333;
        $payoutGeos[0]->duration=20;
        $payoutGeos[1] = new PayoutGeo();
        $payoutGeos[1]->geoId=173;
        $payoutGeos[1]->status="A";
        $payoutGeos[1]->cpm=23;
        $payoutGeos[1]->revShare=12;
        $payoutGeos[1]->duration=30;
        $payouts->payoutGeos=$payoutGeos;       
        $payoutGroup->payouts=$payouts;
        
        $payoutGroupKey = new PayoutGroupKey();
        $payoutGroupKey->advertiserId=1350037;
        $payoutGroupKey->campaignId=1350038;
        $payoutGroupKey->channelId=1350041;
        $payoutGroupKey->dimensionId=13;
        $payoutGroupKey->publisherId=1350039;
        $payoutGroup->payoutGroupKey=$payoutGroupKey;
        
        $payoutGroup->payoutSchemeType="advanced";
        $payoutGroup->status="A";
        
        $param = new createPayoutGroup($payoutGroup);
        
        /**
         *Execute API Call 
         */
                try {
                $response = $stub->createPayoutGroup($param);
                }catch (SoapFault $ex) {
                  var_dump($ex->faultcode, $ex->faultstring, $ex->detail);
                        echo "CREATE PAYOUTGROUP FAILED\n";
            die();
        }
        
        /**
         * Response
         */
                echo "CREATE PAYOUTGROUP COMPLETE\n\n";
        echo "\nReponse:\n";
        echo $stub->__getLastResponse();

SOAP

Request

Response