Oracle® Communications Marketing and Advertising Integration Guide Release 5.1 Part Number E20559-01 |
|
|
View PDF |
This chapter describes the four Web services available for creating and managing campaigns:
Only users who belong to the appropriate organizations can perform the tasks of those organizations. For example, a Web service request authenticated by the username of an ad space owner user can create campaign spaces but not create campaigns.
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 campaign Web services.
Table 3-1 describes the AdServer connection configuration data structure. This data structure describes configurations used in campaigns interacting with external ad content servers.
Table 3-1 The AdServerCC Data Structure
Element Name | Type | Description |
---|---|---|
id |
xs:long |
Connection configuration ID assigned by the system |
name |
xs:string |
Name of the configuration |
adSpaceOwnerId |
xs:long |
ID of the ad space owner to whom this configuration is assigned |
networkProviderId |
xs:long |
ID of the Network Provider with which this configuration is associated |
minimumPrice |
xs:float |
Minimum auction price for ads created using this configuration; the currency unit is set by the System Administrator; range is 0 to 9999.999 |
channelType |
tns:channelType |
Type of channel: one of the following:
|
maxAdSize |
xs:int |
Maximum number of characters allowed in an ad; range is 0 to 2147483647 characters - limited by channel type |
adDelimitorPrefix |
xs:string |
String that sets off the top of the ad |
adDelimitorPostfix |
xs:string |
String that sets off the bottom of the ad |
shortCodes |
xs:string |
Array of short codes to be associated with ads created with this configuration |
applicationId |
xs:string |
Identifies the application for the configuration's message delivery system in a charging data record (CDR); must be unique within the Marketing and Advertising system |
msgServiceType |
tns:msgServiceTypeEnum |
Type of message service: one of the following:
|
Table 3-2 describes the MsgService connection configuration data structure. This data structure describes configurations used in advertising campaigns.
Table 3-2 The MsgServiceCC Data Structure
Element Name | Type | Description |
---|---|---|
id |
xs:long |
Connection configuration ID assigned by the system |
name |
xs:string |
Name of the configuration |
adSpaceOwnerId |
xs:long |
ID of the ad space owner to whom this configuration is assigned |
networkProviderId |
xs:long |
ID of the Network Provider with which this configuration is associated |
minimumPrice |
xs:float |
Minimum auction price for ads created using this configuration; the currency unit is set by the System Administrator; range is 0 to 9999.999 |
channelType |
tns:channelType |
Type of channel: one of the following:
|
maxAdSize |
xs:int |
Maximum number of characters allowed in an ad; range is 0 to 2147483647 characters - limited by channel type |
adDelimitorPrefix |
xs:string |
String that sets off the top of the ad |
adDelimitorPostfix |
xs:string |
String that sets off the bottom of the ad |
shortCodes |
xs:string |
Array of short codes to be associated with ads created with this configuration |
applicationId |
xs:string |
Identifies the application for the configuration's message delivery system in a charging data record (CDR); must be unique within the Marketing and Advertising system |
msgServiceType |
tns:msgServiceTypeEnum |
Type of message service: one of the following:
|
ccFeatures |
feature and price |
List of premium features and pricing used in connection configuration including:
|
Table 3-3 describes the Bulk Messaging connection configuration data structure. This data structure describes configurations used in marketing campaigns.
Table 3-3 The BulkMsgCC Data Structure
Element Name | Type | Description |
---|---|---|
id |
xs:long |
Connection configuration ID assigned by the system |
name |
xs:string |
Name of the configuration |
adSpaceOwnerId |
xs:long |
ID of the ad space owner to whom this configuration is assigned. |
networkProviderId |
xs:long |
ID of the Network Provider with which this configuration is associated |
minimumPrice |
xs:float |
Minimum price for ads created using this configuration; the currency unit is set by the System Administrator; range is 0 to 9999.999 |
channelType |
tns:channelType |
Type of channel: one of the following:
|
thList |
tns:trafficHour |
List that sets the beginning and ending times for premium campaigns. Start time must be less than end time. See Table 3-4 for description of trafficHour data structure |
maxAdSize |
xs:int |
Maximum number of characters allowed in an ad; range is 0 to 2147483647 characters |
adDelimitorPrefix |
xs:string |
String that sets off the top of the ad |
adDelimitorPostfix |
xs:string |
String that sets off the bottom of the ad |
largeAccount |
xs:string |
Short code to be associated with marketing messages created with this configuration |
isPremium |
xs:boolean |
Premium marketing campaigns have more control over scheduling with a configurable start date and priority over non-premium in sending messages during peak traffic hour |
ccFeatures |
feature and price |
List of premium features and pricing used in connection configuration including:
|
Table 3-4 describes the Traffic Hour data structure. This data structure defines when a Bulk Service configuration is available for traffic.
Table 3-4 The TrafficHour Data Structure
Element Name | Type | Description |
---|---|---|
dayOfWeek |
tns:dayOfWeek |
Day of the week: one of the following:
|
startHour |
xs:byte |
Start hour |
endHour |
xs:byte |
End hour |
startMinute |
xs:byte |
Start minute |
endMinute |
xs:byte |
End minute |
Table 3-5 describes the Bulk Messaging Marketing Space data structure. This data structure describes campaign space used in marketing campaigns.
Table 3-5 The BulkMsgMarketingSpace Data Structure
Element Name | Type | Description |
---|---|---|
id |
xs:long |
ID of the Bulk Messaging Marketing Space assigned by the system |
name |
xs:string |
Name of the space |
adSpaceOwnerId |
xs:long |
ID of the ad space owner to whom this space belongs |
bulkCcEntityID |
xs:long |
ID of the connection configuration on which this marketing space is based |
description |
xs:string |
Short descriptive text identifying space |
endMarketTime |
xs:dateTime |
Date and time at which campaigns based on this space end. These values cannot overlap with those of any other of this ad space owner's marketing spaces. |
endServiceTime |
xs:dateTime |
Identical to endMarketTime |
minimumPrice |
xs:float |
Sets the price per ad to use this space. The currency unit is set by the System Administrator. Range is 0 to 9999.999 |
reason |
xs:string |
Explanation for STOPPED or REJECTED state. Null otherwise. |
startMarketTime |
xs:dateTime |
Date and time at which campaigns based on this space can begin. These values cannot overlap with those of any other of this ad space owner's marketing spaces |
startServiceTime |
xs:dateTime |
Identical to startMarketTime |
state |
tns:approvedEntityStateEnum |
State of the space: one of the following
|
minimumListSize |
xs:int |
Minimum number of destination addresses per list for this space |
Table 3-6 describes the Dynamic Ad Space data structure. This data structure describes campaign space used in marketing campaigns.
Table 3-6 The Dynamic Ad Space Data Structure
Element Name | Type | Description |
---|---|---|
id |
xs:long |
ID of the Dynamic Space assigned by the system |
name |
xs:string |
Name of the space |
adSpaceOwnerId |
xs:long |
ID of the ad space owner to whom this space belongs |
bulkCcEntityID |
xs:long |
ID of the connection configuration on which this marketing space is based |
description |
xs:string |
Short descriptive text identifying space |
endMarketTime |
xs:dateTime |
Date and time at which campaigns based on this space end. These values cannot overlap with those of any other of this ad space owner's marketing space. |
endServiceTime |
xs:dateTime |
Identical to endMarketTime |
minimumPrice |
xs:float |
Sets the price per ad to use this space. The currency unit is set by the System Administrator. Range is 0 to 9999.999 |
reason |
xs:string |
Explanation for STOPPED or REJECTED state. Null otherwise. |
startMarketTime |
xs:dateTime |
Date and time at which campaigns based on this space can begin. These values cannot overlap with those of any other of this ad space Owner's marketing spaces |
startServiceTime |
xs:dateTime |
Identical to startMarketTime |
state |
tns:approvedEntityStateEnum |
State of the space: one of the following
|
minimumListSize |
xs:int |
Minimum number of destination addresses per list for this space |
Table 3-7 describes the MsgService ad space data structure. This data structure describes campaign space used in advertising campaigns.
Table 3-7 The MsgServiceAdSpace Data Structure
Element Name | Type | Description |
---|---|---|
id |
xs:long |
ID of the Message Service ad space assigned by the system |
name |
xs:string |
Name of the space |
adSpaceOwnerId |
xs:long |
ID of the ad space owner to whom this space belongs |
bulkCcEntityID |
xs:long |
ID of the Connection Configuration on which this Ad space is based |
description |
xs:string |
Short descriptive text identifying space |
endMarketTime |
xs:dateTime |
Date and time at which bidding on this space ends |
endServiceTime |
xs:dateTime |
Date and time at which campaigns based on this space must end |
minimumPrice |
xs:float |
Sets the minimum bid per ad to use this space. The currency unit is set by the System Administrator. Range is 0 to 9999.999 |
reason |
xs:string |
Explanation for STOPPED or REJECTED state. Null otherwise. |
startMarketTime |
xs:dateTime |
Date and time at which bidding on this space begins |
startServiceTime |
xs:dateTime |
Date and time at which campaigns based on this space may start |
state |
tns:approvedEntityStateEnum |
State of the space: one of the following
|
Table 3-8 describes the Bulk Messaging Marketing campaign data structure. This data structure defines a marketing campaign.
Table 3-8 The BulkMsgMarketingCampaign Data Structure
Element Name | Type | Description |
---|---|---|
adContentId |
xs:long |
ID for the ad content assigned by the system |
adSpaceId |
xs:long |
ID for the Ad space assigned by the system |
advOwnerId |
xs:long |
ID for the advertiser who owns this campaign as assigned by the system |
manuallyStopped |
xs:boolean |
If true, the campaign was stopped manually by the owner |
messageLimit |
xs:int |
The maximum number of messages to be sent in the campaign |
modifiable |
xs:boolean |
Whether this campaign can be modified |
price |
xs:float |
The price per ad to use this space. The currency unit is set by the System Administrator. Range is 0 to 9999.999 |
reason |
xs:string |
Explanation for STOPPED or REJECTED state. Null otherwise. |
state |
tns:approvedEntityStateEnum |
State of the campaign: one of the following
|
startTime |
xs:dateTime |
Date and time the campaign starts |
subscrAddressListId |
xs:long |
ID of the Subscriber Address List assigned by the system. For marketing campaigns that use uploaded lists |
subscrCategories |
tns:subscriberCategory |
List of subscriber categories made available to Advertisers by the operator. For marketing campaigns that use categories. See Table 3-11 for more information. |
Table 3-9 describes the MsgService Ad Campaign data structure. This data structure defines an advertising campaign.
Table 3-9 The MsgServiceAdCampaign Data Structure
Element Name | Type | Description |
---|---|---|
adContentId |
xs:long |
ID for the ad content assigned by the system |
adSpaceId |
xs:long |
ID for the Ad space assigned by the system |
advOwnerId |
xs:long |
ID for the advertiser who owns this campaign as assigned by the system |
manuallyStopped |
xs:boolean |
If true, the campaign was stopped manually by the owner |
messageLimit |
xs:int |
The maximum number of messages to be sent in the campaign |
modifiable |
xs:boolean |
Whether this campaign can be modified |
price |
xs:float |
The price per ad to use this space. The currency unit is set by the System Administrator. Range is 0 to 9999.999 |
reason |
xs:string |
Explanation for STOPPED or REJECTED state. Null otherwise. |
state |
tns:approvedEntityStateEnum |
State of the campaign: one of the following
|
maxMessagesPerSub |
xs:int |
Maximum number of messages to be sent to an individual subscriber |
Table 3-10 describes the Dynamic Ad Campaign data structure. This data structure defines a dynamic campaign.
Table 3-10 The DynamicAdCampaign Data Structure
Element Name | Type | Description |
---|---|---|
adContentId |
xs:long |
ID for the ad content assigned by the system |
adSpaceId |
xs:long |
ID for the Ad space assigned by the system |
advOwnerId |
xs:long |
ID for the advertiser who owns this campaign as assigned by the system |
manuallyStopped |
xs:boolean |
If true, the campaign was stopped manually by the owner |
messageLimit |
xs:int |
The maximum number of messages to be sent in the campaign |
modifiable |
xs:boolean |
Whether this campaign can be modified |
price |
xs:float |
The price per ad to use this space. The currency unit is set by the System Administrator. Range is 0 to 9999.999 |
reason |
xs:string |
Explanation for STOPPED or REJECTED state. Null otherwise. |
state |
tns:approvedEntityStateEnum |
State of the campaign: one of the following
|
maxMessagesPerSub |
xs:int |
Maximum number of messages to be sent to an individual subscriber |
Table 3-11 describes the Subscriber Category data structure. This data structure defines the categories that an operator has made available to Advertisers to use in personalizing and targeting ads for marketing campaigns.
Table 3-12 describes the SMS Ad Content data structure. This data structure describes content to be delivered using the SMS channel.
Table 3-12 The SmsAdContent Data Structure
Element Name | Type | Description |
---|---|---|
id |
xs:long |
ID for the content assigned by the system |
name |
xs:string |
Name of the content |
advOwnerId |
xs:long |
ID for the advertiser who created this content |
textWithTokens |
xs:string |
Textual content of the ad, with tokens for personalization |
textWithoutTokens |
xs:string |
Textual content of the ad |
Table 3-13 describes the MMS Ad Content data structure. This data structure describes content to be delivered using the MMS channel.
Table 3-13 The MmsAdContent Data Structure
Element Name | Type | Description |
---|---|---|
id |
xs:long |
ID for the content assigned by the system |
name |
xs:string |
Name of the content |
advOwnerId |
xs:long |
ID for the advertiser who created this content |
textWithTokens |
xs:string |
Textual content of the ad, with tokens for personalization |
textWithoutTokens |
xs:string |
Textual content of the ad |
imageType |
tns:mmsPictureEnum |
Type of the image to be sent as content. One of the following:
|
subjectWithoutTokens |
xs:string |
Subject for the ad message |
Table 3-14 describes the Simple Html Snippet Ad Content data structure. This data structure describes the content to be delivered using the Simple Html Snippet channel.
Table 3-14 The SimpleHtmlSnippetAdContent Data Structure
Element Name | Type | Description |
---|---|---|
id |
xs:long |
ID for the content assigned by the system |
name |
xs:string |
Name of the content |
advOwnerId |
xs:long |
ID for the advertiser who created this content |
textWithTokens |
xs:string |
Textual content of the ad, with tokens for personalization |
textWithoutTokens |
xs:string |
Textual content of the ad |
activeLink |
xs:string |
Specifies embedded clickable link URL in banner |
Table 3-15 describes the Text Ad Content data structure. This data structure describes the content to be delivered using channels that support text ad content.
Table 3-15 The TextAdContent Data Structure
Element Name | Type | Description |
---|---|---|
id |
xs:long |
ID for the content assigned by the system |
name |
xs:string |
Name of the content |
advOwnerId |
xs:long |
ID for the advertiser who created this content |
textWithTokens |
xs:string |
Textual content of the ad, with tokens for personalization |
textWithoutTokens |
xs:string |
Textual content of the ad |
activeLink |
xs:string |
Specifies embedded clickable link URL in banner |
Table 3-16 describes the Url Ad Content data structure. This data structure describes the content to be delivered using channels that support url ad content.
Table 3-16 The UrlAdContent Data Structure
Element Name | Type | Description |
---|---|---|
id |
xs:long |
ID for the content assigned by the system |
name |
xs:string |
Name of the content |
advOwnerId |
xs:long |
ID for the advertiser who created this content |
textWithTokens |
xs:string |
Textual content of the ad, with tokens for personalization |
textWithoutTokens |
xs:string |
Textual content of the ad |
activeLink |
xs:string |
Specifies embedded clickable link URL in banner |
Table 3-17 describes the WAP Push Ad Content data structure. This data structure describes the content to be delivered using the WAP Push channel.
Table 3-17 The WapPushAdContent Data Structure
Element Name | Type | Description |
---|---|---|
id |
xs:long |
ID for the content assigned by the system |
name |
xs:string |
Name of the content |
advOwnerId |
xs:long |
ID for the advertiser who created this content |
textWithTokens |
xs:string |
Textual content of the ad, with tokens for personalization |
textWithoutTokens |
xs:string |
Textual content of the ad |
activeLink |
xs:string |
Specifies embedded clickable link URL in banner |
Table 3-18 describes the Subscriber Address List data structure. This data structure describes the subscriber address lists provided by an advertiser for marketing campaigns.
The connection configuration Manager Web service creates, deletes, and lists existing connection configurations.
The following describes the operations available in the connection configuration Manager Web service. Additional details can be found in the WSDL.
Deletes an existing connection configuration
Creates a connection configuration to be used by an external ad server
Table 3-20 Input Message Parameter: complexType - createAdServerCc
Element | Type | Description |
---|---|---|
NetworkProviderId |
xs:long |
Optional. ID of the Network Provider with which this configuration is associated. Default value is managedOrganizationId. |
Name |
xs:string |
Name of the configuration |
ChannelType |
tns:channelType |
Type of channel: one of the following:
|
AdSpaceOwnerId |
xs:long |
ID of the ad space owner to whom this configuration is assigned [optional - can be null] |
MinPrice |
xs:float |
Optional. Minimum auction price for ads created using this configuration; the currency unit is set by the System Administrator; range is 0 to 9999.999. Default value is 0. |
MaxAdSize |
xs:int |
Optional. Maximum number of characters allowed in an ad; range is 0 to 2147483647 characters - limited by channel type. Default value is 0. |
SpAppId |
xs:string |
Identifies application using the connection configuration |
DeliveryNotifications |
xs:boolean |
Optional. Determines if delivery notifications should be sent for activity. Default value is False. |
ccFeatures |
feature and price |
Optional. List of premium features and pricing used in connection configuration |
MaxAdsReturnedPerRequest |
xs:int |
Maximum number of ads returned per request for connection configuration |
createAdServerCcResponse
Table 3-21 Output Message Parameter: complexType - createAdServerCcResponse
Element | Type | Description |
---|---|---|
AdServerCc |
tns:msgServiceCc |
List of data structures described in Table 3-1 |
Creates a connection configuration to be used for advertising campaigns
Table 3-22 Input Message Parameter: complexType - createMsgServiceCc
Element | Type | Description |
---|---|---|
NetworkProviderId |
xs:long |
Optional. ID of the Network Provider with which this configuration is associated. Default value is managedOrganizationId. |
Name |
xs:string |
Name of the configuration |
TriggerType |
tns:triggerType |
Type of channel: one of the following:
|
ChannelType |
tns:channelType |
Type of channel: one of the following:
|
AdSpaceOwnerId |
xs:long |
ID of the ad space owner to whom this configuration is assigned |
MinPrice |
xs:float |
Optional. Minimum auction price for ads created using this configuration; the currency unit is set by the System Administrator; range is 0 to 9999.999. Default value is 0. |
MaxAdSize |
xs:int |
Optional. Maximum number of characters allowed in an ad; range is 0 to 2147483647 characters - limited by channel type. Default value is 0. |
AdDelimPrefix |
xs:string |
Optional. String that sets off the top of the ad. |
AdDelimPostfix |
xs:string |
Optional. String that sets off the bottom of the ad. |
MaxAdsReturnedPerRequest |
xs:int |
Maximum number of ads returned per request for connection configuration |
MsgServiceType |
tns:msgServiceTypeEnum |
Type of message service: one of the following:
|
ShortCodes |
xs:string |
Array of short codes to be associated with ads created with this configuration |
ApplicationId |
xs:string |
Identifies the application for the configuration's message delivery system in a charging data record (CDR); must be unique within the Marketing and Advertising system |
DeliveryNotifications |
xs:boolean |
Optional. If true, users can subscribe for notification that a message was delivered. Default value is False. |
ccFeatures |
feature and price |
Optional. List of premium features and pricing used in connection configuration |
createMsgServiceCcResponse
Table 3-23 Output Message Parameter: complexType - createMsgServiceCcResponse
Element | Type | Description |
---|---|---|
MsgServiceCc |
tns:msgServiceCc |
See Table 3-2 |
Creates a connection configuration to be used for marketing campaigns
Table 3-24 Input Message Parameter: complexType - createBulkMessagingCc
Element | Type | Description |
---|---|---|
NetworkProviderId |
xs:long |
Optional. ID of the Network Provider with which this configuration is associated. Default value is managedOrganizationId. |
Name |
xs:string |
Name of the configuration |
ChannelType |
tns:channelType |
Type of channel: one of the following:
|
TrafficHours |
tns:trafficHour |
See Table 3-4 |
AdSpaceOwnerId |
xs:long |
Optional. ID of the ad space owner to whom this configuration is assigned. |
MinPrice |
xs:float |
Optional. Minimum auction price for ads created using this configuration; the currency unit is set by the System Administrator; range is 0 to 9999.999. Default value is 0. |
MaxAdSize |
xs:int |
Optional. Maximum number of characters allowed in an ad; range is 0 to 2147483647 characters - limited by channel type. Default value is 0. |
AdDelimPrefix |
xs:string |
String that sets off the top of the ad. Deprecated. |
AdDelimPostfix |
xs:string |
String that sets off the bottom of the ad Deprectated. |
ShortCode |
xs:string |
Short code to be associated with ads created with this configuration |
Premium |
xs:boolean |
Premium marketing campaigns have more control over scheduling with a configurable start date and priority over non-premium in sending messages during peak traffic hour. Deprecated. |
DeliveryNotifications |
xs:boolean |
If true, users can subscribe for notification that a message was delivered |
ccFeatures |
feature and price |
Optional. List of premium features and pricing used in connection configuration. |
createBulkMessagingCcResponse
Table 3-25 Output Message Parameter: complexType - createBulkServiceCcResponse
Element | Type | Description |
---|---|---|
MsgServiceCc |
tns:bulkMsgCc |
See Table 3-2 |
Retrieves a list of current connection configurations for external ad server(s)
Table 3-26 Input Message Parameter: complexType - listMsgAdServerCc
Element | Type | Description |
---|---|---|
NetworkProviderId |
xs:long |
Optional. ID of the Network Provider with which these configurations are associated. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list of configurations where fetching should start. Default value is 0. |
MaxResult |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
ChannelType |
tns:channelType |
Optional. Type of channel: one of the following:
|
listMsgAdServerCcResponse
Table 3-27 Output Message Parameter: complexType - listMsgServiceCcResponse
Element | Type | Description |
---|---|---|
MsgServiceCcList |
tns:msgServiceCc |
List of data structures described in Table 3-2. |
Retrieves a list of current connection configurations for advertising campaigns
Table 3-28 Input Message Parameter: complexType - listMsgServiceCc
Element | Type | Description |
---|---|---|
NetworkProviderId |
xs:long |
Optional. ID of the Network Provider with which these configurations are associated. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list of configurations where fetching should start. Default value is 0. |
MaxResult |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
ChannelType |
tns:channelType |
Optional. Type of channel: one of the following:
|
listMsgServiceCcResponse
Table 3-29 Output Message Parameter: complexType - listMsgServiceCcResponse
Element | Type | Description |
---|---|---|
MsgServiceCcList |
tns:msgServiceCc |
List of data structures described in Table 3-2 |
Retrieves a list of current connection configurations for advertising campaigns
Table 3-30 Input Message Parameter: complexType - listBulkMsgCc
Element | Type | Description |
---|---|---|
NetworkProviderId |
xs:long |
Optional. ID of the Network Provider with which these configurations are associated. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list of configurations where fetching should start. Default value is 0. |
MaxResult |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
ChannelType |
tns:channelType |
Optional. Type of channel: one of the following:
[optional - can be null] |
listBulkMsgCcResponse
Table 3-31 Output Message Parameter: complexType - listBulkMsgCcResponse
Element | Type | Description |
---|---|---|
BulkMsgCcList |
tns:msgServiceCc |
List of data structures described in Table 3-3 |
The Campaign Space Manager Web service creates and manages campaign spaces; searches for connection configurations by ad space owner; approves or rejects campaigns; and retrieves campaigns by type.
The following describes the operations available in the Campaign Space Manager Web service. Full details can be found in the WSDL.
Creates a campaign space to be used for marketing campaigns
Table 3-32 Input Message Parameter: complexType - createBulkMsgMarketingSpace
Element | Type | Description |
---|---|---|
AdSpaceOwnerId |
xs:long |
Optional. ID of the ad space owner who is creating this space. Default value is managedOrganizationId. |
Name |
xs:string |
Name of the space |
Description |
xs:string |
Short textual description |
ImageType |
tns:imageTypeEnum |
Type of the image that is being provided as an icon for display in the GUI. One of the following:
|
Image |
xs:base64Binary |
Image for the icon |
ConnectionConfigurationId |
xs:long |
ID assigned by the system for the configuration on which this space is based |
StartTime |
xs:dateTime |
Date and time at which this space is available for campaigns |
EndTime |
xs:dateTime |
Date and time at which this space is no longer available for campaigns |
MinPrice |
xs:float |
Optional. The minimum price per ad for campaigns based on this space. Default value is 0. |
MinSubscriberListSize |
xs:int |
Optional. The minimum number of subscriber addresses for campaigns based on this space. Default value is 0. |
createBulkMsgMarketingSpaceResponse
Table 3-33 Output Message Parameter: complexType - createBulkMsgMarkegingSpaceResponse
Element | Type | Description |
---|---|---|
BulkMsgMarketingSpace |
tns:bulkMsgMarketingSpace |
See Table 3-5. |
Creates a campaign space to be used for dynamic campaigns
Table 3-34 Input Message Parameter: complexType - createDynamicAdSpace
Element | Type | Description |
---|---|---|
AdSpaceOwnerId |
xs:long |
Optional. ID of the ad space owner who is creating this space [optional - can be null] Default value is managedOrganizationId. |
ConnectionConfigurationId |
xs:long |
ID assigned by the system for the configuration on which this space is based |
Name |
xs:string |
Name of the space |
Description |
xs:string |
Short textual description |
ImageType |
tns:imageTypeEnum |
Type of the image that is being provided as an icon for display in the GUI. One of the following:
|
Image |
xs:base64Binary |
Image for the icon |
StartServiceTime |
xs:dateTime |
Date and time at which this space is available for campaigns |
EndServiceTime |
xs:dateTime |
Date and time at which this space is no longer available for campaigns |
MinPrice |
xs:float |
The minimum price per ad for campaigns based on this space |
DynamicSpaceFilters |
ns:string, string |
Optional. Filters to be used in the dynamic space. |
DynamicSpaceCategories |
ns:string, string |
Optional. Demographic categories fro the subscriber schema to be included in the ad space. |
createDynamicAdSpaceResponse
Table 3-35 Output Message Parameter: complexType - createDynamicAdSpaceResponse
Element | Type | Description |
---|---|---|
BulkMsgMarketingSpace |
tns:bulkMsgMarketingSpace |
See Table 3-5. |
Creates a campaign space to be used for advertising campaigns
Table 3-36 Input Message Parameter: complexType - createMsgServiceAdSpace
Element | Type | Description |
---|---|---|
AdSpaceOwnerId |
xs:long |
Optional. ID of the ad space owner who is creating this space. Default value is managedOrganizationId. |
Name |
xs:string |
Name of the space |
Description |
xs:string |
Short textual description |
ImageType |
tns:imageTypeEnum |
Type of the image that is being provided as an icon for display in the GUI. One of the following:
|
Image |
xs:base64Binary |
Image for the icon |
ConnectionConfigurationId |
xs:long |
ID assigned by the system for the configuration on which this space is based |
StartMarketTime |
xs:dateTime |
Date and time at which this space is available for auction |
EndMarketTime |
xs:dateTime |
Date and time at which this space is no longer available for auction |
StartServiceTime |
xs:dateTime |
Date and time at which this space is available for campaigns |
EndServiceTime |
xs:dateTime |
Date and time at which this space is no longer available for campaigns |
MinPrice |
xs:float |
Optional. The minimum price per ad for campaigns based on this space. Default value is 0. |
spaceType |
tns:adSpaceTypeEnum |
|
pricePerCampaign |
xs:float |
createMsgServiceAdSpaceResponse
Table 3-37 Output Message Parameter: complexType - createMsgServiceAdSpaceResponse
Element | Type | Description |
---|---|---|
MsgServiceAdSapce |
tns:msgServiceAdSpace |
See Table 3-7. |
Deletes an existing campaign space
Fetches a list of an ad space owner's marketing spaces
Table 3-39 Input Message Parameter: complexType - listBulkMsgMarketingSpaceByAdSpaceOwner
Element | Type | Description |
---|---|---|
AdSpaceOwnerId |
xs:long |
Optional. ID of the ad space owner whose marketing space you wish to fetch. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list where fetching should start. Default value is 0. |
MaxResults |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
listBulkMsgMarketingSpaceByAdSpaceOwnerResponse
Table 3-40 Output Message Parameter: complexType - listBulkMsgMarketingSpaceByAdSpaceOwnerResponse
Element | Type | Description |
---|---|---|
BulkMsgMarketingSpaceList |
tns:bulkMsgMarketingSpace |
List of data structures described in Table 3-5. |
Fetches a list of an ad space owner's Ad spaces
Table 3-41 Input Message Parameter: complexType - listMsgServiceAdSpaceByAdSpaceOwner
Element | Type | Description |
---|---|---|
AdSpaceOwnerId |
xs:long |
Optional. ID of the ad space owner whose advertising space you wish to fetch. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list where fetching should start. Default value is 0. |
MaxResults |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
listMsgServiceAdSpaceByAdSpaceOwnerResponse
Table 3-42 Output Message Parameter: complexType - listMsgServiceAdSpaceByAdSpaceOwnerResponse
Element | Type | Description |
---|---|---|
MsgServiceAdpaceList |
tns:msgServiceAdSpace |
List of data structures described in Table 3-7. |
Fetches a list of the Bulk Msg connection configurations assigned to a particular ad space owner
Table 3-43 Input Message Parameter: complexType - listBulkMsgCcByAdSpaceOwner
Element | Type | Description |
---|---|---|
AdSpaceOwnerId |
xs:long |
Optional. ID of the ad space owner whose BulkMsg connection configurations you wish to fetch. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list where fetching should start. Default value is 0. |
MaxResults |
xs:int |
Optional. The maximum number of results to return. Defualt value is 0. |
ChannelType |
tns:channelType |
Optional. Type of channel: one of the following:
|
listBulkMsgCcByAdSpaceOwnerResponse
Table 3-44 Output Message Parameter: complexType - listBulkMsgCcByAdSpaceOwnerResponse
Element | Type | Description |
---|---|---|
BulkCcList |
tnsbulkMsgCc |
List of data structures described in Table 3-3. |
Fetches a list of the MsgService connection configurations assigned to a particular ad space owner
Table 3-45 Input Message Parameter: complexType - listMsgServiceCcByAdSpaceOwner
Element | Type | Description |
---|---|---|
AdSpaceOwnerId |
xs:long |
Optional. ID of the ad space owner whose MsgService connection configurations you wish to fetch. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list where fetching should start. Default value is 0. |
MaxResults |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
ChannelType |
tns:channelType |
Optional. Type of channel: one of the following
|
listMsgServiceCcByAdSpaceOwnerResponse
Table 3-46 Output Message Parameter: complexType - listMsgServiceCcByAdSpaceOwnerResponse
Element | Type | Description |
---|---|---|
MsgServiceAdspaceList |
tns:msgServiceAdSpace |
List of data structures described in Table 3-7. |
Fetches a list of the dynamic spaces assigned to a particular ad space owner
Table 3-47 Input Message Parameter: complexType - listDynamicSpaceByAdSpaceOwner
Element | Type | Description |
---|---|---|
AdSpaceOwnerId |
xs:long |
Optional. ID of the ad space owner whose MsgService connection configurations you wish to fetch. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list where fetching should start. Default value is 0. |
MaxResults |
xs:int |
Optional. The maximum number of results to return. Default vaule is 0. |
listDynamicSpaceByAdSpaceOwnerResponse
Table 3-48 Output Message Parameter: complexType - listDynamicSpaceByAdSpaceOwnerResponse
Element | Type | Description |
---|---|---|
DynamicAdspaceList |
tns:DynamicAdSpace |
List of data structures described in Table 3-6. |
Approves a campaign by ID
Table 3-49 Input Message Parameter: complexType - approveCampaign
Element | Type | Description |
---|---|---|
Id |
xs:long |
ID of the campaign assigned by the system. |
approveCampaignResponse
Rejects a campaign by ID
Table 3-51 Input Message Parameter: complexType - rejectCampaign
Element | Type | Description |
---|---|---|
Id |
xs:long |
ID of the campaign assigned by the system. |
Reason |
xs:string |
A brief description of why the campaign was rejected. |
rejectCampaignResponse
Fetches a list of current BulkMsg marketing campaigns
Table 3-53 Input Message Parameter: complexType - listBulkMsgMarketingCampaigns
Element | Type | Description |
---|---|---|
CampaignSpaceId |
xs:long |
ID of the campaign space assigned by the system. |
FirstResult |
xs:int |
Optional. The position in the list where fetching should start. Default value is 0. |
MaxResults |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
listBulkMsgMarketingCampaignsResponse
Table 3-54 Output Message Parameter: complexType - listBulkMsgMarketingCampaignsResponse
Element | Type | Description |
---|---|---|
BulkMsgMarketingCampaignList |
tns:bulkMsgMarketingCampaign |
List of data structures described in Table 3-8. |
Fetches a list of current Dynamic advertising campaigns
Table 3-55 Input Message Parameter: complexType - listDynamicAdCampaigns
Element | Type | Description |
---|---|---|
CampaignSpaceId |
xs:long |
ID of the campaign space assigned by the system. |
FirstResult |
xs:int |
The position in the list where fetching should start. |
MaxResults |
xs:int |
The maximum number of results to return. Do not set this to zero. |
listMsgServiceAdCampaignsResponse
Table 3-56 Output Message Parameter: complexType - listDynamicAdCampaignsResponse
Element | Type | Description |
---|---|---|
MsgServiceAdCampaignList |
tns:msgServiceAdCampaign |
List of data structures described in Table 3-9. |
Fetches a list of current MsgService advertising campaigns
Table 3-57 Input Message Parameter: complexType - listMsgServiceAdCampaigns
Element | Type | Description |
---|---|---|
CampaignSpaceId |
xs:long |
ID of the campaign space assigned by the system. |
FirstResult |
xs:int |
Optional. The position in the list where fetching should start. Default value is 0. |
MaxResults |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
listMsgServiceAdCampaignsResponse
Table 3-58 Output Message Parameter: complexType - listMsgServiceAdCampaignsResponse
Element | Type | Description |
---|---|---|
MsgServiceAdCampaignList |
tns:msgServiceAdCampaign |
List of data structures described in Table 3-9. |
The Campaign Space Approval Manager Web service approves or rejects campaign space.
The following describes the operations available in the Campaign Space Approval Manager Web service. Full details can be found in the WSDL.
Approves a campaign space
Table 3-59 Input Message Parameter: complexType - approveCampaignSpace
Element | Type | Description |
---|---|---|
CampaignSpaceId |
xs:long |
ID of the campaign space assigned by the system |
approveCampaignSpaceResponse
Rejects a campaign space
Table 3-61 Input Message Parameter: complexType - rejectCampaignSpace
Element | Type | Description |
---|---|---|
CampaignSpaceId |
xs:long |
ID of the campaign space assigned by the system. |
Reason |
xs:string |
A brief description of why the space was rejected. |
rejectCampaignSpaceResponse
The Campaign Manager Web service creates, deletes, and lists ad content; creates, deletes, and lists Subscriber Lists and Categories; creates, deletes, and stops campaigns; and retrieves current campaigns.
The following describes the operations available in the Campaign Manager Web service. Full details can be found in the WSDL.
Creates ad content for the SMS Channel
Table 3-63 Input Message Parameter: complexType - createSmsAdContent
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser creating this content. Default value is managedOrganizationId. |
Name |
xs:string |
The name of this content. |
TextWithTokens |
xs:string |
The textual content of the ad, with tokens for personalization. |
TextWithoutTokens |
xs:string |
Optional. The textual content of the ad. |
createSmsAdContentResponse
Table 3-64 Output Message Parameter: complexType - createSmsAdContentResponse
Element | Type | Description |
---|---|---|
SmsAdContent |
tns:SmsAdContent |
See Table 3-12. |
Creates ad content for the MMS Channel
Table 3-65 Input Message Parameter: complexType - createMmsAdContent
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser creating this content. Default value is managedOrganizationId. |
Name |
xs:string |
The name of this content |
SubjectWithoutTokens |
xs:string |
Subject of the ad message |
TextWithTokens |
xs:string |
Optional. The textual content of the ad, with tokens for personalization. |
TextWithoutTokens |
xs:string |
Optional. The textual content of the ad. |
MmsMediaList |
ns: type and values |
Optional. Specifies the type and value of media being used in the MMS message. |
createMmsAdContentResponse
Table 3-66 Output Message Parameter: complexType - createMmsAdContentResponse
Element | Type | Description |
---|---|---|
MmsAdContent |
tns:mmsAdContent |
See Table 3-13. |
Creates ad content for the Simple Html Snippet Channel
Table 3-67 Input Message Parameter: complexType - createSimpleHtmlSnippetAdContent
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser creating this content. Default value is managedOrganizationId. |
Name |
xs:string |
The name of this content. |
ActiveLink |
xs:string |
Specifies embedded clickable link URL in banner |
BannerType |
xs:string |
The aspect ratio of the banner ad |
BannerList |
xs:string |
List of banners uploaded by advertiser |
BannerDefault |
xs:int |
Default bannerID to use from Banner list |
createSimpleHtmlSnippetAdContentResponse
Table 3-68 Output Message Parameter: complexType - createSimpleHtmlSnippetAdContentResponse
Element | Type | Description |
---|---|---|
SimpleHtmlSnippetAdContent |
tns:SimpleHtmlSnippetAdContent |
See Table 3-14. |
Creates ad content for the channels supporting text format
Table 3-69 Input Message Parameter: complexType - createTextAdContent
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser creating this content. Default value is managedOrganizationId. |
Name |
xs:string |
The name of this content. |
TextWithTokens |
xs:string |
The textual content of the ad, with tokens for personalization. |
TextWithoutTokens |
xs:string |
Optional. The textual content of the ad. |
createTextAdContentResponse
Table 3-70 Output Message Parameter: complexType - createTextAdContentResponse
Element | Type | Description |
---|---|---|
TextAdContent |
tns:TextContent |
See Table 3-15 |
Creates ad content for the channels supporting Url format
Table 3-71 Input Message Parameter: complexType - createUrlAdContent
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser creating this content.] Default value is managedOrganizationId. |
Name |
xs:string |
The name of this content. |
URL |
xs:string |
Specifies embedded clickable link URL in banner |
createUrlAdContentResponse
Table 3-72 Output Message Parameter: complexType - createUrlAdContentResponse
Element | Type | Description |
---|---|---|
UrlAdContent |
tns:UrlAdContent |
See Table 3-16. |
Creates ad content for the WAP Push Channel
Table 3-73 Input Message Parameter: complexType - createWapPushAdContent
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser creating this content. Default value is managedOrganizationId. |
Name |
xs:string |
The name of this content |
ActiveLink |
xs:string |
Specifies embedded clickable link URL in banner |
TextWithTokens |
xs:string |
Optional. The textual content of the ad, with tokens for personalization. |
TextWithoutTokens |
xs:string |
Optional. The textual content of the ad. |
createWapPushAdContentResponse
Table 3-74 Output Message Parameter: complexType - createWapPushAdContentResponse
Element | Type | Description |
---|---|---|
WapPushAdContent |
tns:wapPushAdContent |
See Table 3-17 |
Deletes an existing ad content
Fetches a list of existing SMS Ad Contents
Table 3-76 Input Message Parameter: complexType - listSmsAdContents
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser whose contents are being fetched. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list of Ad Contents where fetching should start. Default value is 0. |
MaxResult |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
listSmsAdContentsResponse
Table 3-77 Output Message Parameter: complexTy[e - listSmsAdContentsResponse
Element | Type | Description |
---|---|---|
Ad Content |
tns:smsAdContent |
List of data structures described in Table 3-12. |
Fetches a list of existing MMS Ad Contents
Table 3-78 Input Message Parameter: complexType - listMmsAdContents
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser whose contents are being fetched. Default value is managedOrganizationId. |
FirstResult |
xs:int |
The position in the list of Ad Contents where fetching should start |
MaxResult |
xs:int |
The maximum number of results to return. Do not set this to zero. |
listMmsAdContentsResponse
Table 3-79 Output Message Parameter: complexType - listMmsAdContentsResponse
Element | Type | Description |
---|---|---|
AdContent |
tns:mmsAdContent |
List of data structures described in Table 3-13. |
Fetches a list of existing Simple Html Snippet Ad Contents
Table 3-80 Input Message Parameter: complexType - listSimpleHtmlSnippetAdContents
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser whose contents are being fetched. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list of Ad Contents where fetching should start. Default value is 0. |
MaxResult |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
listSimpleHtmlSnippetAdContentsResponse
Table 3-81 Output Message Parameter: complexType - listSimpleHtmlSnippetAdContentsResponse
Element | Type | Description |
---|---|---|
Ad Content |
tns:simpleHtmlSnippetAdContent |
List of data structures described in Table 3-14 |
Fetches a list of existing Text Ad Contents
Table 3-82 Input Message Parameter: complexType - listTextAdContents
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser whose contents are being fetched. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list of Ad Contents where fetching should start. Default value is 0. |
MaxResult |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
listTextAdContentsResponse
Table 3-83 Output Message Parameter: complexType - listTextAdContentsResponse
Element | Type | Description |
---|---|---|
Ad Content |
tns:textAdContent |
List of data structures described in Table 3-15. |
Fetches a list of existing Url Ad Contents
Table 3-84 Input Message Parameter: complexType - listUrlAdContents
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser whose contents are being fetched. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list of Ad Contents where fetching should start. Default value is 0. |
MaxResult |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
listUrlAdContentsResponse
Table 3-85 Output Message Parameter: complexType - listUrlAdContentsResponse
Element | Type | Description |
---|---|---|
Ad Content |
tns:urlAdContent |
List of data structures described in Table 3-16 |
Fetches a list of existing WAP Push Ad Contents
Table 3-86 Input Message Parameter: complexType - listWapPushAdContents
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser whose contents are being fetched. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list of Ad Contents where fetching should start. Default value is 0. |
MaxResult |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
listWapPushAdContentsResponse
Table 3-87 Output Message Parameter: complexType - listWapPushAdContentsResponse
Element | Type | Description |
---|---|---|
Ad Content |
tns:wapPushAdContent |
List of data structures described in Table 3-17 |
Uploads a Subscriber Address List for marketing campaigns
Table 3-88 Input Message Parameter: complexType - createSubscriberAddressList
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser who is providing this list for its use. Default value is managedOrganizationId. |
Name |
xs:string |
Name for the list |
SubscriberList |
xs:base64Binary |
The list, in.csv format or EOL delimited |
createSubscriberAddressListResponse
Table 3-89 Output Message Parameter: complexType - createSubscriberAddressListResponse
Element | Type | Description |
---|---|---|
SubscriberAddressList |
tns:subscriberAddressList |
List of data structures described in Table 3-18. |
Fetches a list of Subscriber Address Lists
Table 3-90 Input Message Parameter: complexType - listSubscriberAddressLists
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser whose lists are being fetched. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list of Subscriber Lists where fetching should start. Default value is 0. |
MaxResult |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
listSubscriberAddressListsResponse
Table 3-91 Output Message Parameter: complexType - listSubscriberAddressListsResponse
Element | Type | Description |
---|---|---|
SubscriberAddressLists |
tns:subscriberAddressList |
List of data structures described in Table 3-18. |
Deletes a Subscriber Address List
Creates a new subscriber category
Table 3-93 Input Message Parameter: complexType - createCategory
Element | Type | Description |
---|---|---|
CategoryTypeName |
xs:string |
Always true |
isStatisticsCategory |
xs:boolean |
|
CategoryValueType |
ns |
Range or enumeration |
CategoryValue |
ns |
Operator attributes to describe category range |
createCategoryResponse
Table 3-94 Output Message Parameter: complexType - createCategoryResponse
Element | Type | Description |
---|---|---|
Category |
tns:subscriberCategory |
Data structures described in Table 3-11 |
Fetches a list of the Subscriber Categories currently being offered
Table 3-95 Input Message Parameter: complexType - listCategories
Element | Type | Description |
---|---|---|
isStatisticsCategory |
xs:boolean |
Always true |
listCategoriesResponse
Table 3-96 Output Message Parameter: complexType - listCategoriesResponse
Element | Type | Description |
---|---|---|
CategoryList |
tns:subscriberCategory |
List of data structures described in Table 3-11 |
Creates an advertising campaign
Table 3-97 Input Message Parameter: complexType - createMsgServiceAdCampaign
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser creating the campaign. Default value is managedOrganizationId. |
Name |
xs:string |
Name for the campaign |
MsgServiceAdSpaceId |
xs:long |
ID of the Ad space on which this campaign is based |
AdContentId |
xs:long |
ID of the content which is to be used |
Price |
xs:float |
Optional. The bid price for this Ad space; the currency unit is set by the System Administrator; range is 0 to 9999.999. Defualt value is 0.0. |
MessageLimit |
xs:int |
Optional. The maximum number of messages for this campaign. Default value is 0. |
Modifiable |
xs:boolean |
Optional. Whether this campaign can be modified. Default value is False. |
MaxMsgsPerSubscriber |
xs:int |
Optional. The maximum number of messages an individual subscriber can receive. Default value is 0. |
campaignFeatures |
ns |
Optional. List of optional/premium features to include in the campaign including:
|
createMsgServiceAdCampaignResponse
Table 3-98 Output Message Parameter: complexType - createMsgServiceAdCampaignResponse
Element | Type | Description |
---|---|---|
MsgServiceAdCampaign |
tns:msgServiceAdCampaign |
See Table 3-9 |
Creates a dynamic advertising campaign
Table 3-99 Input Message Parameter: complexType - createDynamicAdCampaign
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser creating the campaign. Default value is managedOrganizationId. |
Name |
xs:string |
Name for the campaign |
AdContentId |
xs:long |
ID of the content which is to be used |
Price |
xs:float |
Optional. The bid price for this Ad space; the currency unit is set by the System Administrator; range is 0 to 9999.999. Default value is 0.0. |
MessageLimit |
xs:int |
Optional. The maximum number of messages for this campaign. Default value is 0. |
Modifiable |
xs:boolean |
Optional. Whether this campaign can be modified. Default value is false. |
ManuallyStopped |
xs:boolean |
Optional. Whether the campaign can be manually stopped. Default value is false. |
MaxMsgsPerSubscriber |
xs:int |
Optional. The maximum number of messages an individual subscriber can receive. Default value is 0. |
StartTime |
xs:dateTime |
Date and time at which this campaign starts |
EndTime |
xs:dateTime |
Date and time at which this campaign ends |
DynamicCampaignCategories |
ns: name and value |
Optional. Categories to include in dynamic campaign. |
campaignFeature |
tns:campaignFeatures |
Optional. List of optional/premium features to include in the campaign including:
|
createDynamicAdCampaignResponse
Table 3-100 Output Message Parameter: complexType - createDynamicCampaignResponse
Element | Type | Description |
---|---|---|
MsgServiceAdCampaign |
tns:msgServiceAdCampaign |
See Table 3-9. |
Creates a marketing campaign using an address list
Table 3-101 Input Message Parameter: complexType - createBulkMsgMarketingCampaignWithAddressList
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser creating the campaign. Default value is managedOrganizationId. |
Name |
xs:string |
Name for the campaign |
CampaignSpaceId |
xs:long |
ID of the marketing space on which this campaign is based |
AdContentId |
xs:long |
ID of the content which is to be used |
Price |
xs:float |
Optional. The price per ad to use this space; the currency unit is set by the System Administrator; range is 0 to 9999.999. Default value is 0.0. |
MessageLimit |
xs:int |
Optional. The maximum number of messages for this campaign. Default value is 0. |
Modifiable |
xs:boolean |
Optional. Whether this campaign can be modified. Default value is 0. |
SubscriberListId |
xs:long |
ID of the uploaded subscriber address list to be used |
StartTime |
xs:dateTime |
Date and time at which this campaign starts |
EndTime |
xs:dateTime |
Date and time at which this campaign ends |
campaignFeature |
tns:campaignFeatures |
Optional. List of optional/premium features to include in the campaign including:
|
createBulkMsgMarketingCampaignWithAddressListResponse
Table 3-102 Output Message Parameter: complexType - createBulkMsgMarketingCampaingWithAddressListResponse
Element | Type | Description |
---|---|---|
BulkMsgMarketingCampaign |
tns:BulkMsgMarketingCampaign |
See Table 3-8. |
Creates a marketing campaign using subscriber categories
Table 3-103 Input Message Parameter: complexType - createBulkMsgMarketingCampaignWithSelectionCriteria
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser creating the campaign. Default value is managedOrganizationId. |
Name |
xs:string |
Name for the campaign |
CampaignSpaceId |
xs:long |
ID of the marketing space on which this campaign is based |
AdContentId |
xs:long |
ID of the content which is to be used |
Price |
xs:float |
Optional. The price per ad to use this space; the currency unit is set by the System Administrator; range is 0 to 9999.999. Default value is 0.0. |
MessageLimit |
xs:int |
Optional. The maximum number of messages for this campaign. Default value is 0. |
Modifiable |
xs:boolean |
Optional. Whether this campaign can be modified. Default value is False. |
SubscriberCategories |
tns:subscriberCategories |
Optional. See Table 3-11 |
StartTime |
xs:dateTime |
Date and time at which this campaign starts |
EndTime |
xs:dateTime |
Date and time at which this campaign ends |
campaignFeature |
tns:campaignFeatures |
Optional. List of optional/premium features to include in the campaign including:
|
createBulkMsgMarketingCampaignWithSelectionCriteriaResponse
Table 3-104 Output Message Parameter: complexType - createBulkMsgMarketingCampaignWithSelectionCriteriaResponse
Element | Type | Description |
---|---|---|
BulkMsgMarketingCampaign |
tns:BulkMsgMarketingCampaign |
See Table 3-8 |
Stops a campaign
Deletes a campaign
Fetches BulkMsg marketing campaigns by the advertiser that created them
Table 3-107 Input Message Parameter: complexType - listBulkMsgMarketingCampaignsByAdv
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser that created the campaigns. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list of campaigns where fetching should start. Default value is 0. |
MaxResult |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
ApprovedState |
tns:approvedEntityStateEnum |
State of the campaign: one of the following
[optional - can be null] |
listBulkMsgMarketingCampaignsByAdvResponse
Table 3-108 Output Message Parameter: complexType - listBulkMsgMarketingCampaignsByAdvResponse
Element | Type | Description |
---|---|---|
BulkMsgMarketingCampaignList |
tns:bulkMsgMarketingAdCampaign |
List of data structures described in Table 3-8 |
Fetches MsgService advertising campaigns by the advertiser that created them
Table 3-109 Input Message Parameter: complexType - listMsgServiceAdCampaignsByAdv
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser that created the campaigns. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list of campaigns where fetching should start. Default value is 0. |
MaxResult |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
ApprovedState |
tns:approvedEntityStateEnum |
Optional. State of the campaign: one of the following
Default value is all non-deleted states. |
listMsgServiceAdCampaignsByAdvResponse
Table 3-110 Output Message Parameter: complexType - listMsgServiceAdCampaignsByAdvResponse
Element | Type | Description |
---|---|---|
MsgServiceAdCampaignList |
tns:msgServiceAdCampaign |
List of data structures described in Table 3-9 |
Fetches dynamic campaigns by the advertiser that created them
Table 3-111 Input Message Parameter: complexType - listDynamicAdCampaignsByAdv
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser that created the campaigns. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list of campaigns where fetching should start. Default value is 0. |
MaxResult |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
ApprovedState |
tns:approvedEntityStateEnum |
Optional. State of the campaign: one of the following
Default value is all non-deleted states. |
listDynamicAdCampaignsByAdvResponse
Table 3-112 Output Message Parameter: complexType - listDynamicAdCampaignsByAdvResponse
Element | Type | Description |
---|---|---|
DynamicAdCampaignList |
tns:msgServiceAdCampaign |
List of data structures described in Table 3-9 |
Fetches a specific BulkMsg marketing campaign
Table 3-113 Input Message Parameter: complexType - getBulkMsgMarketingCampaign
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser that created the campaign. Default value is managedOrganizationId. |
Id |
xs:long |
ID of the campaign assigned by the system. |
getBulkMsgMarketingCampaignResponse
Table 3-114 Output Message Parameter: complexType - getBulkMsgMarketingCampaignResponse
Element | Type | Description |
---|---|---|
return |
tns:bulkMsgMarketingCampaign |
See Table 3-8 |
Fetches a specific dynamic campaign
Table 3-115 Input Message Parameter: complexType - getDynamicCampaign
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser that created the campaign. Default value is managedOrganizationId. |
Id |
xs:long |
ID of the campaign assigned by the system. |
getDynamicCampaignResponse
Table 3-116 Output Message Parameter: complexType - getDynamicCampaignResponse
Element | Type | Description |
---|---|---|
return |
tns:bulkDynamicCampaign |
See Table 3-10. |
Fetches a specific Msg Service ad campaign
Table 3-117 Input Message Parameter: complexType - getMsgServiceAdCampaign
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser that created the campaign. Default value is managedOrganizationId. |
Id |
xs:long |
ID of the campaign assigned by the system |
getMsgServiceAdCampaignResponse
Table 3-118 Output Message Parameter: complexType - getMsgServiceAdCampaignResponse
Element | Type | Description |
---|---|---|
return |
tns:MsgServiceAdCampaign |
See Table 3-9 |
Fetches Bulk Messaging marketing space by the advertiser that used them to create marketing campaigns
Table 3-119 Input Message Parameter: complexType - listBulkMsgMarketingSpacesByAdv
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser whose use of BulkMsg marketing space is being queried. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list of this advertiser's spaces where fetching should start. Default value is 0. |
MaxResult |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
listBulkMsgMarketingSpacesByAdvResponse
Table 3-120 Output Message Parameter: complexType - listBulkMsgMarketingSpacesByAdvResponse
Element | Type | Description |
---|---|---|
BulkMsgMarketingSpaceLis |
tns:bulkMsgMarketingSpace |
List of data structures described in Table 3-5 |
Fetches MsgService Ad space by the advertiser that used them to create advertising campaigns
Table 3-121 Input Message Parameter: complexType - listMsgServiceAdSpaceByAdv
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser whose use of MsgService Ad space is being queried. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list of this advertiser's spaces where fetching should start. Default value is 0. |
MaxResult |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
listMsgServiceAdSpaceByAdvResponse
Table 3-122 Output Message Parameter: complexType - listMsgServiceAdSpaceByAdvResponse
Element | Type | Description |
---|---|---|
MsgServiceAdSpaceLis |
tns:msgServiceAdSpace |
List of data structures described in Table 3-7 |
Fetches DynamicAd space by the advertiser that used them to create advertising campaigns
Table 3-123 Input Message Parameter: complexType - listDynamicAdSpaceByAdv
Element | Type | Description |
---|---|---|
AdvertiserId |
xs:long |
Optional. ID of the advertiser whose use ofDynamic Ad space is being queried. Default value is managedOrganizationId. |
FirstResult |
xs:int |
Optional. The position in the list of this advertiser's spaces where fetching should start. Default value is 0. |
MaxResult |
xs:int |
Optional. The maximum number of results to return. Default value is 0. |
listDynamicAdSpaceByAdvResponse
Table 3-124 Output Message Parameter: complexType - listDynamicAdSpaceByAdvResponse
Element | Type | Description |
---|---|---|
MsgServiceAdSpaceLis |
tns:msgServiceAdSpace |
List of data structures described in Table 3-7 |