Edit

ImportAdditionalField Value Set - Campaign Management

Defines a list of optional import properties that you can request when calling GetImportJobsByIds and GetImportResults. 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 by default.

Syntax

<xs:simpleType name="ImportAdditionalField" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:appinfo>
      <ActualType Name="long" Namespace="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
    </xs:appinfo>
  </xs:annotation>
  <xs:list>
    <xs:simpleType>
      <xs:restriction base="xs:string">
        <xs:enumeration value="None">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">0</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="NotificationEmail">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="AutoDeviceBidOptimization">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="ActiveAdGroupsOnly">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="SearchAndReplaceForCustomParameters">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="AdScheduleUseSearcherTimezone">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">16</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="NewImageAdExtensions">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">32</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="UpdateImageAdExtensions">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">64</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="SearchAndReplaceForFinalURLSuffix">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">128</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="RenameCampaignNameWithSuffix">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">256</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="UpdateAdUrls">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">512</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="NewLogoAdExtensions">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1024</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="UpdateLogoAdExtensions">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2048</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="UpdateSitelinkUrls">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4096</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="NewLeadFormAdExtensions">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8192</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="UpdateLeadFormAdExtensions">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">16384</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="NewAccountNegativeKeywords">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">32768</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="UpdateAccountNegativeKeywords">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">65536</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="UpdateAdCustomizerAttributes">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">131072</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="NewConversionGoals">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">262144</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="UpdateConversionGoals">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">524288</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="NewBrandSuitability">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1048576</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="UpdateBrandSuitability">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2097152</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="NewCarouselAd">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4194304</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="UpdateAssetAutomationCampaignSetting">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8388608</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="EnableCopilot">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">16777216</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="NewTopicTargets">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">33554432</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="UpdateTopicTargets">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">67108864</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="NewPortfolioBidStrategy">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">134217728</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="NewAIMaxSettings">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">268435456</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="ImageAssetAutomationOptOut">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">536870912</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
        <xs:enumeration value="UpdateAIMaxSettings">
          <xs:annotation>
            <xs:appinfo>
              <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1073741824</EnumerationValue>
            </xs:appinfo>
          </xs:annotation>
        </xs:enumeration>
      </xs:restriction>
    </xs:simpleType>
  </xs:list>
</xs:simpleType>

Values

The ImportAdditionalField value set has the following values: ActiveAdGroupsOnly, AdScheduleUseSearcherTimezone, AutoDeviceBidOptimization, EnableCopilot, ImageAssetAutomationOptOut, NewAccountNegativeKeywords, NewAIMaxSettings, NewBrandSuitability, NewCarouselAd, NewConversionGoals, NewImageAdExtensions, NewLeadFormAdExtensions, NewLogoAdExtensions, NewPortfolioBidStrategy, NewTopicTargets, None, NotificationEmail, RenameCampaignNameWithSuffix, SearchAndReplaceForCustomParameters, SearchAndReplaceForFinalURLSuffix, UpdateAccountNegativeKeywords, UpdateAdCustomizerAttributes, UpdateAdUrls, UpdateAIMaxSettings, UpdateAssetAutomationCampaignSetting, UpdateBrandSuitability, UpdateConversionGoals, UpdateImageAdExtensions, UpdateLeadFormAdExtensions, UpdateLogoAdExtensions, UpdateSitelinkUrls, UpdateTopicTargets.

Value Description
ActiveAdGroupsOnly Request that the ActiveAdGroupsOnly element be returned within the CampaignAdGroupIds element of each returned GoogleImportJob object.
AdScheduleUseSearcherTimezone Request that the AdScheduleUseSearcherTimezone element be included within each returned GoogleImportOption object.
AutoDeviceBidOptimization Request that the AutoDeviceBidOptimization element be included within each returned GoogleImportOption object.
EnableCopilot Reserved.
ImageAssetAutomationOptOut Reserved.
NewAccountNegativeKeywords Request that the NewAccountNegativeKeywords element be included within each returned GoogleImportOption object.
NewAIMaxSettings Reserved.
NewBrandSuitability Request that the NewBrandSuitability element be included within each returned GoogleImportOption object.
NewCarouselAd Request that the NewCarouselAd element be included within each returned GoogleImportOption object.
NewConversionGoals Request that the NewConversionGoals element be included within each returned GoogleImportOption object.
NewImageAdExtensions Request that the NewImageAdExtensions element be included within each returned GoogleImportOption object.
NewLeadFormAdExtensions Request that the NewLeadFormAdExtensions element be included within each returned GoogleImportOption object.
NewLogoAdExtensions Request that the NewLogoAdExtensions element be included within each returned GoogleImportOption object.
NewPortfolioBidStrategy Reserved.
NewTopicTargets Request that the NewTopicTargets element be included within each returned GoogleImportOption object.
None Reserved for internal use.
NotificationEmail Request that the NotificationEmail element be included within each returned GoogleImportJob object.
RenameCampaignNameWithSuffix Request that the RenameCampaignNameWithSuffix element be included within each returned GoogleImportOption object.
SearchAndReplaceForCustomParameters Request that the SearchAndReplaceForCustomParameters element be included within each returned GoogleImportOption object.
SearchAndReplaceForFinalURLSuffix Request that the SearchAndReplaceForFinalURLSuffix element be included within each returned GoogleImportOption object.
UpdateAccountNegativeKeywords Request that the UpdateAccountNegativeKeywords element be included within each returned GoogleImportOption object.
UpdateAdCustomizerAttributes Request that the UpdateAdCustomizerAttributes element be included within each returned GoogleImportOption object.
UpdateAdUrls Request that the UpdateAdUrls element be included within each returned GoogleImportOption object.
UpdateAIMaxSettings Reserved.
UpdateAssetAutomationCampaignSetting Reserved.
UpdateBrandSuitability Request that the UpdateBrandSuitability element be included within each returned GoogleImportOption object.
UpdateConversionGoals Request that the UpdateConversionGoals element be included within each returned GoogleImportOption object.
UpdateImageAdExtensions Request that the UpdateImageAdExtensions element be included within each returned GoogleImportOption object.
UpdateLeadFormAdExtensions Request that the UpdateLeadFormAdExtensions element be included within each returned GoogleImportOption object.
UpdateLogoAdExtensions Request that the UpdateLogoAdExtensions element be included within each returned GoogleImportOption object.
UpdateSitelinkUrls Request that the UpdateSitelinkUrls element be included within each returned GoogleImportOption object.
UpdateTopicTargets Request that the UpdateTopicTargets element be included within each returned GoogleImportOption object.

Requirements

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

Used By

GetImportJobsByIds
GetImportResults

  • Last updated on