CampaignStatusReportFilter Value Set
Defines the campaign status values that you can use to filter the report data. These values are also used as column values in reports that include campaign status, such as the campaign performance report.
<xs:simpleType name="CampaignStatusReportFilter"> <xs:list> <xs:simpleType> <xs:restriction base="xs:string"> <xs:enumeration value="Submitted"/> <xs:enumeration value="Cancelled"/> <xs:enumeration value="Deleted"/> <xs:enumeration value="Paused"/> <xs:enumeration value="BudgetPaused"/> <xs:enumeration value="Active"/> <xs:enumeration value="Suspended"/> </xs:restriction> </xs:simpleType> </xs:list> </xs:simpleType>
|Active||The report will contain campaigns that are active.|
|BudgetPaused||The report will contain campaigns that are paused due to budget restrictions.|
|Cancelled||The report will contain campaigns that have been canceled.|
|Deleted||The report will contain campaigns that have been deleted.|
|Paused||The report will contain campaigns that are paused.|
|Submitted||The same meaning as Active. This value is maintained for backward compatibility; however, you should use |
|Suspended||The report will contain campaigns that have been suspended.|
This value set is used as a set of flags. You may combine the values when setting an element of this type. For example, in C#, use the following code example to filter the report data for paused and deleted campaigns in the report.
objCampaignPerfReportRequest.Status = CampaignStatusReportFilter.Paused | CampaignStatusReportFilter.Deleted;