fetchRedirectClickCommandTagstop
Deprecated 2026-02-20
This method will be removed in upcoming releases.
Deprecated in favor of CampaignRedirectTagService::generateRedirectClickCommandTags
Description
Gets the redirect click command tags for a campaign.
Requires administrator permissions.
CampaignRedirectClickCommandTagList fetchRedirectClickCommandTags(int $campaign_id, boolean $with_tcf_parameters)
Parameters
| int | $campaign_id | |
| boolean | $with_tcf_parameters |
Return Values
| CampaignRedirectClickCommandTagList |
fetchRedirectTagsByTypetop
Deprecated 2026-02-20
This method will be removed in upcoming releases.
Deprecated in favor of CampaignRedirectTagService::generateRedirectTagsByType
Description
Gets redirect tags for a campaign by tag type. Valid types:
- javascript
- iframe
Requires administrator permissions.
CampaignRedirectTagList fetchRedirectTagsByType(int $campaign_id, string $type, boolean $with_tcf_parameters)
Parameters
| int | $campaign_id | |
| string | $type | Javascript|iframe |
| boolean | $with_tcf_parameters |
Return Values
| CampaignRedirectTagList |
fetchRedirectTrackingTagstop
Deprecated 2026-02-20
This method will be removed in upcoming releases.
Deprecated in favor of CampaignRedirectTagService::generateRedirectTrackingTags
Description
Gets redirect tracking tags for a campaign.
Requires administrator permissions.
CampaignRedirectTrackingTagList fetchRedirectTrackingTags(int $campaign_id, boolean $with_tcf_parameters)
Parameters
| int | $campaign_id | |
| boolean | $with_tcf_parameters |
Return Values
| CampaignRedirectTrackingTagList |
fetchRedirectVastTagstop
Deprecated 2026-02-20
This method will be removed in upcoming releases.
Deprecated in favor of CampaignRedirectTagService::generateRedirectVastTags
Description
Gets the redirect VAST tags for a campaign.
Requires administrator permissions.
CampaignRedirectVastTagList fetchRedirectVastTags(int $campaign_id, boolean $with_tcf_parameters)
Parameters
| int | $campaign_id | |
| boolean | $with_tcf_parameters |
Return Values
| CampaignRedirectVastTagList |
generateRedirectClickCommandTagstop
Description
Gets the redirect click command tags for a campaign.
Requires administrator permissions.
CampaignRedirectClickCommandTagList generateRedirectClickCommandTags(int $campaign_id, int $consent_param)
Parameters
| int | $campaign_id | |
| int | $consent_param | Values: 0=none, 1=GDPR, 2=Legacy |
Return Values
| CampaignRedirectClickCommandTagList |
generateRedirectTagsByTypetop
Description
Gets redirect tags for a campaign by tag type. Valid types:
- javascript
- iframe
Requires administrator permissions.
CampaignRedirectTagList generateRedirectTagsByType(int $campaign_id, string $type, int $consent_param)
Parameters
| int | $campaign_id | |
| string | $type | Javascript|iframe |
| int | $consent_param | Values: 0=none, 1=GDPR, 2=Legacy |
Return Values
| CampaignRedirectTagList |
generateRedirectTrackingTagstop
Description
Gets redirect tracking tags for a campaign.
Requires administrator permissions.
CampaignRedirectTrackingTagList generateRedirectTrackingTags(int $campaign_id, int $consent_param)
Parameters
| int | $campaign_id | |
| int | $consent_param | Values: 0=none, 1=GDPR, 2=Legacy |
Return Values
| CampaignRedirectTrackingTagList |
generateRedirectVastTagstop
Description
Gets the redirect VAST tags for a campaign.
Requires administrator permissions.
CampaignRedirectVastTagList generateRedirectVastTags(int $campaign_id, int $consent_param)
Parameters
| int | $campaign_id | |
| int | $consent_param | Values: 0=none, 1=GDPR, 2=Legacy |
Return Values
| CampaignRedirectVastTagList |
getRedirectClickCommandTagstop
Deprecated 2020-08-26
This method will be removed in upcoming releases.
Deprecated in favor of CampaignRedirectTagService::generateRedirectClickCommandTags
Description
Gets the redirect click command tags for a campaign.
Requires administrator permissions.
CampaignRedirectClickCommandTagList getRedirectClickCommandTags(int $campaign_id)
Parameters
| int | $campaign_id |
Return Values
| CampaignRedirectClickCommandTagList |
getRedirectTagsByTypetop
Deprecated 2020-08-26
This method will be removed in upcoming releases.
Deprecated in favor of CampaignRedirectTagService::generateRedirectTagsByType
Description
Gets redirect tags for a campaign by tag type. Valid types:
- javascript
- iframe
Requires administrator permissions.
CampaignRedirectTagList getRedirectTagsByType(int $campaign_id, string $type)
Parameters
| int | $campaign_id | |
| string | $type | Javascript|iframe |
Return Values
| CampaignRedirectTagList |
getRedirectTrackingTagstop
Deprecated 2020-08-26
This method will be removed in upcoming releases.
Deprecated in favor of CampaignRedirectTagService::generateRedirectTrackingTags
Description
Gets redirect tracking tags for a campaign.
Requires administrator permissions.
CampaignRedirectTrackingTagList getRedirectTrackingTags(int $campaign_id)
Parameters
| int | $campaign_id |
Return Values
| CampaignRedirectTrackingTagList |
getRedirectVastTagstop
Deprecated 2020-08-26
This method will be removed in upcoming releases.
Deprecated in favor of CampaignRedirectTagService::generateRedirectVastTags
Description
Gets the redirect VAST tags for a campaign.
Requires administrator permissions.
CampaignRedirectVastTagList getRedirectVastTags(int $campaign_id)
Parameters
| int | $campaign_id |
Return Values
| CampaignRedirectVastTagList |
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 |
CampaignRedirectClickCommandTagtop
Definition
- - int $campaignId
-
required
- - int $contentunitId
-
required
- - int $bannerId
-
required
- - string $code
-
required
CampaignRedirectClickCommandTagListtop
Definition
- - Array <CampaignRedirectClickCommandTag> $tags
-
optional
CampaignRedirectTagtop
Definition
- - int $campaignId
-
required
- - int $contentunitId
-
required
- - string $code
-
required
CampaignRedirectTagListtop
Definition
CampaignRedirectTrackingTagtop
Definition
- - int $campaignId
-
required
- - int $contentunitId
-
required
- - int $bannerId
-
required
- - string $viewCountCode
-
required
- - string $clickCountCode
-
required
CampaignRedirectTrackingTagListtop
Definition
- - Array <CampaignRedirectTrackingTag> $trackingTags
-
optional
CampaignRedirectVastTagtop
Definition
- - int $campaignId
-
required
- - int $contentunitId
-
required
- - string $code
-
required