Genesis Partner API

Adobe Marketing Cloud
Data Connectors Partner API
Contents
Data Connectors Partner API.................................................................................5
May 2014: REST API..............................................................................................................5
Data Connectors 3.0: What's New...........................................................................................5
Data Connectors 2.8: What's New...........................................................................................6
How Data Connectors Works..................................................................................................7
SOAP Service.........................................................................................................................8
SOAP Development Toolkits.......................................................................................................................8
Security......................................................................................................................................................9
REST Service..........................................................................................................................9
Methods................................................................................................................................10
Data Connectors Configuration API.........................................................................................................10
Data Connectors Integration API..............................................................................................................41
Data Types............................................................................................................................63
accessRequest.........................................................................................................................................64
accessRequests.......................................................................................................................................64
adProcessingSettings..............................................................................................................................64
adProcessingStatus.................................................................................................................................65
adProcessingVariables.............................................................................................................................66
authenticationParameter..........................................................................................................................66
chosenAccessRequests...........................................................................................................................67
colArray....................................................................................................................................................68
data_warehouse_report...........................................................................................................................68
data_warehouse_request.........................................................................................................................68
display......................................................................................................................................................69
int_array...................................................................................................................................................70
integrationAccess.....................................................................................................................................70
integrationBrief.........................................................................................................................................70
integrationData.........................................................................................................................................70
integrationDetail.......................................................................................................................................71
integrationDetails......................................................................................................................................72
Last updated 5/23/2014
Contents
integrationMapping...................................................................................................................................73
integrationValue........................................................................................................................................73
integrationValues......................................................................................................................................73
metricClassificationList.............................................................................................................................73
metricClassifications................................................................................................................................73
partner_sandbox_credentials...................................................................................................................74
product.....................................................................................................................................................74
productArray.............................................................................................................................................74
productCalculatedMetric..........................................................................................................................74
productCalculatedMetrics.........................................................................................................................75
productClassification................................................................................................................................75
productClassificationList..........................................................................................................................75
productDetails..........................................................................................................................................76
productDetailsList.....................................................................................................................................76
productFaq...............................................................................................................................................76
productProcessingRule............................................................................................................................76
productResource......................................................................................................................................77
productResourceContent.........................................................................................................................77
productResourceList................................................................................................................................78
productResourceType..............................................................................................................................78
product_approval_status_container.........................................................................................................79
product_info_container.............................................................................................................................79
resourceEncoded.....................................................................................................................................79
responseArray..........................................................................................................................................79
rowArray...................................................................................................................................................79
scriptParameter........................................................................................................................................79
scriptParameters......................................................................................................................................80
status........................................................................................................................................................80
string_array..............................................................................................................................................80
timeBucket................................................................................................................................................80
timeBucketList..........................................................................................................................................81
token_usage_container............................................................................................................................81
token_usage_array...................................................................................................................................81
varMapAll.................................................................................................................................................81
Sample Code........................................................................................................................83
Sample Data Connectors Integration.......................................................................................................84
Sample On-Demand Script Usage...........................................................................................................97
Reference............................................................................................................................100
Data Connectors Standard Elements.....................................................................................................100
Activity Log Error Messages..................................................................................................................117
Time Zones............................................................................................................................................117
Currency Codes.....................................................................................................................................120
Contact and Legal Information............................................................................................120

Data connectors make it possible to exchange data between partner applications and the Adobe Marketing Cloud.
Data connectors let you activate an integration that exchanges data between the partners product or service and
Suite collection servers. Once activated, the client can leverage the partner data in the Suite and export relevant
data, such as re-marketing segments, back to the partner product or service.
The Data Connectors Partner API lets Adobe partners build these integrations for their clients.
Note: Only registered and approved Adobe Data Connectors partners have access to the partner tools. For
information about becoming a partner, visit http://www.omniture.com/en/partners/apply, or send an email to
partners@omniture.com.
The Data Connectors Partner API provides SOAP and REST interfaces, and is comprised of two separate Web
Services:
Data Connectors Configuration API: Lets the partner define the integrations characteristics and the data that the
partner wants to provide clients as part of the data exchange.
Data Connectors Integration API: Enables the day-to-day data transfer between the partner environment and
Suite collection servers.
May 2014: REST API

The May 22, 2014 update includes the following changes:
A set of REST APIs that have the same methods and similar parameters/responses as SOAP APIs. See REST
Service.
Enhanced the existing two REST APIs, Partner.StreamSegmentedData and Partner.StreamClassificationData.
Data Connectors 3.0: What's New

Data Connectors 3.0 (released November 2011) includes the following API updates:
Configuration API Updates
Added the Product.AddFaq method.
Added the Product.ModifyFaq method.
Added the Product.GetFaqs method.
Added the Product.DeleteFaq method.
Added a includeResourceFile parameter to the Product.GetResources method.
Added the Product.EnableAuthentication method.
Added the Product.DisableAuthentication method.
Added the Product.GetAuthentication method.
Renamed Product.UpdateLogo to Product.ModifyLogo.
Renamed Product.SubmitProductScript to Product.AddProductScript
Added the Product.ModifyProductScript method.
Integration API Updates

No updates.
Data Type Updates
Added feed data type to productResourceType.
Added Product.productFaq data type.
Data Connectors 2.8: What's New

Data Connectors 2.8 (released November 2010) includes the following API updates:
Configuration API Updates
Added the Product.Add method.
Added the Product.Delete method.
Added the Product.Get method.
Added the Product.Modify method.
Added the Product.GetResource method.
Added the Product.UpdateLogo method.
Added the Product.AddAccessRequest method.
Added the Product.DeleteAccessRequest method.
Added the Product.ModifyAccessRequest method.
Added the Product.GetAccessRequests method.
Added the Product.GetAdProcessing method.
Added the Product.Clone method.
Updated the Product.AddResource method.
Updated the Product.DeleteResource method.
Updated the Product.GetResource method.
Updated the Product.ModifyResource method.
Integration API Updates
Added the Partner.GetTokenUsage method.
Added the Partner.GetIntegrationAccess method.
Added the Export.ProduceResource method.
Data Type Updates
Added the tns:integrationValue data type.
Added the tns:integrationValues data type.
Added the tns:productDetails data type.
Added the tns:productDetailsList data type.
Added the tns:productResourceList data type.
Added the tns:resourceEncoded data type.
Updated the tns:integrationDetail data type.

Updated the tns:productResource data type.
Updated the tns:productResourceType data type.
How Data Connectors Works

Data Connectors provides a complete development ecosystem to help Data Connectors partners integrate their
products and services into the Adobe Marketing Cloud.
Adobe provides a well-defined process for creating a Data Connectors integration.
1. Partner defines the integration using the Configuration API.

a. Partner defines variable mappings between their metrics and Analytics variables (eVars, events, props).
b. Partner defines any internal variables, known as customvals, necessary for the integration to work. For
example, a username/password, a search term, or an account ID.
c. Partner creates the Product Script, which lets the Integration Wizard call use other Web Services API methods
that might be helpful to the integration. For example, if the partner wants to create some calculated metrics
when the integration completes, they can use the Product Script to call ReportSuite.SaveCalculatedMetrics.
d. Partner uploads the Partner Product Script.
Note: All Web Services APIs should be accessible through the Product Script. However, if you run into
difficulties using a particular API in the Product Script, contact your Account Manager. Information about
all the Web Services APIs is available on the Developer Connection.
2. Partner finalizes and tests the integration in the Data Connectors Sandbox.
3. Partner notifies Adobe that the Integration is ready to verify.
4. Adobe verifies and approves the Integration.
5. Adobe sends Partner an updated WSDL with an correct endpoint for the production environment.
6. Adobe enables the Integration in Data Connectors.
7. Using the Data Connectors Integration API, partner checks on a regular basis for clients that have activated the
integration in their Analytics report suite.
8. After a client activates the partners Data Connectors integration, partner uses the Integration API to enable the
flow of data between the partners product or service and Analytics.
SOAP Service
Simple Object Access Protocol (SOAP) is an XML-based protocol for the exchange of information between applications
over HTTP. See http://www.w3.org/TR/soap12-part1/ for a more complete review of SOAP-based implementations.
The Suite Web Services, including the Data Connectors Partner API, use a document/literal style version of SOAP
(not rpc/encoded). Your program sends a SOAP request; Adobe's Web service processes the request and returns
a response. Both the request and the response use standard XML messages with a header and a body.
Send SOAP requests (in XML format) as an HTTP POST request. It must include a special SOAPAction header.
Adobe returns the response as a response to your POST. All of these communications are encrypted with SSL
(HTTPS), thereby helping to protect data privacy.
Important details must be sent in the Header as metadata about your message, including your login email, password
and a user agent header identifying the client company. The requested operation (such as addAdGroup) is included
in the message body. The message body also includes all pertinent parameters such as the data objects.
Remember that requests for our Web service to process are defined in a Web services definition language (WSDL)
file in XML. This WSDL file describes the operations that our Web service can perform, required parameters for
each operation, and the expected response for each operation.
SOAP Development Toolkits

The easiest way to use the Data Connectors API is with a toolkit that interprets WSDL files and provide a framework
for easier development. Development toolkits encode and decode XML request/response messages for you. More
specifically, toolkits let you work in an object oriented environment, so you can both create and receive objects that
are translated to and from XML by the toolkit.
Note: Make sure the SOAP toolkit you select supports, and is configured for, document/literal SOAP.
Choose a SOAP toolkit that matches the programming language you are using. Toolkits vary in performance,
capability, and user-friendliness. The commonly used toolkits include:
PHP: NuSOAP (http://sourceforge.net/projects/nusoap/) and Pear (http://pear.php.net/).
Java: Apache Axis (http://ws.apache.org/axis/) and Apache WSS4J (http://ws.apache.org/wss4j/).

Windows: .NET SOAP support, and .Net Microsoft Visual Studio .NET
(http://msdn.microsoft.com/en-us/vstudio/default.aspx)
Python: SOAPPy (http://pywebsvcs.sourceforge.net/)
Perl: SOAP::Lite (http://www.soaplite.com/)
SOAPUI (www.soapui.org)
XMLSPY (http://www.altova.com/products/xmlspy/xml_editor.html)
Some SOAP toolkits take care of the XML coding for you. By using a SOAP toolkit that handles the XML generation,
you should rarely have to write XML code to use the Data Connectors Web Service. However, some toolkits might
require you to hand-code some of the XML. For example, nusoap.php requires you to write the XML namespace
for input parameters.
Note: It can sometimes be helpful to capture the XML request and response messages for debugging purposes.
Security
The Suite ensures that access to your company information and transfer of data is secure. The Authentication
procedure is based on the OASIS Web Services Security Username Token Profile 1.0 specification. This method
utilizes a shared secret that can be renewed by an Adobe ClientCare at your request. This shared secret should
never be passed over the Internet unencrypted.
In addition to secure authentication, the Data Connectors API supports secure transfer of data over an SSL data
encryption layer. This method of Web services security is an industry standard and is built into the SOAP technology.
REST Service
Before May 2014, the Data Connectors REST service contained two REST APIs that provided a more efficient option
for downloading large data segments (>10MB), which are not available through the Export.GetSegmentedData
method.
After May 2014, REST APIs are now available for all Data Connectors APIs. These APIs have the same method
names, parameters list, and the same responses as the SOAP APIs.
REST APIs are hosted on a new endpoint, though the two previously supported REST APIs,
Partner.StreamSegmentedData and Partner.StreamClassificationData will continue to use their original endpoint
(https://api.omniture.com/genesis/i/3.1/export/index.html).
The REST API endpoint for all other APIs is:
https://api.omniture.com/genesis/rest/3.1/index.html
Both the configuration and integration REST APIs share the same endpoint.
The parameters can be appended to request URL as query parameters or added to HTTP body. The method name
should always be added to URL similar to the following:
https://api.omniture.com/genesis/rest/3.1/index.html?method=Partner.GetProducts
10
User name and password should be passed by X-WSSE header in HTTP request as following:
Host: api.vm16.dev.ut1.omniture.com
Accept: */*
Content-Type: application/json
Content-Length: 0
X-WSSE: UsernameToken Username="adobe_xinw", PasswordDigest="Or/zpqhCFTZZEAE+mBUL/o623jE=",
Nonce="+UOpU1tx3oN3ED05TVeVrg==", Created="2014-03-24GMT03:00:100"
The following PHP sample demonstrates how to generate X-WSSE

$username = 'username';
$password = 'password';
$created = gmdate('Y-m-dTH:i:sZ');
$nonce = md5(rand(), true);
$base64_nonce = base64_encode($nonce);
$password_digest = base64_encode(sha1($nonce.$created.$password, true));
$data = '{
'data': 'JSON Object to post'
}';
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://api.omniture.com/genesis/rest/index.html');
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
curl_setopt($curl, CURLOPT_HEADER, 0);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
'Content-Type: application/json',
'Content-Length: ' . strlen($data),
sprintf('X-WSSE: UsernameToken Username="%s", PasswordDigest="%s", Nonce="%s", Created="%s"',
$username, $password_digest, $base64_nonce, $created),
));
Methods
The Data Connectors Partner API lets you import data from third-party applications and services into Analytics,
where you can gather and analyze data in a central location.
When a Analytics client uses a Data Connectors-enabled product or service, they can configure an integration
between Analytics and the product or service that imports data into Analytics. Once integrated, they can generate
Analytics reports that include data from the Data Connectors application.
The Data Connectors API methods are organized into two separate Web Services that correspond to the phase of
the integration process where those methods are used.
REST APIs
The existing method documentation was written for SOAP API, so it has parameter types defined. When using the
REST API, there is no need to specify parameter types. Method name should be added to request URL, as described
in REST Service section.
Note: For a list of supported values for many of the parameters used in the Data Connectors API methods,
see Data Connectors Standard Elements.
Data Connectors Configuration API

The Configuration API lets Data Connectors partners define an integrations characteristics, including the data that
the partner wants to share with Analytics.
The Configuration API includes the following methods:
11
Product.Add
Creates a new Data Connectors product.
A Data Connectors Product does the following:
Defines the integration characteristics between the partner's product or service and our Suite client collection
servers.
Facilitates the day-to-day transfer of data between the partner's environment and our Suite collection servers.
Product.Add Parameters
Parameter
Type
Required
Description
contactName
xsd:string
Yes
The name of the principal technical contact.
contactEmail
xsd:string
Yes
The email of the principal technical contact.
version
xsd:string
Yes
The version to assign to the product.
industry
xsd:string
Yes
The industry which best applies to this product.
details
tns:productDetailsList
Yes
The information about this product.
supportPhone
xsd:string
Yes
Phone contact for support.
supportEmail
xsd:string
Yes
Email contact for support.
Product.Add Response
Response
Type
Description
productCode
xsd:string
A unique code assigned to the new product.
status
xsd:string
Status message pertaining to the success of the action.
Product.Clone
Creates a new Data Connectors product based on an existing product.
This is useful when you need to update a product integration due to a new release.
Product.Clone Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes
A valid Data Connectors product code. You can get a list

of your company's product codes by calling .
12
Parameter
Type
Required
Description
newProductVersion
xsd:string
Yes
The product version of the new product.
Product.Clone Response
Response
Type
Description
productCode
xsd:string
A unique code assigned to the new product.
status
xsd:string
Product.Delete
Deletes an existing Data Connectors product.
Product.Delete Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

Product.Delete Response
Response
Type
Description
success
xsd:boolean
Indicates if the operation succeeded (True) or failed (False).
status
xsd:string
Product.Get
Returns information about the specified Data Connectors product.
Product.Get Parameters
Parameter
Type
Description
productCode
xsd:string
A valid Data Connectors product code. You can get a list of your
company's product codes by calling .
13
Product.Get Response
Parameter
Type
Description
productCode
xsd:string
The product code associated with this Data Connectors

product.
contactName
xsd:string
contactEmail
xsd:string
version
xsd:string
The product version.
industry
xsd:string
details
Detailed information about the product configuration.
supportPhone
xsd:string
supportEmail
xsd:string
Product.Modify
Modifies the Data Connectors product as specified.
Product.Modify Parameters
Parameter
Type
Description
productCode
xsd:string
A valid Data Connectors product code. You can get a list of your
company's product codes by calling .
contactName
xsd:string
contactEmail
xsd:string
version
xsd:string
The product version.
industry
xsd:string
details
Detailed information about the product configuration.
supportPhone
xsd:string
supportEmail
xsd:string
14
Product.Modify Response
Parameter
Type
Description
productCode
xsd:string
A unique product code associated with this Data Connectors

product.
status
xsd:string
A status message pertaining to the success of the action.
Product.AddCalculatedMetric
Add a calculated metric for a product.
Added in Data Connectors 3.1.
Product.AddCalculatedMetric Parameters
Element
Type
Required
Description
productCode
xsd:string
Yes
A valid Data Connectors product code. You can get a

list of your company's product codes by calling
Partner.GetProducts.
name
xsd:string
Yes
Name of the calculated metric to be created.
formula
xsd:string
Yes
The formula for the new calculated metric.
Yes
Set to 1 to automatically replace formula metrics with

variable-mapped metrics when an integration is saved.
Yes
Human-readable calculated metric formula.
Yes
The type of metric to be created. 1:numeric, 2:percent,

3:currency
Yes
The number of decimal places to be displayed for this

formula result.
replace_with_mapping xsd:boolean
friendly_formula
xsd:string
metric_type
xsd:integer
decimal_places
xsd:integer
Product.AddCalculatedMetric Response
Parameter
status
Type
Description
status
Product.DeleteCalculatedMetric
Deletes a calculated metric for a product.
15

Product.DeleteCalculatedMetric Parameters
Element
Type
Required
Description
productCode
xsd:string
Yes

name
xsd:string
Yes
Name of the calculated metric to be deleted.
Product.DeleteCalculatedMetric Response
Parameter
status
Type
Description
status
Product.GetCalculatedMetrics
Gets all calculated metrics for a product.
Product.GetCalculatedMetrics Parameters
Element
Type
Required
Description
productCode
xsd:string
Yes

Product.GetCalculatedMetrics Response
Parameter
metrics
Type
Description
productCalculatedMetrics Details about calculated metrics.
Product.ModifyCalculatedMetric
Modifies a calculated metric for a product.
16
Product.ModifyCalculatedMetric Parameters
Element
Type
Required
Description
productCode
xsd:string
Yes

name
xsd:string
Yes
Name of the calculated metric to be modified.
formula
xsd:string
Yes
The formula for the calculated metric.
Yes

Yes
Yes
The type of metric to be created. 1:numeric, 2:percent,

3:currency
Yes
The number of decimal places to be displayed for this

formula result.
friendly_formula
xsd:string
metric_type
xsd:integer
decimal_places
xsd:integer
Product.ModifyCalculatedMetric Response
Parameter
status
Type
Description
status
Product.AddClassification
Add a classification for a metric.
Product.AddClassification Parameters
Element
Type
Required
Description
productCode
xsd:string
Yes

classificationName
xsd:string
Yes
Name of the classification to be created.
metricName
xsd:string
Yes
The partners metric name.
Element
17
Type
parentClassificationNum xsd:integer
type
xsd:string
Required
Description
False
The parent classification's classificationNum. Assign a

value of 0 or leave empty if it is simple classifying the
metric directly.
Yes
One of the following values indicating the classification

type:
text
numeric
percent
currency
version
xsd:integer
campaignViewFlag
xsd:integer
False
Product version.
False
Whether or not to treat this classification like a

campaign.
Product.AddClassification Response
Parameter
Type
Description
classificationNum
xsd:integer
ID for the new classification.
metricName
xsd:string
status
status
Product.DeleteClassification
Deletes a classification for a metric.
Product.DeleteClassification Parameters
Element
Type
Required
Description
productCode
xsd:string
Yes

metricName
xsd:string
Yes
Name of the metric where the classification is created.
False
The parent classification's classificationNum. Assign a

value of 0 or leave empty if it is simple classifying the
metric directly.
18
Product.DeleteClassification Response
Parameter
status
Type
Description
status
Product.GetClassifications
Get classifications for a product.
Product.GetClassifications Parameters
Element
Type
Required
Description
productCode
xsd:string
Yes

Product.GetClassifications Response
Parameter
classificationList
Type
Description
productClassificationList
Classifications defined for the specified

product.
Product.ModifyClassification
Modifies a classification for a metric.
Product.ModifyClassification Parameters
Element
Type
Required
Description
productCode
xsd:string
Yes

classificationName
xsd:string
Yes
Name of the classification.
metricName
xsd:string
Yes
Yes
ID of the classification you want to modify.
Yes
One of the following values indicating the classification

type:
classificationNum
type
xsd:integer
xsd:string
Element
19
Type
Required
Description
text
numeric
percent
currency
campaignViewFlag
xsd:integer
False
Whether or not to treat this classification like a

campaign.
Product.ModifyClassification Response
Parameter
Type
Description
classificationNum
xsd:integer
ID for the new classification.
metricName
xsd:string
status
status
Product.GetProcessingRule
Get the processing rule template for this product.
Product.GetProcessingRule Parameters
Element
Type
Required
Description
productCode
xsd:string
Yes

Product.GetProcessingRule Response
Parameter
rule
Type
Description
productProcessingRule Processing rule template.
Product.DeleteProcessingRule
Deletes the processing rule template for this product.
20
Product.DeleteProcessingRule Parameters
Element
Type
Required
Description
productCode
xsd:string
Yes

Product.DeleteProcessingRule Response
Parameter
status
Type
Description
status
Product.ModifyProcessingRule
Modifies the processing rule template for this product.
Product.ModifyProcessingRule Parameters
Element
Type
Required
Description
productCode
xsd:string
Yes

xml
xsd:string
Yes
The processing rule template XML string.
Product.ModifyProcessingRule Response
Parameter
status
Type
Description
status
Product.AddFaq
Add a FAQ for a product.
Product.AddFaq Parameters
Parameter
Type
Required
Description
answer
xsd:string
Yes
Answer to the provided question.
21
Parameter
Type
Required
Description
productCode
xsd:string
Yes

question
xsd:string
Yes
Question to add to the frequently asked questions list.
Product.AddFaq Response
Parameter
status
Type
Description
status
Product.AddProductScript
Creates a new script associated with the specified Data Connectors product.
In Data Connectors 3.0, Product.SubmitProductScript was renamed to Product.AddProductScript.
Product.SubmitProductScript Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

script
xsd:string
Yes
The product script that you want to submit. For

information about the script format and structure, see
the Product.GetProductScriptresponse.
name
xsd:string
Yes
A short name for this product script. The scriptName

must be unique.
description
xsd:string
No
A detailed description of the product script.
runOn
xsd:string
Yes
When the script should execute. Supported values

include:
demand: Designates the script as an on-demand script
that you can call at any time (see Partner.RunScript).
integration_create: Runs the script after the Data
Connectors Wizard completes for a new integration.
Parameter
22
Type
Required
Description
integration_edit: Runs the script after the Data
Connectors Wizard completes for an existing
integration.
Product.SubmitProductScript Response
Parameter
Type
Description
status
status
A status code and associated message related to the operation.
Product.AddVariableMappings
Configures mappings between partner product metrics and Analytics eVars, events, and properties.
Product.AddVariableMappings Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes
A valid Data Connectors product code. You can

get a list of your company's product codes by
calling .
variableMappings
array( tns:varMapAll )
Yes
XML that defines the variable mappings.
Product.AddVariableMappings Response
Parameter
Type
Description
status
status
Product.DeleteFaq
Delete a FAQ for a product.
Product.DeleteFaq Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

question
xsd:string
Yes
Question that you want to remove from the frequently

asked questions list.
23
Product.DeleteFaq Response
Parameter
status
Type
Description
status
Product.DeleteVariableMappings
Product.DeleteVariableMappings Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

Yes
A list of variable mappings to delete.
variableMappings array(xsd:string)
Product.DeleteVariableMappings Response
Parameter
Type
Description
status
status
Product.DisableAuthentication
Disables the authentication request to the partner API for a product.
Product.DisableAuthentication Request
Parameter
Type
productCode
xsd:string
Required
Description
Yes
A valid Data Connectors

product code. You can get
a list of your company's
product codes by calling .
Product.DisableAuthentication Response
Parameter
Type
status
status
Product.EnableAuthentication
Enables authentication to partner APIs.
Description
24

To authenticate to a partner API, you need the following:
Authentication methods supported by the partner API
Name of the partner API that performs the authentication (for example, authenticate)
Location of the partner WSDL
Product.EnableAuthentication Request
Parameter
Type
endpoint
xsd:string
Required
Description
No
Optional only if the endpoint can be

determined using the WSDL. Full URL
to the endpoint where authentication
occurs. For example,
http://myhost/Authenticationservice.asmx?
functionName
xsd:string
parameterList
Array of
authenticationParameter
productCode
xsd:string
response
xsd:string
type
xsd:string
Yes
Name of the function that performs

authentication in the partner API. For
example, authenticate.
Yes
Product.authenticationParameter.
Yes
A valid Data Connectors product code.

You can get a list of your company's
product codes by calling .
Yes
String to parse out of the response

message from the partner
authentication API that indicates
success. If this string is not located in
the response the authentication
attempt is considered unsuccessful.
For example, "request OK".
Yes
Authentication type to use. One of the

following values:
plain
soap
wsse
curl
url
xsd:string
Yes
Typically the URL of the WSDL, or an

asmx file for CURL.
25
Product.EnableAuthentication Response
Parameter
Type
status
status
Description
Product.GetAuthentication
Returns authentication configuration information
Product.GetAuthentication Request
Parameter
Type
productCode
xsd:string
Required
Description
Yes

Product.GetAuthentication Response
Parameter
Type
Description
authenticationConfiguration
authResponse
AuthResponse:
type type string
functionName type string
response type string
url type string
endpoint type string
parameterList type
authenticationParameterArray - array
of type authenticationParameter
type type string
location type string
name type string
value type string
label type string
p_order type int
Product.GetFaqs
Returns the FAQs for a product.
26
Product.GetFaqs Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

Product.GetFaqs Response
Parameter
faqs
Type
Description
An array of
Product.productFaq
Product.GetLogo
Gets the logo of a product for a given locale.
Product.GetLogo Parameters
Parameter
Type
Required
Description
locale
xsd:string
No
The locale to be used for the image uploaded. If no

locale is used, Data Connectors defaults to en_US.
productCode
xsd:string
Yes

Product.GetLogo Response
Parameter
Type
Description
encodedData
xsd:string
The base64-encoded string of the Data Connectors logo to be updated.

The image must be transparent, 88x28 pixels, in either GIF or PNG format.
Product.GetVariableMappings
Gets the variable mappings for the specified product.
27
Product.GetVariableMappings Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

list of your company's product codes by calling .
filter
xsd:string)
No
An expression-like string that limits the variable

mapping info returned. The format for the filter string
is as follows:
<Variable1> <Operator1> <Constant1>[,
...]]
Variable: One of the tags supported by the

tns:varMapAll data type.
Operator: A boolean operator (<, <=, =, >, >=, or !=).
Constant: The filter value. Constant is either a string
expression or a numeric value. For example, the
following filter returns all variable mappings of type
evar.
om_variable == evar
The following filter returns variable mappings where

metric is Clicks:
metric == Clicks
Product.GetVariableMappings Response
Parameter
Type
variableMappings array( varMapAll )
Description
XML that defines the variable mappings.
Product.ModifyFaq
Modify a FAQ for a product.
Product.ModifyFaq Parameters
Parameter
Type
Required
Description
answer
xsd:string
Yes
productCode
xsd:string
Yes

28
Parameter
Type
Required
Description
question
xsd:string
Yes
Question to add to the frequently asked questions list.
Product.ModifyFaq Response
Parameter
status
Type
Description
status
Product.ModifyLogo
Updates the logo of a product for a given locale.
In Data Connectors 3.0, Product.UpdateLogo was renamed to Product.ModifyLogo.
Product.ModifyLogo Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

encodedData
xsd:string
Yes
The base64-encoded string of the Data Connectors

logo to be updated. The image must be transparent,
88x28 pixels, in either GIF or PNG format.
locale
xsd:string
No

Product.ModifyLogo Response
Parameter
Type
Description
result
xsd:string
Indicates if the logo was successfully updated. The response

returns Logo updated if successful, or an error message if
unsuccessful.
Product.ModifyProductScript
Creates or modifies a product script.
29
Product.ModifyProductScript Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

script
xsd:string
Yes

name
xsd:string
Yes

must be unique.
description
xsd:string
No
runOn
xsd:string
Yes

include:
integration.
Product.ModifyProductScript Response
Parameter
Type
Description
status
status
Product.ModifyVariableMappings
Product.ModifyVariableMappings Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

Yes
XML that defines the variable mappings you want to

change.
variableMappings array( tns:varMapAll )
30
Product.ModifyVariableMappings Response
Parameter
Type
Description
status
status
Product.DisableAdProcessing
Disables ad processing for the specified product during the Data Connectors configuration.
Product.DisableAdProcessing Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

Product.DisableAdProcessing Response
Parameter
Type
Description
status
status
Product.EnableAdProcessing
Enables ad processing during the product configuration in the Data Connectors environment.
Product.EnableAdProcessing Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

prefix
xsd:string
Yes
A partner-specific value used to identify the click and

view data in the request.
variables
adProcessingVariables
Yes
Specifies the names of the variable mappings used to

receive data from the ad processing system.
settings
adProcessingSettings
No
Specifies settings that change the behavior and setup

of the ad processing system.
31
Product.EnableAdProcessing Response
Parameter
Type
Description
status
status
Product.GetAdProcessing
Returns the current add processing settings for the specified product.
Product.GetAdProcessing Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

Product.GetAdProcessing Response
Parameter
Type
status
adProcessingStatus
Description
The current ad processing status for the specified Data Connectors
product.
Product.DeleteProductScript
Removes the product script from the specified product.
Product.DeleteProductScript Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

scriptName
xsd:string
Yes
A name for the product script you want to delete.
Product.DeleteProductScript Response
Parameter
Type
Description
status
status
Product.GetProductScript
Returns the product script from the specified Data Connectors product.
32
Product.GetProductScript Parameters
Parameter
Type
Required
Description
Name
xsd:string
Yes
Name of the script.
productCode
xsd:string
Yes

Product.GetProductScript Response
Type
Description
<genesis>
<ReportSuite.SaveClassifications> 
<c_options/>
<c_view replaceWith="mapping">Ad
Campaign</c_view> 
<camp_view>0</camp_view>
<name>My Site Name</name>
<rsid_list>
<item replaceWith="client">RSID</item> <!-#3 -->
</rsid_list>
</ReportSuite.SaveClassifications>
<Report.QueueRanked>
...
</Report.QueueRanked>
</genesis>
The encapsulated product script.*

(See #1) A Web Services API method. This example
calls a method from the Administration API.
(See #2) The replaceWith attribute instructs Data
Connectors to replace the attribute contents with a
setting or property from the clients account. Data
Connectors supports the following replaceWith
values:
mapping: (See #2) Replaces the attribute with the

specified attribute mapping. For more information
* You should be able to call any Web Services API method
about variable mapping, see
through the Product Script. However, if you run into difficulties Product.AddVariableMappings.
using a particular API method in the Product Script, contact
client: (See #3) Substitutes a client account property
your Adobe Account Manager. For detailed information about
when making the call. Supported values include:
Web Services APIs, visit the Developer Connection.
RSID (insert the Report Suite ID), INT_NAME (insert
the Integration name), INT_EMAIL (insert the
Integration Email).
param: (Used only with On Demand scripts) Inserts
a partner-specified parameter when calling
Partner.RunScript.
For a more detailed product script example, see
Sample Data Connectors Integration.
Product.SubmitProductScript
Creates a list of API calls to make when the Integration Wizard completes.
In Data Connectors 3.0, Product.SubmitProductScript was renamed to Product.AddProductScript.
33
Product.SubmitProductScript Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

script
xsd:string
Yes

scriptName
xsd:string
Yes

must be unique.
scriptDesc
xsd:string
No
runOn
xsd:string
Yes

include:
integration.
Product.SubmitProductScript Response
Parameter
Type
Description
status
status
Product.GetProductScripts
Returns a list of all product scripts submitted for the specified product.
Product.GetProductScripts Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

34
Product.GetProductScripts Response
Parameter
Type
Description
status
string_array
A list of product scripts submitted for the specified product code.
Product.GetProductApprovalStatus
Returns a current status of the approval process.
Call this method after Product.SubmitProductForApproval to check the approval status.
Product.GetProductApprovalStatus Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

Product.GetProductApprovalStatus Response
Parameter
Type
Description
status
xsd:string
Indicates the current status of the approval process for the submitted
product integration. Suppported response values include unsubmitted,
pending, approved, or rejected.
comments
xsd:string
If status == rejected, the comment contains a reason why the

product integration was rejected.
Product.SubmitProductForApproval
Submits the specified product integration for approval.
Product.SubmitProductForApproval Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

Product.SubmitProductForApproval Response
Parameter
Type
Description
status
status
35
Product.AddResource
Adds a resource to the specified product.
A resource is additional information or code that a client needs when activating an integration. Data Connectors
provides clients access to integration resources in multiple ways, including:
On the Summary page of the Data Connectors Integration Wizard
In an Email sent upon activating an integration
In the Data Connectors UI by clicking the Resources link
Product.AddResource Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

type
productResourceType
Yes
The type of resource to add.
title
xsd:string
Yes
The resource name.
description
xsd:string
Yes
The resource URL.

If the type = static or type = dynamic, then the
URL must be the publicly accessible location of a
resource document. Data Connectors downloads the
document and stores it on its servers. The url
parameter truncates the value to the name of the file
instead of the full URL.
Nothing is done if type is set to link.
url
xsd:string
No
Contains the name and base64-encoded bytes of a file

that is uploaded to our servers directly.
resourceFile
resourceEncoded
No
Contains the name and base64-encoded bytes of a file

that is uploaded to Data Connectors servers directly.
variablePrefix
xsd:string
No
Used only when type = dynamic.

A unique string value used to identify the start of a
variable in the dynamic file.
variableSuffix
xsd:string
No
Parameter
36
Type
Required
Description
A unique string value, which can be the same as
variablePrefix, used to identify the end of a variable
in the dynamic file.
locale
xsd:string
No
The language locale used for this resource.

Defaults to en_US.
Product.AddResource Response
Parameter
Type
Description
resourceCode
xsd:string
A unique code assigned to the new resource.
Product.DeleteResource
Deletes a resource from the specified product.
Product.DeleteResource Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

resourceCode
xsd:string
Yes
The unique code assigned to the resource you want to

delete.
Product.DeleteResource Response
Parameter
Type
Description
status
status
Product.GetResource
Returns the specified resource associated with the specified product.
Product.GetResource Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

37
Parameter
Type
Required
Description
resourceCode
xsd:string
Yes
The unique code assigned to the resource you want to

get.
Product.GetResource Response
Parameter
Type
Description
resource
productResource
A structure containing information about the specified resource.
Product.ModifyResource
Modifies an existing resource associated with the specified product.
Product.ModifyResource Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

resourceCode
xsd:string
Yes
A unique code assigned to the resource you want to

modify.
type
productResourceType
No
The type of resource.
title
xsd:string
No
The resource name.
description
xsd:string
No
A description of the resource.
url
xsd:string
No
The resource URL.

If the type = static or type = dynamic, then the
URL must be the publicly accessible location of a
resource document. Data Connectors downloads the
document and stores it on its servers. The url
parameter truncates the value to the name of the file
instead of the full URL.
resourceFile
resourceEncoded
No
Contains the name and base64-encoded bytes of a

resource file to upload directly to Data Connectors
servers.
38
Parameter
Type
Required
Description
variablePrefix
xsd:string
No

A unique string value used to identify the start of a
variable in the dynamic file.
variableSuffix
xsd:string
No

A unique string value, which can be the same as
variablePrefix, used to identify the end of a variable
in the dynamic file.
locale
xsd:string
No
The language locale used for this resource.

Defaults to en_US.
Product.ModifyResource Response
Parameter
Type
Description
status
status
Product.GetResources
Returns all of the resources associated with the specified product.
Data Connectors 3.0: Added includeResourceFile.
Product.GetResources Parameters
Parameter
Type
Required
Description
includeResourceFile
xsd:boolean
Yes
Controls whether or not the actual file data associated

with each resource is returned with the response. If
false, the call will return a list of resources without
returning the actual file data. If true, data for each
file-based resource will be returned.
Added in Data Connectors 3.0
productCode
xsd:string
Yes

39
Product.GetResources Response
Parameter
Type
Description
resource
productDetailsList
A list of all resources associated with the specified product.
Product.AddAccessRequest
Adds an access request to the specified product.
Product.AddAccessRequest Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

access
xsd:string
Yes
The type of access that is being requested: import,

export, or import/export.
element
xsd:string
Yes
The name of the metric or dimension that access is

being requested for. See Data Connectors Standard
Elements for a list of valid values for this parameter.
required
xsd:string
Yes
Specifies if the request must be granted to complete

the integration. Either yes or no.
Product.AddAccessRequest Response
Parameter
Type
Description
status
status
Product.DeleteAccessRequest
Deletes an access request from the specified product.
Product.DeleteAccessRequest Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

40
Parameter
Type
Required
Description
element
xsd:string
Yes
The name of the metric or dimension where you want

to delete the access request. See Data Connectors
Standard Elements for a list of valid values for this
parameter.
Product.DeleteAccessRequest Response
Parameter
Type
Description
status
status
Product.ModifyAccessRequest
Modifies an existing access request for the specified product.
Product.ModifyAccessRequest Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

access
xsd:string
Yes
The type of access that is being requested: import,

export, or import/export.
element
xsd:string
Yes
The name of the metric or dimension that access is

being requested for. See Data Connectors Standard
Elements for a list of valid values for this parameter.
required
xsd:string
Yes
Specifies if the request must be granted to complete

the integration. Either yes or no.
Product.ModifyAccessRequest Response
Parameter
Type
Description
status
status
Product.GetAccessRequests
Returns the current add processing settings for the specified product.
41
Product.GetAccessRequests Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

Product.GetAccessRequests Response
Parameter
Type
Description
requests
tns:accessRequests
A list of the current access requests for the specified product.
Product.UpdateLogo
Modifies the logo graphic that Data Connectors displays in the Partner List.
In Data Connectors 3.0, Product.UpdateLogo was renamed to Product.ModifyLogo. The parameters have not
changed so you can safely rename the method with no additional changes.
Product.UpdateLogo Parameters
Parameter
Type
Required
Description
productCode
xsd:string
Yes

encodedData
xsd:string
Yes
The base64-encoded string of the Data Connectors

logo to be updated. The image must be transparent,
88x28 pixels, in either GIF or PNG format.
locale
xsd:string
No

Product.UpdateLogo Response
Parameter
Type
Description
result
xsd:string
Indicates if the logo was successfully updated. The response

returns Logo updated if successful, or an error message if
unsuccessful.
Data Connectors Integration API

The Integration API enables the day-to-day data transfer between the partner environment and Adobe data collection
servers.
42
The Integration API includes the following methods:

Partner.GetProduct
Get the product for the given partner.
While this method is part of the Integration API, you might find it useful in both the Configuration and Integration
phases of the integration development process.
Partner.GetProduct Parameters
Response
Type
productCode
xsd:string
Description
An array of information about one partner product.
Partner.GetProduct returns an array of product information
for the product identified by the specified productCode.
Partner.GetProduct Response
Response
Type
Description
productInfo
tns:product

Partner.GetProducts returns a separate array of product
information for each product associated with the current
partner.
Partner.GetProducts
Returns information about each product associated with the current Data Connectors partner.
While this method is part of the Integration API, you might find it useful in both the Configuration and Integration
phases of the integration development process.
Note: Several Data Connectors API methods rely on the productCode returned by Partner.GetProducts.
Partner.GetProducts Parameters
None. Data Connectors determines the product list based on the authentication credentials used to log in to the
Data Connectors Partner Portal.
Partner.GetProducts Response
Response
Type
Description
productInfo
tns:product

Partner.GetProducts returns a separate array of product
information for each product associated with the current
partner.
43
Partner.GetIntegrationAccess
Lets a partner see what data a customer has granted access to in the integration.
Also identifies if the client has granted export access, import access, or both.
Partner.GetIntegrationAccess Parameters
Parameter
Type
Required Description
integrationCode
xsd:string
No

Partner.GetProducts returns a separate array of
product information for each product associated with
the current partner.
Partner.GetIntegrationAccess Response
Response
Type
Description
element
xsd:string
Displays the name of the element for which access was requested.
requested
xsd:string
Displays the level of access that was requested: import, export, or

import/export.
granted
xsd:string
Displays the level of access that was granted by the customer:

import, export, or import/export.
Partner.GetIntegrationMappings
Retrieves the mappings and access chosen by the user for an Integration.
Partner.GetIntegrationMappings Parameters
Parameter
Type
integrationCode
xsd:string
Required
Description
No
An array of information about one partner

product. Partner.GetProducts returns
a separate array of product information
for each product associated with the
current partner.
Partner.GetIntegrationMappings Response
Response
Type
Description
chosenMappings
string_array
The chosen data mappings which

were selected by the user.
chosenAccessRequests
The chosen access requests selected

by the user. These contain the
Response
44
Type
Description
exportable access requests (can be
requested via Data Warehouse) and
importable access requests (can be
imported with Data Sources and
SAINT).
Partner.GetIntegrations
Returns details about active Data Connectors integrations.
Partner.GetIntegrations Parameters
Parameter
Type
Required
Description
filter
xsd:string
No
An expression-like string that limits the returned results.

The format for filter string is as follows:
<Variable2> <Operator2> <Constant2>[, ...]]
The list below this table contains the available filter

items.
CustomVals are searched with a customValue filter
similar to the following:
<filter
xsi:type="xsd:string">customValue='key=value'</filter>
Variable: One of the keys returned in the

Partner.GetIntegrationAccess response.
expression (enclosed in single or double quotes), or a
numeric value.
For example, the following filter returns all integrations
between d1.100 and d2.200:
integrationCode >= "d1.100", integrationCode
<= "d1.200"
The following filter items are available:

integrationCode
integrationName
integrationEmail
integrationTimeZone
45
integrationCurrency
productCode
productVersion
productName
reportSuiteId
company
creationDate
lastModifiedDate
status
selectedSegment
soapEndpoint
customValue
Partner.GetIntegrations Response
Response
Type
Description
integrationInfo
integrationDetails
Displays details about the active integrations that pass

the specified filter definition.
Partner.GetIntegrationsBrief
Returns brief information about a partner's active Data Connectors integrations.
Partner.GetIntegrationsBrief Parameters
Parameter
Type
Required
Description
filter
xsd:string
No


<filter

Parameter
46
Type
Required
Description
numeric value.
<= "d1.200"
Partner.GetIntegrationsBrief Response
Response
Type
Description
integrationBriefs
Array of integrationBrief

Partner.GetIntegrationsDetail
Returns information about a partner's active Data Connectors integrations.
Partner.GetIntegrationsDetail Parameters
Parameter
Type
Required
Description
filter
xsd:string
No


<filter

numeric value.
Parameter
47
Type
Required
Description
<= "d1.200"
Partner.GetIntegrationsDetail Response
Response
Type
Description
integrationData
Array of integrationData

Partner.GetSandboxCredentials
Returns the login information a partner needs to access their Data Connectors sandbox environment.
Partner.GetSandboxCredentials Parameters
None. Data Connectors determines the partner identity based on the authentication credentials used to log in to the
Partner.GetSandboxCredentials Response
Response
Type
Description
soap_host
partner_sandbox_credentials
The partners access credentials for the Data

Connectors sandbox environment.
Partner.GetTokenUsage
Returns the sandbox token usage details for the authenticated partner.
Partner.GetTokenUsage Parameters
None. Data Connectors determines the partner identity based on the authentication credentials used to log in to the
Partner.GetTokenUsage Response
Response
Type
Description
allowedTokens
xsd:int
The total number of tokens available for use during a usage

period.
consumedTokens
xsd:int
The number of tokens consumed during the current usage period.
Partner.RunScript
Runs an on-demand script against a clients account during an integration.
48
For sample code related to using Partner.RunScript with on-demand product scripts, see Sample On-Demand
Script Usage.
Partner.RunScript Parameters
Parameter
Type
Required
Description
integrationCode
xsd:string
Yes
The integration identifier. Call

Partner.GetIntegrationAccess to get this value.
name
xsd:string
Yes
The name of the on-demand script to execute. You

can select only scripts that were submitted with the
runOn = demand parameter (see
Product.SubmitProductScript ).
parameters
scriptParameters
Yes
The parameters inserted into the scripts replaceWith

attributes. The list must include values for ALL
replaceWith parameters.
Partner.RunScript Response
Response
Type
Description
functionName
xsd:string
Name of the on-demand script executed.
hadSOAPFault
xsd:boolean
Indicates if a SOAP error was encountered.
result
any
An array that contains the script results.
Import.UploadMetrics
Submits the first data block in the Data Connectors data submission.
Individual data blocks can contain no more than 10,000 data rows (to keep the HTTP POST below 10MB), so you
might need to break up data submissions into multiple data blocks.
Import.UploadMetrics Parameters
Parameter
Type
Required
Description
integrationCode
xsd:string
Yes

columnNames
colArray
Yes
The names of the data columns (the column

heading).
There must be at least three <item> elements
nested inside this parameter. The first must be
Parameter
49
Type
Required
Description
Date. The others must be either a valid metric
name of a submitted variable mapping (see

Product.AddVariableMappings), or Product (to
upload product data)*.
Note: There must be at least one eVar
metric and one Event metric.
rows
rowArray
Yes
The data to import. The rows element should

contain the same number of columns as specified
in the columnNames parameter.
dataSourceId
xsd:string
Yes
Specifies the data source where you want to

import the metrics. You can get the
dataSourceID from Partner.GetIntegrations.
endOfBlock
xsd:string
No
A value of 1 indicates that this is the last block

in the data submission. A value of 0 indicates
that additional data will be sent.
To indicate the end of a data block, pass the
following:
<endOfBlock>1</endOfBlock>.
To indicate that additional data will be sent, pass

the following:
If you pass an endOfBlock with a value of 0, you

must call Import.ContinueMetricsUpload to
resume uploading.
* To use Product as the ColumnNames parameter, you must set the productUpload flag in the Integration Wizard.
To do this, select Allow this integration to upload product data when using the Template Wizard in the Data
Connectors Sandbox.
Import.UploadMetrics Response
Response
Type
Description
status
xsd:string
Indicates if the call was successful. Valid return values

include Failed or Success.
If the call fails, Data Connectors returns an error
message to help you understand why the call failed.
50
Response
Type
Description
blockId
xsd:int
The ID used to append additional data blocks to this

Data Connectors data submission.
This parameter is assigned a value only when the
request does not include the <endOfBlock/> tag.
fileId
xsd:int
The unique ID generated by the Processing Queue to

identify a particular Data Connectors data submission.
Import.CheckMetricsUpload
Checks a Data Connectors data submission.
Import.CheckMetricsUpload Parameters
Parameter
Type
fileId
xsd:int
Required
Description
Yes
The unique ID generated by the Processing

Queue to identify a particular Data
Connectors classifications submission.
Returned by Import.UploadMetrics or
Import.ContinueMetricsUpload
integrationCode
xsd:string
Yes

Partner.GetIntegrationAccess to get this
value.
Import.CheckMetricsUpload Response
Response
Type
fileInfoResult
Array of
DataSource.dsFileStruct
Description
Contains information about the submitted files
associated with a data source.
Import.ContinueMetricsUpload
Appends an additional data block to an existing Data Connectors data submission.
51
Import.ContinueMetricsUpload Parameters
Parameter
Type
Required
Description
integrationCode
xsd:string
Yes

blockId
colArray
Yes
The ID of the previous block sent for this data

submission.
Both Import.UploadMetrics and
Import.ContinueMetricsUpload returns
blockID in its response, as long as endOfBlock
is not included in the UploadMetrics call.

endOfBlock
xsd:string
No

following:

the following:

must continue to call this method
(ContinueMetricsUpload) until you set end of
block equal to 1.
Import.ContinueMetricsUpload Response
Response
Type
Description
status
xsd:string

fileId
xsd:int

identify a particular Data Connectors data submission.
52
Import.UploadClassifications
Submits SAINT classification data for a Data Connectors integration on behalf of a client.
Import.UploadClassifications Parameters
Parameter
Type
Required
Description
integrationCode
xsd:string
Yes

metricName
The name of the metric where you want to import

classification data.
The metric must be a previously defined variable
mapping that is available by calling
Product.GetVariableMappings.
columnNames
colArray
Yes
The names of the classification columns (the

column heading).
There must be at least 2 <item> elements nested
inside this parameter. The first must be Key. All
others must be valid classifications created
through the Product Script (see
Product.GetProductScript).
rows
rowArray
Yes
The classification data to import.

The rows element should contain the same
number of columns as specified in the
columnNames parameter.
endOfBlock
xsd:string
No

following:

the following:
Parameter
53
Type
Required
Description
must call Import.ContinueClassificationsUpload
to resume uploading.
Import.UploadClassifications Response
Response
Type
Description
status
xsd:string

blockId
xsd:int

Data Connectors classifications submission.
fileId
xsd:int

identify a particular Data Connectors classifications
submission.
Import.CheckClassificationsUpload
Checks submitted SAINT classification data for a Data Connectors integration.
Import.CheckClassificationsUpload Parameters
Parameter
Type
fileId
xsd:int
Required
Description
Yes
The unique ID generated by the Processing

Queue to identify a particular Data
Connectors classifications submission.
Returned by Import.UploadClassifications
or Import.ContinueClassificationsUpload
integrationCode
xsd:string
Yes

Partner.GetIntegrationAccess to get this
value.
54
Import.CheckClassificationsUpload Response
Response
Type
Description
saintresults
saintresults
The status of the specified SAINT job. Possible values

are as follows:
Waiting for user data
In Progress
In Progress - <number>% Complete
Completed
Completed - With Errors : <message>
Import.ContinueClassificationsUpload
Appends an additional data block to an existing Data Connectors classifications submission.
Import.ContinueClassificationsUpload Parameters
Parameter
Type
Required
Description
integrationCode
xsd:string
Yes

blockId
xsd:int
Yes
The ID of the previous block sent for this

classifications submission.
Both Import.UploadClassifications and
Import.ContinueClassificationsUpload return
blockID in its response, as long as endOfBlock
is not included in the call.
rows
rowArray
Yes
The classification data to import.

The rows parameter should contain the same
number of columns as specified in the
columnNames parameter of the
Import.UploadClassifications call.
endOfBlock
xsd:string
No

following:
Parameter
55
Type
Required
Description
the following:

must continue to call this method
(ContinueClassificationsUpload) until you set
end of block equal to 1.
Import.ContinueClassificationsUpload Response
Response
Type
Description
status
xsd:string

blockId
xsd:int

Data Connectors classifications submission.
fileId
xsd:int

identify a particular Data Connectors classifications
submission.
Export.RequestClassificationData
Retrieves classification data from SAINT.
After creating an export job, use Export.CheckClassificationRequest to determine when the export data is
ready for download. Export data files can be very large. Use Export.GetClassificationData to download the
file in pieces (segments).
Export.RequestClassificationData Parameters
Parameter
Type
Required
Description
integrationCode
xsd:string
Yes
The partner product for which you

want to retrieve classification
data.
56
Parameter
Type
Required
Description
campaign_filter_begin_range
xsd:string
No
The campaign start date. Include

this parameter when
campaign_filter_option = 2.
Specify the date range using the
following
format:<start_date>-<end_date>.
Provide the date in the following
format: YYYMMDD, where:
YYY + 1900 equals the year (For
example, 2008 is 108).

MM equals the month number
minus 1 (January = 00, February

= 01, and so on).
DD equals the 2 digit day.
For example, May 22, 2008 is

1080422.
campaign_filter_end_range
xsd:string
No
The campaign end date. Include

this parameter when
Use the same date range format
described for the
campaign_filter_begin_range
parameter.
campaign_filter_option
xsd:int
No
The filter option to use for the

SAINT export. Supported values
include:
0 : Return all Campaigns (No
filter)
1 : (Default) Return active
campaigns
2 : Return campaigns with the
specified begin and end date.

date_filter_row_start_date
xsd:string
No
The start date for including rows

in the export. Include this
parameter when
Parameter
57
Type
Required
Description
Specify the date using the
following format: Mmm YYYY,
where:
Mmm: A three-character month
code. For example, January=Jan,

February=Feb, and so on.
YYYY: The 4-digit year.
For example, September, 2008 is

Sep 2008.
date_filter_row_end_date
xsd:string
No
The end date for including rows

in the export. Include this
parameter when
Use the same date range format

described for the
date_filter_row_start_date
parameter.
email_address
xsd:string
Yes
The email address to receive job

notifications.
relation_id
xsd:int
Yes
The relation ID.

You get this ID as a return value
from
Saint.GetCompatibilityMetrics
.
For example, 53 is the ID for the
"campaign" relation.
row_match_filter_empty_column_name
xsd:string
No
(Optional) The column ID number

of the column that SAINT checks
for empty data cells.
If this parameter is specified, the
export contains only keys which
have empty values for the
provided column.
You get the column ID by
callingSaint.GetFilters for a
specific relation id.
58
Parameter
Type
Required
Description
row_match_filter_match_column_name
xsd:string
No
(Optional) The column name that

SAINT checks for cell values that
match the value specified in the
row_match_filter_match_column_value
parameter.
If the cell value matches the
value, SAINT excludes it from the
export.
row_match_filter_match_column_value
xsd:string
No
(Optional) The value that SAINT

uses to exclude a data row from
the export.
Include this parameter when
using
row_match_filter_match_column_name.
select_all_rows
xsd:int
Yes
Specifies whether to include all

data rows in the export (up to the
50,000 row limit). Supported
values include:
0: Do not include all rows in the
export.
1: (Default) Include all rows in the
export.
select_number_of_rows
xsd:int
No
(Optional) Limits the number of

data rows in the export file to the
specified value. The default limit
is 50,000.
Include this parameter when
select_all_rows = 0.
Export.RequestClassificationData Response
Name
Type
Description
requestID
xsd:int
The request ID associated with your export request.
Export.CheckClassificationRequest
Determines if a requested classification from Export.RequestClassificationData is ready to be acquired by
Export.GetClassificationData or downloaded by REST URL.
59
Export.CheckClassificationRequest Parameters
Parameter
Type
Required
Description
integrationCode
xsd:string
Yes
The partner product for which you want to retrieve

requestId
xsd:int
Yes
The request ID returned by

Export.RequestClassificationData.
Export.CheckClassificationRequest Response
Name
Type
Description
data_url
xsd:string
The REST URL where the data can be downloaded.
return
tns:saintresults
The status of the classification request. Possible values are

as follows:
Waiting for user data
In Progress
In Progress - <number>% Complete
Completed
Completed - With Errors : <message>
Export.GetClassificationData
Retrieves classification data for a Data Connectors partner which was requested previously from
Export.RequestClassificationData.
Export.GetClassificationData Parameters
Parameter
Type
Required
Description
integrationCode
xsd:string
Yes
The partner product for which you want to retrieve

file_id
xsd:int
Yes
The ID of the export file you want to view.

You can get this value from
SAINT.CheckJobStatus .
segment_id
xsd:int
Yes
The number of the data page you want to view

from the SAINT export job.
The viewable_pages value in
SAINT.CheckJobStatus indicates the number of
Parameter
60
Type
Required
Description
data pages in the job. Valid values for segment_id
are between 1 and the value of viewable_pages.
Export.GetClassificationData Response
Name
Type
Description
rows
tns:pagedetails
Information and data for the specified SAINT data segment.
Export.RequestSegmentedData
Submits a Data Warehouse request to return data to the Data Connectors partner.
Export.RequestSegmentedData Parameters
Parameter
Type
Required
Description
integrationCode
xsd:string
Yes
The identifier of the integration for which you

want to request an export. Call
Partner.GetIntegrations to get this value.
breakdownNames
string_array
Yes
The breakdowns to include in the Data

Warehouse request. The breakdown must be
the name of a variable mapping defined in the
Data Connectors integration (See
Product.GetVariableMappings).
A valid request must contain at least one Metric
or Breakdown.
metricNames
string_array
Yes
The metrics to include in the Data Warehouse

request. The metric must be the name of a
variable mapping defined in the Data Connectors
integration (See Product.GetVariableMappings).
A valid request must contain at least one Metric
or Breakdown.
segmentName
xsd:string
Yes
The segment to use with this Data Warehouse

request. Use Partner.GetIntegrations to get a list
of valid segment names.
dateGranularity
xsd:string
Yes
The granularity of the Data Warehouse request.

Supported values include the following: none,
hour, day, week, month, quarter, year.
61
Parameter
Type
Required
Description
dateType
xsd:string
Yes
The type of date range used with the Data

Warehouse request. Supported values include:
range: Specifies that you want to use a custom
date range. To do this, specify the report's start
date using the dateFrom parameter, and the end
using the dateTo parameter.
preset: Specifies that you want to use a
predefined date range. To do this, specify the
report's preset date using the datePreset
parameter.
datePreset
xsd:string
No
The predefined date range to use with the Data

Warehouse request. Specify this parameter when
dateType = preset.
Supported values include the following (values
are case-sensitive): Last month, Last week,
Last 2 weeks, Last 4 weeks, Last 7 days,
Last 30 days, This month, This week, Today,
Yesterday.
dateFrom
xsd:string
No
The start date of the custom date range for the

Data Warehouse request. Specify this parameter
when dateType = range.
Date values must use the format MM/DD/YY.
dateTo
xsd:string
No
The end date of the custom date range for the

Data Warehouse request. Specify this parameter
when dateType = range.
Date values must use the format MM/DD/YY.
Export.RequestSegmentedData Response
Response
Type
Description
requestId
xsd:int
A unique identifier for the requested data segment.
status
xsd:string
Indicates if the call was successful. Valid return values include

Failed or Success.
If the call fails, Data Connectors returns an error message to
help you understand why the call failed.
62
Export.CheckDataRequest
Returns the status of a previously requested data segment.
Export.CheckDataRequest Parameters
Parameter
Type
Required
Description
integrationCode
xsd:string
Yes
The integration where you want to submit the

metric data. Call Partner.GetIntegrationAccess
to get this value.
requestId
xsd:int
Yes
The data segment identifier that you want to get.

The Export.RequestSegmentedData method
returns this identifier when it creates a new data
segment.
Export.CheckDataRequest Response
Response
Type
Description
return
data_warehouse_request
A structure that includes information about the specified data

request.
Export.GetSegmentedData
Downloads previously requested segment data.
You must first request the data segment using Export.RequestSegmentedData. Use this method only when the data
segment is less than 10MB. Use Export.CheckDataRequest to determine the size of the data segment. For data
segments larger than 10MB use the Data Connectors REST Service.
Export.GetSegmentedData Parameters
Parameter
Type
Required
Description
integrationCode
xsd:string
Yes

requestId
xsd:int
Yes
The data segment identifier. The

Export.RequestSegmentedData method returns
this identifier when it creates a new data
segment.
startRow
xsd:int
Yes
Start the retrieval at the specified row.
63
Export.GetSegmentedData Response
Response
Type
Description
return
data_warehouse_report
A table containing the requested segment data.
Export.ProduceResource
Produces a dynamic resource for the specified integration.
Export.ProduceResource Parameters
Parameter
Type
Required
Description
integrationCode
xsd:string
Yes

resourceCode
xsd:string
Yes
The resource identifier.
Export.ProduceResource Response
Response
Type
Description
return
productResourceContent
A structure containing the resource content.
Data Types
The Data Connectors Partner API uses these custom data types.
A custom data type defines a structure for organizing and containing a specific set of data. Additionally, XML defines
certain primitive (common) data types such as int, string or date. The XML Schema Definition describes these
primitive data types.
Adobe uses the following convention to identify a data type related to Marketing Cloud web services:
<namespace>:<type>
For example:
xsd:int identifies a primitive data type that is part of the xsd namespace (XML Schema Definition), and that the
type is int (Integer).
tns:code_items identifies a custom data type that is part of the tns namespace (an Adobe private namespace),
and that the type is code_items. The tns namespace prefixes all custom data types related to the Adobe Marketing
Cloud.
REST APIs
The existing data type documentation was written for SOAP API, so it has parameter types defined. When using
the REST API, there is no need to specify parameter types. Method name should be added to request URL, as
described in REST Service section.
64
accessRequest
Information about a single access request.
Element
Type
element
xsd:string
access
xsd:string
required
xsd:string
Description
??
??
??
accessRequests
An array of accessRequest .
Element
Type
variable
xsd:string
Description
The name of the variable mapping that contains the incoming
data string.
If not specified, Data Connectors uses the value from the
variables.viewsVariable parameter.
delimiters
xsd:string
The default value is :=.

A list of the delimiters used to indicate new tokens in the incoming
data string.
tokenCount
xsd:int
The default value is 9.

The total number of tokens in the incoming data string.
format
xsd:string
The default value is : (colon).

The string indicating the delimiter used when building the outgoing
strings.
clickToken
xsd:int

A number indicating the token that contains the click information.
clickSeconds
xsd:int

The number of seconds after which a click is no longer counted.
Element
Type
clickFormat
xsd:string
65
Description
The default value is :$7:$8:$9.
A string used to build the outgoing click data. It contains a
template string that indicates the tokens used and the delimiters
separating them. This data is appended to the prefix to create
the full click string.
viewToken
xsd:int

A number indicating the token that contains the view information.
viewSeconds
xsd:int
The default value is 2592000 (30 days).

The number of seconds after which a view is no longer counted.
viewFormat
xsd:string
The default value is :$3:$4:$5.

A string used to build the outgoing view data. It contains a
template string that indicates the tokens used and the delimiters
separating them. This data is appended to the prefix to create
the full view string.
timeBucketFormat timeBucketList
A list that contains the timebucket intervals used for the time
bucket metric.
adProcessingStatus
Element
Type
enabled
xsd:boolean
prefix
xsd:string
variables
settings
Description
Identifies if ad processing is enabled (true) or disabled (false).
The unique text pre-pended to outgoing click and view data.
Contains the names of the variable mappings what will be used
to receive the data from the ad processing system.
Contains information that changes the behavior and setup of the
ad processing system.
66
Element
Type
clickVariable
xsd:string
clickEventVariable
xsd:string
viewsVariable
xsd:string
viewsEventVariable
xsd:string
timeBucketVariable
xsd:string
Description
The name of the variable that stores the clicks metric. For
example, Click Through.
The name of the variable that stores the clicks metric. For
example, Click Throughs.
The name of the variable that stores the views metric. For
example, View Through.
The name of the variable that stores the views event. For
example, View Throughs.
The name of the variable that stores the time bucket metric.
For example, Time Bucket.
Product.authenticationParameter
Contains details on an authentication parameter that is used for partner API authentication.
Element
Type
Description
type
xsd:string
Can be input, static, array_key

Input indicates a value that the user needs to provide at
authentication time. Static is a persistent value that is used every
time for authentication. Array key
location
xsd:string
Location of the authentication parameter. Values can be header,

argument, both. Consult the partner API to determine where
authentication information should be located.
name
xsd:string
Name that the partner is expecting for the authentication

parameter.
If the type is array_key, this value is an array that contains the
name:value pairs.
Some WSDLs require multi-dimensional arrays, similar to the
following:
Array('username' => xxxx,
'password' => xxx)
Array(parameters => Array('username' => xxxx,
'password' => xxx)
67
Element
Type
Description
value
xsd:string
Contains the authentication password if type is static, otherwise

value is not used.
label
xsd:string
Friendly name of the parameter and a brief description of the

information expected from the user. This string is displayed in
the configuration Wizard.
p_order
xsd:int
Order in which you want the parameters sent. If 1 is specified,

the parameters are sent in the order provided. If 0 is specified, it
indicates that parameter order doesn't matter to the partner API.
The following contains an example of an authentication parameter:

<parameterList xsi:type="SOAP-ENC:Array">
<prodAuthParam>
<type>input</type>
<location>both</location>
<name>UserName</name>
<value/>
<label>Username</label>
<p_order>0</p_order>
</prodAuthParam>
<prodAuthParam>
<type>input</type>
<location>both</location>
<name>Password</name>
<value/>
<label>Password</label>
</prodAuthParam>
<prodAuthParam>
<type>input</type>
<location>argument</location>
<name>AdvertiserID</name>
<value/>
<label>Advertiser ID</label>
</prodAuthParam>
<prodAuthParam>
<type>input</type>
<name>ConversionTagID</name>
<value/>
<label>Conversion Tag ID</label>
</prodAuthParam>
<prodAuthParam>
<type>array_key</type>
<name>parameters</name>
<value/>
<label></label>
</prodAuthParam>
</parameterList>
Chosen access requests selected by the user.
68
Element
Type
Description
importable
string_array
Contains the exportable access requests (can

be requested via Data Warehouse).
exportable
string_array
Contains the importable access requests (can

be imported with Data Sources and SAINT).
colArray
An array of xsd:string.
data_warehouse_report
Contains a segmented Data Warehouse report.
Element
Type
start_row
xsd:int
end_row
xsd:int
finished
xsd:boolean
headings
string_array
rows
string_array
Description
The first data row to include in the report. This value should
always be 1.
The last data row to include in the report.This value should always
equal the number of elements in rows.
Indicates that additional data is available (a paged report). This
value is not currently enabled. It always returns True.
An array of column headings for this report.
An array of data rows for this report.
data_warehouse_request
Element
Type
status
xsd:int
Description
A code representing the status of the data segment. Supported
status values include:
status == 0: Waiting to Start
status == 1: In Progress
status == 2: Completed
status == 3: On Hold
status == 4: Cancelled
status == 5: Has Error
Element
Type
69
Description
status == 7: Too Big
status == 9: Waiting for Data
status == 10: Waiting to Send
status == 11: Waiting for Verification
status == 12: Waiting to Send
status == 13: Sent to Product
status == 14: Sending
status == 15: Waiting to Continue
status == 16: Waiting to Continue
status == 17: Continuing
status == 18: Not Delivered
message
xsd:string
filesize
xsd:string
data_url
xsd:string
A brief description of the status code. The message string for

each status code is listed in the description of the status
parameter.
Populated only when status == 2. The size of the requested
data segment, in MB.
Populated only when status == 2. Contains the REST URL
where you can download the completed data segment.
Use the REST URL to download all data segments larger than
10MB. For more information, see Data Connectors REST Service.
display
Display information for a custom value.
Element
Type
type
xsd:string
Description
Type of custom value, must be one of the following:
text
textarea
list
radio
values
tns:string_array
The array of custom values.
70
int_array
An array of xsd:int.
integrationAccess
Element
Type
element
xsd:string
requested
xsd:string
granted
xsd:string
Description
Displays the name of the element for which access was
requested.
Displays the level of access that was requested: import, export,
or import/export.
Displays the level of access that was granted by the customer:
import, export, or import/export.
integrationBrief
Element
Type
integrationCode
xsd:string
integrationName
xsd:string
soapEndpoint
xsd:string
Description
The integration's unique identifier.
The integration name.
The SOAP endpoint used to perform the integrations data
exchange.
integrationData
Element
Type
integrationCode
xsd:string
integrationName
xsd:string
integrationEmail
xsd:string
integrationTimeZone xsd:string
integrationCurrency xsd:string
Description
The email address that receives notifications and messages for
this integration.
The time zone of the report suite that contains this integration.
The currency of the report suite that contains this integration.
Element
Type
productCode
xsd:string
productVersion
xsd:string
productName
xsd:string
reportSuiteId
xsd:string
company
xsd:string
creationDate
xsd:string
lastModifiedDate
xsd:string
status
xsd:string
71
Description
The version of the product that this integration represents.
The product name related to this integration.
The report suite that uses this integration.
The company that created this integration.
The date and time this integration was created.
The date and time this integration was last modified.
One of the following:
In Progress
Active
Deleted
Paused
selectedSegments string_array
integrationValues
integrationValues
dataSourceIds
int_array
soapEndpoint
xsd:string
integrationAccesses Array of
ntegrationAccess
integrationMappings Array of
If applicable, a list of the data segments chosen during the

creation of the integration (in the Data Connectors Wizard).
An array of integrationValue that contains the variable mappings
and the value that was entered for this integration.
The list of Data Source IDs created for this integration. Use the
Data Source IDs with Import.UploadMetrics.
exchange.
integrationAccess
integrationMapping
integrationMapping
Element
Type
Description
integrationCode
xsd:string
integrationDetail
Element
Type
integrationName
xsd:string
integrationEmail
xsd:string
integrationTimeZone xsd:string
integrationCurrency xsd:string
productCode
xsd:string
productVersion
xsd:string
productName
xsd:string
reportSuiteId
xsd:string
company
xsd:string
creationDate
xsd:string
selectedSegments string_array
integrationValues
integrationValues
dataSourceIds
int_array
soapEndpoint
xsd:string
integrationDetails
An array of integrationDetail .
72
Description
The email address that receives notifications and messages for
this integration. See Time Zones.
The time zone of the report suite that contains this integration.
The currency of the report suite that contains this integration. See
Currency Codes.
The product name related to this integration.
The report suite that uses this integration.
The company that created this integration.
The date and time this integration was created.
If applicable, a list of the data segments chosen during the
creation of the integration (in the Data Connectors Wizard).
A list of customval variable mappings and the value that was
entered for this integration.
The list of Data Source IDs created for this integration. Use the
Data Source IDs with Import.UploadMetrics.
exchange.
73
integrationMapping
Element
Type
type
xsd:string
sc_field
xsd:integer
feature_name
xsd:string
Description
The type of Analytics variable used in the mapping (supported
values include evar, event, or prop).
The relation ID. You get this ID as a return value from
GetCompatibilityMetrics. For example, 53 is the ID for the
"campaign" relation.
The customized metric name displayed in Analytics
integrationValue
Element
Type
name
xsd:string
value
xsd:string
Description
The name of the customval.
The value entered for the "name" parameter in the Integration
Wizard.
integrationValues
An array of integrationValue .
metricClassificationList
An array of metricClassifications .
metricClassifications
Element
Type
metricName
xsd:string
classifications
Description
A list of productClassification objects defined for this metric.
74
partner_sandbox_credentials
Element
Type
web_host
xsd:string
company
xsd:string
username
xsd:string
password
xsd:string
Description
The URL to the partners sandbox environment.
The company name to use when logging in to the partners
sandbox environment.
The username to use when logging in to the partners sandbox
environment.
A one-time-use password to use when logging in to the partners
sandbox environment. You must change the password after
logging in for the first time.
product
Element
Type
productCode
xsd:string
name
xsd:string
contactName
xsd:string
contactEmail
xsd:string
version
xsd:string
dateAdded
xsd:dateTime
Description
The Data Connectors Product Code assigned to this product.
The product name.
The partners contact name.
The partner's contact e-mail address.
Product version.
Date product was added.
productArray
An array of product .
productCalculatedMetric
Element
Type
name
xsd:string
formula
xsd:string
Description
Name of the calculated metric to be created.
The formula for the new calculated metric.
Element
Type
friendly_formula
xsd:string
metric_type
xsd:integer
decimal_places
xsd:integer
75
Description
The type of metric to be created. 1:numeric, 2:percent, 3:currency
The number of decimal places to be displayed for this formula
result.
productCalculatedMetrics
An array of productCalculatedMetric .
productClassification
Element
Type
metricName
xsd:string
classificationName xsd:string
classificationNum
xsd:integer
campaignViewFlag xsd:integer
type
tns:productClassificationType
childNodes
An array of productClassification .
Description
Name of the classification.
Numeric identifier of this classification for this metric.
Item that this classification is classifying. Assign a value of 0 if it
is simple classifying the metric directly.
Whether or not to treat this classification like a campaign.
The classification type: Numeric or Text.
A list of child productClassification objects.
76
productDetails
Element
Type
name
xsd:string
menuName
xsd:string
boilerplate
xsd:string
instructions
xsd:string
final_instructions
xsd:string
locale
xsd:string
Description
The name of the product in the specified locale.
The customized name for this product to display in the Data
Connectors left navigation. Added in Data Connectors 3.1.
The boilerplate description in the specified locale.
The activation installation instructions for the product in the
specified locale.
The post-activation instructions for the product in the specified
locale.
The specified locale.
productDetailsList
An array of productDetails .
Product.productFaq
Contains a frequently asked question.
Element
Type
Description
question
xsd:string
Frequently asked question.
answer
xsd:string
productProcessingRule
Element
Type
xml
xsd:string
Description
The processing rule template XML string.
77
productResource
Element
Type
resourceCode
xsd:string
type
productResourceType
title
xsd:string
description
xsd:string
url
xsd:string
Description
A partner-specific value used to identify the click and view data
in the request.
The type of resource you want to add. Supported values include
link, static, and dynamic.
A title for the resource.
A description of the resource.
The resource URL.
If the type field is set to static or dynamic then the URL must
be the publically accessible location of a resource document.
Data Connectors downloads the document and stores it on its
servers. The url parameter is truncated to file name instead of
the full URL.
resourceFile
resourceEncoded
variablePrefix
xsd:string
Contains the name and base64-encoded bytes of a file that is

uploaded to our servers directly.
Used only with dynamic resources.
The prefix used to delimit variables in the dynamic resource file
that will be replaced on the fly with information specific to any
particular integration.
variableSuffix
xsd:string
Used only with dynamic resources.

The suffix used to delimit variables in the dynamic resource file
that will be replaced on the fly with information specific to any
particular integration.
locale
xsd:string
The locale used for this resource.
productResourceContent
Element
Type
status
xsd:int
Description
The status of the resource upload. Supported values include:
Element
Type
78
Description
0: Success.
1: Failure.
error
xsd:string
content
xsd:string
If status = 1, contains a message describing the cause of the

failure.
The resource content. You must base64-encode a resource to
upload it to Data Connectors. Data Connectors subsequently
decodes the resource and stores it in this element.
productResourceList
An array of productResource .
productResourceType
Data Connectors 3.0: Added feed resource type.
An enumerated list of supported resource types:
Element
link
static
Description
A simple URL that redirects the integration client to an external Web page.
A static file, such as a PDF. Data Connectors downloads and includes static resources as Email
attachments to an integrations Welcome Email.
A static resource is identical for all integrations.
dynamic
feed
Data Connectors includes dynamic resources as Email attachments to an integrations Welcome

Email. A dynamically generated file, typically code such as a JavaScript file. Data Connectors
processes dynamic resources, replacing variables in the dynamic template file with values the
client specified when activating the integration. This lets you create a single file that Data
Connectors dynamically modifies for each client that activates your integration.
A URL to an RSS or Atom feed. The content of this feed is displayed on the Tips & Tricks tab in
Data Connectors.
79
product_approval_status_container
Element
Type
status
xsd:string
comments
xsd:string
Description
The products approval status.
Any comments that have been included regarding the products
accreditation.
product_info_container
Element
Type
name
xsd:string
info_url
xsd:string
Description
The product name.
The URL of the partner's product information page.
resourceEncoded
Element
Type
filename
xsd:string
filedata
xsd:base64Binary
Description
The name of the encoded resource file.
The base-64-encoded content of the file. You must
base64-encode a resource file before uploading it to Data
Connectors.
responseArray
An array of varMapAll.
rowArray
An array of colArray .
scriptParameter
Element
Type
name
xsd:string
Description
The script key to replace. For more information about script keys,
see Product.GetProductScript.
Element
Type
value
xsd:string
80
Description
The value to insert into the script.
scriptParameters
An array of scriptParameter .
status
Element
Type
statusCode
xsd:int
message
xsd:string
Description
The status code of the executed request.
A description of the status code.
string_array
An array of xsd:string. The string_array XML has a consistent structure:
<parameterType>
<item> </item>
<item> </item>
...
</parameterType>
Element
Type
Description
parameterType
N/A
The root tag that identifies the type of parameter for which the
string_array contains values. Possible values for
parameterType include: variableMappings, metricNames, and
breakdownNames.
Each variableMappings tag can contain multiple <item> tags.
item
xsd:string
An individual item in the string array.
Element
Type
Description
seconds
xsd:int
name
xsd:string
timeBucket
The number of seconds where this bucket starts (the bucket ends
at one second less than the start time of the next bucket)
The name of the time bucket.
Element
Type
81
Description
The default time bucket names, and the number of seconds at
which each time bucket starts, are:
0-5 minutes: 0 seconds
1-3 hours: 3600 seconds
1-2 days: 86400 seconds
20+ days: 1728000 seconds
timeBucketList
An array of timeBucket .
token_usage_container
Element
Type
allowed_tokens
xsd:int
used_tokens
xsd:int
Description
The number of remaining allowed tokens.
The number of tokens consumed during the current usage period.
token_usage_array
An array of token_usage_container .
varMapAll
Includes the variable mapping XML that defines the mappings between partner metrics and Analytics variables
(eVars, events, and props). The XML for this purpose uses the following structure and tags:
<variableMappings>
<item>
<metric></metric>
<friendly_name></friendly_name>
82
<om_variable></om_variable>
<type_flag>
<item></item>
...
<item></item>
</type_flag>
<description></description>
<required>yes</required>
<access></access>
</item>
<item>
...
</item>
</variableMappings>
Element
Type
variableMappings
N/A
Yes
The root tag for all variable mappings.
item
N/A
Yes
Contains a single variable mapping. You can map multiple

partner metrics by using multiple <item> tags.
metric
xsd:string
Yes
friendly_name
xsd:string
No
A more easily understood name for the mapped variable.
om_variable
xsd:string
Conditional The type of Analytics variable used in the mapping

(supported values include evar, event, or prop).
Note: The om_variable tag is required for adding
and modifying variable mappings, but is not required
for deleting variable mappings.
type_flag
xsd:string
No
The variable subcategory for this partner metric. Enclose

each variable subcategory in an <item> tag.
Use type_flag to restrict the list of variables (evars or
events) that users can select from when configuring the
product integration through the Data Connectors Integration
Wizard. If you do not specify type_flag, the Integration
Wizard lets users select from the full list of currently defined
variables of that type (evar, event, or prop).
Each <om_variable> value (evar, event, prop) has a specific
set of type_flag options:
evar: campaign, merchandising, or custom.
event: custom, standard, counter, counter_nosub,
currency, currency_nosub, numeric, or numeric_nosub.
Element
83
Type
Note: To import the metric using
Import.UploadMetrics, an event must be of type
Currency or Numeric.
prop: Not Applicable. No type_flag needed.
customval: Not Applicable. No type_flag needed.
Note: Customval is used only to store internal
integration variables. These values are not available
to, or used in, Analytics.
You can specify multiple options in a single type_flag. For
example, the following type_flag definition restricts the
variable list to events of type Custom and Numeric:
<type_flag>
<item>custom</item>
<item>numeric</item>
<type_flag>
description
xsd:string
No
A description of the variable mapping (255 character max.)
required
xsd:string
No
Indicates if this mapping is required (supported values

include yes and no).
access
xsd:string
Conditional Indicates whether you can import data to, or export data
from, the variable. Supported values include import,
export, and import/export.
Note: The access tag is required for adding and
modifying variable mappings, but is not required for
deleting variable mappings.
display
display
Conditional Specifies the display type and values of the custom value.
Sample Code
Data Connectors Partner API Sample Code
This section contains sample code demonstrating use of the Data Connectors Partner API. These samples are all
based on the SOAP API. The concepts and work flows described in this section work for REST API, but the sample
code uses SOAP.
84
Sample Data Connectors Integration

Illustrates the process of creating a Data Connectors integration using the Data Connectors Partner API.
The registration process includes uploading an icon to represent the integration in the Data Connectors Network
and Data Connectors Showcase. For examples or suitable product icons, visit the Data Connectors area in the
Adobe Marketing Cloud. The product icon must have the following characteristics:
High-quality image
88 X 28 pixels
Suitable for display on a white background (the image background should be transparent).
GIF (.gif) file format
Clearly identifies the integration using product and/or partner name.
Prior to starting the development process, you must apply and be approved as a Data Connectors partner. If you
are not yet a Data Connectors partner, visit http://www.omniture.com/en/partners/apply for more information, or send
an email to partners@omniture.com.
Once approved as a Data Connectors partner, register the new integration in the Partner Portal.
Integration Overview
This sample integration gathers data from Twitter* so you can see it in Analytics reports. The Twitter report contains
information about tweets that contain a particular keyword. Once installed, you can access the Twitter integration
reports in Analytics by selecting Campaigns > Twitter Search Term > Twitter Search Term.
The sample Twitter integration includes the following files:
config: Stores integration information, including Data Connectors Sandbox login credentials and the integrations
working folder. The config file eliminates the need to manually provide login information manually when running
the integration.
GenesisConfiguration-2.7.wsdl: The WSDL for the Data Connectors Configuration API.
GenesisIntegration-2.7.wsdl: The WSDL for the Data Connectors Integration API.
GenesisSoapApp.class.php: The SOAP class for the Twitter sample integration (See GenesisSoapApp.class.php).
GetGenesisProducts.php: Returns information about all your currently defined products and lets you save the
information to the config file, as described in Step 1 (See GetGenesisIntegrations.php). Once saved to the config
file, you can use the product information in product-specific calls, such as AddVariableMappings.
ConfigureTwitterApp.php: The Twitter sample integration configuration and Product Script (See
ConfigureTwitterApp.php). This code leverages the methods and data types in the Data Connectors Configuration
API.
GetGenesisIntegrations.php: Returns information about all your currently defined integrations and lets you save
the information to the config file, as described in Step 1 (See GetGenesisIntegrations.php). Once saved to the
config file, you can use the integration information in integration-specific calls, such as GetDWSegment.
UploadTwitterData.php: The Twitter sample integration data exchange with Adobe collection servers. This code
leverages the methods and data types in the Data Connectors Integration API.
85
GetDWSegment.php: Returns a Data Warehouse segment for the integration specified in the config file (See
GetDWSegment.php).
Implementation
The following process, used to create the Twitter sample integration, serves as a general model for creating
integrations of any type using the Data Connectors Partner APIs
Create the Data Connectors Integration Wizard: Each Data Connectors integration includes a Data Connectors
Integration Wizard that steps customers through the process of integrating a partner application with Data Connectors.
Data Connectors partners must identify the integration points between the application and Data Connectors, and
gather the information necessary to construct the Data Connectors Integration Wizard.
Test the Integration: Use the Data Connectors sandbox to test and refine the integration until it behaves just how
you want it to.
Upload Data to Analytics: Once configured, the integration is ready to receive data from the partner application
and insert it into the associated Analytics report suite.
Download Segmented Data: (Optional) Once data is uploaded to Analytics, you can retrieve data segments that
include the partner data by using Data Warehouse.
To Create a Data Connectors Integration Wizard
1. Create a working folder for the integration.
For the sample Twitter integration, the working folder stores the config file, the integration code files, the Data
Connectors Partner API WSDL files (from the Data Connectors Sandbox Welcome Email).
Note: The sample Twitter integration also creates a subfolder, called TweetIds, that contains information
about the last TweetId used.
2. Create a config file that contains information needed by the integration.
The config file eliminates the need to provide account credentials each time you run the integration. The file
must be named config, and should contain the following entries:
username=YOUR_Data Connectors_API_USERNAME:Your Data Connectors Partner API username, as provided
in the Data Connectors Sandbox Welcome Email.
password=YOUR_Data Connectors_API_PASSWORD: Your Data Connectors Partner API password, as provided
in the Data Connectors Sandbox Welcome Email.
workingDir=/path/to/working/dir: The full path to the integrations working directory.
configWSDL=GenesisConfiguration-2.7.wsdl: The name of the Data Connectors Partner Configuration Web
Service file.
integrationWSDL=GenesisIntegration-2.7.wsdl: The name of the Data Connectors Partner Integration
Web Service.
3. Run GetGenesisProducts.php to call partner.GetProducts.
This call returns information about your existing products. When GetGenesisProducts runs, it prompts you to
save integration information to the config file:
86
y: Select the appropriate product from the product list, and GetGenesisProducts copies the product information
for the selected product into the config file.

n: GetGenesisProducts displays product information for existing products, but does not copy any information
to the config file.

4. Configure the AddVariableMappings section of ConfigureTwitterApp.php as needed for the integration.
To do this, you must identify the application metrics that you want to integrate into the Analytics report suite. For
the sample Twitter integration, this includes the following:
Application Metric
Variable Type Desciption
Twitter Search Term
eVar
Collects data about the Twitter search term for which you want
to generate a Analytics report.
This mapping requires that the assigned eVar has full
sub-relations enabled, so Adobe recommends using the
Campaign Variable for this purpose.
Twitter
eVar
Collects data about the Twitter ID that publishes tweets with the
specified search term.
This mapping requires that the assigned eVar has basic
sub-relations enabled.
Tweets
Event
Saved Search Term
Customval
A counter of the Tweets that include the specified search term.

Stores the Twitter search term value.
5. Configure the Product Script section of ConfigureTwitterApp.php as needed for the integration.
To do this, you must identify the non-Data Connectors API calls that you want to call at the end of the Data
Connectors Integration Wizard. The sample Twitter integration requires the following non-Data Connectors API
calls:
ReportSuite.SaveCalculatedMetrics
ReportSuite.SaveClassifications
DataSource.SetupGeneric
6. Configure the SubmitProductScript section of ConfigureTwitterApp.php as needed for the integration.
To do this, you must determine when you want the non-Data Connectors API calls to execute. For more information,
see Product.SubmitProductScript.
7. Run ConfigureTwitterApp.php.
ConfigureTwitterApp does the following:
Calls Product.AddVariableMappings.The complete AddVariableMappings section of the sample Twitter integration

is available at ConfigureTwitterApp.php.
Calls Product.SubmitProductScript to set up any post-installation API calls. The complete Product Script for the
sample Twitter integration is available at ConfigureTwitterApp.php.
87
To Test a Data Connectors Integration

1. Log in to the Data Connectors sandbox, then open Data Connectors.
2. Drag and drop the Twitter integration icon to launch the Data Connectors Integration Wizard.
The Wizard steps you through the process of configuring the integration. This is the process a customer uses to
activate the integration for their Analytics report suite.
For the sample Twitter integration, this includes the following:
Specify a name for the integration.
Specify one or more Twitter search terms (separate multiple search terms with a comma).
Select Analytics eVars to use with the Twitter metrics.
Select a Analytics Event to store the number of tweets.
Save the integration.
To Upload Data to Analytics
1. Run GetGenesisIntegrations.php to call partner.GetIntegrations .
This call returns information about your active integrations. When GetGenesisIntegrations runs, it prompts
you to save integration information to the config file:
y: Select the appropriate integration from a list of active integrations. GetGenesisIntegrations copies the
integration information for the selected integration into the integrationCode parameter of the config file. The
Data Connectors integration uses this information when uploading data to Analytics.
n: GetGenesisIntegrations displays integration information for all active integrations, but does not copy any
information to the config file.

Note: Exclude the integrationCode parameter from the config file to upload data for ALL configured
integrations.
2. Run UploadTwitterData.php.
UploadTwitterData does the following:
Calls the Twitter Search API using the Saved Search Term value to gather information about Tweets that contain
the search term. To keep the data in Analytics current, call the Twitter Search API regularly. For example, every
60 minutes. For information about the Twitter Search API, visit the Twitter API Documentation Web site. The
code for the Twitter search call for the Twitter integration is available at UploadTwitterData.php.
Stores the tweet id in a file for use in the next Twitter call. This prevents downloading data from the same tweets
multiple times. The tweet id contains the ID of the last tweet included in the current Twitter search, so you can
use it as a starting point for the next search. The code for storing and retrieving the tweet id in the Twitter
integration is available at UploadTwitterData.php.
Calls Import.UploadMetrics. This call uploads the Twitter search data to Analytics. The code for the data transfer
in the Twitter integration is available at UploadTwitterData.php.
Calls Import.UploadClassifications. This call submits SAINT classification data for the integration.
To Download Segmented Data
1. If necessary, enable Data Warehouse before attempting to download data segments..
88
Contact your Account Manager or ClientCare to help you with this.

2. Run GetDWSegment.php.
This calls the RequestSegmentedData and GetSegmentedData methods from the Data Warehouse API.
GetGenesisIntegrations.php returns the Data Warehouse segment names for each integration. If you stored the
integration information in the config file, GetDWSegment.php retrieves this information automatically. For more
information about Data Warehouse API methods, see the Data Warehouse API.
Integration Code
The sample integration for Twitter uses the following code files:
GetGenesisProducts.php
Returns information about your existing products and lets you save the information to the config file.
For information about when to run GetGenesisProducts.php, see Step 5 in Implementation.
<?
/**
* @file
* GenesisSoapApp.class.php
*
* Copyright 2009-2011 Adobe, Inc. All rights reserved.
**/
require_once 'nusoap-0.7.3/lib/nusoap.php';
class GenesisSoapApp
{
private $_username = '';
private $_password = '';
private $_working_dir = '';
private $_int_wsdl = '';
private $_con_wsdl = '';
private $_product_code = '';
private $_integration_code = '';
private $_wsdl_locations = array('integration'=>'', 'config'=>'');
private $_debug = 0;
function __construct()
{
$config_params = parse_ini_file("config");
$this->_username = $config_params['username'];
$this->_password = $config_params['password'];
$this->_working_dir = $config_params['workingDir'];
$this->_int_wsdl = $config_params['integrationWSDL'];
$this->_con_wsdl = $config_params['configWSDL'];
$this->_product_code = $config_params['productCode'];
$this->_integration_code = $config_params['integrationCode'];
$this->_wsdl_locations['integration'] = $config_params['workingDir'] . "/" .
$config_params['integrationWSDL'];
$this->_wsdl_locations['config'] = $config_params['workingDir'] . "/" .
$config_params['configWSDL'];
}
function sendRequest($functionName, $params, $wsdlType, $debug) {
// Create nuSOAP client
$client = new nusoap_client($this->_wsdl_locations[$wsdlType], 'wsdl');
$client->debugLevel = 1; //Debug level 0-9, where 0 turns off
// handle client setup error
if($err = $client->getError()) {
echo "ERROR:".$err."\n";
exit();
}
$client->setUseCurl(true);
89
// call a Web Services method

$result = $client->call($functionName, // function name
$params, // parameters
'http://omniture.com', // namespace
'', // SOAP Action
$this->getHeader($this->_username, $this->_password)); // security header
if ($debug > 0 ) {
switch ($debug) {
case 1:
// Display results
echo "\nAPI called: " . $functionName . "\n";
echo "RESULTS: \n";
var_dump($result);
echo "\n";
break;
case 2:
var_dump($client->request);
break;
case 3:
var_dump($client->responseData);
break;
default:
var_dump($client->getDebug());
break;
}
}
return ($result);
}
function getHeader($username, $password)
{
// Create a unique identifier, a.k.a. nonce.
// This example is used for simplicity in demonstration. A method
// that guarantees uniqueness should be used in a production environment.
$nonce = md5(rand());
$created = date("Y-m-d H:i:s");
$combo_string = $nonce . $created . $password;
// Note: the sha1 command is not available in all versions of PHP.
// If your version of PHP does not support this command, you
// can use openssl directly with the command:
// echo -n <string> | openssl dgst -sha1
$sha1_string = sha1($combo_string);
$password_hash = base64_encode($sha1_string);
$headers =
'<wsse:Security SOAP-ENV:mustUnderstand="1">
<wsse:UsernameToken wsu:Id="User">
<wsse:Username>' . $username . '</wsse:Username>
<wsse:Password Type=
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest">'.$password_hash.'</wsse:Password>
<wsse:Nonce>' . $nonce . '</wsse:Nonce>
<wsu:Created>' . $created . '</wsu:Created>
</wsse:UsernameToken>
</wsse:Security>';
return $headers;
}
// Getters
function
{
return
}
function
{
return
}
function
{
getUsername()
$this->_username;
getPassword()
$this->_password;
getWorkingDir()
return
}
function
{
return
}
function
{
return
}
function
{
return
}
function
{
return
}
90
$this->_working_dir;
getConfigWSDL()
$this->_con_wsdl;
getIntegrationWSDL()
$this->_int_wsdl;
getProductCode()
$this->_product_code;
getIntegrationCode()
$this->_integration_code;
}
?>
GetGenesisProducts.php
Returns information about your existing products and lets you save the information to the config file.
For information about when to run GetGenesisProducts.php, see Step 5 in Implementation.
<?
/**
* @file
* GetGenesisProducts.php
*
* Copyright 2009 Adobe, Inc. All rights reserved.
**/
require_once "GenesisSoapApp.class.php";
$soapApp = new GenesisSoapApp();
$debug = 0;
// Override username and password if provided on command line
if($argc >= 2) {
$arguments = getopt("d:");
if (!empty($arguments['d'])) {
$debug = $arguments['d'];
}
}
if ($argc >= 4) {
echo "Usage: GetGenesisProducts.php [-d debug level]\n\n";
exit();
}
$wsdlType = 'integration'; // Use Data Connectors Integration WSDL
$functionName = 'Partner.GetProducts';
$params = array();
$result = $soapApp->sendRequest($functionName, $params, $wsdlType, $debug);
if (is_array($result)) {
if (array_key_exists('faultstring', $result)) {
echo "Error-GetProducts: " . $result['faultstring'] . "\n";
} else {
fwrite(STDOUT, "\nWould you like to send the results to the configuration file? (y\\n)
");
// Read input
$response = fgets(STDIN);
if (strpos($response, 'y') === 0 || strpos($response, 'Y') === 0) {
fwrite(STDOUT, "\nAvailable products:\n");
$index = 1;
foreach($result as $product) {
echo $index . '- ' . $product['name'] . "\n";
91
$index++;
}
fwrite(STDOUT, "Please select a product number to use- ");
$productIndex = fgets(STDIN);
unlink('config');
$outfile = fopen('config', 'w');
$product = $result[$productIndex - 1];
// Write details to config file
fwrite($outfile, 'username=' . $soapApp->getUsername() . "\n");
fwrite($outfile, 'password=' . $soapApp->getPassword() . "\n");
fwrite($outfile, 'workingDir=' . $soapApp->getWorkingDir() . "\n");
fwrite($outfile, 'configWSDL=' . $soapApp->getConfigWSDL() . "\n");
fwrite($outfile, 'integrationWSDL=' . $soapApp->getIntegrationWSDL() . "\n");
fwrite($outfile, 'productCode=' . $product['productCode'] . "\n");
fclose($outfile);
// Display product information
var_dump($product);
} else {
var_dump($result);
}
}
}
?>
ConfigureTwitterApp.php
Configures the Twitter App Integration Wizard and the product script to run following the Integration Wizard.
For information about when to run ConfigureTwitterApp.php, see Step 7 in Implementation.
<?
/**
* @file
* ConfigureTwitterApp.php
*
**/
$debug = 0;
if($argc >= 2) {
}
}
if ($argc >= 4) {
echo "Usage: ConfigureTwitterApp.php [-d debug level]\n\n";
exit();
}
$productCode = $soapApp->getProductCode(); // Partner's product identifier
if (empty($productCode)) {
die("\nError: The product code was not found in the configuration file!\n\n");
}
$wsdlType = 'config';
// Use Data Connectors Config WSDL
$functionName = 'Product.AddVariableMappings';
$params = array('productCode' => $productCode,
'variableMappings' => array(
array('metric' => 'Twitter Search Term',
'friendly_name' => 'Tracking code for Twitter',
92
'om_variable' => 'evar',

'type_flag' => array('custom', 'campaign'),
'description' => 'This was created by OMTR engineering.',
'required' => 'yes',
'access' => 'import'),
array('metric' => 'Twitter',
'friendly_name' => 'Twitter evar',
'om_variable' => 'evar',
'type_flag' => array('custom'),
'access' => 'import/export'),
array('metric' => 'Tweets',
'friendly_name' => 'Tweets event',
'om_variable' => 'event',
'type_flag' => array('custom', 'counter'),
'access' => 'import'),
array('metric' => 'Saved Search Term',
'friendly_name' => 'Saved Search Term',
'om_variable' => 'customval',
'type_flag' => '',
'access' => 'import')));
var_dump($result);
echo "\nError-AddVariableMappings: " . $result['faultstring'] . "\n";
} else {
echo "\nVariable mappings have been successfully added for product code " . $productCode .
".\n";
}
// The product script is used to run needed API calls after the Data Connectors wizard has run.
//
// If there are APIs that need to be run upon creation of the integration and other when the
// integration is edited, 2 scripts must be created, one for each.
//
// This product script will:
// 1-Create a calculated metric for the report suite
// 2-Create a classification for the Twitter evar
// 3-Create a datasource for use with the integration
// 4-Create a DataWarehouse segment
$functionName = 'Product.AddProductScript';
'scriptName' => 'Twitter Create Script',
'scriptDesc' => 'This script will only be run when creating a new integration.',
'runOn' => 'integration_create',
'script' => '
<genesis version="3">
<rsid_list>
<item>{{RSID}}</item>
</rsid_list>
</ReportSuite.SaveCalculatedMetrics>
<ReportSuite.SaveClassifications>
<c_options/>
<c_view>{{Twitter|classification}}</c_view>
<name>Twitter User</name>
<rsid_list>
</rsid_list>
<DataSource.SetupGeneric>
<dataSourceID></dataSourceID>
<dataSourceSettingseve>
<dataSourceName>{{INT_NAME}}</dataSourceName>
93
<dataSourceEmail>{{EMAIL}}</dataSourceEmail>
</dataSourceSettings>
<dataSourceType>12</dataSourceType>
<reportSuiteID>{{RSID}}</reportSuiteID>
</DataSource.SetupGeneric>
<DataWarehouse.CreateSegment>
<rsid>{{RSID}}</rsid>
<segment>
<name>Got a Tweet</name>
<group_include>
<type>ROOT</type>
<name>Include</name>
<group_operator>UNKNOWN</group_operator>
<rule_operator>AND</rule_operator>
<rule_list/>
<group_list>
<item>
<type>VISIT</type>
<name>Visit</name>
<rule_list/>
<group_list>
<item>
<type>EVENT</type>
<name>Tweets</name>
<rule_list>
<item>
<operator>></operator>
<item>{{Twitter|api_code}}</item>
<value>!</value>
<event/>
</item>
<item>
<operator/>
<item/>
<value/>
<event>{{Tweets|mod_stat}}</event>
</item>
</rule_list>
<group_list/>
</item>
</group_list>
</item>
</group_list>
</group_include>
<group_exclude>
<type>ROOT</type>
<name>Exclude</name>
<rule_list/>
<group_list/>
</group_exclude>
</segment>
</DataWarehouse.CreateSegment>
</genesis>');
echo "\nError-AddProductScript: " . $result['faultstring'] . "\n";
} else {
echo "\nProduct script for creating integrations has been successfully uploaded for product
code " . $productCode . ".\n\n";
}
//
94
// This product script will:

// 1-Create a calculated metric for the report suite
// 2-Create a classification for the Twitter evar
'scriptName' => 'Twitter Edit Script',
'scriptDesc' => 'This script will only be run when editing an integration.',
'runOn' => 'integration_edit',
'script' => '
<genesis>
<ReportSuite.SaveCalculatedMetrics>
<calculated_metrics>
<item>
<name>Tweets per hour</name>
<formula>{{[Tweets]}} / 24</formula>
<friendly_formula>[Tweets] / 24</friendly_formula>
<metric_type>2</metric_type>
<metric_type_string>Percent (%)</metric_type_string>
<decimal_places>2</decimal_places>
<in_queue>0</in_queue>
<status>0</status>
</item>
</calculated_metrics>
<rsid_list>
</rsid_list>
</ReportSuite.SaveCalculatedMetrics>
<ReportSuite.SaveClassifications>
<c_options/>
<c_view>{{Twitter|classification}}</c_view>
<name>Twitter User</name>
<rsid_list>
</rsid_list>
</genesis>');
echo "\nError-AddProductScript: " . $result['faultstring'] . "\n";
} else {
echo "\nProduct script for editing integrations has been successfully uploaded for product
code " . $productCode . ".\n\n";
}
?>
GetGenesisIntegrations.php
Returns information about your defined integrations and lets you save the information to the config file.
For information about when to run GetGenesisIntegrations.php, see Step 9 in Implementation.
<?
/**
* @file
* GetGenesisIntegrations.php
*
**/
$debug = 0;
// Override username and password if provided on command line
if($argc >= 2) {
95
}
}
if ($argc >= 4) {
echo "Usage: GetGenesisIntegrations.php [-d debug level]\n\n";
exit();
}
$wsdlType = 'integration';
$functionName = 'Partner.GetIntegrations';
$params = array();
echo "Error-GetIntegrations: " . $result['faultstring'] . "\n";
} else {
fwrite(STDOUT, "\nWould you like to send the results to the configuration file? (y\\n)
");
// Read input
$response = fgets(STDIN);
if (strpos($response, 'y') === 0 || strpos($response, 'Y') === 0) {
fwrite(STDOUT, "\nAvailable integrations:\n");
$index = 1;
foreach($result as $integration) {
echo $index . '- ' . $integration['integrationName'] . "\n";
$index++;
}
fwrite(STDOUT, "Please select an integration number to use- ");
$integrationIndex = fgets(STDIN);
unlink('config');
$outfile = fopen('config', 'w');
$integration = $result[$integrationIndex - 1];
// Write details to config file
fwrite($outfile, 'username=' . $soapApp->getUsername() . "\n");
fwrite($outfile, 'password=' . $soapApp->getPassword() . "\n");
fwrite($outfile, 'workingDir=' . $soapApp->getWorkingDir() . "\n");
fwrite($outfile, 'configWSDL=' . $soapApp->getConfigWSDL() . "\n");
fwrite($outfile, 'integrationWSDL=' . $soapApp->getIntegrationWSDL() . "\n");
fwrite($outfile, 'integrationCode=' . $integration['integrationCode'] . "\n");
fwrite($outfile, 'integrationName=' . $integration['integrationName'] . "\n");
fwrite($outfile, 'integrationEmail=' . $integration['integrationEmail'] . "\n");
fwrite($outfile, 'productCode=' . $integration['productCode'] . "\n");
fwrite($outfile, 'productName=' . $integration['productName'] . "\n");
fwrite($outfile, 'reportSuiteId=' . $integration['reportSuiteId'] . "\n");
fwrite($outfile, 'company=' . $integration['company'] . "\n");
fwrite($outfile, 'creationDate=' . $integration['creationDate'] . "\n");
fwrite($outfile, 'dataSourceId=' . $integration['dataSourceIds'][0] . "\n");
fwrite($outfile, 'soapEndpoint=' . $integration['soapEndpoint'] . "\n");
fclose($outfile);
// Display integration information
var_dump($integration);
} else {
var_dump($result);
}
}
}
?>
GetDWSegment.php
Returns a Data Warehouse segment for the integration specified in the config file.
For information about when to run GetDWSegment.php, see Step 11 in Implementation.
<?
/**
96
* @file
* GetDWSegment.php
*
**/
define ('MAX_ITERATIONS', 5);
define ('ITERATION_PAUSE', 300);
// in seconds

$debug = 0;
// Use debug level from command line
if($argc >= 2) {
}
}
if ($argc >= 4) {
echo "Usage: GetDWSegment.php [-d debug level]\n\n";
exit();
}
$integrationCode = $soapApp->getIntegrationCode();
if (empty($integrationCode)) {
die("\nError: The integration code was not found in the configuration file!\n\n");
}
$wsdlType = 'integration';
$functionName = 'Export.RequestSegmentedData';
// change these parameters to suit your needs
$params = array('dateFrom' => '02/01/09',
'dateGranularity' => 'none',
'datePreset' => 'This month',
'dateTo' => '07/08/09',
'dateType' => 'range',
'integrationCode' => $integrationCode, // Found in result of GetIntegrations call
'segmentName' => 'Got a Tweet', // Found in CreateSegment call or by using GetIntegrations
'breakdownNames' => array(
'item' => 'Twitter')); // Name of metric for the evar used
echo "Error-RequestSegmentedData: " . $result['faultstring'] . "\n";
} else {
$requestId = $result['requestId'];
}
}
$functionName = 'Export.GetSegmentedData';
$params = array('requestId' => $requestId, 'integrationCode' => $integrationCode);
// Loop, pausing ITERATION_PAUSE seconds between each iteration until the segment request is
found
$dataFound = false;
$count = 0;
while (!$dataFound) {
sleep(ITERATION_PAUSE);
$count++;
if (!array_key_exists('faultstring', $result) || strpos($result['faultstring'], 'Request
data cannot be located') < 0) {
$dataFound = true;
97
}
}
if ( $count > MAX_ITERATIONS ) {
continue;
}
}
echo "Error-GetSegmentedData: " . $result['faultstring'] . "\n";
} else {
var_dump($result);
echo "\n" . $count . " iteration(s) needed to get segment.\n";
}
}
?>
Sample On-Demand Script Usage

These code samples illustrate the use of on-demand scripts to generate a Analytics report.
The Data Connectors Partner API lets you include on-demand product scripts as part of your Data Connectors
integration. On-demand product scripts let you use the Web Services APIs, such as the Analytics Reporting API, at
any time to gather data relevant to a clients integration. You can use this data as feedback to help improve a clients
service over time, or to identify additional services that might benefit the client.
Note: All code provided in this section was created for SOAPUI.
On-Demand Product Script

Generating the sample Analytics report involves the following Web Services API calls. Each of these calls should
be uploaded (using Product.SubmitProductScript) as a separate on-demand product script. For detailed information
about these Web Services API methods, see the Analytics Reporting API on the Developer Connection.
Note: The scripts include generic parameter values (for example: **PRODUCT_CODE**) that you would replace
with values appropriate to your integration.
Report.QueueOvertime Script
Sample script to generate a Analytics Overtime report.
Note: The response to this method call includes a report ID used to check the report status and download
the report when ready.
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:omn="http://www.omniture.com/">
<soapenv:Header/>
<soapenv:Body>
<omn:Product.SubmitProductScript
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<productCode xsi:type="xsd:string">**PRODUCT_CODE**</productCode>
<runOn xsi:type="xsd:string">demand</runOn>
<script xsi:type="xsd:string"><![CDATA[<genesis version="3">
<Report.QueueOvertime>
<reportDescription>
<reportSuiteID>{{RSID}}</reportSuiteID>
98
<date/>
<dateFrom>2010-01-01</dateFrom>
<dateTo>{{myDateTo}}</dateTo>
<dateGranularity>day</dateGranularity>
<metrics>
<id>pageviews</id>
</metrics>
<sortBy/>
<elements/>
<locale/>
</reportDescription>
</Report.QueueOvertime>
</genesis>]]></script>
<scriptDesc xsi:type="xsd:string">Script to call QueueOvertime Reporting
API</scriptDesc>
<scriptName xsi:type="xsd:string">Queue Report</scriptName>
</omn:Product.SubmitProductScript>
</soapenv:Body>
</soapenv:Envelope>
Report.GetStatus Script
Sample script to check the status of a previously submitted report request using the report ID received from the
Report.QueueOvertime call.
Once the report status is done, you can download the report data.
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/
soap/envelope/" xmlns:omn="http://www.omniture.com/">
<soapenv:Header/>
<soapenv:Body>
<omn:Product.SubmitProductScript soapenv:encodingStyle="http://
schemas.xmlsoap.org/soap/encoding/">
<Report.GetStatus>
<reportID>{{REPORT_ID}}</reportID>
</Report.GetStatus>
<scriptDesc xsi:type="xsd:string">First try at Reporting API</scriptDesc>
<scriptName xsi:type="xsd:string">Get Status</scriptName>
</soapenv:Body>
</soapenv:Envelope>
Report.GetReport Script
Script that downloads report data from a completed report, using the report ID received from the
Report.QueueOvertime call.
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:omn="http://www.omniture.com/">
<soapenv:Header/>
<soapenv:Body>
<omn:Product.SubmitProductScript
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<Report.GetReport>
<reportID>{{REPORT_ID}}</reportID>
</Report.GetReport>
<scriptDesc xsi:type="xsd:string">First try at Reporting API</scriptDesc>
<scriptName xsi:type="xsd:string">Get Report</scriptName>
99
</soapenv:Body>
</soapenv:Envelope>
Sample RunScript Code

Once uploaded, you can call an on-demand product script at any time. For example, once a client activates your
Data Connectors integration, you might want to request a Analytics report at regular intervals to evaluate clients
use of your services and identify ways to improve client results.
The following scripts use Partner.RunScript to call the on-demand product scripts described in On-Demand
Product Script.
Note: Once you have uploaded the desired product scripts, you can automate on-demand script usage by
creating an application that makes the Partner.RunScript calls at regular intervals.
Run the QueueOvertime Script
Sample code that uses Partner.RunScript to call the QueueOvertime product script.
For more information, see Report.QueueOvertime Script.
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:omn="http://www.omniture.com/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header/>
<soapenv:Body>
<omn:Partner.RunScript soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<integrationCode xsi:type="xsd:string">**CLIENT_INTEGRATION_CODE**</integrationCode>
<scriptName xsi:type="xsd:string">Queue Report</scriptName>
<scriptParameters>
<scriptParameter>
<name>myDateTo</name>
<value>2010-01-31</value>
</scriptParameter>
</scriptParameters>
</omn:Partner.RunScript>
</soapenv:Body>
</soapenv:Envelope>
Run the GetStatus Script

Sample code that uses Partner.RunScript to call the GetStatus product script.
This script returns the current status of the report request. For more information, see Report.GetStatus Script.
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:omn="http://www.omniture.com/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header/>
<soapenv:Body>
<scriptName xsi:type="xsd:string">Report Status</scriptName>
<scriptParameters>
<scriptParameter>
<name>REPORT_ID</name>
<value>**REPORT_ID**</value>
</scriptParameter>
</scriptParameters>
100
</soapenv:Body>
</soapenv:Envelope>
Run the GetReport Script

Sample code that uses Partner.RunScript to call the GetReport product script.
This script downloads the report data for a completed report request. For more information, see Report.GetReport
Script.
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/
soap/envelope/" xmlns:omn="http://www.omniture.com/" xmlns:soapenc="http://
schemas.xmlsoap.org/soap/encoding/">
<soapenv:Header/>
<soapenv:Body>
<scriptName xsi:type="xsd:string">Get Report</scriptName>
<scriptParameters>
<scriptParameter>
<name>REPORT_ID</name>
<value>**REPORT_ID**</value>
</scriptParameter>
</scriptParameters>
</soapenv:Body>
</soapenv:Envelope>
Reference
Data Connectors Partner API Reference
This section contains information to help you use the Data Connectors Partner API.
Data Connectors Standard Elements

Lists the names used by each element for the specified API calls.
When accessing standard elements through the Data Connectors API, elements use different names depending on
the context in which they are used. Not all elements are valid for all API calls.
Note: The title of each section indicates the element name as displayed in the Data Connectors Integration
Wizard.
Browser
API Method
Element Name
browser
N/A
?browser
Report.Queue
browser
101
Browser Height
API Method
Element Name
browser_height
N/A
browser_height
Report.Queue
browserheight
Browser Type
API Method
Element Name
browser_type
N/A
browser_type
Report.Queue
browsertype
Browser Width
API Method
Element Name
browser_width
N/A
browser_width
Report.Queue
browserwidth
Campaign Views
API Method
Element Name
campaign_views
clickthroughs
N/A
Report.Queue
N/A
Cart Additions
API Method
Element Name
cart_adds
cart adds
scAdd
102
API Method
Element Name
Report.Queue
shoppingcartadd
Cart Removes
API Method
Element Name
cart_removes
cart removes
scRemove
Report.Queue
shoppingcartremove
Cart Views
API Method
Element Name
cart_views
cart views
scView
Report.Queue
shoppingcartview
Carts
API Method
Element Name
cart_opens
cart opens
scOpen
Report.Queue
shoppingcartopen
Category
API Method
Element Name
category
category
category
Report.Queue
category
103
Checkouts
API Method
Element Name
checkouts
checkout
scCheckout
Report.Queue
checkout
Clicks to Page
API Method
Element Name
visit_page_num
N/A
visit_page_num
Report.Queue
N/A
Connection Type
API Method
Element Name
connection_type
N/A
?connection_type
Report.Queue
connectiontype
Cookies
API Method
Element Name
cookies
N/A
cookies
Report.Queue
cookiesenabled
Currency Code
API Method
Element Name
currency
currency code
N/A
104
API Method
Element Name
Report.Queue
N/A
Custom Link
API Method
Element Name
custom_link
N/A
custom_link
Report.Queue
linkcustom
Customer Loyalty
API Method
Element Name
customer_loyalty
N/A
customer_loyalty
Report.Queue
loyalty_loyal
Days Before First Purchase

API Method
Element Name
days_before_first_purchase
N/A
days_before_first_purchase
Report.Queue
daysbeforefirstpurchase
Days Since Last Purchase

API Method
Element Name
days_since_last_purchase
N/A
days_since_last_purchase
Report.Queue
dayssincelastpurchase
105
Days Since Last Visit

API Method
Element Name
return_freq
N/A
return_freq
Report.Queue
returnfrequency
Domain
API Method
Element Name
isp
N/A
isp
Report.Queue
N/A
Entry Page
API Method
Element Name
entry_page
N/A
entry_page
Report.Queue
entrypage
Exit Link
API Method
Element Name
exit_link
N/A
exit_link
Report.Queue
linkexit
Exit Page
API Method
Element Name
exit_page
N/A
exit_page
106
API Method
Element Name
Report.Queue
N/A
File Download
API Method
Element Name
download_link
N/A
download_link
Report.Queue
linkdownload
GeoSegmentation City
API Method
Element Name
geo_city
N/A
geo_city
Report.Queue
geocity
Geosegmentation Country
API Method
Element Name
geo_country
N/A
?geo_country
Report.Queue
geocountry
GeoSegmentation Demographic Area

API Method
Element Name
geo_dma
N/A
?geo_dma
Report.Queue
geo_dma
107
GeoSegmentation Region/State
API Method
Element Name
geo_region
N/A
?geo_region
Report.Queue
georegion
IP
API Method
Element Name
ip
N/A
ip
Report.Queue
N/A
Java
API Method
Element Name
java_enabled
N/A
java_enabled
Report.Queue
javaenabled
JavaScript
API Method
Element Name
javascript
N/A
javascript
Report.Queue
javascriptenabled
JavaScript Version
API Method
Element Name
javascript_version
N/A
?javascript_version
108
API Method
Element Name
Report.Queue
javascriptversion
Language
API Method
Element Name
language
N/A
?language
Report.Queue
language
Marketing Channel
API Method
Element Name
va_mawster_id
marketing channel
N/A
Report.Queue
N/A
Marketing Channel Detail

API Method
Element Name
va_detail
marketing channel detail
N/A
Report.Queue
N/A
Monitor Color Depth

API Method
Element Name
color
N/A
?color
Report.Queue
monitorcolordepth
109
Monitor Resolution
API Method
Element Name
resolution
N/A
?resolution
Report.Queue
monitorresolution
NetScape Plug-In
API Method
Element Name
plugin
N/A
?plugin
Report.Queue
N/A
Next Page
API Method
Element Name
next_page
N/A
next_page
Report.Queue
N/A
Occurrences
API Method
Element Name
occurences
occurences
N/A
Report.Queue
N/A
Operating System
API Method
Element Name
os
N/A
?os
110
API Method
Element Name
Report.Queue
operatingsystem
Orders
API Method
Element Name
purchases
orders
purchase
Report.Queue
orders
Original Entry Page

API Method
Element Name
first_hit_page
N/A
first_hit_page
Report.Queue
entrypage
Original Referring Domain

API Method
Element Name
first_hit_referrer_domain
N/A
first_hit_referrer_domain
Report.Queue
referringdomainoriginal
Page
API Method
Element Name
page
N/A
page
Report.Queue
page
111
Page Not Found

API Method
Element Name
page_type_error
N/A
page_type_error
Report.Queue
pagenotfound
Page Views
API Method
Element Name
page_views
N/A
page_views
Report.Queue
pageviews
Page Length
API Method
Element Name
path_length
N/A
path_length
Report.Queue
pathlength
Previous Page
API Method
Element Name
_prev_page
N/A
_prev_page
Report.Queue
N/A
Product
API Method
Element Name
product
product
product
112
API Method
Element Name
Report.Queue
product
Product Views
API Method
Element Name
prod_views
product views
prodview
Report.Queue
productview
Purchase ID
API Method
Element Name
purchaseid
N/A
purchaseid
Report.Queue
N/A
Referrer
API Method
Element Name
referrer
N/A
referrer
Report.Queue
referrer
Referrer Domain
API Method
Element Name
referrer_domain
N/A
referrer_domain_v2
Report.Queue
referringdomain
113
Revenue
API Method
Element Name
revenue
price
revenue
Report.Queue
revenue
Search Engine
API Method
Element Name
search_engine
N/A
?search_engine
Report.Queue
searchengine
Search Keyword
API Method
Element Name
search_engine_keywords
N/A
Report.Queue
Server
API Method
Element Name
user_server
N/A
user_server
Report.Queue
server
Site Section
API Method
Element Name
channel
channel
channel
114
API Method
Element Name
Report.Queue
sitesection
State
API Method
Element Name
state
state
state
Report.Queue
state
Time Spent on Page

API Method
Element Name
page_time
N/A
page_time
Report.Queue
N/A
Time Spent on Site

API Method
Element Name
site_time
N/A
site_time
Report.Queue
N/A
Time Zone
API Method
Element Name
time_zone
N/A
time_zone
Report.Queue
timezone
115
Top Level Domain

API Method
Element Name
top_level_domain
N/A
top_level_domain
Report.Queue
toplevelname
Tracking Code
API Method
Element Name
campaign
trackingcode
campaign
Report.Queue
trackingcode
Transaction ID
API Method
Element Name
transactionid
transactionid
N/A
Report.Queue
N/A
Unique Visitors
API Method
Element Name
visitors
N/A
visitors
Report.Queue
visitors
Units
API Method
Element Name
units
quantity
units
116
API Method
Element Name
Report.Queue
units
User Home Page

API Method
Element Name
_homepage
N/A
_homepage
Report.Queue
homepage
Visit Number
API Method
Element Name
visit_num
N/A
visit_num
Report.Queue
visitnumber
Visitor ID
API Method
Element Name
cust_visid
visitorid
N/A
Report.Queue
N/A
Visits
API Method
Element Name
visits
N/A
visits
Report.Queue
visits
117
ZIP/Postal Code
API Method
Element Name
zip
zip
zip
Report.Queue
zip
Activity Log Error Messages

Error Code
Description
This error code indicates a problem with exporting customer data to a partner via data warehouse.
This error code indicates that the data sent by the partner did not contain all of the same metrics
that were mapped by the customer.
This error indicates that the data sent by the partner could not be processed because of a
formatting error.
This error indicates that no data was imported. This may also indicate that there simply wasn't
any data that needed to be sent. The customer and partner should determine if that is the case.
This error code indicates that the classifications sent by partner did not contain all of the same
attributes that were specified by the integration.
This error indicates that the classifications sent by the partner could not be processed because
of a formatting error.
This error indicates that no classifications were imported. This may also indicate that there
weren't any classifications that needed to be imported. The customer and partner should make
this determination.
Time Zones
The following time zones are used for the integrationTimeZone parameter in integrationDetail.
Eniwetok, Kwajalein [GMT-12:00]
Midway Island, Samoa [GMT-11:00]
US Hawaii [GMT-10:00]
US Alaska [GMT-09:00]
US Pacific Time [GMT-08:00]

US Arizona [GMT-07:00]
US Mountain Time [GMT-07:00]
US Central Time [GMT-06:00]
Mexico City [GMT-06:00]
Saskatchewan [GMT-06:00]
Botoga, Lima [GMT-05:00]
US Eastern Time [GMT-05:00]
US Indiana (East) [GMT-05:00]
Canada Atlantic Time [GMT-04:00]
La Paz [GMT-04:00]
Newfoundland [GMT-03:30]
Brasilia, Sao Paulo [GMT-03:00]
Buenos Aires [GMT-03:00]
Mid-Atlantic [GMT-02:00]
Azores [GMT-01:00]
Greenwich, Dublin, Edinburgh, London, Lisbon
Greenwich Mean Time; Monrovia, Casablanca [GMT]
Berlin, Stockholm, Rome, Bern, Brussels, Vienna, Amsterdam [GMT+01:00]
Paris, Madrid [GMT+01:00]
Prague, Bratislava [GMT+01:00]
Warsaw [GMT+01:00]
Athens, Helsinki [GMT+02:00]
Cairo [GMT+02:00]
Eastern Europe [GMT+02:00]
Harare, Pretoria [GMT+02:00]
Israel [GMT+02:00]
Baghdad [GMT+03:00]
Moscow, St. Petersburg [GMT+04:00]
Tehran [GMT+03:30]
Abu Dhabi, Muscat [GMT+04:00]
Kabul [GMT+04:30]
Islamabad, Karachi [GMT+05:00]
Bombay, Calcutta, Madras, New Delhi [GMT+05:30]
Almaty [GMT+06:00]
118
Bangkok, Jakarta, Hanoi [GMT+07:00]

Beijing, Chongqing, Urumqi [GMT+08:00]
Hong Kong, Singapore, Taipei [GMT+08:00]
Tokyo, Osaka, Sapporo, Seoul [GMT+09:00]
Adelaide [GMT+09:30]
Darwin [GMT+09:30]
Brisbane [GMT+10:00]
Canberra, Melbourne, Sydney [GMT+10:00]
Vladivostok, Khabarovsk [GMT+10:00]
Hobart [GMT+10:00]
Magadan [GMT+11:00]
Fiji [GMT+12:00]
Wellington, Auckland [GMT+12:00]
Test timezone
Guam [GMT+10:00]
Western Australia, Perth [GMT+08:00]
Chile (Santiago) [GMT-04:00]
Caracas [GMT-04:30]
Cape Verde Is. [GMT-01:00]
Istanbul [GMT+02:00]
Kuwait, Nairobi, Riyadh [GMT+03:00]
Dhaka [GMT+06:00]
Yakutsk [GMT+09:00]
Port Moresby [GMT+10:00]
Kamchatka [GMT+12:00]
Marshall Is. [GMT+12:00]
Colombo [GMT+05:30]
Ekaterinburg [GMT+05:00]
Tashkent [GMT+05:00]
Tbilisi [GMT+04:00]
Kazan [GMT+04:00]
Volgograd [GMT+04:00]
Tijuana [GMT-08:00]
Georgetown [GMT-03:00]
Solomon Is., New Caledonia [GMT+11:00]
119
120
Currency Codes
See Currency Codes for a list of currency codes used by the integrationCurrency parameter in integrationDetail.
Contact and Legal Information

Information to help you contact Adobe and to understand the legal issues concerning your use of this product and
documentation.
Help & Technical Support
The Adobe Marketing Cloud Customer Care team is here to assist you and provides a number of mechanisms by
which they can be engaged:
Check the Marketing Cloud help pages for advice, tips, and FAQs
Ask us a quick question on Twitter @AdobeMktgCare
Log an incident in our customer portal
Contact the Customer Care team directly
Check availability and status of Marketing Cloud Solutions
Service, Capability & Billing
Dependent on your solution configuration, some options described in this documentation might not be available to
you. As each account is unique, please refer to your contract for pricing, due dates, terms, and conditions. If you
would like to add to or otherwise change your service level, or if you have questions regarding your current service,
please contact your Account Manager.
Feedback
We welcome any suggestions or feedback regarding this solution. Enhancement ideas and suggestions for the
Analytics suite can be added to our Customer Idea Exchange.
Legal
2014, Adobe
All rights reserved.
Published by Adobe Systems Inc.
Terms of Use | Privacy Center
A trademark symbol (, , etc.) denotes an Adobe trademark.
All third-party trademarks are the property of their respective owners. Updated Information/Additional Third Party
Code Information available at http://www.adobe.com/go/thirdparty.

Genesis Partner API

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Genesis Partner API

Enviado por

Direitos autorais:

Formatos disponíveis

Adobe Marketing Cloud

Data Connectors Partner API

Last updated 5/23/2014

Data Connectors Partner API

Last updated 5/23/2014

Data Connectors Partner API

Contact and Legal Information............................................................................................120

Last updated 5/23/2014

Data Connectors Partner API

Data Connectors Partner API

Data Connectors Partner API

May 2014: REST API

Data Connectors 3.0: What's New

Data Connectors Partner API

Integration API Updates

Data Connectors 2.8: What's New

Data Connectors Partner API

Updated the tns:integrationDetail data type.

How Data Connectors Works

1. Partner defines the integration using the Configuration API.

Data Connectors Partner API

SOAP Development Toolkits

Data Connectors Partner API

Java: Apache Axis (http://ws.apache.org/axis/) and Apache WSS4J (http://ws.apache.org/wss4j/).

Data Connectors Partner API

The following PHP sample demonstrates how to generate X-WSSE

Data Connectors Configuration API

Data Connectors Partner API

The name of the principal technical contact.

The email of the principal technical contact.

The version to assign to the product.

The industry which best applies to this product.

The information about this product.

Phone contact for support.

Email contact for support.

A unique code assigned to the new product.

Status message pertaining to the success of the action.

A valid Data Connectors product code. You can get a list

Data Connectors Partner API

The product version of the new product.

A unique code assigned to the new product.

Status message pertaining to the success of the action.

A valid Data Connectors product code. You can get a list

Indicates if the operation succeeded (True) or failed (False).

Status message pertaining to the success of the action.

Data Connectors Partner API

The product code associated with this Data Connectors

The name of the principal technical contact.

The email of the principal technical contact.

The product version.

The industry which best applies to this product.

Detailed information about the product configuration.

Phone contact for support.

Email contact for support.

The name of the principal technical contact.

The email of the principal technical contact.

The product version.

The industry which best applies to this product.

Detailed information about the product configuration.

Phone contact for support.

Email contact for support.

Data Connectors Partner API

A unique product code associated with this Data Connectors

A status message pertaining to the success of the action.