CompanyFilterPolicyService WSDL
Manages filter policies for "advertiser" companies.A campaign's advertiser company is the client company of the corresponding order.
By adding a company filter policy, all existing campaigns owned by that company in its role as advertiser
are assigned to the given filter. New campaigns are assigned automatically to all filters defined by its advertiser's
policies during creation time. By removing a policy all of the advertiser company's
campaigns are removed from that filter. Campaign filter assignments enforced by a campaign advertiser's
policy can not be removed from the campaign as long as the policy exists.
This service is stateless.
addPolicytop
Description
Adds a policy for given company and filter id
boolean addPolicy(int $company_id, int $filter_id)
Parameters
| int | $company_id | |
| int | $filter_id |
Return Values
| boolean | True on success, otherwise false |
getFilterIdsForPoliciesByCompanyIdtop
Description
Returns the ids of all filters referenced by the company's policies
string getFilterIdsForPoliciesByCompanyId(int $company_id)
Parameters
| int | $company_id |
Return Values
| string |
hasPolicytop
Description
Determines whether a policy exists for given company and filter
boolean hasPolicy(int $company_id, int $filter_id)
Parameters
| int | $company_id | |
| int | $filter_id |
Return Values
| boolean |
isPolicyApplicationInProgresstop
Description
Checks whether policy defined by company and filter id
is currently in the process of being applied to all affected campaigns. This happens right after
adding a policy with "addPolicy".
boolean isPolicyApplicationInProgress(int $company_id, int $filter_id)
Parameters
| int | $company_id | |
| int | $filter_id |
Return Values
| boolean |
logintop
Description
Initializes a new session with given information
boolean login(string $user, string $pass, int $network)
Parameters
| string | $user | Username |
| string | $pass | Password |
| int | $network | $network Network ID |
Return Values
| boolean | true on success, false on fail |
logouttop
Description
Destroys the active session, logging out the user.
boolean logout()
Return Values
| boolean | true on success, false on fail |
removePolicytop
Description
Removes the policy defined by company and filter id
boolean removePolicy(int $company_id, int $filter_id)
Parameters
| int | $company_id | |
| int | $filter_id |
Return Values
| boolean | True on success, otherwise false |