Edit

AdGroupAdditionalField Value Set - Campaign Management

  • Article

Defines a list of optional ad group properties that you can request when calling GetAdGroupsByCampaignId and GetAdGroupsByIds. The additional field values enable you to get the latest features using the current version of Campaign Management API, and in the next version the corresponding properties will be included in the ad group by default.

Syntax

<xs:simpleType name="AdGroupAdditionalField" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:list>
    <xs:simpleType>
      <xs:restriction base="xs:string">
        <xs:enumeration value="AdScheduleUseSearcherTimeZone" />
        <xs:enumeration value="AdGroupType" />
        <xs:enumeration value="CpvBid" />
        <xs:enumeration value="CpmBid" />
        <xs:enumeration value="MultimediaAdsBidAdjustment" />
        <xs:enumeration value="CommissionRate" />
        <xs:enumeration value="PercentCpcBid" />
        <xs:enumeration value="McpaBid" />
        <xs:enumeration value="UseOptimizedTargeting" />
        <xs:enumeration value="FrequencyCapSettings" />
        <xs:enumeration value="UsePredictiveTargeting" />
      </xs:restriction>
    </xs:simpleType>
  </xs:list>
</xs:simpleType>

Values

The AdGroupAdditionalField value set has the following values: AdGroupType, AdScheduleUseSearcherTimeZone, CommissionRate, CpmBid, CpvBid, FrequencyCapSettings, McpaBid, MultimediaAdsBidAdjustment, PercentCpcBid, UseOptimizedTargeting, UsePredictiveTargeting.

Value Description
AdGroupType Request that the AdGroupType element be included within each returned AdGroup object.
AdScheduleUseSearcherTimeZone Request that the AdScheduleUseSearcherTimeZone element be included within each returned AdGroup object.
CommissionRate Reserved.
CpmBid Request that the CpmBid element be included within each returned AdGroup object.
CpvBid Request that the CpvBid element be included within each returned AdGroup object.
FrequencyCapSettings Settings for the frequency cap.
McpaBid Reserved.
MultimediaAdsBidAdjustment Request that the MultimediaAdsBidAdjustment element be included within each returned AdGroup object.
PercentCpcBid Reserved.
UseOptimizedTargeting This will be deprecated. Use UsePredictiveTargeting instead.
UsePredictiveTargeting Indicates if predictive targeting is enabled for an AdGroup.

Note: UsePredictiveTargeting is only available for Audience campaigns.

Add: Optional
Update: Optional.

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Used By

GetAdGroupsByCampaignId
GetAdGroupsByIds