CSFLoadAdvertisements
Use this component with the CacheManager object to load advertising content from a database.
.gif "Ee825397.note(en-US,CS.10).gif")
Note
- Although the CSFLoadAdvertisements component implements two pipeline component interfaces (IPipelineComponent and IPipelineComponentAdmin), it is not a pipeline component, it does not appear in the Pipeline Editor, and it cannot be used or configured from the Editor.
Configuration Values
None.
Values Read
None.
Values Written
None.
Remarks
You can use the CSFLoadAdvertisements component with the CacheManager object to load advertising content for use later in your application.
When executed by the CacheManager object, the CSFLoadAdvertisements component uses two pipeline dictionaries (Order and Context) to determine how to run and how to return information to the CacheManager object.
The CSFLoadAdvertisements component first opens a connection to the database and gets the list of ads. The component uses a ContentListFactory object to populate a ContentList object with the data. The component then breaks the retrieved data into templates, target groups, and page groups.
Columns in the ContentList
The following table describes the columns in the ContentList object returned by the CSFLoadAdvertisements component. Column names appear in alphabetical order.
| Column Name | Type | Flags |
| ad_type | short (CLCOL_I2) | 1 (CLCOL_READONLY) |
| ad_weight | int (CLCOL_I4) | 1 (CLCOL_READONLY) |
| campaign_id | int (CLCOL_I4) | 1 (CLCOL_READONLY) |
| customer_id | int (CLCOL_I4) | 1 (CLCOL_READONLY) |
| date_end | date/time (CLCOL_DATE) | 1 (CLCOL_READONLY) |
| date_start | date/time (CLCOL_DATE) | 1 (CLCOL_READONLY) |
| days_of_week | short (CLCOL_I2) | 1 (CLCOL_READONLY) |
| eff_date_start | date/time (CLCOL_DATE) | 1 (CLCOL_READONLY) |
| event_name | String (CLCOL_STRING) | 1 (CLCOL_READONLY) |
| events_scheduled | int (CLCOL_I4) | 1 (CLCOL_READONLY) |
| events_served | int (CLCOL_I4) | 1 (CLCOL_READONLY) |
| exposure_limit | int (CLCOL_I4) | 1 (CLCOL_READONLY) |
| height | short (CLCOL_I2) | 1 (CLCOL_READONLY) |
| industry | String (CLCOL_STRING) | 1 (CLCOL_READONLY) |
| invalid_nod | Boolean (CLCOL_BOOL) | 0 (DEFAULT) |
| item_id | int (CLCOL_I4) | 1 (CLCOL_READONLY) |
| name | String (CLCOL_STRING) | 1 (CLCOL_READONLY) |
| need_of_delivery | real (CLCOL_R4) | 0 (DEFAULT) |
| prev_events_served | int (CLCOL_I4) | 1 (CLCOL_READONLY) |
| score | real (CLCOL_R4) | 6 (CLCOL_PRIVATE | CLCOL_SCORE_COLUMN) |
| size | String (CLCOL_STRING) | 1 (CLCOL_READONLY) |
| target_groups | SafeArray (CLCOL_VARIANTARRAY) | 1 (CLCOL_READONLY) |
| template | String (CLCOL_STRING) | 1 (CLCOL_READONLY) |
| time_of_day_end | short (CLCOL_I2) | 1 (CLCOL_READONLY) |
| time_of_day_start | short (CLCOL_I2) | 1 (CLCOL_READONLY) |
| values | IDispatch (CLCOL_DISPATCH) | 1 (CLCOL_READONLY) |
| width | short (CLCOL_I2) | 1 (CLCOL_READONLY) |
Abbreviations in the table above are enumerated values for the ContentList object. For more information, see the Remarks section of ContentListSchema.ColumnType.
Example
See the example in CacheManager Object.