An advertisement is an SMS announcement that a software package is available for installation. The Advertisement object type consists of a single class called SMS_Advertisement. This object is not part of the inventory process. This class contains information about SMS advertisements.
Table B.3 Advertisement Object Type (SMS_Advertisement)
| Property | Data type | Example | Notes |
|---|---|---|---|
| ActionInProgress | uint32 | 1 | Indicates the current action that SMS performs on the package.
Values are: |
| AdvertFlags | uint32 | See “Interpreting Bitfield Properties” at the beginning of this appendix. | Indicates when to announce an advertisement to the user.
Bit flags are: |
| AdvertisementID | string | "TTG00001" | Describes a unique, autogenerated key. |
| AdvertisementName | string | "myAdvert" | Indicates the name of the advertisement. |
| AssignedSchedule[] | SMS_ Schedule Token | This may appear as a lengthy array of object labels. | Lazy. Defines an array of schedule tokens when the advertisement will become mandatory on clients. |
| AssignedScheduleEnabled | Boolean | FALSE | Lazy. Indicates whether the schedule defined in AssignedSchedule is active.
Values are: If the value is TRUE, the schedule is active. |
| AssignedScheduleIsGMT | Boolean | FALSE | Lazy. Indicates whether the schedule defined in AssignedSchedule uses Greenwich Mean Time (GMT).
Values are: If the value is TRUE, the schedule uses GMT. |
| CollectionID | string | "SMS00001" | Refers to the collection that the advertisement is targeted to. |
| Comment | string | "Any comment." | Indicates a comment about the advertisement. |
| ExpirationTime | datetime | See “Date and Time Formats” at the beginning of this appendix. | Indicates the time the advertisement is no longer available to clients. |
| ExpirationTimeEnabled | Boolean | FALSE | Lazy. Indicates whether the advertisement expires at the time defined in ExpirationTime.
Values are: If the value is TRUE, the advertisement expires at the time indicated in the ExpirationTime property. |
| ExpirationTimeIsGMT | Boolean | FALSE | Lazy. Indicates whether the time defined in the ExpirationTime property is GMT.
Values are: If TRUE, the expiration time is expressed in GMT. |
| HierarchyPath | string | ||
| IncludeSubCollection | Boolean | TRUE | Indicates, when set to TRUE, that the advertisement should be advertised to the subcollections of the selected collection.
Values are: |
| PackageID | string | "TTG00001" | Indicates the Package ID associated with this advertisement. |
| PresentTime | datetime | See “Date and Time Formats” at the beginning of this appendix. | Indicates the time that the advertisement is presented to clients. |
| PresentTimeEnabled | Boolean | TRUE | Lazy. Denotes, when set to TRUE, that SMS enforces the present time.
Values are: |
| PresentTimeIsGMT | Boolean | FALSE | Lazy. Indicates whether the time defined in PresentTime is GMT.
Values are: If the value is TRUE, the PresentTime property is expressed in GMT. |
| Priority | uint32 | 2 | Indicates the priority of the advertisement at child sites.
Values are: |
| ProgramName | string | "Typical Installation" | Indicates the name of the SMS program object associated with this advertisement. |
| SourceSite | string | "TTG" | Indicates a three-letter site code of the originating site. |
| TimeFlags | uint32 | See “Interpreting Bitfield Properties” at the beginning of this appendix. | Duplicates the information in the time Boolean properties.
Bit flags are: |