| Oracle® Communications Marketing and Advertising Integration Guide Release 5.1 Part Number E20559-01 |
|
|
View PDF |
| Oracle® Communications Marketing and Advertising Integration Guide Release 5.1 Part Number E20559-01 |
|
|
View PDF |
This chapter describes the operations available for querying campaign statistics using the Statistics Manager web service. Oracle Communications Marketing and Advertising collects campaign data for the following ad metrics:
Ads Failed
Ad Impressions
Ads Served
Ad Click Through Responses
Only statistics available to authorized users can be queried via the web service. For example, an advertiser will only be able to retrieve statistics for campaigns that are created and executed by him/herself.
Errors are returned in a SOAP Message that includes a human readable faultstring element that describes the error.
The following data structures are returned in the Statistics Manager web service.
Table 4-1 contains the ocmaBean data structure. This data structure describes the entity for which statistics are returned by the Statistics Manager Web service.
Table 4-2 contains the ocmaBean data structure. This data structure describes the entity for which statistics are returned by the Statistics Manager Web service.
Table 4-2 The statistics Data Structure
| Element Name | Type | Description |
|---|---|---|
|
abstractStatistics |
xs:extension base |
See Table 4-3 |
Table 4-3 contains the abstractStatistics data structure. This data structure describes the statistical ad elements returned by the Statistics Manager Web service.
Table 4-3 The abstractStatistics Data Structure
| Element Name | Type | Description |
|---|---|---|
|
adFailed |
xs:lint |
Number of failed ads for the entity for which statistics are being queried |
|
adImpression |
xs:int |
Number of ads actually delivered for the entity for which statistics are being queried |
|
adServed |
xs:int |
Number of ads served for the entity for which statistics are being queried |
|
clickThrough |
xs:int |
Number of click through responses generated from the ads served |
Table 4-4 contains the categoryStatistics data structure. This data structure describes the statistical category elements returned by the Statistics Manager Web service getCategoryStatistics operation.
Table 4-4 The categoryStatistics Data Structure
| Element Name | Type | Description |
|---|---|---|
|
abstractStatistics |
xs:extension base |
See Table 4-3 |
|
typeName |
xs:string |
Category name |
|
value |
xs:string |
Category value |
Table 4-5 contains the timeBasedStatistics data structure. This data structure describes the statistical elements returned by the Statistics Manager Web service getTimeBasedStatistics operation.
Table 4-5 The timeBasedStatistics Data Structure
| Element Name | Type | Description |
|---|---|---|
|
abstractStatistics |
xs:extension base |
See Table 4-3 |
|
recordTime |
xs:dateTime |
Start time of the campaign being queried |
|
resolution |
tns:resolution |
Time measurement:
|
The Statistics Manager web service can be used to retrieve statistical information about campaigns based on various entity filters (e.g. Connection Configuration, Ad Space, etc.). A number of operations are provided for querying Marketing and Advertising campaign statistics.
The following describes the operations available in the Statistics Manager web service. Full details can be found in the WSDL and xsd files.
Retrieves campaign statistical information for the specified category. Table 4-6 contains the input message parameters for the getCategoryStatistics operation
Table 4-6 Input Message Parameter: complexType - getCategoryStatistics
| Element | Type | Description |
|---|---|---|
|
Id |
xs:long |
Category ID assigned by the system |
|
Category |
xs:string |
Name of Category |
getCategoryStatisticsResponse
Table 4-7 contains the output parameter in the getCategoryStatisticsResponse message.
Retrieves statistical information about campaigns based on Connection Configuration. Table 4-8 contains the input message parameter for the getStatisticsByConnectionConfig operation
Table 4-8 Input Message Parameter: complexType - getStatisticsByConnectionConfig
| Element | Type | Description |
|---|---|---|
|
Id |
xs:long |
Connection Configuration ID assigned by the system |
getStatisticsByConnectionConfigResponse
Table 4-9 contains the output parameter in the getStatisticsByConnectionConfigResponse message.
Retrieves statistical information about campaigns based on campaign ID. Table 4-10 contains the input message parameter for the getStatisticsById operation
Table 4-10 Input Message Parameter: complexType - getStatisticsById
| Element | Type | Description |
|---|---|---|
|
Id |
xs:long |
Campaign ID assigned by the system |
getStatisticsByIdResponse
Table 4-11contains the output parameter in the getStatisticsByIdResponse message.
Retrieves statistical information about campaigns per Ad Space. Table 4-12 contains the input message parameter for the getStatisticsPerAdSpace operation
Table 4-12 Input Message Parameter: complexType - getStatisticsPerAdSpace
| Element | Type | Description |
|---|---|---|
|
Id |
xs:long |
Ad Space ID assigned by the system |
getStatisticsPerAdSpaceResponse
Table 4-13 contains the output parameter in the getStatisticsPerAdSpaceResponse message.
Retrieves statistical information about campaigns based on time parameters. Table 4-14 contains the input message parameters for the getTimeBasedStatistics operation
Table 4-14 Input Message Parameter: complexType - getTimeBasedStatistics
| Element | Type | Description |
|---|---|---|
|
Id |
xs:long |
Campaign ID assigned by the system |
|
StartTime |
xs:dateTime |
Start time boundary for range of query |
|
EndTime |
xs:dateTime |
End time boundary for range of query |
|
Resolution |
tns:resolution |
Time measurement:
|
getTimeBasedStatisticsResponse
Table 4-15 contains the output parameter in the in the getTimeBasedStatisticsResponse message.
|
 Copyright © 2009, 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
