PHP 클래스 SoapMethods

The module implements all Api methods defined by the IMethods interface. Supported Version: PHP >= 5.0
또한 보기: http://wiki.zanox.com/en/Web_Services
또한 보기: http://apps.zanox.com
저자: Thomas Nicolai ([email protected])
저자: Lars Kirchhoff ([email protected])
상속: extends ApiMethods, implements IMethods
파일 보기 프로젝트 열기: fubralimited/php-oara

공개 메소드들

메소드 설명
closeSession ( string $connectId ) : boolean Closes OAuth user session
createAdspace ( string $name, string $language, string $url, string $contact, string $description, string $adspaceType, array $scope, integer $visitors, integer $impressions, string $keywords = NULL, array $regions = [], array $categories = [], integer $checkNumber ) : object Create advertising space (signature).
createApplication ( string $name = NULL, string $version = NULL, integer $adrank, string $tags = NULL, integer $status, boolean $mediaSlotCompatible = false, boolean $inline = false, string $integrationCode = NULL, string $integrationNotes = NULL, string $description = NULL, string $terms = NULL, string $connectRole = NULL, string $connectId = NULL, string $connectStatus = NULL, string $connectUrl = NULL, string $cancelUrl = NULL, string $documentationUrl = NULL, string $companyUrl = NULL, string $developer = NULL, float $pricingShare, float $pricingSetup, float $pricingMonthly, string $pricingCurrency = NULL, string $pricingDescription = NULL, string $startDate = NULL, string $modifiedDate = NULL, string $installableTo = NULL, string $applicationType = NULL, integer $width = NULL, integer $height = NULL, string $format = NULL, string $technique = NULL, string $logoUrl = NULL, string $previewUrl = NULL ) : object Create an application
createMediaSlot ( string $name, integer $adspaceId, string $applicationId, string $status, integer $width, integer $height, string $format = NULL, string $createDate = NULL, string $modifiedDate = NULL ) : object Get media slot.
createProgramApplication ( integer $programId, integer $adspaceId ) : boolean Create program application for a given adspace.
createSetting ( integer $applicationId, integer $mediaslotId = NULL, string $key, string $value, string $customValue, string $type = NULL, string $name = NULL, string $description = NULL ) : object Create setting
deleteAdspace ( integer $adspaceId ) : boolean Removes advertising space.
deleteApplication ( integer $applicationId ) : boolean Delete application.
deleteMediaSlot ( integer $mediaslotId ) : object Delete media slot.
deleteProgramApplication ( integer $programId, integer $adspaceId ) : boolean Delete program application.
deleteSetting ( integer $applicationId, string $mediaslotId, string $key ) : object Delete setting
getAdmedia ( integer $programId = NULL, string $region = NULL, string $format = NULL, string $partnerShip = NULL, string $purpose = NULL, string $admediumType = NULL, integer $categoryId = NULL, integer $adspaceId = NULL, integer $page, integer $items = 10 ) : object done
getAdmedium ( integer $admediumId, integer $adspaceId = NULL ) : object done
getAdmediumCategories ( integer $programId ) : object done
getAdspace ( integer $adspaceId ) : object Returns a single advertising spaces.
getAdspaces ( integer $page, integer $items = 10 ) : object Returns all advertising spaces.
getApplication ( integer $applicationId ) : object Get single application.
getApplications ( string $name = NULL, integer $width = NULL, integer $height = NULL, string $format = NULL, string $role = NULL, string $applicationType = NULL, integer $page, integer $items ) : object Get applications.
getBalance ( integer $currency ) : object Get account balance
getBalances ( integer $page, integer $items = 10 ) : object Get currency account balances.
getBankAccount ( integer $bankAccountId ) : object Get single back account.
getBankAccounts ( integer $page, integer $items = 10 ) : object Get back accounts.
getExclusiveIncentive ( integer $incentiveId, integer $adspaceId = NULL ) : object Get single exclusive incentive.
getIncentive ( integer $incentiveId, integer $adspaceId = NULL ) : object Get single incentive.
getLead ( integer $leadId ) : object Get single sale item.
getLeads ( string $date, string $dateType = NULL, integer $programId = NULL, integer $adspaceId = NULL, array $reviewState = NULL, integer $page, integer $items = 10 ) : object Get leads report.
getMediaSlot ( $mediaSlotId ) : object Get media slots.
getMediaSlots ( integer $adspaceId, integer $width, integer $height, string $format = NULL, integer $page, integer $items ) : object Create media slots.
getOfflineSession ( $offlineToken ) : object Returns new offline user session
getPayment ( integer $paymentId ) : object Get a single payment item.
getPayments ( integer $page, integer $items = 10 ) : object Get payment transactions of the current zanox account.
getProduct ( string $productId, integer $adspaceId = NULL ) : object done
getProductCategories ( integer $rootCategory, boolean $includeChilds = false ) : object done
getProfile ( ) : object Return zanox user profile.
getProgram ( integer $programId ) : object done
getProgramApplications ( integer $adspaceId = NULL, integer $programId = NULL, string $status = NULL, integer $page, integer $items = 10 ) : object done
getProgramCategories ( ) : object done
getProgramsByAdspace ( integer $adspaceId, integer $page, integer $items = 10 ) : object TODO: probably needs to be removed
getReportBasic ( string $fromDate, string $toDate, string $dateType = NULL, string $currency = NULL, integer $programId = NULL, integer $admediumId = NULL, integer $admediumFormat = NULL, integer $adspaceId = NULL, string $reviewState = NULL, string $groupBy = NULL ) : object Get basic sales/leads report.
getSale ( integer $saleId ) : object Get single sale item.
getSales ( string $date, string $dateType = NULL, integer $programId = NULL, integer $adspaceId = NULL, array $reviewState = NULL, integer $page, integer $items = 10 ) : object Get sales report.
getSession ( string $authToken ) : object Returns new OAuth user session
getSetting ( integer $applicationId, integer $mediaslotId = NULL, key $key ) : object Get single setting.
getSettings ( integer $applicationId, integer $mediaslotId = NULL, integer $page, integer $items ) : object Get settings.
getTrackingCategories ( integer $adspaceId, integer $programId, integer $page, integer $items = 50 ) : object Get tracking categories for ad space; if not program member, returns program's default categories
getUiUrl ( string $connectId, string $sessionKey ) : string Get zanox User Interface Url
searchExclusiveIncentives ( integer $programId = NULL, integer $adspaceId = NULL, string $incentiveType = NULL, string $region = NULL, integer $page, integer $items = 10 ) : object Search for exclusive incentives.
searchIncentives ( integer $programId = NULL, integer $adspaceId = NULL, string $incentiveType = NULL, string $region = NULL, integer $page, integer $items = 10 ) : object Search for incentives.
searchProducts ( string $query, string $searchType = 'phrase', string $region = NULL, integer $categoryId = NULL, array $programId = [], boolean $hasImages = true, float $minPrice, float $maxPrice = NULL, integer $adspaceId = NULL, integer $page, integer $items = 10 ) : object done
searchPrograms ( string $query = NULL, string $startDate = NULL, string $partnerShip = NULL, boolean $hasProducts = false, string $region = NULL, string $categoryId = NULL, integer $page, integer $items = 10 ) : object done
updateAdspace ( integer $adspaceId, string $name, string $language, string $url, string $contact, string $description, string $adspaceType, array $scope, integer $visitors, integer $impressions, string $keywords = NULL, array $regions = [], array $categories = [], integer $checkNumber ) : object Update advertising space.
updateApplication ( integer $applicationId, string $name = NULL, string $version = NULL, integer $adrank, string $tags = NULL, integer $status, boolean $mediaSlotCompatible = false, boolean $inline = false, string $integrationCode = NULL, string $integrationNotes = NULL, string $description = NULL, string $terms = NULL, string $connectRole = NULL, string $connectId = NULL, string $connectStatus = NULL, string $connectUrl = NULL, string $cancelUrl = NULL, string $documentationUrl = NULL, string $companyUrl = NULL, string $developer = NULL, float $pricingShare, float $pricingSetup, float $pricingMonthly, string $pricingCurrency = NULL, string $pricingDescription = NULL, string $startDate = NULL, string $modifiedDate = NULL, string $installableTo = NULL, string $applicationType = NULL, integer $width = NULL, integer $height = NULL, string $format = NULL, string $technique = NULL, string $logoUrl = NULL, string $previewUrl = NULL ) : object Update an application
updateMediaSlot ( integer $mediaslotId, string $name, integer $adspaceId, string $adspaceName = NULL, string $applicationId, string $applicationName = NULL, string $status = NULL, integer $width, integer $height, string $format = NULL, string $createDate = NULL, string $modifiedDate = NULL ) : object Update media slot.
updateProfile ( array $profileId, string $loginName, string $userName, string $firstName = NULL, string $lastName = NULL, string $email = NULL, string $country = NULL, string $street1 = NULL, string $street2 = NULL, string $city = NULL, $zipcode = NULL, string $company = NULL, string $phone = NULL, string $mobile = NULL, string $fax = NULL, boolean $isAdvertiser, boolean $isSublogin ) : boolean Update zanox user profile.
updateSetting ( integer $applicationId, integer $mediaslotId = NULL, string $key, string $value, string $customValue, string $type = NULL, string $name = NULL, string $description = NULL ) : object Update setting

메소드 상세

closeSession() 공개 메소드

Closes OAuth user session
public closeSession ( string $connectId ) : boolean
$connectId string connect ID
리턴 boolean returns true on success

createAdspace() 공개 메소드

Create advertising space (signature).
public createAdspace ( string $name, string $language, string $url, string $contact, string $description, string $adspaceType, array $scope, integer $visitors, integer $impressions, string $keywords = NULL, array $regions = [], array $categories = [], integer $checkNumber ) : object
$name string adspace name
$language string language of adspace (e.g. en)
$url string url of adspace
$contact string contact address (email)
$description string description of adspace
$adspaceType string adspace typ (website, email or searchengine)
$scope array adspace scope (private or business)
$visitors integer adspace monthly visitors
$impressions integer adspace monthly page impressions
$keywords string keywords for adspace (optional)
$regions array adspace customer regions (optional)
$categories array adspace categories (optional)
$checkNumber integer
리턴 object or string adspace item or false

createApplication() 공개 메소드

Create an application
public createApplication ( string $name = NULL, string $version = NULL, integer $adrank, string $tags = NULL, integer $status, boolean $mediaSlotCompatible = false, boolean $inline = false, string $integrationCode = NULL, string $integrationNotes = NULL, string $description = NULL, string $terms = NULL, string $connectRole = NULL, string $connectId = NULL, string $connectStatus = NULL, string $connectUrl = NULL, string $cancelUrl = NULL, string $documentationUrl = NULL, string $companyUrl = NULL, string $developer = NULL, float $pricingShare, float $pricingSetup, float $pricingMonthly, string $pricingCurrency = NULL, string $pricingDescription = NULL, string $startDate = NULL, string $modifiedDate = NULL, string $installableTo = NULL, string $applicationType = NULL, integer $width = NULL, integer $height = NULL, string $format = NULL, string $technique = NULL, string $logoUrl = NULL, string $previewUrl = NULL ) : object
$name string name (optional)
$version string version (optional)
$adrank integer adrank (optional)
$tags string tags (optional)
$status integer status (optional)
$mediaSlotCompatible boolean compatible to media slot (optional)
$inline boolean
$integrationCode string integration code (optional)
$integrationNotes string integration notes (optional)
$description string description (optional)
$terms string terms of service (optional)
$connectRole string role of the application (optional) (developer, customer, tester)
$connectId string connect id (optional)
$connectStatus string connect status (optional) (active, inactive)
$connectUrl string connect url (optional)
$cancelUrl string cancel url (optional)
$documentationUrl string documentation url (optional)
$companyUrl string company url (optional)
$developer string developer (optional)
$pricingShare float price for share model (optional)
$pricingSetup float price for setup (optional)
$pricingMonthly float price for monthly usage (optional)
$pricingCurrency string pricing currency (optional)
$pricingDescription string pricing description (optional)
$startDate string start date (optional)
$modifiedDate string modification date (optional)
$installableTo string who can install the (optional) application (advertiser, publisher)
$applicationType string type of application (optional) (widget, saas, software)
$width integer width of application (optional)
$height integer height of application (optional)
$format string format of application (optional)
$technique string technique (optional)
$logoUrl string logo url (optional)
$previewUrl string preview url (optional)
리턴 object or string application item or false

createMediaSlot() 공개 메소드

Get media slot.
public createMediaSlot ( string $name, integer $adspaceId, string $applicationId, string $status, integer $width, integer $height, string $format = NULL, string $createDate = NULL, string $modifiedDate = NULL ) : object
$name string media slot name (mandatory)
$adspaceId integer adspace id (mandatory)
$applicationId string application id (mandatory)
$status string media slot status (mandatory) (active, deleted)
$width integer width of application (optional)
$height integer height of application (optional)
$format string format of application (optional)
$createDate string create date (optional)
$modifiedDate string modified date (optional)
리턴 object or string list of media slot objects or false

createProgramApplication() 공개 메소드

Create program application for a given adspace.
public createProgramApplication ( integer $programId, integer $adspaceId ) : boolean
$programId integer advertiser program id
$adspaceId integer advertising space id
리턴 boolean true or false

createSetting() 공개 메소드

Create setting
public createSetting ( integer $applicationId, integer $mediaslotId = NULL, string $key, string $value, string $customValue, string $type = NULL, string $name = NULL, string $description = NULL ) : object
$applicationId integer application id (mandatory)
$mediaslotId integer media slot id (optional)
$key string settings key (mandatory)
$value string settings value (optional)
$customValue string settings custom value (optional)
$type string settings type (optional) (boolean, color, number, string, date)
$name string settings name (optional)
$description string settings description (optional)
리턴 object or string setting

deleteAdspace() 공개 메소드

Removes advertising space.
public deleteAdspace ( integer $adspaceId ) : boolean
$adspaceId integer advertising space id
리턴 boolean true on success

deleteApplication() 공개 메소드

Delete application.
public deleteApplication ( integer $applicationId ) : boolean
$applicationId integer application id (mandatory)
리턴 boolean true on success

deleteMediaSlot() 공개 메소드

Delete media slot.
public deleteMediaSlot ( integer $mediaslotId ) : object
$mediaslotId integer media slot id (mandatory)
리턴 object or string true if success

deleteProgramApplication() 공개 메소드

Delete program application.
public deleteProgramApplication ( integer $programId, integer $adspaceId ) : boolean
$programId integer advertiser program id
$adspaceId integer advertising space id
리턴 boolean true or false

deleteSetting() 공개 메소드

Delete setting
public deleteSetting ( integer $applicationId, string $mediaslotId, string $key ) : object
$applicationId integer application id (mandatory)
$mediaslotId string mediaslot id (optional)
$key string settings key (mandatory)
리턴 object or string setting

getAdmedia() 공개 메소드

Retrieve all advertising media items. Note: The admedium categories are specific to each advertiser program. Supported admedium types are 801: Text 802: Image 803: Image with text 804: HTML (may also include Flash) 805: Script (may also include Flash)
public getAdmedia ( integer $programId = NULL, string $region = NULL, string $format = NULL, string $partnerShip = NULL, string $purpose = NULL, string $admediumType = NULL, integer $categoryId = NULL, integer $adspaceId = NULL, integer $page, integer $items = 10 ) : object
$programId integer advertiser program id (optional)
$region string limit search to region (optional)
$format string admedia format (optional)
$partnerShip string partnership status (optional) (direct or indirect)
$purpose string purpose of admedia (optional) (startPage, productDeeplink, categoryDeeplink, searchDeeplink)
$admediumType string type of admedium (optional) (html, script, lookatMedia, image, imageText, text)
$categoryId integer admedium category id (optional)
$adspaceId integer adspace id (optional)
$page integer page of result set (optional)
$items integer items per page (optional)
리턴 object or string admedia result set or false

getAdmedium() 공개 메소드

Get a single admedium.
public getAdmedium ( integer $admediumId, integer $adspaceId = NULL ) : object
$admediumId integer advertising medium id
$adspaceId integer advertising space id (optional)
리턴 object or string single product item or false

getAdmediumCategories() 공개 메소드

Get admedium categories.
public getAdmediumCategories ( integer $programId ) : object
$programId integer program admedium categories
리턴 object or string list of admedium categories

getAdspace() 공개 메소드

Returns a single advertising spaces.
public getAdspace ( integer $adspaceId ) : object
$adspaceId integer advertising space id
리턴 object or string adspace item or false

getAdspaces() 공개 메소드

Returns all advertising spaces.
public getAdspaces ( integer $page, integer $items = 10 ) : object
$page integer result set page (optional)
$items integer items per page (optional)
리턴 object or string adspaces result set or false

getApplication() 공개 메소드

Get single application.
public getApplication ( integer $applicationId ) : object
$applicationId integer application id (mandatory)
리턴 object or string application item or false

getApplications() 공개 메소드

Get applications.
public getApplications ( string $name = NULL, integer $width = NULL, integer $height = NULL, string $format = NULL, string $role = NULL, string $applicationType = NULL, integer $page, integer $items ) : object
$name string name of the application (optional)
$width integer width of application (optional)
$height integer height of application (optional)
$format string format of application (optional)
$role string role of the application (optional) (developer, customer, tester)
$applicationType string type of application (optional) (widget, saas, software)
$page integer page of result set (optional)
$items integer items per page (optional)
리턴 object or string application item or false

getBalance() 공개 메소드

Get account balance
public getBalance ( integer $currency ) : object
$currency integer currence code of balance account
리턴 object or string payment item or false

getBalances() 공개 메소드

Get currency account balances.
public getBalances ( integer $page, integer $items = 10 ) : object
$page integer result set page (optional)
$items integer items per page (optional)
리턴 object or string account balances result set or false

getBankAccount() 공개 메소드

Get single back account.
public getBankAccount ( integer $bankAccountId ) : object
$bankAccountId integer result set page
리턴 object or string account balances result set or false

getBankAccounts() 공개 메소드

Get back accounts.
public getBankAccounts ( integer $page, integer $items = 10 ) : object
$page integer result set page (optional)
$items integer items per page (optional)
리턴 object or string account balances result set or false

getExclusiveIncentive() 공개 메소드

Get single exclusive incentive.
public getExclusiveIncentive ( integer $incentiveId, integer $adspaceId = NULL ) : object
$incentiveId integer incentive id (mandatory)
$adspaceId integer adspace id (optional)
리턴 object or string incentive or false

getIncentive() 공개 메소드

Get single incentive.
public getIncentive ( integer $incentiveId, integer $adspaceId = NULL ) : object
$incentiveId integer incentive id (mandatory)
$adspaceId integer adspace id (optional)
리턴 object or string incentive or false

getLead() 공개 메소드

Get single sale item.
public getLead ( integer $leadId ) : object
$leadId integer lead id
리턴 object or string sales result set or false

getLeads() 공개 메소드

--- Sample usage: $zx = ZanoxAPI::factory(PROTOCOL_XML); $zx->getLeads('2009-09-01'); ---
public getLeads ( string $date, string $dateType = NULL, integer $programId = NULL, integer $adspaceId = NULL, array $reviewState = NULL, integer $page, integer $items = 10 ) : object
$date string date of sales
$dateType string type of date to filter by (optional) (clickDate, trackingDate, modifiedDate)
$programId integer filter by program id (optional)
$adspaceId integer filter by adspace id (optional)
$reviewState array filter by review status (optional) (confirmed, open, rejected or approved)
$page integer page of result set (optional)
$items integer items per page (optional)
리턴 object or string sales result set or false

getMediaSlot() 공개 메소드

Get media slots.
public getMediaSlot ( $mediaSlotId ) : object
리턴 object or string media slot object or false

getMediaSlots() 공개 메소드

Create media slots.
public getMediaSlots ( integer $adspaceId, integer $width, integer $height, string $format = NULL, integer $page, integer $items ) : object
$adspaceId integer advertising space id (optional)
$width integer width of application (optional)
$height integer height of application (optional)
$format string format of application (optional)
$page integer page of result set (optional)
$items integer items per page (optional)
리턴 object or string list of media slot objects or false

getOfflineSession() 공개 메소드

Returns new offline user session
public getOfflineSession ( $offlineToken ) : object
리턴 object user session

getPayment() 공개 메소드

Get a single payment item.
public getPayment ( integer $paymentId ) : object
$paymentId integer payment item id
리턴 object or string payment item or false

getPayments() 공개 메소드

Get payment transactions of the current zanox account.
public getPayments ( integer $page, integer $items = 10 ) : object
$page integer page of result set (optional)
$items integer items per page (optional)
리턴 object or string payments result set or false

getProduct() 공개 메소드

Get a single product.
public getProduct ( string $productId, integer $adspaceId = NULL ) : object
$productId string product id hash
$adspaceId integer adspace id (optional)
리턴 object or string single product item or false

getProductCategories() 공개 메소드

Get product categories.
public getProductCategories ( integer $rootCategory, boolean $includeChilds = false ) : object
$rootCategory integer category id (optional)
$includeChilds boolean include child nodes (optional)
리턴 object or string single product item or false

getProfile() 공개 메소드

Return zanox user profile.
public getProfile ( ) : object
리턴 object or string profile item

getProgram() 공개 메소드

Retrieve a single zanox advertiser program item.
public getProgram ( integer $programId ) : object
$programId integer id of program to retrieve
리턴 object or string program item or false

getProgramApplications() 공개 메소드

Get advertiser program applications for a user.
public getProgramApplications ( integer $adspaceId = NULL, integer $programId = NULL, string $status = NULL, integer $page, integer $items = 10 ) : object
$adspaceId integer advertising space id (optional)
$programId integer restrict results to applications (optional) to the id of this program (optional)
$status string restrict results to program applications with this status: "open", "confirmed", "rejected", "deferred", "waiting", "blocked", "terminated", "canceled", "called", "declined", "deleted"
$page integer page of result set (optional)
$items integer items per page (optional)
리턴 object or string program result set or false

getProgramCategories() 공개 메소드

Get advertiser program categories.
public getProgramCategories ( ) : object
리턴 object or string category result set or false

getProgramsByAdspace() 공개 메소드

Get advertiser program applications by adspace.
public getProgramsByAdspace ( integer $adspaceId, integer $page, integer $items = 10 ) : object
$adspaceId integer advertising space id
$page integer page of result set (optional)
$items integer items per page (optional)
리턴 object or string program result set or false

getReportBasic() 공개 메소드

Get basic sales/leads report.
public getReportBasic ( string $fromDate, string $toDate, string $dateType = NULL, string $currency = NULL, integer $programId = NULL, integer $admediumId = NULL, integer $admediumFormat = NULL, integer $adspaceId = NULL, string $reviewState = NULL, string $groupBy = NULL ) : object
$fromDate string report start date
$toDate string report end date
$dateType string type of date to filter by (optional) (clickDate, trackingDate, modifiedDate)
$currency string currency (optional)
$programId integer program id (optional)
$admediumId integer admedium id (optional)
$admediumFormat integer admedium format id (optional)
$adspaceId integer adspace id (optional)
$reviewState string filter by review status (optional) (confirmed, open, rejected or approved)
$groupBy string group report by option (optional) (country, region, city, currency, admedium, program, adspace, linkFormat, reviewState, trackingCategory, month, day, hour, year, dayOfWeek)
리턴 object or string payment item or false

getSale() 공개 메소드

Get single sale item.
public getSale ( integer $saleId ) : object
$saleId integer sale id
리턴 object or string sales result set or false

getSales() 공개 메소드

Sample usage: $zx = ZanoxAPI::factory(PROTOCOL_XML); $zx->getSales('2009-09-01');
public getSales ( string $date, string $dateType = NULL, integer $programId = NULL, integer $adspaceId = NULL, array $reviewState = NULL, integer $page, integer $items = 10 ) : object
$date string date of sales
$dateType string type of date to filter by (optional) (clickDate, trackingDate, modifiedDate)
$programId integer filter by program id (optional)
$adspaceId integer filter by adspace id (optional)
$reviewState array filter by review status (optional) (confirmed, open, rejected or approved)
$page integer page of result set (optional)
$items integer items per page (optional)
리턴 object or string sales result set or false

getSession() 공개 메소드

Returns new OAuth user session
public getSession ( string $authToken ) : object
$authToken string authentication token
리턴 object user session

getSetting() 공개 메소드

Get single setting.
public getSetting ( integer $applicationId, integer $mediaslotId = NULL, key $key ) : object
$applicationId integer application id (mandatory)
$mediaslotId integer media slot id (optional)
$key key application specific key
리턴 object or string application item or false

getSettings() 공개 메소드

Get settings.
public getSettings ( integer $applicationId, integer $mediaslotId = NULL, integer $page, integer $items ) : object
$applicationId integer application id (mandatory)
$mediaslotId integer media slot id (optional)
$page integer page of result set (optional)
$items integer items per page (optional)
리턴 object or string list of settings or false

getTrackingCategories() 공개 메소드

Get tracking categories for ad space; if not program member, returns program's default categories
public getTrackingCategories ( integer $adspaceId, integer $programId, integer $page, integer $items = 50 ) : object
$adspaceId integer adspace id (mandatory)
$programId integer advertiser program id (mandatory)
$page integer result set page (optional)
$items integer items per page (optional)
리턴 object or string program result set of trackingCategoryItems

getUiUrl() 공개 메소드

Get zanox User Interface Url
public getUiUrl ( string $connectId, string $sessionKey ) : string
$connectId string connect ID
$sessionKey string session key
리턴 string URL to the UI

searchExclusiveIncentives() 공개 메소드

Search for exclusive incentives.
public searchExclusiveIncentives ( integer $programId = NULL, integer $adspaceId = NULL, string $incentiveType = NULL, string $region = NULL, integer $page, integer $items = 10 ) : object
$programId integer limit search to program list of programs (optional)
$adspaceId integer adspace id (optional)
$incentiveType string type of incentive (optional) (coupons, samples, bargains, freeProducts, noShippingCosts, lotteries)
$region string program region (optional)
$page integer page of result set (optional)
$items integer items per page (optional)
리턴 object or string list of incentives or false

searchIncentives() 공개 메소드

Search for incentives.
public searchIncentives ( integer $programId = NULL, integer $adspaceId = NULL, string $incentiveType = NULL, string $region = NULL, integer $page, integer $items = 10 ) : object
$programId integer limit search to program list of programs (optional)
$adspaceId integer adspace id (optional)
$incentiveType string type of incentive (optional) (coupons, samples, bargains, freeProducts, noShippingCosts, lotteries)
$region string program region (optional)
$page integer page of result set (optional)
$items integer items per page (optional)
리턴 object or string list of incentives or false

searchProducts() 공개 메소드

Search for products.
public searchProducts ( string $query, string $searchType = 'phrase', string $region = NULL, integer $categoryId = NULL, array $programId = [], boolean $hasImages = true, float $minPrice, float $maxPrice = NULL, integer $adspaceId = NULL, integer $page, integer $items = 10 ) : object
$query string search string
$searchType string search type (optional) (contextual or phrase)
$region string limit search to region (optional)
$categoryId integer limit search to categorys (optional)
$programId array limit search to program list of programs (optional)
$hasImages boolean products with images (optional)
$minPrice float minimum price (optional)
$maxPrice float maximum price (optional)
$adspaceId integer adspace id (optional)
$page integer page of result set (optional)
$items integer items per page (optional)
리턴 object or string list of products or false

searchPrograms() 공개 메소드

Search zanox advertiser programs.
public searchPrograms ( string $query = NULL, string $startDate = NULL, string $partnerShip = NULL, boolean $hasProducts = false, string $region = NULL, string $categoryId = NULL, integer $page, integer $items = 10 ) : object
$query string search string
$startDate string program start date (optional)
$partnerShip string partnership status (optional) (direct or indirect)
$hasProducts boolean program has product data
$region string program region
$categoryId string program category id
$page integer page of result set
$items integer items per page
리턴 object or string programs result set or false

updateAdspace() 공개 메소드

Update advertising space.
public updateAdspace ( integer $adspaceId, string $name, string $language, string $url, string $contact, string $description, string $adspaceType, array $scope, integer $visitors, integer $impressions, string $keywords = NULL, array $regions = [], array $categories = [], integer $checkNumber ) : object
$adspaceId integer adspace id
$name string adspace name
$language string language of adspace (e.g. en)
$url string url of adspace
$contact string contact address (email)
$description string description of adspace
$adspaceType string adspace typ (website, email or searchengine)
$scope array adspace scope (private or business)
$visitors integer adspace monthly visitors
$impressions integer adspace monthly page impressions
$keywords string keywords for adspace (optional)
$regions array adspace customer regions (optional)
$categories array adspace categories (optional)
$checkNumber integer
리턴 object or string adspace item or false

updateApplication() 공개 메소드

Update an application
public updateApplication ( integer $applicationId, string $name = NULL, string $version = NULL, integer $adrank, string $tags = NULL, integer $status, boolean $mediaSlotCompatible = false, boolean $inline = false, string $integrationCode = NULL, string $integrationNotes = NULL, string $description = NULL, string $terms = NULL, string $connectRole = NULL, string $connectId = NULL, string $connectStatus = NULL, string $connectUrl = NULL, string $cancelUrl = NULL, string $documentationUrl = NULL, string $companyUrl = NULL, string $developer = NULL, float $pricingShare, float $pricingSetup, float $pricingMonthly, string $pricingCurrency = NULL, string $pricingDescription = NULL, string $startDate = NULL, string $modifiedDate = NULL, string $installableTo = NULL, string $applicationType = NULL, integer $width = NULL, integer $height = NULL, string $format = NULL, string $technique = NULL, string $logoUrl = NULL, string $previewUrl = NULL ) : object
$applicationId integer application id (mandatory)
$name string name (optional)
$version string version (optional)
$adrank integer adrank (optional)
$tags string tags (optional)
$status integer status (optional)
$mediaSlotCompatible boolean compatible to media slot (optional)
$inline boolean
$integrationCode string integration code (optional)
$integrationNotes string integration notes (optional)
$description string description (optional)
$terms string terms of service (optional)
$connectRole string role of the application (optional) (developer, customer, tester)
$connectId string connect id (optional)
$connectStatus string connect status (optional) (active, inactive)
$connectUrl string connect url (optional)
$cancelUrl string cancel url (optional)
$documentationUrl string documentation url (optional)
$companyUrl string company url (optional)
$developer string developer (optional)
$pricingShare float price for share model (optional)
$pricingSetup float price for setup (optional)
$pricingMonthly float price for monthly usage (optional)
$pricingCurrency string pricing currency (optional)
$pricingDescription string pricing description (optional)
$startDate string start date (optional)
$modifiedDate string modification date (optional)
$installableTo string who can install the (optional) application (advertiser, publisher)
$applicationType string type of application (optional) (widget, saas, software)
$width integer width of application (optional)
$height integer height of application (optional)
$format string format of application (optional)
$technique string technique (optional)
$logoUrl string logo url (optional)
$previewUrl string preview url (optional)
리턴 object or string application item or false

updateMediaSlot() 공개 메소드

Update media slot.
public updateMediaSlot ( integer $mediaslotId, string $name, integer $adspaceId, string $adspaceName = NULL, string $applicationId, string $applicationName = NULL, string $status = NULL, integer $width, integer $height, string $format = NULL, string $createDate = NULL, string $modifiedDate = NULL ) : object
$mediaslotId integer media slot id (mandatory)
$name string media slot name (mandatory)
$adspaceId integer adspace id (mandatory)
$adspaceName string name of the adspace (optional)
$applicationId string application id (mandatory)
$applicationName string name of the application (optional)
$status string media slot status (mandatory) (active, deleted)
$width integer width of application (optional)
$height integer height of application (optional)
$format string format of application (optional)
$createDate string create date (optional)
$modifiedDate string modified date (optional)
리턴 object or string list of media slot objects or false

updateProfile() 공개 메소드

Update zanox user profile.
public updateProfile ( array $profileId, string $loginName, string $userName, string $firstName = NULL, string $lastName = NULL, string $email = NULL, string $country = NULL, string $street1 = NULL, string $street2 = NULL, string $city = NULL, $zipcode = NULL, string $company = NULL, string $phone = NULL, string $mobile = NULL, string $fax = NULL, boolean $isAdvertiser, boolean $isSublogin ) : boolean
$profileId array user profile id
$loginName string login name
$userName string user name
$firstName string first name
$lastName string last name
$email string email address
$country string country or residence
$street1 string street 1
$street2 string street 2 (optional)
$city string city
$company string name of company (optional)
$phone string phone number (optional)
$mobile string mobile number (optional)
$fax string fax number (optional)
$isAdvertiser boolean is Advertiser account
$isSublogin boolean is Sublogin account
리턴 boolean true on success

updateSetting() 공개 메소드

Update setting
public updateSetting ( integer $applicationId, integer $mediaslotId = NULL, string $key, string $value, string $customValue, string $type = NULL, string $name = NULL, string $description = NULL ) : object
$applicationId integer application id (mandatory)
$mediaslotId integer media slot id (optional)
$key string settings key (mandatory)
$value string settings value (optional)
$customValue string settings custom value (optional)
$type string settings type (optional) (boolean, color, number, string, date)
$name string settings name (optional)
$description string settings description (optional)
리턴 object or string setting