Home » updatePayoutGroup

updatePayoutGroup

Description

Group Updates the Payout with the given Payout ID

Attributes

FieldTypeRequired
pubPayoutPayoutGroupFalse

PayoutGroup

 

NameTypeDescriptionRequiredAccepted 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".
payoutspayoutCalculates 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 UpdatePayoutGroupTest {

    public static void main(String[] args) {
        UpdatePayoutGroupTest.updatePayoutGroupTest();
    }
    
    private static void updatePayoutGroupTest() {
        
        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.GetPayoutGroup req = new ZEDOAPIStub.GetPayoutGroup();
            
            ZEDOAPIStub.PayoutGroupKey pgKey = new ZEDOAPIStub.PayoutGroupKey();
   
            pgKey.setPublisherId(-3);
            pgKey.setAdvertiserId(476080);
            pgKey.setCampaignId(476081);
            pgKey.setChannelId(425276);
            pgKey.setDimensionId(1);
       
            req.setPgKey(pgKey);
            Thread.sleep(1000);
            ZEDOAPIStub.GetPayoutGroupResponse res = stub.getPayoutGroup(req);      
            ZEDOAPIStub.PayoutGroup pp = res.get_return();

            pp.setStatus("I");
            pp.setPayoutSchemeType("advanced");
            
            
            ZEDOAPIStub.Payout[] p = new ZEDOAPIStub.Payout[3];
            p[0] = new ZEDOAPIStub.Payout();
            p[0].setStartDate("2008-11-18");
            p[0].setEndDate("2008-11-20");
            p[0].setStatus("A");            
             ZEDOAPIStub.PayoutGeo[] pGeo = new ZEDOAPIStub.PayoutGeo[2]; 
             pGeo[0] = new ZEDOAPIStub.PayoutGeo();
             pGeo[0].setGeoId(2);
             pGeo[0].setStatus("A");
             pGeo[0].setCpm(26);
             //pGeo[0].setCpc(12);
             pGeo[0].setRevShare(90);
             pGeo[0].setDuration(10);              
             pGeo[1] = new ZEDOAPIStub.PayoutGeo();
             pGeo[1].setGeoId(1);
             pGeo[1].setStatus("A");
             pGeo[1].setCpm(888.99);
             //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-15");
            p[1].setStatus("I");            
             ZEDOAPIStub.PayoutGeo[] pGeo2 = new ZEDOAPIStub.PayoutGeo[3]; 
             pGeo2[0] = new ZEDOAPIStub.PayoutGeo();
             pGeo2[0].setGeoId(2);
             pGeo2[0].setStatus("A");
             pGeo2[0].setCpm(77.99);
             //pGeo2[0].setCpc(12);
             //pGeo2[0].setRevShare(12);
             pGeo2[0].setDuration(20);
             pGeo2[1] = new ZEDOAPIStub.PayoutGeo();
             pGeo2[1].setGeoId(4);
             pGeo2[1].setStatus("A");
             pGeo2[1].setCpm(876.88);
             //pGeo2[1].setCpc(12.23);
             //pGeo2[1].setRevShare(12.3);
             pGeo2[1].setDuration(40);
             pGeo2[2] = new ZEDOAPIStub.PayoutGeo();
             pGeo2[2].setGeoId(1);
             pGeo2[2].setStatus("A");
             pGeo2[2].setCpm(66.99);
             //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-09-20");
            p[2].setEndDate("2008-09-25");
            p[2].setStatus("A");            
             ZEDOAPIStub.PayoutGeo[] pGeo3 = new ZEDOAPIStub.PayoutGeo[2]; 
             pGeo3[0] = new ZEDOAPIStub.PayoutGeo();
             pGeo3[0].setGeoId(1);
             pGeo3[0].setStatus("A");
             //pGeo3[0].setCpm(55.55);
             pGeo3[0].setCpc(333.99);
             //pGeo3[0].setRevShare(12);
             pGeo3[0].setDuration(20);
             pGeo3[1] = new ZEDOAPIStub.PayoutGeo();
             pGeo3[1].setGeoId(6);
             pGeo3[1].setStatus("I");
             //pGeo3[1].setCpm(666.11);
             pGeo3[1].setCpc(666.11);
             //pGeo3[1].setRevShare(12);
             pGeo3[1].setDuration(20);
            p[2].setPayoutGeos(pGeo3);
            
            pp.setPayouts(p);
        
            ZEDOAPIStub.UpdatePayoutGroup upp = new ZEDOAPIStub.UpdatePayoutGroup();
            upp.setPubPayout(pp);
            stub.updatePayoutGroup(upp);
   
            System.out.println("UPDATE_PAYOUT_GROUP COMPLETE!");
            ZEDOAPIStub.PayoutGroupKey pgk =  upp.getPubPayout().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: UPDATE_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 
         */
        $payoutGroupKey = new PayoutGroupKey();
        $payoutGroupKey->advertiserId=1350037;
        $payoutGroupKey->campaignId=1350038;
        $payoutGroupKey->channelId=1350041;
        $payoutGroupKey->dimensionId=13;
        $payoutGroupKey->publisherId=1350039;
        $param = new getPayoutGroup($payoutGroupKey);
        
        /**
         *Execute API Call 
         */
        try {
        $response = $stub->getPayoutGroup($param);
        }catch (SoapFault $ex) {
           var_dump($ex->faultcode, $ex->faultstring, $ex->detail);
                echo "GET PAYOUTGROUP FAILED\n";
                die();
        }
        
        /**
         * Response
         */
        $tmp = new getPayoutGroupResponse($response);
        $tmp = $tmp->return;
        $payoutGroup = $tmp->return;
        /**
         * Edit Payout Group
         */
        $payoutGroup->status="I";
        
        /**
         * Update Payout Group
         */
        print_r($payoutGroup);
        $updatePayoutGroup = new updatePayoutGroup($payoutGroup);
        try {
                $response = $stub->updatePayoutGroup($updatePayoutGroup);
        }catch (SoapFault $ex) {
             var_dump($ex->faultcode, $ex->faultstring, $ex->detail);
                echo "UPDATE PAYOUTGROUP FAILED\n";
                die();
        }


SOAP