GetCreativeCategories

Advertisers can organise their creatives in categories. This method delivers those categories for a given program.

To access live data, please use this WSDL file:
https://api.affili.net/V2.0/PublisherCreative.svc?wsdl
To access demo data, please use this WSDL file:
https://developer-api.affili.net/V2.0/PublisherCreative.svc?wsdl

Web service description

Test data document

Operation test

With this form, you can try out this web service. We already filled it out with a sample request which will return data. Feel free to fill in different parameter values - our test data reference gives you an overview of our sample data.

Field	Type	Values
PublisherId *	int
ProgramId *	int

XML response

Short paramter definitions

PublisherId (int):: Id of the publisher whose account is being used.
ProgramId (int):: The Id of the program whose creative categories you would like to receive.

Complete code examples

package wsapi_publishercreative;

import com.microsoft.schemas._2003._10.serialization.arrays.ArrayOfKeyValueOfstringstring.KeyValueOfstringstring;
import com.microsoft.schemas._2003._10.serialization.arrays.ArrayOfint;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.xml.bind.JAXBElement;
import webservices.framework.affilinet.svc.PublisherCreativeServiceContract;
import webservices.framework.affilinet.svc.PublisherCreativeServiceContractGetCreativeCategoriesPublisherCreativeFaultFaultFaultMessage;
import webservices.framework.affilinet.svc.PublisherCreativeServiceContractSearchCreativesPublisherCreativeFaultFaultFaultMessage;
import webservices.framework.affilinet.types.publishercreative.ArrayOfCreativeTypeEnum;
import webservices.framework.affilinet.types.publishercreative.ArrayOfHTMLLinkTypeEnum;
import webservices.framework.affilinet.types.publishercreative.ArrayOfTextLinkTypeEnum;
import webservices.framework.affilinet.types.publishercreative.CreativeCategory;
import webservices.framework.affilinet.types.publishercreative.CreativeDisplaySettings;
import webservices.framework.affilinet.types.publishercreative.CreativeTypeEnum;
import webservices.framework.affilinet.types.publishercreative.HTMLLinkTypeEnum;
import webservices.framework.affilinet.types.publishercreative.SearchCreativesQuery;
import webservices.framework.affilinet.types.publishercreative.TextLinkTypeEnum;

/**
 *
 * @author affilinet
 */
public class PublisherCreativeWrapper {

    public CreativeCategory GetCreativeCategories(String credentialToken, Integer programId)
    {
        try {
            /*
            ObjectFactory to create types that are used in the service
             */
            webservices.framework.affilinet.svc.ObjectFactory svcObjectFactory =
                    new webservices.framework.affilinet.svc.ObjectFactory();
            webservices.framework.affilinet.types.publishercreative.ObjectFactory typesObjectFactory =
                    new webservices.framework.affilinet.types.publishercreative.ObjectFactory();
            /*
            Create the service endpoint interface
             */
            webservices.framework.affilinet.svc.PublisherCreative service =
                    new webservices.framework.affilinet.svc.PublisherCreative();
            /*
            Create a proxy out of the service endpoint interface
             */
            PublisherCreativeServiceContract proxy =
                    service.getPort(PublisherCreativeServiceContract.class);
            /*
            Create typed parameters which will be used in the service call
             */
            JAXBElement<String> credentialTokenJE =
                    svcObjectFactory.createGetCreativeCategoriesRequestCredentialToken(credentialToken);
            
            /*
            Create typed request message which will be used in the service call
             */
            webservices.framework.affilinet.svc.GetCreativeCategoriesRequest request =
                    svcObjectFactory.createGetCreativeCategoriesRequest();
            request.setCredentialToken(credentialTokenJE);
            request.setProgramId(programId);
            /*
            call the service method and process the result
             */
            webservices.framework.affilinet.svc.GetCreativeCategoriesResponse response =
                    proxy.getCreativeCategories(request);
            return response.getCreativeCategoryCollection().getValue();

        } catch (PublisherCreativeServiceContractGetCreativeCategoriesPublisherCreativeFaultFaultFaultMessage ex) {
            Logger.getLogger(PublisherCreativeWrapper.class.getName()).log(Level.SEVERE, null, ex);
            List<KeyValueOfstringstring> errors =
                    ex.getFaultInfo().getErrors().getValue().getKeyValueOfstringstring();
            for(KeyValueOfstringstring error : errors) {
                System.out.println("ERROR: " + error.getKey() + " - " + error.getValue());
            }
        }
        return null;
    }

}

<?php

/* <LIVE DATA>  
define ("WSDL_LOGON", "https://api.affili.net/V2.0/Logon.svc?wsdl");
define ("WSDL_CREAT",  "https://api.affili.net/V2.0/PublisherCreative.svc?wsdl");

$Username   = ''; // the publisher ID
$Password   = ''; // the publisher web services password

$SOAP_LOGON = new SoapClient(WSDL_LOGON);
$Token      = $SOAP_LOGON->Logon(array(
             'Username'  => $Username,
             'Password'  => $Password,
             'WebServiceType' => 'Publisher'
             ));
  </LIVE DATA> */

/* <DEMO DATA>  */
define ("WSDL_LOGON", "https://developer-api.affili.net/V2.0/Logon.svc?wsdl");
define ("WSDL_CREAT", "https://developer-api.affili.net/V2.0/PublisherCreative.svc?wsdl");

$Username   = '';     // your developer ID, as seen in the developer portal under "My Account", normally something like "Users.X.XXX"
$Password   = '';     // your developer portal password
$DemoPublisherId   = 403233;  // one of the publisher IDs of our demo database
$DeveloperSettings = array('SandboxPublisherID' => $DemoPublisherId);

$SOAP_LOGON = new SoapClient(WSDL_LOGON);
$Token      = $SOAP_LOGON->Logon(array(
                     'Username'  => $Username,
                     'Password'  => $Password,
                     'WebServiceType' => 'Publisher',
                     'DeveloperSettings' => $DeveloperSettings
                     ));
/* </DEMO DATA> */

$SOAP_REQUEST = new SoapClient(WSDL_CREAT);
$req = $SOAP_REQUEST->GetCreativeCategories(array(
            'CredentialToken' => $Token,
			'ProgramId' => '3432'
            ));

print '<pre>RESULTS:<br>'.htmlspecialchars(print_r($req, true)).'</pre>';

?>

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;

namespace WSAPI_CodeSamples.Services.PublisherCreative
{
    /// <summary>
    /// Encapsulates all service calls for the PublisherCreative service
    /// </summary>
    public class PublisherCreativeWrapper
    {
        /// <summary>
        /// The name of the client endpoint configured in the configuration file
        /// </summary>
        private const String publisherCreativeEndpoint = "DefaultPublisherCreative";

        /// <summary>
        /// Receive all categories for a program specified in the signature.
        /// </summary>
        /// <param name="credentialToken">The token used to authenticate the webservice caller</param>
        /// <param name="programId">The identifier of the program the caller needs the categories for</param>
        public void GetCreativeCategories(String credentialToken, Int32 programId)
        {
            /* 
             * The service proxy generated through the service reference, 
             * allowing service calls to any PublisherCreative service method
             */
            SvcPublisherCreative.PublisherCreativeServiceContractClient client = null;
            try
            {
                /* 
                 * request containing the input parameters:
                 * CredentialToken(to authenticate) and ProgramId (to specify the program you need the categories for)
                 */
                SvcPublisherCreative.GetCreativeCategoriesRequest request = new SvcPublisherCreative.GetCreativeCategoriesRequest();
                request.CredentialToken = credentialToken;
                request.ProgramId = programId;

                /* 
                 * Spoiler code for the GUI, which has to be IGNORED in this sample.
                 */
                Frame.SetRequest(request);

                /* 
                 * Initialization of the proxy with the name of the client endpoint configured in the configuration.
                 */
                client = new SvcPublisherCreative.PublisherCreativeServiceContractClient(publisherCreativeEndpoint);

                /* 
                 * Calling the service proxy to receive the response, 
                 * which can be parsed to get the needed information.
                 */
                SvcPublisherCreative.GetCreativeCategoriesResponse response = client.GetCreativeCategories(request);

                /* 
                 * Spoiler code for the GUI, which has to be IGNORED in this sample.
                 */
                Frame.SetResponse(response);
            }
            catch (FaultException<SvcPublisherCreative.PublisherCreativeFault> fe)
            {
                /* 
                 * Handling exceptions of type PublisherCreativeFault, 
                 * which occurs when there was a problem during the processing of request message.
                 * This code is only spoiler code. You should handle these exceptions in a way that fits your needs.
                 */
                Frame.SetResponse(fe.Detail.Errors);
            }
            finally
            {
                /* 
                 * Finally close the open connection to the service through the proxy.
                 */
                if (client != null)
                {
                    client.Close();
                }
            }
        }

    }
}

GetCreativeCategories

GetCreativeCategories

Web service description

Test data document

More questions?

Operation test

XML response

Complete code examples

JAVA

PHP

.NET