SearchCreatives

This method is used to return a list of creatives, which match the given search criteria.

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
DisplaySettings *	DisplaySettings
CurrentPage *	int
PageSize *	int
SearchCreativesQuery*	SearchCreativesQuery
CategoryIds	int array
CreativeTypes	CreativeTypeEnum array
HTMLLinkTypes	HTMLLinkTypeEnum array
MaxHeight	int
MinHeight	int
MaxWidth	int
MinWidth	int
ProgramIds	int array
SearchString	string
TextLinkTypes	TextLinkTypeEnum array

XML response

Short paramter definitions

PublisherId (int):: Id of the publisher whose account is being used.
CurrentPage (int):: The number of the page of creatives which shall be returned.
PageSize (int):: The maximum number of creatives a page shall hold. Must be between 1 and 100.
CategoryIds (array of int):: The IDs of the creative categories whose contents shall be returned.
CreativeTypes (array of CreativeTypeEnum):: The type of the desired creatives. Possible values are: Banner, Text, HTML, Rotation
HTMLLinkTypes (array of HTMLLinkTypeEnum):: If you want to receive HTML links, you can define here what exact sub-types shall be returned. Possible values are: HTMLBanner, FlashBanner, Microsite, PopUp, PopUnder, IFrame, HTMLForm, FlashForm, VideoAd, ProductLink, BannerRotation, PagePeel, Other
MaxHeight (int):: The maximum height of the returned creatives (only applicable for creatives which have an actual height).
MinHeight (int):: The minimum height of the returned creatives (only applicable for creatives which have an actual height).
MaxWidth (int):: The maximum width of the returned creatives (only applicable for creatives which have an actual width).
MinWidth (int):: The minimum width of the returned creatives (only applicable for creatives which have an actual width).
ProgramIds (array of int):: The IDs of the programs whose creatives shall be returned.
SearchString (string):: A key phrase that shall be contained in the creative name or description.
TextLinkTypes (array of TextLinkTypeEnum):: If you want to receive text links, you can define here what exact sub-types shall be returned. Possible values are: TextLink, LinkGenerator, Microsite, Other

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 webservices.framework.affilinet.types.publishercreative.Creative SearchCreatives(
            String credentialToken, List<Integer> programIds, String searchString,
            List<Integer> categoryIds, List<CreativeTypeEnum> creativeTypes,
            List<HTMLLinkTypeEnum> hTMLLinkTypes, List<TextLinkTypeEnum> textLinkTypes,
            Integer maxHeight, Integer minHeight, Integer maxWidth, Integer minWidth)
    {
        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);

            JAXBElement<ArrayOfint> categoryIdsJE = null;
            if(categoryIds != null) {
                ArrayOfint categoryIdsArray = new ArrayOfint();
                categoryIdsArray.getInt().addAll(categoryIds);
                categoryIdsJE =
                        typesObjectFactory.createSearchCreativesQueryCategoryIds(categoryIdsArray);
            }

            JAXBElement<ArrayOfCreativeTypeEnum> creativeTypesJE = null;
            if(creativeTypes != null) {
                ArrayOfCreativeTypeEnum creativeTypesArray =
                        typesObjectFactory.createArrayOfCreativeTypeEnum();
                creativeTypesArray.getCreativeTypeEnum().addAll(creativeTypes);
                creativeTypesJE =
                        typesObjectFactory.createSearchCreativesQueryCreativeTypes(creativeTypesArray);
            }
            
            JAXBElement<ArrayOfHTMLLinkTypeEnum> htmlLinkTypesJE = null;
            if(hTMLLinkTypes != null) {
                ArrayOfHTMLLinkTypeEnum htmlLinkTypesArray =
                        typesObjectFactory.createArrayOfHTMLLinkTypeEnum();
                htmlLinkTypesArray.getHTMLLinkTypeEnum().addAll(hTMLLinkTypes);
                htmlLinkTypesJE =
                        typesObjectFactory.createSearchCreativesQueryHTMLLinkTypes(htmlLinkTypesArray);
            }

            JAXBElement<ArrayOfTextLinkTypeEnum> textLinkTypesJE = null;
            if(textLinkTypes != null) {
            ArrayOfTextLinkTypeEnum textLinkTypesArray =
                    typesObjectFactory.createArrayOfTextLinkTypeEnum();
            textLinkTypesArray.getTextLinkTypeEnum().addAll(textLinkTypes);
            textLinkTypesJE =
                    typesObjectFactory.createSearchCreativesQueryTextLinkTypes(textLinkTypesArray);
            }

            JAXBElement<ArrayOfint> programIdsJE = null;
            if(programIds != null) {
                ArrayOfint programIdsArray = new ArrayOfint();
                programIdsArray.getInt().addAll(programIds);
                programIdsJE =
                        typesObjectFactory.createSearchCreativesQueryProgramIds(programIdsArray);
            }

            JAXBElement<String> searchStringJE = null;
            if(searchString != null) {
                searchStringJE =
                        typesObjectFactory.createSearchCreativesQuerySearchString(searchString);
            }
            /*
            Create the Query and DisplaySettings, after that set their properties
             */
            CreativeDisplaySettings displaySettings = 
                    new CreativeDisplaySettings();
            displaySettings.setCurrentPage(1);
            displaySettings.setPageSize(100);
            SearchCreativesQuery query = 
                    new SearchCreativesQuery();
            query.setCategoryIds(categoryIdsJE);
            query.setCreativeTypes(creativeTypesJE);
            query.setHTMLLinkTypes(htmlLinkTypesJE);
            query.setTextLinkTypes(textLinkTypesJE);
            query.setMaxHeight(maxHeight);
            query.setMinHeight(minHeight);
            query.setMaxWidth(maxWidth);
            query.setMinWidth(minWidth);
            query.setProgramIds(programIdsJE);
            query.setSearchString(searchStringJE);

            /*
            Create typed request message which will be used in the service call
             */
            JAXBElement<CreativeDisplaySettings> displaySettingsJE =
                    svcObjectFactory.createSearchCreativesRequestDisplaySettings(displaySettings);
            JAXBElement<SearchCreativesQuery> queryJE =
                    svcObjectFactory.createSearchCreativesRequestSearchCreativesQuery(query);
            webservices.framework.affilinet.svc.SearchCreativesRequest request =
                    svcObjectFactory.createSearchCreativesRequest();
            request.setCredentialToken(credentialTokenJE);
            request.setDisplaySettings(displaySettingsJE);
            request.setSearchCreativesQuery(queryJE);
            /*
            call the service method and process the result
             */
            webservices.framework.affilinet.svc.SearchCreativesResponse response =
                    proxy.searchCreatives(request);
            return response.getCreativeCollection().getValue();

        } catch (PublisherCreativeServiceContractSearchCreativesPublisherCreativeFaultFaultFaultMessage 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> */

$DisplaySettings = array (
			'PageSize' => 10,
			'CurrentPage' => 1
			);
$SearchCreativesQuery = array(
		    'ProgramIds' => array('3432')
		    );
			
$SOAP_REQUEST = new SoapClient(WSDL_CREAT);
$req = $SOAP_REQUEST->SearchCreatives(array(
            'CredentialToken' => $Token,
            'DisplaySettings' => $DisplaySettings,
			'SearchCreativesQuery' => $SearchCreativesQuery
            ));
			
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>
        /// Search creatives that match the provided parameters.
        /// </summary>
        /// <param name="credentialToken">The token used to authenticate the webservice caller</param>
        /// <param name="programIds">The programids the caller needs creatives for</param>
        /// <param name="categoryIds">The identifiers of the categories the creatives should be in</param>
        /// <param name="creativeTypes">The creativetypes the creatives should match</param>
        /// <param name="hTMLLinkTypes">The htmlLinkTypes the creatives should be in</param>
        /// <param name="textLinkTypes">The textLinkTypes the creatives should be in</param>
        /// <param name="maxHeight">The maximum height of the needed creatives</param>
        /// <param name="minHeight">The minimum height of the needed creatives</param>
        /// <param name="maxWidth">The maximum width of the needed creatives</param>
        /// <param name="minWidth">The minimum width of the needed creatives</param>
        public void SearchCreatives(String credentialToken, List<Int32> programIds, List<Int32> categoryIds, 
            List<SvcPublisherCreative.CreativeTypeEnum> creativeTypes,
            List<SvcPublisherCreative.HTMLLinkTypeEnum> hTMLLinkTypes, 
            List<SvcPublisherCreative.TextLinkTypeEnum> textLinkTypes, 
            Int32 maxHeight, Int32 minHeight, Int32 maxWidth, Int32 minWidth)
        {
            /* 
             * The service proxy generated through the service reference, 
             * allowing service calls to any PublisherCreative service method
             */
            SvcPublisherCreative.PublisherCreativeServiceContractClient client = null;
            try
            {

                /* 
                 * Display Settings specifying the format of the response, 
                 * please provide parameters that fit your needs (dynamically)
                 */
                SvcPublisherCreative.CreativeDisplaySettings displaySettings = new SvcPublisherCreative.CreativeDisplaySettings();
                displaySettings.CurrentPage = 1;
                displaySettings.PageSize = 100;

                /* 
                 * query containing the input parameters
                 */
                SvcPublisherCreative.SearchCreativesQuery searchCreativesQuery = new SvcPublisherCreative.SearchCreativesQuery();
                searchCreativesQuery.CategoryIds = categoryIds;
                searchCreativesQuery.CreativeTypes = creativeTypes;
                searchCreativesQuery.HTMLLinkTypes = hTMLLinkTypes;
                searchCreativesQuery.TextLinkTypes = textLinkTypes;
                searchCreativesQuery.MaxHeight = maxHeight;
                searchCreativesQuery.MinHeight = minHeight;
                searchCreativesQuery.MaxWidth = maxWidth;
                searchCreativesQuery.MinWidth = minWidth;
                searchCreativesQuery.ProgramIds = programIds;

                /* 
                 * request containing the input parameters:
                 * CredentialToken(to authenticate) and ProgramId (to specify the program you need the categories for)
                 */
                SvcPublisherCreative.SearchCreativesRequest request = new SvcPublisherCreative.SearchCreativesRequest();
                request.CredentialToken = credentialToken;
                request.DisplaySettings = displaySettings;
                request.SearchCreativesQuery = searchCreativesQuery;

                /* 
                 * 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.SearchCreativesResponse response = client.SearchCreatives(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();
                }
            }
        }

    }
}

SearchCreatives

SearchCreatives

Web service description

Test data document

More questions?

Operation test

XML response

Complete code examples

JAVA

PHP

.NET