genesis partner api
TRANSCRIPT
-
8/20/2019 Genesis Partner API
1/120
Adobe ® Marketing Cloud
Data Connectors Partner API
-
8/20/2019 Genesis Partner API
2/120
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
Data Connectors Partner APILast updated 5/23/2014
-
8/20/2019 Genesis Partner API
3/120
-
8/20/2019 Genesis Partner API
4/120
-
8/20/2019 Genesis Partner API
5/120
Data Connectors Partner APIData 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 partner’s 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
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 integration’s 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 andSuite 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.
5Data Connectors Partner API
http://www.omniture.com/en/partners/applyhttp://www.omniture.com/en/partners/apply
-
8/20/2019 Genesis Partner API
6/120
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.
6Data Connectors Partner API
-
8/20/2019 Genesis Partner API
7/120
• 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.
7Data Connectors Partner API
-
8/20/2019 Genesis Partner API
8/120
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 partner’s Data Connectors integration, partner uses the Integration API to enable the
flow of data between the partner’s 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 thatare 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/ ).
8Data Connectors Partner API
http://developer.omniture.com/http://www.w3.org/TR/soap12-part1/http://sourceforge.net/projects/nusoap/http://pear.php.net/http://pear.php.net/http://sourceforge.net/projects/nusoap/http://www.w3.org/TR/soap12-part1/http://developer.omniture.com/
-
8/20/2019 Genesis Partner API
9/120
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
9Data Connectors Partner API
http://ws.apache.org/axis/http://ws.apache.org/wss4j/http://msdn.microsoft.com/en-us/vstudio/default.aspxhttp://pywebsvcs.sourceforge.net/http://www.soaplite.com/http://www.soapui.org/http://www.altova.com/products/xmlspy/xml_editor.htmlhttp://www.altova.com/products/xmlspy/xml_editor.htmlhttp://www.soapui.org/http://www.soaplite.com/http://pywebsvcs.sourceforge.net/http://msdn.microsoft.com/en-us/vstudio/default.aspxhttp://ws.apache.org/wss4j/http://ws.apache.org/axis/
-
8/20/2019 Genesis Partner API
10/120
User name and password should be passed by X-WSSE header in HTTP request as following:
Host: api.vm16.dev.ut1.omniture.comAccept: */*Content-Type: application/jsonContent-Length: 0X-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 generateAnalytics 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 par tners define an integration’s characteristics, including the data that
the partner wants to share with Analytics.
The Configuration API includes the following methods:
10Data Connectors Partner API
-
8/20/2019 Genesis Partner API
11/120
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
DescriptionRequiredTypeParameter
The name of the principal technical contact.Yesxsd:stringcontactName
The email of the principal technical contact.Yesxsd:stringcontactEmail
The version to assign to the product.Yesxsd:stringversion
The industry which best applies to this product.Yesxsd:stringindustry
The information about this product.Yestns:productDetailsListdetails
Phone contact for support.Yesxsd:stringsupportPhone
Email contact for support.Yesxsd:stringsupportEmail
Product.Add Response
DescriptionTypeResponse
A unique code assigned to the new product.xsd:stringproductCode
Status message pertaining to the success of the action.xsd:stringstatus
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
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a list
of your company's product codes by calling .
Yesxsd:stringproductCode
11Data Connectors Partner API
-
8/20/2019 Genesis Partner API
12/120
DescriptionRequiredTypeParameter
The product version of the new product.Yesxsd:stringnewProductVersion
Product.Clone Response
DescriptionTypeResponse
A unique code assigned to the new product.xsd:stringproductCode
Status message pertaining to the success of the action.xsd:stringstatus
Product.Delete
Deletes an existing Data Connectors product.
Product.Delete Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a list
of your company's product codes by calling .
Yesxsd:stringproductCode
Product.Delete Response
DescriptionTypeResponse
Indicates if the operation succeeded (True) or failed (False).xsd:booleansuccess
Status message pertaining to the success of the action.xsd:stringstatus
Product.Get
Returns information about the specified Data Connectors product.
Product.Get Parameters
DescriptionTypeParameter
A valid Data Connectors product code. You can get a list of yourcompany's product codes by calling .
xsd:stringproductCode
12Data Connectors Partner API
-
8/20/2019 Genesis Partner API
13/120
Product.Get Response
DescriptionTypeParameter
The product code associated with this Data Connectors
product.
xsd:stringproductCode
The name of the principal technical contact.xsd:stringcontactName
The email of the principal technical contact.xsd:stringcontactEmail
The product version.xsd:stringversion
The industry which best applies to this product.xsd:stringindustry
Detailed information about the product configuration.tns:productDetailsListdetails
Phone contact for support.
xsd:stringsupportPhone
Email contact for support.xsd:stringsupportEmail
Product.Modify
Modifies the Data Connectors product as specified.
Product.Modify Parameters
DescriptionTypeParameter
A valid Data Connectors product code. You can get a list of your
company's product codes by calling .
xsd:stringproductCode
The name of the principal technical contact.xsd:stringcontactName
The email of the principal technical contact.xsd:stringcontactEmail
The product version.xsd:stringversion
The industry which best applies to this product.xsd:stringindustry
Detailed information about the product configuration.tns:productDetailsListdetails
Phone contact for support.xsd:stringsupportPhone
Email contact for support.xsd:stringsupportEmail
13Data Connectors Partner API
-
8/20/2019 Genesis Partner API
14/120
Product.Modify Response
DescriptionTypeParameter
A unique product code associated with this Data Connectors
product.
xsd:stringproductCode
A status message pertaining to the success of the action.xsd:stringstatus
Product.AddCalculatedMetric
Add a calculated metric for a product.
Added in Data Connectors 3.1.
Product.AddCalculatedMetric Parameters
DescriptionRequiredTypeElement
A valid Data Connectors product code. You can get alist of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
Name of the calculated metric to be created.Yesxsd:stringname
The formula for the new calculated metric.Yesxsd:stringformula
Set to 1 to automatically replace formula metrics with
variable-mapped metrics when an integration is saved.
Yesxsd:booleanreplace_with_mapping
Human-readable calculated metric formula.Yesxsd:stringfriendly_formula
The type of metric to be created. 1:numeric, 2:percent,
3:currency
Yesxsd:integermetric_type
The number of decimal places to be displayed for this
formula result.
Yesxsd:integerdecimal_places
Product.AddCalculatedMetric Response
DescriptionTypeParameter
A status message pertaining to the success of the action.statusstatus
Product.DeleteCalculatedMetric
Deletes a calculated metric for a product.
14Data Connectors Partner API
-
8/20/2019 Genesis Partner API
15/120
Added in Data Connectors 3.1.
Product.DeleteCalculatedMetric Parameters
DescriptionRequiredTypeElement
A valid Data Connectors product code. You can get a
list of your company's product codes by callingPartner.GetProducts .
Yesxsd:stringproductCode
Name of the calculated metric to be deleted.Yesxsd:stringname
Product.DeleteCalculatedMetric Response
DescriptionTypeParameter
A status message pertaining to the success of the action.statusstatus
Product.GetCalculatedMetrics
Gets all calculated metrics for a product.
Added in Data Connectors 3.1.
Product.GetCalculatedMetrics Parameters
DescriptionRequiredTypeElement
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
Product.GetCalculatedMetrics Response
DescriptionTypeParameter
Details about calculated metrics.productCalculatedMetrics metrics
Product.ModifyCalculatedMetric
Modifies a calculated metric for a product.
Added in Data Connectors 3.1.
15Data Connectors Partner API
-
8/20/2019 Genesis Partner API
16/120
Product.ModifyCalculatedMetric Parameters
DescriptionRequiredTypeElement
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
Name of the calculated metric to be modified.Yesxsd:stringname
The formula for the calculated metric.Yesxsd:stringformula
Set to 1 to automatically replace formula metrics with
variable-mapped metrics when an integration is saved.
Yesxsd:booleanreplace_with_mapping
Human-readable calculated metric formula.Yesxsd:stringfriendly_formula
The type of metric to be created. 1:numeric, 2:percent,
3:currency
Yesxsd:integermetric_type
The number of decimal places to be displayed for this
formula result.
Yesxsd:integerdecimal_places
Product.ModifyCalculatedMetric Response
DescriptionTypeParameter
A status message pertaining to the success of the action.statusstatus
Product.AddClassification
Add a classification for a metric.
Added in Data Connectors 3.1.
Product.AddClassification Parameters
DescriptionRequiredTypeElement
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
Name of the classification to be created.Yesxsd:stringclassificationName
The partner’s metric name.Yesxsd:stringmetricName
16Data Connectors Partner API
-
8/20/2019 Genesis Partner API
17/120
DescriptionRequiredTypeElement
The parent classification's classificationNum. Assign a
value of 0 or leave empty if it is simple classifying the
metric directly.
Falsexsd:integerparentClassificationNum
One of the following values indicating the classification
type:
Yesxsd:stringtype
• text
• numeric
• percent
• currency
Product version.Falsexsd:integerversion
Whether or not to treat this classification like a
campaign.
Falsexsd:integercampaignViewFlag
Product.AddClassification Response
DescriptionTypeParameter
ID for the new classification.xsd:integer
classificationNum
The partner’s metric name.xsd:string
metricName
A status message pertaining to the success of the action.statusstatus
Product.DeleteClassification
Deletes a classification for a metric.
Added in Data Connectors 3.1.
Product.DeleteClassification Parameters
DescriptionRequiredTypeElement
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
Name of the metric where the classification is created.Yesxsd:stringmetricName
The parent classification's classificationNum. Assign a
value of 0 or leave empty if it is simple classifying the
metric directly.
Falsexsd:integerparentClassificationNum
17Data Connectors Partner API
-
8/20/2019 Genesis Partner API
18/120
-
8/20/2019 Genesis Partner API
19/120
DescriptionRequiredTypeElement
• text
• numeric
• percent
• currency
Whether or not to treat this classification like acampaign.
Falsexsd:integercampaignViewFlag
Product.ModifyClassification Response
DescriptionTypeParameter
ID for the new classification.xsd:integer
classificationNum
The partner’s metric name.xsd:string
metricName
A status message pertaining to the success of the action.statusstatus
Product.GetProcessingRule
Get the processing rule template for this product.
Added in Data Connectors 3.1.
Product.GetProcessingRule Parameters
DescriptionRequiredTypeElement
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
Product.GetProcessingRule Response
DescriptionTypeParameter
Processing rule template. productProcessingRulerule
Product.DeleteProcessingRule
Deletes the processing rule template for this product.
Added in Data Connectors 3.1.
19Data Connectors Partner API
-
8/20/2019 Genesis Partner API
20/120
Product.DeleteProcessingRule Parameters
DescriptionRequiredTypeElement
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
Product.DeleteProcessingRule Response
DescriptionTypeParameter
A status message pertaining to the success of the action.statusstatus
Product.ModifyProcessingRule
Modifies the processing rule template for this product.
Added in Data Connectors 3.1.
Product.ModifyProcessingRule Parameters
DescriptionRequiredTypeElement
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
The processing rule template XML string.Yesxsd:stringxml
Product.ModifyProcessingRule Response
DescriptionTypeParameter
A status message pertaining to the success of the action.statusstatus
Product.AddFaq
Add a FAQ for a product.
Added in Data Connectors 3.0.
Product.AddFaq Parameters
DescriptionRequiredTypeParameter
Answer to the provided question.Yesxsd:stringanswer
20Data Connectors Partner API
-
8/20/2019 Genesis Partner API
21/120
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
Question to add to the frequently asked questions list.Yesxsd:stringquestion
Product.AddFaq Response
DescriptionTypeParameter
A status message pertaining to the success of the action.statusstatus
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
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
The product script that you want to submit. For
information about the script format and structure, see
the Product.GetProductScript response.
Yesxsd:stringscript
A short name for this product script. The scriptName
must be unique.
Yesxsd:stringname
A detailed description of the product script.Noxsd:stringdescription
When the script should execute. Supported values
include:
Yesxsd:stringrunOn
demand: Designates the script as an on-demand scriptthat you can call at any time (see Partner.RunScript ).
integration_create: Runs the script after the Data
Connectors Wizard completes for a new integration.
21Data Connectors Partner API
-
8/20/2019 Genesis Partner API
22/120
DescriptionRequiredTypeParameter
integration_edit: Runs the script after the Data
Connectors Wizard completes for an existing
integration.
Product.SubmitProductScript Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
Product.AddVariableMappings
Configures mappings between partner product metrics and Analytics eVars, events, and properties.
Product.AddVariableMappings Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can
get a list of your company's product codes by
calling .
Yesxsd:stringproductCode
XML that defines the variable mappings.Yesarray( tns:varMapAll )variableMappings
Product.AddVariableMappings Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
Product.DeleteFaq
Delete a FAQ for a product.
Added in Data Connectors 3.0.
Product.DeleteFaq Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
Question that you want to remove from the frequently
asked questions list.
Yesxsd:stringquestion
22Data Connectors Partner API
-
8/20/2019 Genesis Partner API
23/120
Product.DeleteFaq Response
DescriptionTypeParameter
A status message pertaining to the success of the action.statusstatus
Product.DeleteVariableMappings
Configures mappings between partner product metrics and Analytics eVars, events, and properties.
Product.DeleteVariableMappings Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a list
of your company's product codes by calling .
Yesxsd:stringproductCode
A list of variable mappings to delete.Yesarray(xsd:string)variableMappings
Product.DeleteVariableMappings Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
Product.DisableAuthentication
Disables the authentication request to the partner API for a product.
Added in Data Connectors 3.0.
Product.DisableAuthentication Request
DescriptionRequiredTypeParameter
A valid Data Connectors
product code.You can get
Yesxsd:stringproductCode
a list of your company's
product codes by calling .
Product.DisableAuthentication Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
Product.EnableAuthentication
Enables authentication to partner APIs.
23Data Connectors Partner API
-
8/20/2019 Genesis Partner API
24/120
Added in Data Connectors 3.0.
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
DescriptionRequiredTypeParameter
Optional only if the endpoint can be
determined using the WSDL. Full URL
Noxsd:stringendpoint
to the endpoint where authentication
occurs. For example,
http://myhost/Authenticationservice.asmx?
Name of the function that performs
authentication in the partner API. For
example, authenticate.
Yesxsd:stringfunctionName
Product.authenticationParameter .YesArray of
authenticationParameter
parameterList
A valid Data Connectors product code.
You can get a list of your company's
product codes by calling .
Yesxsd:stringproductCode
String to parse out of the response
message from the partner
Yesxsd:stringresponse
authentication API that indicatessuccess. If this string is not located in
the response the authentication
attempt is considered unsuccessful.
For example, "request OK".
Authentication type to use. One of the
following values:
Yesxsd:stringtype
• plain
• soap
• wsse
• curl
Typically the URL of the WSDL, or an
asmx file for CURL.
Yesxsd:stringurl
24Data Connectors Partner API
-
8/20/2019 Genesis Partner API
25/120
Product.EnableAuthentication Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
Product.GetAuthentication
Returns authentication configuration information
Added in Data Connectors 3.0.
Product.GetAuthentication Request
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a list
of your company's product codes by calling .
Yesxsd:stringproductCode
Product.GetAuthentication Response
DescriptionTypeParameter
AuthResponse:authResponseauthenticationConfiguration
•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.
Added in Data Connectors 3.0.
25Data Connectors Partner API
-
8/20/2019 Genesis Partner API
26/120
Product.GetFaqs Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
Product.GetFaqs Response
DescriptionTypeParameter
An array of
Product.productFaq
faqs
Product.GetLogo
Gets the logo of a product for a given locale.
Added in Data Connectors 3.0.
Product.GetLogo Parameters
DescriptionRequiredTypeParameter
The locale to be used for the image uploaded. If no
locale is used, Data Connectors defaults to en_US.
Noxsd:stringlocale
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
Product.GetLogo Response
DescriptionTypeParameter
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.
xsd:stringencodedData
Product.GetVariableMappings
Gets the variable mappings for the specified product.
26Data Connectors Partner API
-
8/20/2019 Genesis Partner API
27/120
Product.GetVariableMappings Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling .
Yesxsd:stringproductCode
An expression-like string that limits the variablemapping info returned. The format for the filter string
is as follows:
[, [,...]]
Noxsd:string)filter
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, thefollowing 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
DescriptionTypeParameter
XML that defines the variable mappings.array( varMapAll )variableMappings
Product.ModifyFaq
Modify a FAQ for a product.
Added in Data Connectors 3.0.
Product.ModifyFaq Parameters
DescriptionRequiredTypeParameter
Answer to the provided question.Yesxsd:stringanswer
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
27Data Connectors Partner API
-
8/20/2019 Genesis Partner API
28/120
DescriptionRequiredTypeParameter
Question to add to the frequently asked questions list.Yesxsd:stringquestion
Product.ModifyFaq Response
DescriptionTypeParameter
A status message pertaining to the success of the action.statusstatus
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
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
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.
Yesxsd:stringencodedData
The locale to be used for the image uploaded. If no
locale is used, Data Connectors defaults to en_US.
Noxsd:stringlocale
Product.ModifyLogo Response
DescriptionTypeParameter
Indicates if the logo was successfully updated. The response
returns Logo updated if successful, or an error message if
unsuccessful.
xsd:stringresult
Product.ModifyProductScript
Creates or modifies a product script.
Added in Data Connectors 3.0.
28Data Connectors Partner API
-
8/20/2019 Genesis Partner API
29/120
Product.ModifyProductScript Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
The product script that you want to submit. For
information about the script format and structure, see
the Product.GetProductScript response.
Yesxsd:stringscript
A short name for this product script. The scriptName
must be unique.
Yesxsd:stringname
A detailed description of the product script.Noxsd:stringdescription
When the script should execute. Supported values
include:
Yesxsd:stringrunOn
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.
integration_edit: Runs the script after the Data
Connectors Wizard completes for an existing
integration.
Product.ModifyProductScript Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
Product.ModifyVariableMappings
Configures mappings between partner product metrics and Analytics eVars, events, and properties.
Product.ModifyVariableMappings Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling .
Yesxsd:stringproductCode
XML that defines the variable mappings you want to
change.
Yesarray( tns:varMapAll )variableMappings
29Data Connectors Partner API
-
8/20/2019 Genesis Partner API
30/120
Product.ModifyVariableMappings Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
Product.DisableAdProcessingDisables ad processing for the specified product during the Data Connectors configuration.
Product.DisableAdProcessing Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling .
Yesxsd:stringproductCode
Product.DisableAdProcessing Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
Product.EnableAdProcessing
Enables ad processing during the product configuration in the Data Connectors environment.
Product.EnableAdProcessing Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling .
Yesxsd:stringproductCode
A partner-specific value used to identify the click and
view data in the request.
Yesxsd:stringprefix
Specifies the names of the variable mappings used to
receive data from the ad processing system.
YesadProcessingVariablesvariables
Specifies settings that change the behavior and setupof the ad processing system.
NoadProcessingSettingssettings
30Data Connectors Partner API
-
8/20/2019 Genesis Partner API
31/120
Product.EnableAdProcessing Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
Product.GetAdProcessingReturns the current add processing settings for the specified product.
Product.GetAdProcessing Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
Product.GetAdProcessing Response
DescriptionTypeParameter
The current ad processing status for the specified Data Connectors
product.
adProcessingStatus status
Product.DeleteProductScript
Removes the product script from the specified product.
Product.DeleteProductScript Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
A name for the product script you want to delete.Yesxsd:stringscriptName
Product.DeleteProductScript Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
Product.GetProductScript
Returns the product script from the specified Data Connectors product.
31Data Connectors Partner API
-
8/20/2019 Genesis Partner API
32/120
Product.GetProductScript Parameters
DescriptionRequiredTypeParameter
Name of the script.Yesxsd:stringName
A valid Data Connectors product code. You can get a
list of your company's product codes by callingPartner.GetProducts .
Yesxsd:stringproductCode
Product.GetProductScript Response
DescriptionType
The encapsulated product script.*
(See #1) A Web Services API method.This example
calls a method from the Administration API. AdCampaign 0
(See #2) The replaceWith attribute instructs DataConnectors to replace the attribute contents with a
My Site Name RSID
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
through the Product Script. However, if you run into difficulties
about variable mapping, see
Product.AddVariableMappings .
using a particular API method in the Product Script, contactclient: (See #3) Substitutes a client account property
when making the call. Supported values include:your Adobe Account Manager. For detailed information about
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 .
32Data Connectors Partner API
http://developer.omniture.com/http://developer.omniture.com/
-
8/20/2019 Genesis Partner API
33/120
Product.SubmitProductScript Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
The product script that you want to submit. For
information about the script format and structure, see
the Product.GetProductScript response.
Yesxsd:stringscript
A short name for this product script. The scriptName
must be unique.
Yesxsd:stringscriptName
A detailed description of the product script.Noxsd:stringscriptDesc
When the script should execute. Supported values
include:
Yesxsd:stringrunOn
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.
integration_edit: Runs the script after the Data
Connectors Wizard completes for an existing
integration.
Product.SubmitProductScript Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
Product.GetProductScripts
Returns a list of all product scripts submitted for the specified product.
Product.GetProductScripts Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
33Data Connectors Partner API
-
8/20/2019 Genesis Partner API
34/120
Product.GetProductScripts Response
DescriptionTypeParameter
A list of product scripts submitted for the specified product code.string_array status
Product.GetProductApprovalStatusReturns a current status of the approval process.
Call this method after Product.SubmitProductForApproval to check the approval status.
Product.GetProductApprovalStatus Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
Product.GetProductApprovalStatus Response
DescriptionTypeParameter
Indicates the current status of the approval process for the submitted
product integration. Suppported response values include unsubmitted,
pending, approved, or rejected.
xsd:stringstatus
If status == rejected, the comment contains a reason why the
product integration was rejected.
xsd:stringcomments
Product.SubmitProductForApproval
Submits the specified product integration for approval.
Product.SubmitProductForApproval Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
Product.SubmitProductForApproval Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
34Data Connectors Partner API
-
8/20/2019 Genesis Partner API
35/120
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
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
The type of resource to add.Yes productResourceTypetype
The resource name.Yesxsd:stringtitle
The resource URL.Yesxsd:stringdescription
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.
Contains the name and base64-encoded bytes of a file
that is uploaded to our servers directly.
Noxsd:stringurl
Contains the name and base64-encoded bytes of a file
that is uploaded to Data Connectors servers directly.
NoresourceEncoded resourceFile
Used only when type = dynamic.Noxsd:stringvariablePrefix
A unique string value used to identify the start of a
variable in the dynamic file.
Used only when type = dynamic.Noxsd:stringvariableSuffix
35Data Connectors Partner API
-
8/20/2019 Genesis Partner API
36/120
DescriptionRequiredTypeParameter
A unique string value, which can be the same as
variablePrefix, used to identify the end of a variable
in the dynamic file.
The language locale used for this resource.Noxsd:stringlocale
Defaults to en_US.
Product.AddResource Response
DescriptionTypeParameter
A unique code assigned to the new resource.xsd:stringresourceCode
Product.DeleteResource
Deletes a resource from the specified product.
Product.DeleteResource Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
The unique code assigned to the resource you want to
delete.
Yesxsd:stringresourceCode
Product.DeleteResource Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
Product.GetResource
Returns the specified resource associated with the specified product.
Product.GetResource Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
36Data Connectors Partner API
-
8/20/2019 Genesis Partner API
37/120
DescriptionRequiredTypeParameter
The unique code assigned to the resource you want to
get.
Yesxsd:stringresourceCode
Product.GetResource Response
DescriptionTypeParameter
A structure containing information about the specified resource. productResourceresource
Product.ModifyResource
Modifies an existing resource associated with the specified product.
Product.ModifyResource Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
A unique code assigned to the resource you want to
modify.
Yesxsd:stringresourceCode
The type of resource.No productResourceTypetype
The resource name.No
xsd:stringtitle
A description of the resource.Noxsd:stringdescription
The resource URL.Noxsd:stringurl
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.
Contains the name and base64-encoded bytes of a
resource file to upload directly to Data Connectors
servers.
NoresourceEncoded resourceFile
37Data Connectors Partner API
-
8/20/2019 Genesis Partner API
38/120
DescriptionRequiredTypeParameter
Used only when type = dynamic.Noxsd:stringvariablePrefix
A unique string value used to identify the start of a
variable in the dynamic file.
Used only when type = dynamic.Noxsd:stringvariableSuffix
A unique string value, which can be the same as
variablePrefix, used to identify the end of a variable
in the dynamic file.
The language locale used for this resource.Noxsd:stringlocale
Defaults to en_US.
Product.ModifyResource Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
Product.GetResources
Returns all of the resources associated with the specified product.
Data Connectors 3.0: Added includeResourceFile.
Product.GetResources Parameters
DescriptionRequiredTypeParameter
Controls whether or not the actual file data associated
with each resource is returned with the response. If
Yesxsd:booleanincludeResourceFile
“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
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
38Data Connectors Partner API
-
8/20/2019 Genesis Partner API
39/120
Product.GetResources Response
DescriptionTypeParameter
A list of all resources associated with the specified product. productDetailsListresource
Product.AddAccessRequestAdds an access request to the specified product.
Product.AddAccessRequest Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
The type of access that is being requested: import,export, or import/export.
Yes
xsd:stringaccess
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.
Yesxsd:stringelement
Specifies if the request must be granted to complete
the integration. Either yes or no.
Yesxsd:stringrequired
Product.AddAccessRequest Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
Product.DeleteAccessRequest
Deletes an access request from the specified product.
Product.DeleteAccessRequest Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
39Data Connectors Partner API
-
8/20/2019 Genesis Partner API
40/120
DescriptionRequiredTypeParameter
The name of the metric or dimension where you want
to delete the access request. See Data Connectors
Yesxsd:stringelement
Standard Elements for a list of valid values for this
parameter.
Product.DeleteAccessRequest Response
DescriptionTypeParameter
A status code and associated message related to the operation.statusstatus
Product.ModifyAccessRequest
Modifies an existing access request for the specified product.
Product.ModifyAccessRequest Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
The type of access that is being requested: import,
export, or import/export.
Yesxsd:stringaccess
The name of the metric or dimension that access isbeing requested for. See Data Connectors Standard
Elements for a list of valid values for this parameter.
Yes
xsd:stringelement
Specifies if the request must be granted to complete
the integration. Either yes or no.
Yesxsd:stringrequired
Product.ModifyAccessRequest Response
DescriptionTypeParameter
A status code and associated message related to the operation.status
status
Product.GetAccessRequests
Returns the current add processing settings for the specified product.
40Data Connectors Partner API
-
8/20/2019 Genesis Partner API
41/120
Product.GetAccessRequests Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
Product.GetAccessRequests Response
DescriptionTypeParameter
A list of the current access requests for the specified product.tns:accessRequestsrequests
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 notchanged so you can safely rename the method with no additional changes.
Product.UpdateLogo Parameters
DescriptionRequiredTypeParameter
A valid Data Connectors product code. You can get a
list of your company's product codes by calling
Partner.GetProducts .
Yesxsd:stringproductCode
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.
Yesxsd:stringencodedData
The locale to be used for the image uploaded. If no
locale is used, Data Connectors defaults to en_US.
Noxsd:stringlocale
Product.UpdateLogo Response
DescriptionTypeParameter
Indicates if the logo was successfully updated. The responsereturns Logo updated if successful, or an error message if
unsuccessful.
xsd:stringresult
Data Connectors Integration API
The Integration API enables the day-to-day data transfer between the partner environment and Adobe data collectionservers.
41Data Connectors Partner API
-
8/20/2019 Genesis Partner API
42/120
The Integration API includes the following methods:
Partner.GetProduct
Get the product for the given partner.
Added in Data Connectors 3.1.
While this method is par t of the Integration API, you might find it useful in both the Configuration and Integration
phases of the integration development process.
Partner.GetProduct Parameters
DescriptionTypeResponse
An array of information about one partner product.
Partner.GetProduct returns an array of product information
for the product identified by the specified productCode.
xsd:stringproductCode
Partner.GetProduct Response
DescriptionTypeResponse
An array of information about one partner product.
Partner.GetProducts returns a separate array of product
tns:productproductInfo
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 par t 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
DescriptionTypeResponse
An array of information about one partner product.
Partner.GetProducts returns a separate array of product
tns:productproductInfo
information for each product associated with the current
partner.
42Data Connectors Partner API
-
8/20/2019 Genesis Partner API
43/120
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
DescriptionRequiredTypeParameter
An array of information about one partner product.
Partner.GetProducts returns a separate array of
Noxsd:stringintegrationCode
product information for each product associated with
the current partner.
Partner.GetIntegrationAccess Response
DescriptionTypeResponse
Displays the name of the element for which access was requested.xsd:stringelement
Displays the level of access that was requested: import, export, or
import/export.
xsd:stringrequested
Displays the level of access that was granted by the customer:
import, export, or import/export.
xsd:stringgranted
Partner.GetIntegrationMappings
Retrieves the mappings and access chosen by the user for an Integration.
Partner.GetIntegrationMappings Parameters
DescriptionRequiredTypeParameter
An array of information about one partner
product. Partner.GetProducts returns
Noxsd:stringintegrationCode
a separate array of product information
for each product associated with the
current partner.
Partner.GetIntegrationMappings Response
DescriptionTypeResponse
The chosen data mappings whichwere selected by the user.
string_arraychosenMappings
The chosen access requests selectedby the user. These contain the
chosenAccessRequestschosenAccessRequests
43Data Connectors Partner API
-
8/20/2019 Genesis Partner API
44/120
DescriptionTypeResponse
exportable access requests (can berequested via Data Warehouse) andimportable access requests (can be
imported with Data Sources andSAINT).
Partner.GetIntegrations
Returns details about active Data Connectors integrations.
Partner.GetIntegrations Parameters
DescriptionRequiredTypeParameter
An expression-like string that limits the returned results.
The format for filter string is as follows:
Noxsd:stringfilter
[,
[, ...]]
The list below this table contains the available filter
items.
CustomVals are searched with a customValue filter
similar to the following:
customValue='key=value'
Variable: One of the keys returned in the
Partner.GetIntegrationAccess response.
Operator: A boolean operator (=, or !=).
Constant: The filter value. Constant is either a string
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
-
8/20/2019 Genesis Partner API
45/120
integrationCurrency
productCode
productVersion
productName
reportSuiteId
company
creationDate
lastModifiedDate
status
selectedSegment
soapEndpoint
customValue
Partner.GetIntegrations Response
DescriptionTypeResponse
Displays details about the active integrations that pass
the specified filter definition.
integrationDetailsintegrationInfo
Partner.GetIntegrationsBrief
Returns brief information about a partner's active Data Connectors integrations.
Added in Data Connectors 3.1.
Partner.GetIntegrationsBrief Parameters
DescriptionRequiredTypeParameter
An expression-like string that limits the returned results.
The format for filter string is as follows:
Noxsd:stringfilter
[,
[, ...]]
CustomVals are searched with a customValue filter
similar to the following:
customValue='key=value'
Variable: One of the keys returned in the
Partner.GetIntegrationAccess response.
Operator: A boolean operator (=, or !=).
45Data Connectors Partner API
-
8/20/2019 Genesis Partner API
46/120
DescriptionRequiredTypeParameter
Constant: The filter value. Constant is either a string
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
-
8/20/2019 Genesis Partner API
47/120
DescriptionRequiredTypeParameter
integrationCode >= "d1.100", integrationCode
-
8/20/2019 Genesis Partner API
48/120
For sample code related to using Partner.RunScript with on-demand product scripts, see Sample On-Demand
Script Usage .
Partner.RunScript Parameters
DescriptionRequiredTypeParameter
The integration identifier. CallPartner.GetIntegrationAccess to get this value.
Yesxsd:stringintegrationCode
The name of the on-demand script to execute.You
can select only scripts that were submitted with the
Yesxsd:stringname
runOn = demand parameter (see
Product.SubmitProductScript ).
The parameters inserted into the script’s replaceWith
attributes.The list must include values for ALL
replaceWith parameters.
YesscriptParametersparameters
Partner.RunScript Response
DescriptionTypeResponse
Name of the on-demand script executed.xsd:stringfunctionName
Indicates if a SOAP error was encountered.xsd:booleanhadSOAPFault
An array that contains the script results.anyresult
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
DescriptionRequiredTypeParameter
The integration identifier. Call
Partner.GetIntegrationAccess to get this value.
Yesxsd:stringintegrationCode
The names of the data columns (the column
heading).
YescolArray columnNames
There must be at least three elements
nested inside this parameter. The first must be
48Data Connectors Partner API
-
8/20/2019 Genesis Partner API
49/120
DescriptionRequiredTypeParameter
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.
The data to import. The rows element should
contain the same number of columns as specified
in the columnNames parameter.
YesrowArray rows
Specifies the data source where you want to
import the metrics. You can get the
dataSourceID from Partner.GetIntegrations .
Yesxsd:stringdataSourceId
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.
Noxsd:stringendOfBlock
To indicate the end of a data block, pass the
following:
1.
To indicate that additional data will be sent, pass
the following:
0.
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
DescriptionTypeResponse
Indicates if the call was successful.Valid return values
include Failed or Success.
xsd:stringstatus
If the call fails, Data Connectors returns an error
message to help you understand why the call failed.
49Data Connectors Partner API
-
8/20/2019 Genesis Partner API
50/120
DescriptionTypeResponse
The ID used to append additional data blocks to this
Data Connectors data submission.
xsd:intblockId
This parameter is assigned a value only when the
request does not include the tag.
The unique ID generated by the Processing Queue to
identify a particular Data Connectors data submission.
xsd:intfileId
This parameter is assigned a value only when the
request does not include the tag.
Import.CheckMetricsUpload
Checks a Data Connectors data submission.
Import.CheckMetricsUpload Parameters
DescriptionRequiredTypeParameter
The unique ID generated by the Processing
Queue to identify a particular Data
Connectors classifications submission.
Yesxsd:intfileId
Returned by Import.UploadMetrics or
Import.ContinueMetricsUpload
The integration identifier. Call
Partner.GetIntegrationAccess to get thisvalue.
Yesxsd:stringintegrationCode
Import.CheckMetricsUpload Response
DescriptionTypeResponse
Contains information about the submitted files
associated with a data source.
Array of
DataSource.dsFileStruct
fileInfoResult
Import.ContinueMetricsUpload
Appends an additional data block to an existing 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.
50Data Connectors Partner API
http://-/?-http://-/?-
-
8/20/2019 Genesis Partner API
51/120
Import.ContinueMetricsUpload Parameters
DescriptionRequiredTypeParameter
The integration identifier. Call
Partner.GetIntegrationAccess to get this value.
Yesxsd:stringintegrationCode
The ID of the previous block sent for this datasubmission.
YescolArray blockId
Both Import.UploadMetrics and
Import.ContinueMetricsUpload returns
blockID in its response, as long as endOfBlock
is not included in the UploadMetrics call.
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.
Noxsd:stringendOfBlock
To indicate the end of a data block, pass thefollowing:
1.
To indicate that additional data will be sent, pass
the following:
0.
If you pass an endOfBlock with a value of 0, you
must continue to call this method
(ContinueMetricsUpload) until you set end of
block equal to 1.
Import.ContinueMetricsUpload Response
DescriptionTypeResponse
Indicates if the call was successful.Valid return values
include Failed or Success.
xsd:stringstatus
If the call fails, Data Connectors returns an error
message to help you understand why the call failed.
The unique ID generated by the Processing Queue to
identify a particular Data Connectors data submission.
xsd:intfileId
This parameter is assigned a value only when the
request does not include the tag.
51Data Connectors Partner API
-
8/20/2019 Genesis Partner API
52/120
Import.UploadClassifications
Submits SAINT classification data for a Data Connectors integration on behalf of a client.
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.UploadClassifications Parameters
DescriptionRequiredTypeParameter
The integration identifier. Call
Partner.GetIntegrationAccess to get this value.
Yesxsd:stringintegrationCode
The name of the metric where you want to import
classification data.
metricName
The metric must be a previously defined variable
mapping that is available by calling
Product.GetVariableMappings .
The names of the classification columns (the
column heading).
YescolArray columnNames
There must be at least 2 elements nested
inside this parameter. The first must be Key. All
others must be valid classifications created
through the Product Script (see
Product.GetProductScript ).
The classification data to import.Yes
rowArray rows
The rows element should contain the same
number of columns as specified in the
columnNames parameter.
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.
Noxsd:stringendOfBlock
To indicate the end of a data block, pass the
following:
1.
To indicate that additional data will be sent, pass
the following:
0.
52Data Connectors Partner API
-
8/20/2019 Genesis Partner API
53/120
DescriptionRequiredTypeParameter
If you pass an endOfBlock with a value of 0, you
must call Import.ContinueClassificationsUpload
to resume uploading.
Import.UploadClassifications Response
DescriptionTypeResponse
Indicates if the call was successful.Valid return values
include Failed or Success.
xsd:stringstatus
If the call fails, Data Connectors returns an error
message to help you understand why the call failed.
The ID used to append additional data blocks to this
Data Connectors classifications submission.
xsd:intblockId
This parameter is assigned a value only when the
request does not include the tag.
The unique ID generated by the Processing Queue to
identify a particular Data Connectors classifications
submission.
xsd:intfileId
This parameter is assigned a value only when the
request does not include the tag.
Import.CheckClassificationsUpload
Checks submitted SAINT classification data for a Data Connectors integration.
Import.CheckClassificationsUpload Parameters
DescriptionRequiredTypeParameter
The unique ID generated by the Processing
Queue to identify a particular Data
Connectors classifications submission.
Yesxsd:intfileId
Returned by Import.UploadClassifications
or Import.ContinueClassificationsUpload
The integration identifier. Call
Partner.GetIntegrationAccess to get this
value.
Yesxsd:stringintegrationCode
53Data Connectors Partner API
-
8/20/2019 Genesis Partner API
54/120
Import.CheckClassificationsUpload Response
DescriptionTypeResponse
The status of the specified SAINT job. Possible values
are as follows:
saintresultssaintresults
• Waiting for user data
• In Progress
• In Progress - % Complete
• Completed
• Completed - With Errors :
Import.ContinueClassificationsUpload
Appends an additional data block to an existing Data Connectors classifications 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.ContinueClassificationsUpload Parameters
DescriptionRequiredTypeParameter
The integration identifier. Call
Partner.GetIntegrationAccess to get this value.
Yesxsd:stringintegrationCode
The ID of the previous block sent for this
classifications submission.
Yesxsd:intblockId
Both Import.UploadClassifications andImport.ContinueClassificationsUpload return
blockID in its response, as long as endOfBlock
is not included in the call.
The classification data to import.YesrowArray rows
The rows parameter should contain the same
number of columns as specified in the
columnNames parameter of the
Import.UploadClassifications call.
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.
Noxsd:stringendOfBlock
To indicate the end of a data block, pass the
following:
1.
54Data Connectors Partner API
http://-/?-http://-/?-
-
8/20/2019 Genesis Partner API
55/120
DescriptionRequiredTypeParameter
To indicate that additional data will be sent, pass
the following:
0.
If you pass an endOfBlock with a value of 0, you
must continue to call this method(ContinueClassificationsUpload) until you set
end of block equal to 1.
Import.ContinueClassificationsUpload Response
DescriptionTypeResponse
Indicates if the call was successful.Valid return values
include Failed or Success.
xsd:stringstatus
If the call fails, Data Connectors returns an error
message to help you understand why the call failed.
The ID used to append additional data blocks to this
Data Connectors classifications submission.
xsd:intblockId
This parameter is assigned a value only when the
request does not include the tag.
The unique ID generated by the Processing Queue to
identify a particular Data Connectors classifications
submission.
xsd:intfileId
This parameter is assigned a value only when the
request does not include the tag.
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
DescriptionRequiredTypeParameter
The partner product for which you
want to retrieve classification
data.
Yesxsd:stringintegrationCode
55Data Connectors Partner API
-
8/20/2019 Genesis Partner API
56/120
-
8/20/2019 Genesis Partner API
57/120
DescriptionRequiredTypeParameter
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.
The end date for including rows
in the export. Include this
Noxsd:stringdate_filter_row_end_date
parameter when
campaign_filter_option = 1.
Use the same date range format
described for the
date_filter_row_start_date
parameter.
The email address to receive job
notifications.
Yesxsd:stringemail_address
The relation ID.Yesxsd:intrelation_id
You get this ID as a return value
fromSaint.GetCompatibilityMetrics
.
For example, 53 is the ID for the
"campaign" relation.
(Optional) The column ID number
of the column that SAINT checks
for empty data cells.
Noxsd:stringrow_match_filter_empty_column_name
If this parameter is specified, the
export contains only keys whichhave empty values for the
provided column.
You get the column ID by
callingSaint.GetFilters for a
specific relation id.
57Data Connectors Partner API
-
8/20/2019 Genesis Partner API
58/120
DescriptionRequiredTypeParameter
(Optional) The column name that
SAINT checks for cell values that
Noxsd:stringrow_match_filter_match_column_name
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.
(Optional) The value that SAINT
uses to exclude a data row from
the export.
Noxsd:stringrow_match_filter_match_column_value
Include this parameter when
using
row_match_filter_match_column_name.
Specifies whether to include all
data rows in the export (up to the
Yesxsd:intselect_all_rows
50,000 row limit). Supported
values include:
0: Do not include all rows in the
export.
1: (Default) Include all rows in the
export.
(Optional) Limits the number of
data rows in the export file to the
Noxsd:intselect_number_of_rows