public interface TagManagerService
TagManagerService
wraps SitecatalystHttpClient
and
implements the TagManager related API methods.Modifier and Type | Method and Description |
---|---|
JSONObject |
copyContainer(Configuration configuration,
JSONObject copydescription)
Copies a container into another (or the same) environment and allows to change
the deployment status of a container.
|
JSONObject |
deleteBucket(Configuration configuration,
long bucketId)
Marks a bucket as deleted.
|
JSONArray |
getBuckets(Configuration configuration)
Returns a list of initialized buckets.
|
JSONObject |
getContainer(Configuration configuration,
Long bucketId,
Environment environment,
Long revisionId)
Returns a container JSONObject of the provided
revisionId . |
String |
getContainerFile(Configuration configuration,
Long bucketId,
Environment environment,
Long revisionId)
Returns the container file contents.
|
JSONArray |
getContainerHistory(Configuration configuration,
JSONObject historydescription)
Returns all revisions of a container for the specified environment.
|
String |
getContainerLoaderFile(Configuration configuration,
Long bucketId)
Returns the container loader file contents.
|
Environment |
getEnvironment()
Returns the
Environment configured for this service. |
JSONObject |
getSCConfig(Configuration configuration,
String reportsuite,
String variablename,
String trackingserver,
String charset,
String currencyCode)
Returns the SiteCatalyst tag object.
|
JSONObject |
getSCMediaConfig(Configuration configuration,
String reportSuiteID,
String variableName)
Returns the Media Module tag object.
|
JSONObject |
getSCPartnerConfig(Configuration configuration,
String variableName)
Returns the Dependent JavaScript Code tag object.
|
JSONObject |
getSCSurveyConfig(Configuration configuration,
String variableName)
Return the Survey Module tag object.
|
JSONObject |
getTTConfig(Configuration configuration,
String clientCode)
Returns the Adobe Target tag object.
|
JSONObject |
initializeBucket(Configuration configuration,
String name,
String description)
Initializes a bucket which is an entity to hold revisions of a container.
|
JSONObject |
saveContainer(Configuration configuration,
JSONObject container)
Saves a new revision of a container in the specified environment.
|
JSONObject initializeBucket(Configuration configuration, String name, String description) throws TagManagerException
configuration
- Service configurationname
- Bucket name consisting only of alphanumeric or underscore
characters.description
- A description{ "bucket_id": 123, "bucket_description": "A bucket", "bucket_name": "bucket1" }
TagManagerException
- if bucket can not be created (i.e. max.
numbers of buckets is reached)JSONObject deleteBucket(Configuration configuration, long bucketId) throws TagManagerException
configuration
- Service configurationbucketId
- Bucket identifier{ "bucket_id": 123, "bucket_description": "A bucket", "bucket_name": "bucket1" }
TagManagerException
- if an error occurs during the operationJSONArray getBuckets(Configuration configuration) throws TagManagerException
configuration
- Service configurationTagManager
for JSON format.TagManagerException
- if an error occurs during the operationJSONObject getContainer(Configuration configuration, Long bucketId, Environment environment, Long revisionId) throws TagManagerException
revisionId
.
If no revisionId
is provided the latest revision will be
returned.configuration
- Service configurationbucketId
- ID of the bucketenvironment
- EnvironmentrevisionId
- Revision ID or null
to get the latest
revision{ "bucket_id": 123, "environment": "live", "revision_id": 4, "status": "deployed", "created_at": "datetime", "deployed_at": "datetime", "deployed_url": "http://...", "js_before": "userid", "change_login": 122, "change_note": "Change x from dev", "tags": [ { "description": "a desc", "script_url": "location of script", "client_js": "The javascript source of the tag", "trigger_conditions": { "bar": "b", "key": "a" }, "type": "product_sc" } ] }
TagManagerException
- if an error occurs during the operationJSONObject saveContainer(Configuration configuration, JSONObject container) throws TagManagerException
configuration
- Service configurationcontainer
- Container JSONObject to save in the format:
{ "bucket_id": 123, "environment": "live", "deploy": true, "js_before": "userid", "change_note": "Change x from dev", "tags": [ { "description": "a desc", "script_url": "location of script", "client_js": "The javascript source of the tag", "trigger_conditions": { "...": "..." }, "type": "product_sc" } ] }
{ "bucket_id": 123, "environment": "live", "revision_id": 4, "status": "deployed", "created_at": "datetime", "deployed_at": "datetime", "deployed_url": "http://...", "js_before": "userid", "change_login": 122, "change_note": "Change x from dev", "tags": [ { "description": "a desc", "script_url": "location of script", "client_js": "The javascript source of the tag", "trigger_conditions": { "bar": "b", "key": "a" }, "type": "product_sc" } ] }
TagManagerException
- if an error occurs during the operationJSONArray getContainerHistory(Configuration configuration, JSONObject historydescription) throws TagManagerException
configuration
- Service configurationhistorydescription
- A history description in the following format:
{ "bucket_id": 123, "environment": "live", "limit": 10, "offset": 4, "only_deployed": true }
{ "bucket_id": 123, "environment": "live", "revision_id": 4, "status": "deployed", "created_at": "datetime", "deployed_at": "datetime", "deployed_url": "http://...", "change_login": 122, "change_note": "Change x from dev", }
TagManagerException
- if an error occurs during the operationJSONObject copyContainer(Configuration configuration, JSONObject copydescription) throws TagManagerException
configuration
- Service configurationcontainerdesc
- copy description in the format:
{ "bucket_id": 123, "source_environment": "stage", "revision_id": 10 "destination_environment": "live", "deploy": 1, }
{ "bucket_id": 123, "environment": "live", "revision_id": 4, "status": "deployed", "created_at": "datetime", "deployed_at": "datetime", "deployed_url": "http://...", "js_before": "userid", "change_login": 122, "change_note": "Change x from dev", "tags": [ { "type": "product_sc", "description": "a desc", "script_url": "location of script", "client_js": "The javascript source of the tag", "trigger_conditions": { "bar": "b", "key": "a" } } ] }
TagManagerException
- if an error occurs during the operationString getContainerFile(Configuration configuration, Long bucketId, Environment environment, Long revisionId) throws TagManagerException
configuration
- Service configurationbucketId
- Bucket identifierenvironment
- TagManager environmentrevisionId
- Revision identifierTagManagerException
- if an error occurs during the operationString getContainerLoaderFile(Configuration configuration, Long bucketId) throws TagManagerException
configuration
- Service configurationbucketId
- Bucket identifierTagManagerException
- if an error occurs during the operationJSONObject getSCConfig(Configuration configuration, String reportsuite, String variablename, String trackingserver, String charset, String currencyCode) throws TagManagerException
configuration
- Service configurationreportsuite
- SiteCataylst report suite IDvariablename
- SiteCatalyst variable name or null
trackingserver
- Tracking server URL or null
charset
- SiteCatalyst charset or null
currencyCode
- SiteCatalyst currency code or null
{ "type": "product_sc", "client_js": "some javascript in here ...", "product_config": { "regenerate_core": true, "sc_version": "25.1", "sc_account": "bugzilla_dal", "sc_instance_variable": "s", "sc_tracking_server": "adobetagmanagerengineering.d2.sc.omtrdc.net", "sc_tracking_server_secure": "adobetagmanagerengineering.d2.sc.omtrdc.net", "sc_charset": "UTF-8", "sc_currency_code": "" } }
TagManagerException
- if an error occurs during the operationJSONObject getSCMediaConfig(Configuration configuration, String reportSuiteID, String variableName) throws TagManagerException
configuration
- Service configurationreportSuiteID
- SiteCatalyst ReportSuite IDvariableName
- SiteCatalyst instance variable name or
null
{ "type": "product_sc_media", "client_js": "some javascript in here ...", "product_config": { "regenerate_core": true } }
TagManagerException
- if an error occurs during the operationJSONObject getSCSurveyConfig(Configuration configuration, String variableName) throws TagManagerException
configuration
- Service configurationvariableName
- SiteCatalyst instance variable name or null
{ "type": "product_sc_survey", "client_js": "some javascript in here ...", "product_config": { "regenerate_core": true } }
TagManagerException
- if an error occurs during the operationJSONObject getSCPartnerConfig(Configuration configuration, String variableName) throws TagManagerException
configuration
- Service configurationvariableName
- SiteCatalyst instance variable name or null
{ "type": "product_sc_partner", "client_js": "some javascript in here ...", "product_config": { "regenerate_core": true } }
TagManagerException
- if an error occurs during the operationJSONObject getTTConfig(Configuration configuration, String clientCode) throws TagManagerException
configuration
- Service configurationclientCode
- Adobe Target client code{ "type": "product_tt", "client_js": "some javascript in here ...", "product_config": { "regenerate_core": true, "tt_client_code": "tagmanagereng" } }
TagManagerException
- if an error occurs during the operationEnvironment getEnvironment()
Environment
configured for this service."Copyright © 2006 - 2015 Adobe Systems Incorporated. All Rights Reserved"