BulkDownloadEntity Value Set

 

Defines the entities that may be downloaded in bulk.

System_CAPS_ICON_note.jpg Note

Available entities vary by file format version. For more information, see Bulk File Schema.

<xs:simpleType name="BulkDownloadEntity">
  <xs:list>
    <xs:simpleType>
      <xs:restriction base="xs:string">
        <xs:enumeration value="Campaigns" />
        <xs:enumeration value="AdGroups" />
        <xs:enumeration value="Ads" />
        <xs:enumeration value="Keywords" />
        <xs:enumeration value="CampaignNegativeKeywords" />
        <xs:enumeration value="AdGroupNegativeKeywords" />
        <xs:enumeration value="CampaignTargets" />
        <xs:enumeration value="AdGroupTargets" />
        <xs:enumeration value="CampaignNegativeSites" />
        <xs:enumeration value="AdGroupNegativeSites" />
        <xs:enumeration value="CampaignSiteLinksAdExtensions" />
        <xs:enumeration value="CampaignLocationAdExtensions" />
        <xs:enumeration value="CampaignCallAdExtensions" />
        <xs:enumeration value="AdGroupSiteLinksAdExtensions" />
        <xs:enumeration value="LocationAdExtensions" />
        <xs:enumeration value="CallAdExtensions" />
        <xs:enumeration value="SiteLinksAdExtensions" />
        <xs:enumeration value="NegativeKeywordLists" />
        <xs:enumeration value="SharedNegativeKeywords" />
        <xs:enumeration value="CampaignNegativeKeywordListAssociations" />
        <xs:enumeration value="ImageAdExtensions" />
        <xs:enumeration value="AdGroupImageAdExtensions" />
        <xs:enumeration value="CampaignImageAdExtensions" />
        <xs:enumeration value="AppAdExtensions" />
        <xs:enumeration value="AdGroupAppAdExtensions" />
        <xs:enumeration value="CampaignAppAdExtensions" />
        <xs:enumeration value="ReviewAdExtensions" />
        <xs:enumeration value="CampaignNegativeDynamicSearchAdTargets" />
        <xs:enumeration value="AdGroupProductPartitions" />
        <xs:enumeration value="CampaignProductScopes" />
        <xs:enumeration value="CampaignReviewAdExtensions" />
        <xs:enumeration value="AdGroupReviewAdExtensions" />
        <xs:enumeration value="CalloutAdExtensions" />
        <xs:enumeration value="CampaignCalloutAdExtensions" />
        <xs:enumeration value="AdGroupCalloutAdExtensions" /> 
        <xs:enumeration value="Sitelink2AdExtensions" />
        <xs:enumeration value="CampaignSitelink2AdExtensions" />
        <xs:enumeration value="AdGroupSitelink2AdExtensions" />       
        <xs:enumeration value="StructuredSnippetAdExtensions" />
        <xs:enumeration value="CampaignStructuredSnippetAdExtensions" />
        <xs:enumeration value="AdGroupStructuredSnippetAdExtensions" />
        <xs:enumeration value="RemarketingLists" />
        <xs:enumeration value="AdGroupRemarketingListAssociations" />
        <xs:enumeration value="Budgets" />
        <xs:enumeration value="TextAds" />
        <xs:enumeration value="ProductAds" />
        <xs:enumeration value="AppInstallAds" />
        <xs:enumeration value="ExpandedTextAds" />
        <xs:enumeration value="DynamicSearchAds" />
        <xs:enumeration value="AdGroupDynamicSearchAdTargets" />
        <xs:enumeration value="AdGroupNegativeDynamicSearchAdTargets" />
      </xs:restriction>
    </xs:simpleType>
  </xs:list>
</xs:simpleType>

ValueDescription
AdGroupAppAdExtensionsInclude Ad Group App Ad Extension records in the download that each represent the association relationship between an ad group and an app ad extension. For App Ad Extension records, you should include the AppAdExtensions value in the download request.
AdGroupCalloutAdExtensionsInclude Ad Group Callout Ad Extension records in the download that each represent the association relationship between an ad group and a callout ad extension. For Callout Ad Extension records, you should include the CalloutAdExtensions value in the download request.
AdGroupDynamicSearchAdTargetsInclude Ad Group Dynamic Search Ad Target records in the download data.
AdGroupImageAdExtensionsInclude Ad Group Image Ad Extension records in the download that each represent the association relationship between an ad group and an image ad extension. For Image Ad Extension records, you should include the ImageAdExtensions value in the download request.
AdGroupNegativeDynamicSearchAdTargetsInclude Ad Group Negative Dynamic Search Ad Target records in the download data.
AdGroupNegativeKeywordsInclude Ad Group Negative Keyword records in the download data.
AdGroupNegativeSitesInclude Ad Group Negative Site records in the download data.
AdGroupProductPartitionsInclude Ad Group Product Partition records in the download data.
AdGroupRemarketingListAssociationsInclude Ad Group Remarketing List Association records in the download that each represent the association relationship between an ad group and a remarketing list. For Remarketing List records, you should include the RemarketingLists value in the download request.
AdGroupReviewAdExtensionsInclude Ad Group Review Ad Extension records in the download that each represent the association relationship between an ad group and a review ad extension. For Review Ad Extension records, you should include the ReviewAdExtensions value in the download request.
AdGroupsInclude Ad Group records in the download data.
AdGroupSiteLinksAdExtensionsInclude AdGroup Sitelink Ad Extension records in the download that each represent the association relationship between an ad group and a sitelink ad extension. For Sitelink Ad Extension records, you should include the SiteLinksAdExtensions value in the download request.
AdGroupSitelink2AdExtensionsInclude Ad Group Sitelink2 Ad Extension records in the download that each represent the association relationship between an ad group and a sitelink2 ad extension. For Sitelink2 Ad Extension records, you should include the Sitelink2AdExtensions value in the download request.
AdGroupStructuredSnippetAdExtensionsInclude Ad Group Structured Snippet Ad Extension records in the download that each represent the association relationship between an ad group and a structured snippet ad extension. For Structured Snippet Ad Extension records, you should include the StructuredSnippetAdExtensions value in the download request.
AdGroupTargetsInclude Ad Group Age Target, Ad Group DayTime Target, Ad Group DeviceOS Target, Ad Group Gender Target, Ad Group Location Target, Ad Group Negative Location Target, and Ad Group Radius Target records in the download data.
AdsInclude App Install Ad, Dynamic Search Ad, Expanded Text Ad, Product Ad, and Text Ad records in the download data.

Note: To get ads by type instead of requesting all types of ads, you can include one or more of the AppInstallAds, DynamicSearchAds, ExpandedTextAds, ProductAds, and TextAds values in the download request.
AppAdExtensionsInclude App Ad Extension records in the download data.

Note: To get all app ad extensions from your account's extension library, use the DownloadCampaignsByAccountIds operation. To get only the app ad extensions that are associated with the specified campaigns, use the DownloadCampaignsByCampaignIds operation.
AppInstallAdsInclude App Install Ad records in the download data.

Note: To get all types of ads instead of requesting ads by type, you can include the Ads value in the download request.
BudgetsInclude Budget records in the download data.
CallAdExtensionsInclude Call Ad Extension records in the download data.

Note: To get all call ad extensions from your account's extension library, use the DownloadCampaignsByAccountIds operation. To get only the call ad extensions that are associated with the specified campaigns, use the DownloadCampaignsByCampaignIds operation.
CalloutAdExtensionsInclude Callout Ad Extension records in the download data.

Note: To get all callout ad extensions from your account's extension library, use the DownloadCampaignsByAccountIds operation. To get only the callout ad extensions that are associated with the specified campaigns, use the DownloadCampaignsByCampaignIds operation.
CampaignAppAdExtensionsInclude Campaign App Ad Extension records in the download that each represent the association relationship between a campaign and an app ad extension. For App Ad Extension records, you should include the AppAdExtensions value in the download request.
CampaignCallAdExtensionsInclude Campaign Call Ad Extension records in the download that represents the association relationship between a campaign and a call ad extension. For Call Ad Extension records, you should include the CallAdExtensions value in the download request.
CampaignCalloutAdExtensionsInclude Campaign Callout Ad Extension records in the download that represents the association relationship between a campaign and a callout ad extension. For Callout Ad Extension records, you should include the CalloutAdExtensions value in the download request.
CampaignImageAdExtensionsInclude Campaign Image Ad Extension records in the download that represents the association relationship between a campaign and an image ad extension. For Image Ad Extension records, you should include the ImageAdExtensions value in the download request.
CampaignLocationAdExtensionsInclude Campaign Location Ad Extension records in the download that represents the association relationship between a campaign and a location ad extension. For Location Ad Extension records, you should include the LocationAdExtensions value in the download request.
CampaignNegativeDynamicSearchAdTargetsInclude Campaign Negative Dynamic Search Ad Target records in the download data.
CampaignNegativeKeywordsInclude Campaign Negative Keyword records in the download data.
CampaignNegativeKeywordListAssociationsInclude Campaign Negative Keyword List Association records in the download that represents the association relationship between a campaign and a negative keyword list. For Negative Keyword List records, you should include the NegativeKeywordLists value in the download request.
CampaignNegativeSitesInclude Campaign Negative Site records in the download data.
CampaignProductScopesInclude Campaign Product Scope records in the download data.
CampaignsInclude Campaign records in the download data.
CampaignSiteLinksAdExtensionsInclude Campaign Sitelink Ad Extension records in the download that represents the association relationship between a campaign and a sitelink ad extension. For Sitelink Ad Extension records, you should include the SiteLinksAdExtensions value in the download request.
CampaignSitelink2AdExtensionsInclude Campaign Sitelink2 Ad Extension records in the download that represents the association relationship between a campaign and a sitelink ad extension. For Sitelink2 Ad Extension records, you should include the Sitelink2AdExtensions value in the download request.
CampaignStructuredSnippetAdExtensionsInclude Campaign Structured Snippet Ad Extension records in the download that represents the association relationship between a campaign and a structured snippet ad extension. For Structured Snippet Ad Extension records, you should include the StructuredSnippetAdExtensions value in the download request.
CampaignTargetsInclude Campaign Age Target, Campaign DayTime Target, Campaign DeviceOS Target, Campaign Gender Target, Campaign Location Target, Campaign Negative Location Target, and Campaign Radius Target records in the download data.
DynamicSearchAdsInclude Dynamic Search Ad records in the download data.

Note: To get all types of ads instead of requesting ads by type, you can include the Ads value in the download request.
ExpandedTextAdsInclude Expanded Text Ad records in the download data.

Note: To get all types of ads instead of requesting ads by type, you can include the Ads value in the download request.
ImageAdExtensionsInclude Image Ad Extension records in the download data.

Note: To get all image ad extensions from your account's extension library, use the DownloadCampaignsByAccountIds operation. To get only the image ad extensions that are associated with the specified campaigns, use the DownloadCampaignsByCampaignIds operation.
KeywordsInclude Keyword records in the download data.
LocationAdExtensionsInclude Location Ad Extension records in the download data.

Note: To get all location ad extensions from your account's extension library, use the DownloadCampaignsByAccountIds operation. To get only the location ad extensions that are associated with the specified campaigns, use the DownloadCampaignsByCampaignIds operation.
NegativeKeywordListsInclude Negative Keyword List records in the download data. The Negative Keyword List records do not include negative keywords that are shared in each list. For Shared Negative Keyword records, you should include the SharedNegativeKeywords value in the download request.

Note: The DownloadCampaignsByCampaignIds will return all negative keyword lists from your account's negative keyword list library, whether or not the lists are associated with the specified campaigns .
ProductAdsInclude Product Ad records in the download data.

Note: To get all types of ads instead of requesting ads by type, you can include the Ads value in the download request.
ReviewAdExtensionsInclude Review Ad Extension records in the download data.

Note: To get all review ad extensions from your account's extension library, use the DownloadCampaignsByAccountIds operation. To get only the review ad extensions that are associated with the specified campaigns, use the DownloadCampaignsByCampaignIds operation.
RemarketingListsInclude Remarketing List records in the download data.

Note: The DownloadCampaignsByAccountIds and DownloadCampaignsByCampaignIds operations return the same set of remarketing lists for the current authenticated user. All remarketing lists that have Scope set to Customer are included. The remarketing lists that have Scope set to Account are also included if the user has access to view or manage those accounts. In other words, if a remarketing list is in account scope for an account that the user cannot access, then it is excluded from the download results.
SharedNegativeKeywordsInclude Shared Negative Keyword records in the download data. Shared negative keywords belong to a negative keyword list. For Negative Keyword List records, you should include the NegativeKeywordLists value in the download request.
SiteLinksAdExtensionsInclude Sitelink Ad Extension records in the download data.

Note: To get all sitelink ad extensions from your account's extension library, use the DownloadCampaignsByAccountIds operation. To get only the sitelink ad extensions that are associated with the specified campaigns, use the DownloadCampaignsByCampaignIds operation.
Sitelink2AdExtensionsInclude Sitelink2 Ad Extension records in the download data.

Note: To get all sitelink2 ad extensions from your account's extension library, use the DownloadCampaignsByAccountIds operation. To get only the sitelink2 ad extensions that are associated with the specified campaigns, use the DownloadCampaignsByCampaignIds operation.
StructuredSnippetAdExtensionsInclude Structured Snippet Ad Extension records in the download data.

Note: To get all structured snippet ad extensions from your account's extension library, use the DownloadCampaignsByAccountIds operation. To get only the structured snippet ad extensions that are associated with the specified campaigns, use the DownloadCampaignsByCampaignIds operation.
TextAdsInclude Text Ad records in the download data.

Note: To get all types of ads instead of requesting ads by type, you can include the Ads value in the download request.

BulkService.svc v10

Namespace: https://bingads.microsoft.com/CampaignManagement/v10

DownloadCampaignsByAccountIds
DownloadCampaignsByCampaignIds

Show: