SearchCampaignChangeHistoryReportColumn
TOC
Collapse the table of content
Expand the table of content

SearchCampaignChangeHistoryReportColumn Value Set

 

Defines the attribute columns that you can include in the SearchCampaignChangeHistoryReportRequest.

For a list of columns that you must include, please see the Required Columns section below.

<xs:simpleType name="SearchCampaignChangeHistoryReportColumn">
  <xs:restriction base="xs:string">
    <xs:enumeration value="DateTime" />
    <xs:enumeration value="AccountId" />
    <xs:enumeration value="AccountName" />
    <xs:enumeration value="AccountNumber" />
    <xs:enumeration value="ChangedBy" />
    <xs:enumeration value="CampaignName" />
    <xs:enumeration value="CampaignId" />
    <xs:enumeration value="AdGroupName" />
    <xs:enumeration value="AdGroupId" />
    <xs:enumeration value="AdTitle" />
    <xs:enumeration value="AdDescription" />
    <xs:enumeration value="DisplayUrl" />
    <xs:enumeration value="Keyword" />
    <xs:enumeration value="ItemChanged" />
    <xs:enumeration value="AttributeChanged" />
    <xs:enumeration value="HowChanged" />
    <xs:enumeration value="OldValue" />
    <xs:enumeration value="NewValue" />
  </xs:restriction>
</xs:simpleType>

ValueDescription
AccountIdThe Bing Ads assigned identifier of an account.
AccountNameThe account name.
AccountNumberThe Bing Ads assigned number of an account.
AdDescriptionThe text attribute of an ad. Note: This column will be empty if ItemChanged is not Ad.
AdGroupIdThe Bing Ads assigned identifier of an ad group. Note: This column will be empty if ItemChanged is not Ad , Ad group, or Keyword.
AdGroupNameThe ad group name. Note: This column will be empty if ItemChanged is not Ad , Ad group, or Keyword.
AdTitleThe ad title.
AttributeChanged

Identifies the attribute or property of the entity from the ItemChanged column that changed.

For a list of elements whose change history is reported, see the Attribute Changed column within Remarks.

Note: This column is empty if a campaign, ad group, or ad entity was added or deleted.

CampaignIdThe Bing Ads assigned identifier of a campaign.
CampaignNameThe campaign name.
ChangedByThe username of the user that made the change to settings within the account. If the system made the change, the value will be Administrator.
DateTime

The date and time of the change. The date and time will be in the time zone of the campaign.

Note: Prior to February 7, 2014, the date and time was relative to UTC.

DisplayUrlThe ad display URL. Note: This column will be empty if ItemChanged is not Ad.
HowChanged

The value that indicates whether the element was added, updated, or deleted. For possible values, see ChangeTypeReportFilter Value Set.

For adds, the NewValue column contains the added entity. For deletes, the OldValue column contains the deleted entity. For updates, the NewValue column contains the new value and the OldValue column contains the old value.

If an entity which has a delivery status property was added, for example a campaign, the value of HowChanged is Added. To report a deleted entity, the ItemChanged field is Status, the HowChanged field is Changed, and the NewValue field is Deleted.

Associating a target with a campaign or ad group will be reported as an add change. The AttributeChanged column will identify the target types contained in the target object. Updates to a target object will be reported as a delete change and an add change. Removing a campaign's or ad group's association with a target object will be reported as a delete change.

ItemChanged

The value that identifies the entity that changed.

If the change is an update to an element of the entity or is related to a target associated with a campaign or ad group, the AttributeChanged column contains the element of the entity that changed or the type of target that was changed.

KeywordThe keyword text. Note: This column will be empty if ItemChanged is not Keyword.
NewValueThe value after the change. For more information, see the HowChanged column.
OldValueThe value before the change. For more information, see the HowChanged column.

The report must include the following column.

Column
DateTime

The following are the entity types whose change history is reported.

System_CAPS_ICON_note.jpg Note

If the AttributeChanged field is blank or empty, and the HowChanged field is Added or Deleted, then the contents of the NewValue or OldValue field represents an element of the entity that was added or deleted, respectively. For example if a keyword is added, the NewValue field contains the keyword text.

Account

When the ItemChanged field's value is Account, change history for the following attributes are available.

Attribute ChangedDescription
None (blank)Refers to the name of the account that was added.

Note: The value of the corresponding HowChanged field is Added.
AccountRefers to the name of the account that was changed.
Agency contactRefers to the name of the agency contact.
Sales house customerRefers to the sales house customer.
Bill-to customerRefers to the bill-to customer
Financial statusRefers to the financial status
Lock statusRefers to the lock status
Payment optionRefers to the payment option
Preferred bill-to payment methodRefers to the preferred bill-to payment method
Preferred languageRefers to the preferred language
Sold-to payment methodSold-to payment method
StatusRefers to the account status.
Preferred userRefers to the preferred user
Spend limitRefers to the spend limit
Tracking templateRefers to the tracking template of the account.

Ad

When the ItemChanged field's value is Ad, change history for the following attributes are available.

Attribute ChangedDescription
None (blank)Refers to the title of the ad that was added.

Note: The value of the corresponding HowChanged field is Added.
Ad textRefers to the description of the ad copy.
Ad titleRefers to the title of the ad that was changed.
Custom parametersRefers to the custom parameters of the ad.
Destination URLRefers to the destination URL of the ad.
Display URLRefers to the display URL of the ad.
Editorial statusRefers to the editorial status of the ad.

Note: If the ad is pending offline editorial review, then within a downloaded change history report the editorial status is represented as either Pending – Active or Pending – Inactive. For more information, see Entities and Delivery Status.
Final URLRefers to the Final URL of the ad.
Mobile URLRefers to the Final Mobile URL of the ad.
StatusRefers to the delivery status of the ad.

Note: If reporting a deleted ad, the ItemChanged field is Status, the HowChanged field is Changed, and the NewValue field is Deleted.
Tracking templateRefers to the tracking template of the ad.

Ad group

When the ItemChanged field's value is Ad group, change history for the following attributes are available.

Attribute ChangedDescription
None (blank)Refers to the name of the ad group that was added.

Note: The value of the corresponding HowChanged field is Added.
Ad groupRefers to the name of the ad group that was changed.
Advanced location targetingRefers to intent option of the location target that is associated with the ad group.
AgeRefers to the age target.
Custom parametersRefers to the custom parameters of the ad group.
DayRefers to the day target that was deprecated after Bing Ads API version 9.
Default broad match bidRefers to the default broad match bid
Default content match bidRefers to the default content match bid
Default exact match bidRefers to the default exact match bid
Default phrase match bidRefers to the default phrase match bid
DeviceRefers to the defers to the device target.
DistanceRefers to the distance of the radius target.
End dateRefers to the scheduled end date for the ad group.
End timeRefers to the combined To Hour and To Minute of the DayTime target. The bid adjustment is also included in this field, delimited from the time by a single vertical bar character.
GenderRefers to the gender target.
HourRefers to the hour target that was deprecated after Bing Ads API version 9.
LocationRefers to the location target.
Location exclusionRefers to excluding locations from a location target.
MediumRefers to the Search or Content ad distribution.
Negative keywordRefers to a negative keyword associated with the ad group.

Note: Updates to negative keywords are reported as a Removed and Added change in two rows. The Removed record corresponds to the old value, and the Added record reflects the new value.
Pause statusRefers to the any of the paused states of the ad group.
Product groupThe product conditions of a product group are delimited from each other by a backward slash (''), and delimited from the bid by a single space character.
Site ExclusionRefers to the ad group’s negative site URLs. An ad group can have multiple site exclusions, and each site exclusion is represented separately in its own report row.
Start timeRefers to the combined From Hour and From Minute of the DayTime target. The bid adjustment is also included in this field, delimited from the time by a single vertical bar character.
StatusRefers to the delivery status of the ad group.

Note: If reporting a deleted ad group, the ItemChanged field is Status, the HowChanged field is Changed, and the NewValue field is Deleted.
Targeted daysRefers day of the DayTime target. The bid adjustment is also included in this field, delimited from the day by a single vertical bar character.
Tracking templateRefers to the tracking template of the ad group.

Call extension

When the ItemChanged field's value is Call extension, change history for the following attributes are available.

Attribute ChangedDescription
AssociationRefers to the association of a call extension with an entity.

For example if the extension is associated with a campaign, CampaignName field's value is the name of the associated campaign, the ItemChanged field's value is Call extension, the AttributeChanged field's value is Association, and the HowChanged field's value is Added.
Country/regionRefers to the country/region of the call extension.
Phone NumberRefers to the phone number of the call extension.
Show website or phoneRefers to whether the website should be displayed with the phone number of the call extension. Possible values in the OldValue and NewValue columns are Phone and Website and phone.
Use forward numberRefers to whether forwarding is set up for the call extension. Possible values in the OldValue and NewValue columns are No and Yes.

Campaign

When the ItemChanged field's value is Campaign, change history for the following attributes are available.

Attribute ChangedDescription
None (blank)Refers to the name of the campaign that was added.

Note: The value of the corresponding HowChanged field is Added.
Advanced location targetingRefers to intent option of the location target that is associated with the campaign.
AgeRefers to the age target.
Budget typeRefers to the campaign budget type.

Possible values in the OldValue and NewValue columns are as follows:

- Value of Daily target (accelerated) corresponds to the Bing Ads web application Daily Accelerated setting.

- Value of Daily target (standard) corresponds to the Bing Ads web application Daily Standard setting.

- Value of Monthly (open) corresponds to the Bing Ads web application Monthly setting.
Campaign priorityRefers to the priority of a Bing Shopping campaign.
Custom parametersRefers to the custom parameters of the campaign.
Daily budgetRefers to the campaign daily budget amount.
DayRefers to the day target that was deprecated after Bing Ads API version 9.
DeviceRefers to the device target.
DistanceRefers to the distance of the radius target.
End dateRefers to the scheduled end date for the ad group.
End timeRefers to the combined To Hour and To Minute of the DayTime target. The bid adjustment is also included in this field, delimited from the time by a single vertical bar character.
GenderRefers to the gender target.
HourRefers to the hour target that was deprecated after Bing Ads API version 9.
IP exclusionRefers to the IP exclusions created via the Bing Ads web application.
LocationRefers to the location target.
Location exclusionRefers to excluding locations from a location target.
Monthly budgetRefers to the campaign monthly budget amount.
NameRefers to the name of the campaign that was changed.
Negative keywordRefers to a negative keyword associated with the campaign.

Note: Updates to negative keywords are reported as a Removed and Added change in two rows. The Removed record corresponds to the old value, and the Added record reflects the new value.
Pause statusRefers to the any of the paused states of the campaign.

Possible values in the OldValue``NewValue columns are Budget Paused and Not paused.
Product flterRefers to the product scope or condition of a Bing Shopping campaign. A Bing Shopping campaign can have multiple product conditions, and each condition is represented separately in its own report row.
Site ExclusionRefers to the campaign’s negative site URLs. A campaign can have multiple site exclusions, and each site exclusion is represented separately in its own report row.
Start dateFor internal use.
Start timeRefers to the combined From Hour and From Minute of the DayTime target. The bid adjustment is also included in this field, delimited from the time by a single vertical bar character.
StatusRefers to the delivery status of the campaign.

Note: If reporting a deleted campaign, the ItemChanged field is Status, the HowChanged field is Changed, and the NewValue field is Deleted.
Targeted daysRefers day of the DayTime target. The bid adjustment is also included in this field, delimited from the day by a single vertical bar character.
Tracking templateRefers to the Tracking template of the campaign.

Keyword

When the ItemChanged field's value is Keyword, change history for the following attributes are available.

Attribute ChangedDescription
None (blank)Refers to the text of the keyword that was added.

Note: The value of the corresponding HowChanged field is Added.
Broad match bidRefers to the broad match bid amount for the keyword.
Content match bidRefers to the content match bid amount for the keyword.
Custom parametersRefers to the custom parameters of the keyword.
Editorial statusRefers to the editorial status of the keyword.

Note: If the keyword is pending offline editorial review, then within a downloaded change history report the editorial status is represented as either Pending – Active or Pending – Inactive. For more information, see Entities and Delivery Status.
Exact match bidRefers to the exact match bid amount for the keyword.
Final URLRefers to the Final URL of the keyword.
Mobile URLRefers to the Final Mobile URL of the keyword.
Match typeRefers to the bid match type for the keyword.

Note: The bid match type cannot be updated using Bing Ads API; however, it is possible to change the bid match type using the Bing Ads web application.
Phrase match bidRefers to the phrase match bid amount for the keyword.
StatusRefers to the delivery status of the keyword.

Note: If reporting a deleted keyword, the ItemChanged field is Status, the HowChanged field is Changed, and the NewValue field is Deleted.
Tracking templateRefers to the tracking template of the keyword.

Location extension

When the ItemChanged field's value is Location extension, change history for the following attributes are available.

Attribute ChangedDescription
AssociationRefers to the association of a location extension with an entity.

For example if the extension is associated with a campaign, CampaignName field's value is the name of the associated campaign, the ItemChanged field's value is Location extension, the AttributeChanged field's value is Association, and the HowChanged field's value is Added.

Negative Keyword List

When the ItemChanged field's value is Negative Keyword List, change history for the following attributes are available.

Attribute ChangedDescription
AssociationRefers to the association of a Negative Keyword List with a campaign.

For example if the negative keyword list is associated with a campaign, CampaignName field's value is the name of the associated campaign, the ItemChanged field's value is Negative Keyword List, the AttributeChanged field's value is Association, and the HowChanged field's value is Added.
Negative keywordRefers to the negative keyword that was added or removed from the negative keyword list.
Negative Keyword List NameRefers to the name of the negative keyword list.

Sitelink extension

When the ItemChanged field's value is Sitelink extension, change history for the following attributes are available.

Attribute ChangedDescription
AssociationRefers to the association of a sitelink extension with an entity.

For example if the extension is associated with a campaign, CampaignName field's value is the name of the associated campaign, the ItemChanged field's value is Sitelink extension, the AttributeChanged field's value is Association, and the HowChanged field's value is Added.
Custom parametersRefers to the custom parameters of a sitelink.
Destination URLRefers to the destination URL of the sitelink extension.
Display TextRefers to the display text of the sitelink extension.
Final URLRefers to the Final URL of a sitelink.
Mobile URLRefers to the Final Mobile URL of a sitelink.
Tracking templateRefers to the tracking template of a sitelink.

User

When the ItemChanged field's value is User, change history for the following attributes are available.

Attribute ChangedDescription
None (blank)Refers to the user name of the user that was added.

Note: The value of the corresponding HowChanged field is Added.
CodeFor internal use.
EmailRefers to the contact email address of the user.
First nameRefers to the first name of the user.
Last nameRefers to the last name of the user.
StatusRefers to the status of the user.

ReportingService.svc v9

Namespace: https://bingads.microsoft.com/Reporting/v9

SearchCampaignChangeHistoryReportRequest

Community Additions

ADD
Show:
© 2016 Microsoft