GetImportJobsByIds Service Operation - Campaign Management
Gets import jobs by their type and identifiers.
Tip
For an implementation overview, see the Google Ads Import technical guide.
Request Elements
The GetImportJobsByIdsRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| ImportJobIds | The identifiers of the import jobs to get. You can specify a maximum of 100 import job IDs. If this element is not specified, the operation will return up to 500 import jobs in the ad account. |
long array |
| ImportType | The type of import job to get. To get GoogleImportJob objects, set this element to "GoogleImportJob". |
string |
| ReturnAdditionalFields | 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 elements will be included by default. This request element is optional. |
ImportAdditionalField |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| AuthenticationToken | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The GetImportJobsByIdsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| ImportJobs | The import jobs that matched the request criteria. | ImportJob array |
| PartialErrors | An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request. |
BatchError array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Action mustUnderstand="1">GetImportJobsByIds</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
<CustomerId i:nil="false">ValueHere</CustomerId>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<GetImportJobsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<ImportJobIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</ImportJobIds>
<ImportType i:nil="false">ValueHere</ImportType>
<ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
</GetImportJobsByIdsRequest>
</s:Body>
</s:Envelope>
Response SOAP
This template was generated by a tool to show the order of the body and header elements for the SOAP response.
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
</s:Header>
<s:Body>
<GetImportJobsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<ImportJobs d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<ImportJob d4p1:type="-- derived type specified here with the appropriate prefix --">
<CreatedByUserId d4p1:nil="false">ValueHere</CreatedByUserId>
<CreatedByUserName d4p1:nil="false">ValueHere</CreatedByUserName>
<CreatedDateTimeInUTC d4p1:nil="false">ValueHere</CreatedDateTimeInUTC>
<Frequency d4p1:nil="false">
<Cron d4p1:nil="false">ValueHere</Cron>
<TimeZone d4p1:nil="false">ValueHere</TimeZone>
<Type d4p1:nil="false">ValueHere</Type>
</Frequency>
<Id d4p1:nil="false">ValueHere</Id>
<ImportOption d4p1:nil="false" d4p1:type="-- derived type specified here with the appropriate prefix --">
<ForwardCompatibilityMap xmlns:e309="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e309:KeyValuePairOfstringstring>
<e309:key d4p1:nil="false">ValueHere</e309:key>
<e309:value d4p1:nil="false">ValueHere</e309:value>
</e309:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to GoogleImportOption-->
<AccountUrlOptions d4p1:nil="false">ValueHere</AccountUrlOptions>
<AdScheduleUseSearcherTimezone d4p1:nil="false">ValueHere</AdScheduleUseSearcherTimezone>
<AdjustmentForBids d4p1:nil="false">ValueHere</AdjustmentForBids>
<AdjustmentForCampaignBudgets d4p1:nil="false">ValueHere</AdjustmentForCampaignBudgets>
<AssociatedStoreId d4p1:nil="false">ValueHere</AssociatedStoreId>
<AssociatedUetTagId d4p1:nil="false">ValueHere</AssociatedUetTagId>
<AutoDeviceBidOptimization d4p1:nil="false">ValueHere</AutoDeviceBidOptimization>
<DeleteRemovedEntities d4p1:nil="false">ValueHere</DeleteRemovedEntities>
<EnableAutoCurrencyConversion d4p1:nil="false">ValueHere</EnableAutoCurrencyConversion>
<EnableParentLocationMapping d4p1:nil="false">ValueHere</EnableParentLocationMapping>
<NewAccountNegativeKeywords d4p1:nil="false">ValueHere</NewAccountNegativeKeywords>
<NewActiveAdsForExistingAdGroups d4p1:nil="false">ValueHere</NewActiveAdsForExistingAdGroups>
<NewActiveCampaignsAndChildEntities d4p1:nil="false">ValueHere</NewActiveCampaignsAndChildEntities>
<NewAdCustomizerFeeds d4p1:nil="false">ValueHere</NewAdCustomizerFeeds>
<NewAdGroupsAndChildEntitiesForExistingCampaigns d4p1:nil="false">ValueHere</NewAdGroupsAndChildEntitiesForExistingCampaigns>
<NewAdSchedules d4p1:nil="false">ValueHere</NewAdSchedules>
<NewAppAdExtensions d4p1:nil="false">ValueHere</NewAppAdExtensions>
<NewAudienceTargets d4p1:nil="false">ValueHere</NewAudienceTargets>
<NewBrandSuitability d4p1:nil="false">ValueHere</NewBrandSuitability>
<NewCallAdExtensions d4p1:nil="false">ValueHere</NewCallAdExtensions>
<NewCalloutAdExtensions d4p1:nil="false">ValueHere</NewCalloutAdExtensions>
<NewConversionGoals d4p1:nil="false">ValueHere</NewConversionGoals>
<NewDemographicTargets d4p1:nil="false">ValueHere</NewDemographicTargets>
<NewDeviceTargets d4p1:nil="false">ValueHere</NewDeviceTargets>
<NewEntities d4p1:nil="false">ValueHere</NewEntities>
<NewImageAdExtensions d4p1:nil="false">ValueHere</NewImageAdExtensions>
<NewKeywordUrls d4p1:nil="false">ValueHere</NewKeywordUrls>
<NewKeywordsForExistingAdGroups d4p1:nil="false">ValueHere</NewKeywordsForExistingAdGroups>
<NewLabels d4p1:nil="false">ValueHere</NewLabels>
<NewLeadFormAdExtensions d4p1:nil="false">ValueHere</NewLeadFormAdExtensions>
<NewLocationAdExtensions d4p1:nil="false">ValueHere</NewLocationAdExtensions>
<NewLocationTargets d4p1:nil="false">ValueHere</NewLocationTargets>
<NewLogoAdExtensions d4p1:nil="false">ValueHere</NewLogoAdExtensions>
<NewNegativeKeywordLists d4p1:nil="false">ValueHere</NewNegativeKeywordLists>
<NewNegativeKeywordsForExistingParents d4p1:nil="false">ValueHere</NewNegativeKeywordsForExistingParents>
<NewNegativeSites d4p1:nil="false">ValueHere</NewNegativeSites>
<NewPageFeeds d4p1:nil="false">ValueHere</NewPageFeeds>
<NewPausedAdsForExistingAdGroups d4p1:nil="false">ValueHere</NewPausedAdsForExistingAdGroups>
<NewPausedCampaignsAndChildEntities d4p1:nil="false">ValueHere</NewPausedCampaignsAndChildEntities>
<NewPriceAdExtensions d4p1:nil="false">ValueHere</NewPriceAdExtensions>
<NewProductFilters d4p1:nil="false">ValueHere</NewProductFilters>
<NewPromotionAdExtensions d4p1:nil="false">ValueHere</NewPromotionAdExtensions>
<NewReviewAdExtensions d4p1:nil="false">ValueHere</NewReviewAdExtensions>
<NewSitelinkAdExtensions d4p1:nil="false">ValueHere</NewSitelinkAdExtensions>
<NewStructuredSnippetAdExtensions d4p1:nil="false">ValueHere</NewStructuredSnippetAdExtensions>
<NewUrlOptions d4p1:nil="false">ValueHere</NewUrlOptions>
<PauseAIMAdGroupIfAllAudienceCriterionNotImported d4p1:nil="false">ValueHere</PauseAIMAdGroupIfAllAudienceCriterionNotImported>
<PauseCampaignsWithoutSupportedLocations d4p1:nil="false">ValueHere</PauseCampaignsWithoutSupportedLocations>
<PauseNewCampaigns d4p1:nil="false">ValueHere</PauseNewCampaigns>
<RaiseBidsToMinimum d4p1:nil="false">ValueHere</RaiseBidsToMinimum>
<RaiseCampaignBudgetsToMinimum d4p1:nil="false">ValueHere</RaiseCampaignBudgetsToMinimum>
<RaiseProductGroupBidsToMinimum d4p1:nil="false">ValueHere</RaiseProductGroupBidsToMinimum>
<RenameCampaignNameWithSuffix d4p1:nil="false">ValueHere</RenameCampaignNameWithSuffix>
<SearchAndDsaMixedCampaignAsSearchCampaign d4p1:nil="false">ValueHere</SearchAndDsaMixedCampaignAsSearchCampaign>
<SearchAndReplaceForCampaignNames d4p1:nil="false">
<ReplaceString d4p1:nil="false">ValueHere</ReplaceString>
<SearchString d4p1:nil="false">ValueHere</SearchString>
</SearchAndReplaceForCampaignNames>
<SearchAndReplaceForCustomParameters d4p1:nil="false">
<ReplaceString d4p1:nil="false">ValueHere</ReplaceString>
<SearchString d4p1:nil="false">ValueHere</SearchString>
</SearchAndReplaceForCustomParameters>
<SearchAndReplaceForFinalURLSuffix d4p1:nil="false">
<ReplaceString d4p1:nil="false">ValueHere</ReplaceString>
<SearchString d4p1:nil="false">ValueHere</SearchString>
</SearchAndReplaceForFinalURLSuffix>
<SearchAndReplaceForTrackingTemplates d4p1:nil="false">
<ReplaceString d4p1:nil="false">ValueHere</ReplaceString>
<SearchString d4p1:nil="false">ValueHere</SearchString>
</SearchAndReplaceForTrackingTemplates>
<SearchAndReplaceForUrls d4p1:nil="false">
<ReplaceString d4p1:nil="false">ValueHere</ReplaceString>
<SearchString d4p1:nil="false">ValueHere</SearchString>
</SearchAndReplaceForUrls>
<SuffixForCampaignNames d4p1:nil="false">ValueHere</SuffixForCampaignNames>
<SuffixForTrackingTemplates d4p1:nil="false">ValueHere</SuffixForTrackingTemplates>
<SuffixForUrls d4p1:nil="false">ValueHere</SuffixForUrls>
<UpdateAccountNegativeKeywords d4p1:nil="false">ValueHere</UpdateAccountNegativeKeywords>
<UpdateAdCustomizerAttributes d4p1:nil="false">ValueHere</UpdateAdCustomizerAttributes>
<UpdateAdCustomizerFeeds d4p1:nil="false">ValueHere</UpdateAdCustomizerFeeds>
<UpdateAdGroupNetwork d4p1:nil="false">ValueHere</UpdateAdGroupNetwork>
<UpdateAdSchedules d4p1:nil="false">ValueHere</UpdateAdSchedules>
<UpdateAdUrls d4p1:nil="false">ValueHere</UpdateAdUrls>
<UpdateAppAdExtensions d4p1:nil="false">ValueHere</UpdateAppAdExtensions>
<UpdateAudienceTargets d4p1:nil="false">ValueHere</UpdateAudienceTargets>
<UpdateBiddingStrategies d4p1:nil="false">ValueHere</UpdateBiddingStrategies>
<UpdateBids d4p1:nil="false">ValueHere</UpdateBids>
<UpdateBrandSuitability d4p1:nil="false">ValueHere</UpdateBrandSuitability>
<UpdateCallAdExtensions d4p1:nil="false">ValueHere</UpdateCallAdExtensions>
<UpdateCalloutAdExtensions d4p1:nil="false">ValueHere</UpdateCalloutAdExtensions>
<UpdateCampaignAdGroupLanguages d4p1:nil="false">ValueHere</UpdateCampaignAdGroupLanguages>
<UpdateCampaignBudgets d4p1:nil="false">ValueHere</UpdateCampaignBudgets>
<UpdateCampaignNames d4p1:nil="false">ValueHere</UpdateCampaignNames>
<UpdateConversionGoals d4p1:nil="false">ValueHere</UpdateConversionGoals>
<UpdateDemographicTargets d4p1:nil="false">ValueHere</UpdateDemographicTargets>
<UpdateDeviceTargets d4p1:nil="false">ValueHere</UpdateDeviceTargets>
<UpdateEntities d4p1:nil="false">ValueHere</UpdateEntities>
<UpdateImageAdExtensions d4p1:nil="false">ValueHere</UpdateImageAdExtensions>
<UpdateKeywordUrls d4p1:nil="false">ValueHere</UpdateKeywordUrls>
<UpdateLabels d4p1:nil="false">ValueHere</UpdateLabels>
<UpdateLeadFormAdExtensions d4p1:nil="false">ValueHere</UpdateLeadFormAdExtensions>
<UpdateLocationAdExtensions d4p1:nil="false">ValueHere</UpdateLocationAdExtensions>
<UpdateLocationTargets d4p1:nil="false">ValueHere</UpdateLocationTargets>
<UpdateLogoAdExtensions d4p1:nil="false">ValueHere</UpdateLogoAdExtensions>
<UpdateNegativeKeywordLists d4p1:nil="false">ValueHere</UpdateNegativeKeywordLists>
<UpdateNegativeSites d4p1:nil="false">ValueHere</UpdateNegativeSites>
<UpdatePageFeeds d4p1:nil="false">ValueHere</UpdatePageFeeds>
<UpdatePriceAdExtensions d4p1:nil="false">ValueHere</UpdatePriceAdExtensions>
<UpdateProductFilters d4p1:nil="false">ValueHere</UpdateProductFilters>
<UpdatePromotionAdExtensions d4p1:nil="false">ValueHere</UpdatePromotionAdExtensions>
<UpdateReviewAdExtensions d4p1:nil="false">ValueHere</UpdateReviewAdExtensions>
<UpdateSitelinkAdExtensions d4p1:nil="false">ValueHere</UpdateSitelinkAdExtensions>
<UpdateSitelinkUrls d4p1:nil="false">ValueHere</UpdateSitelinkUrls>
<UpdateStatusForAdGroups d4p1:nil="false">ValueHere</UpdateStatusForAdGroups>
<UpdateStatusForAds d4p1:nil="false">ValueHere</UpdateStatusForAds>
<UpdateStatusForCampaigns d4p1:nil="false">ValueHere</UpdateStatusForCampaigns>
<UpdateStatusForKeywords d4p1:nil="false">ValueHere</UpdateStatusForKeywords>
<UpdateStructuredSnippetAdExtensions d4p1:nil="false">ValueHere</UpdateStructuredSnippetAdExtensions>
<UpdateUrlOptions d4p1:nil="false">ValueHere</UpdateUrlOptions>
<!--No additional fields are applicable if the derived type attribute is set to FileImportOption-->
</ImportOption>
<LastRunTimeInUTC d4p1:nil="false">ValueHere</LastRunTimeInUTC>
<Name d4p1:nil="false">ValueHere</Name>
<NotificationEmail d4p1:nil="false">ValueHere</NotificationEmail>
<NotificationType d4p1:nil="false">ValueHere</NotificationType>
<Status d4p1:nil="false">ValueHere</Status>
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to GoogleImportJob-->
<CampaignAdGroupIds d4p1:nil="false">
<CampaignAdGroupIds>
<ActiveAdGroupsOnly d4p1:nil="false">ValueHere</ActiveAdGroupsOnly>
<AdGroupIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</AdGroupIds>
<CampaignId>ValueHere</CampaignId>
</CampaignAdGroupIds>
</CampaignAdGroupIds>
<CredentialId d4p1:nil="false">ValueHere</CredentialId>
<GoogleAccountId d4p1:nil="false">ValueHere</GoogleAccountId>
<GoogleUserName d4p1:nil="false">ValueHere</GoogleUserName>
<!--These fields are applicable if the derived type attribute is set to FileImportJob-->
<FileSource d4p1:nil="false">ValueHere</FileSource>
<FileUrl d4p1:nil="false">ValueHere</FileUrl>
</ImportJob>
</ImportJobs>
<PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
<Code>ValueHere</Code>
<Details d4p1:nil="false">ValueHere</Details>
<ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
<FieldPath d4p1:nil="false">ValueHere</FieldPath>
<ForwardCompatibilityMap xmlns:e310="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e310:KeyValuePairOfstringstring>
<e310:key d4p1:nil="false">ValueHere</e310:key>
<e310:value d4p1:nil="false">ValueHere</e310:value>
</e310:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Index>ValueHere</Index>
<Message d4p1:nil="false">ValueHere</Message>
<Type d4p1:nil="false">ValueHere</Type>
<!--These fields are applicable if the derived type attribute is set to EditorialError-->
<Appealable d4p1:nil="false">ValueHere</Appealable>
<DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
<Location d4p1:nil="false">ValueHere</Location>
<PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
<ReasonCode>ValueHere</ReasonCode>
</BatchError>
</PartialErrors>
</GetImportJobsByIdsResponse>
</s:Body>
</s:Envelope>
Code Syntax
The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<GetImportJobsByIdsResponse> GetImportJobsByIdsAsync(
IList<long> importJobIds,
string importType,
ImportAdditionalField? returnAdditionalFields)
{
var request = new GetImportJobsByIdsRequest
{
ImportJobIds = importJobIds,
ImportType = importType,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetImportJobsByIdsAsync(r), request));
}
static GetImportJobsByIdsResponse getImportJobsByIds(
ArrayOflong importJobIds,
java.lang.String importType,
ArrayList<ImportAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetImportJobsByIdsRequest request = new GetImportJobsByIdsRequest();
request.setImportJobIds(importJobIds);
request.setImportType(importType);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getImportJobsByIds(request);
}
static function GetImportJobsByIds(
$importJobIds,
$importType,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetImportJobsByIdsRequest();
$request->ImportJobIds = $importJobIds;
$request->ImportType = $importType;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetImportJobsByIds($request);
}
response=campaignmanagement_service.GetImportJobsByIds(
ImportJobIds=ImportJobIds,
ImportType=ImportType,
ReturnAdditionalFields=ReturnAdditionalFields)
Requirements
Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
Request Url
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/ImportJobs/QueryByIds
Request Elements
The GetImportJobsByIdsRequest object defines the body and header elements of the service operation request.
Note
Unless otherwise noted below, all request elements are required.
Request Body Elements
| Element | Description | Data Type |
|---|---|---|
| ImportJobIds | The identifiers of the import jobs to get. You can specify a maximum of 100 import job IDs. If this element is not specified, the operation will return up to 500 import jobs in the ad account. |
long array |
| ImportType | The type of import job to get. To get GoogleImportJob objects, set this element to "GoogleImportJob". |
string |
| ReturnAdditionalFields | 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 elements will be included by default. This request element is optional. |
ImportAdditionalField |
Request Header Elements
| Element | Description | Data Type |
|---|---|---|
| Authorization | The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth. |
string |
| CustomerAccountId | The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| CustomerId | The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs. |
string |
| DeveloperToken | The developer token used to access the Bing Ads API. For more information see Get a Developer Token. |
string |
| Password | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
| UserName | This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials. | string |
Response Elements
The GetImportJobsByIdsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.
Response Body Elements
| Element | Description | Data Type |
|---|---|---|
| ImportJobs | The import jobs that matched the request criteria. | ImportJob array |
| PartialErrors | An array of BatchError objects that contain details for any request items that were not successful. The list of errors do not correspond directly to the list of items in the request. The list can be empty if there were no errors, or can include one or more error objects corresponding to each unsuccessful list item in the request. |
BatchError array |
Response Header Elements
| Element | Description | Data Type |
|---|---|---|
| TrackingId | The identifier of the log entry that contains the details of the API call. | string |
Request JSON
This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.
{
"ImportJobIds": [
"LongValueHere"
],
"ImportType": "ValueHere",
"ReturnAdditionalFields": "ValueHere"
}
Response JSON
This template was generated by a tool to show the body and header elements for the JSON response.
Below is an example that is applicable if the type of ImportJob is FileImportJob, ImportOption is GoogleImportOption, BatchError is EditorialError.
{
"ImportJobs": [
{
"CreatedByUserId": "LongValueHere",
"CreatedByUserName": "ValueHere",
"CreatedDateTimeInUTC": "ValueHere",
"Frequency": {
"Cron": "ValueHere",
"TimeZone": "ValueHere",
"Type": "ValueHere"
},
"Id": "LongValueHere",
"ImportOption": {
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Type": "GoogleImportOption",
"AccountUrlOptions": "ValueHere",
"AdjustmentForBids": DoubleValueHere,
"AdjustmentForCampaignBudgets": DoubleValueHere,
"AdScheduleUseSearcherTimezone": "ValueHere",
"AssociatedStoreId": "LongValueHere",
"AssociatedUetTagId": "LongValueHere",
"AutoDeviceBidOptimization": "ValueHere",
"DeleteRemovedEntities": "ValueHere",
"EnableAutoCurrencyConversion": "ValueHere",
"EnableParentLocationMapping": "ValueHere",
"NewAccountNegativeKeywords": "ValueHere",
"NewActiveAdsForExistingAdGroups": "ValueHere",
"NewActiveCampaignsAndChildEntities": "ValueHere",
"NewAdCustomizerFeeds": "ValueHere",
"NewAdGroupsAndChildEntitiesForExistingCampaigns": "ValueHere",
"NewAdSchedules": "ValueHere",
"NewAppAdExtensions": "ValueHere",
"NewAudienceTargets": "ValueHere",
"NewBrandSuitability": "ValueHere",
"NewCallAdExtensions": "ValueHere",
"NewCalloutAdExtensions": "ValueHere",
"NewConversionGoals": "ValueHere",
"NewDemographicTargets": "ValueHere",
"NewDeviceTargets": "ValueHere",
"NewEntities": "ValueHere",
"NewImageAdExtensions": "ValueHere",
"NewKeywordsForExistingAdGroups": "ValueHere",
"NewKeywordUrls": "ValueHere",
"NewLabels": "ValueHere",
"NewLeadFormAdExtensions": "ValueHere",
"NewLocationAdExtensions": "ValueHere",
"NewLocationTargets": "ValueHere",
"NewLogoAdExtensions": "ValueHere",
"NewNegativeKeywordLists": "ValueHere",
"NewNegativeKeywordsForExistingParents": "ValueHere",
"NewNegativeSites": "ValueHere",
"NewPageFeeds": "ValueHere",
"NewPausedAdsForExistingAdGroups": "ValueHere",
"NewPausedCampaignsAndChildEntities": "ValueHere",
"NewPriceAdExtensions": "ValueHere",
"NewProductFilters": "ValueHere",
"NewPromotionAdExtensions": "ValueHere",
"NewReviewAdExtensions": "ValueHere",
"NewSitelinkAdExtensions": "ValueHere",
"NewStructuredSnippetAdExtensions": "ValueHere",
"NewUrlOptions": "ValueHere",
"PauseAIMAdGroupIfAllAudienceCriterionNotImported": "ValueHere",
"PauseCampaignsWithoutSupportedLocations": "ValueHere",
"PauseNewCampaigns": "ValueHere",
"RaiseBidsToMinimum": "ValueHere",
"RaiseCampaignBudgetsToMinimum": "ValueHere",
"RaiseProductGroupBidsToMinimum": "ValueHere",
"RenameCampaignNameWithSuffix": "ValueHere",
"SearchAndDsaMixedCampaignAsSearchCampaign": "ValueHere",
"SearchAndReplaceForCampaignNames": {
"ReplaceString": "ValueHere",
"SearchString": "ValueHere"
},
"SearchAndReplaceForCustomParameters": {
"ReplaceString": "ValueHere",
"SearchString": "ValueHere"
},
"SearchAndReplaceForFinalURLSuffix": {
"ReplaceString": "ValueHere",
"SearchString": "ValueHere"
},
"SearchAndReplaceForTrackingTemplates": {
"ReplaceString": "ValueHere",
"SearchString": "ValueHere"
},
"SearchAndReplaceForUrls": {
"ReplaceString": "ValueHere",
"SearchString": "ValueHere"
},
"SuffixForCampaignNames": "ValueHere",
"SuffixForTrackingTemplates": "ValueHere",
"SuffixForUrls": "ValueHere",
"UpdateAccountNegativeKeywords": "ValueHere",
"UpdateAdCustomizerAttributes": "ValueHere",
"UpdateAdCustomizerFeeds": "ValueHere",
"UpdateAdGroupNetwork": "ValueHere",
"UpdateAdSchedules": "ValueHere",
"UpdateAdUrls": "ValueHere",
"UpdateAppAdExtensions": "ValueHere",
"UpdateAudienceTargets": "ValueHere",
"UpdateBiddingStrategies": "ValueHere",
"UpdateBids": "ValueHere",
"UpdateBrandSuitability": "ValueHere",
"UpdateCallAdExtensions": "ValueHere",
"UpdateCalloutAdExtensions": "ValueHere",
"UpdateCampaignAdGroupLanguages": "ValueHere",
"UpdateCampaignBudgets": "ValueHere",
"UpdateCampaignNames": "ValueHere",
"UpdateConversionGoals": "ValueHere",
"UpdateDemographicTargets": "ValueHere",
"UpdateDeviceTargets": "ValueHere",
"UpdateEntities": "ValueHere",
"UpdateImageAdExtensions": "ValueHere",
"UpdateKeywordUrls": "ValueHere",
"UpdateLabels": "ValueHere",
"UpdateLeadFormAdExtensions": "ValueHere",
"UpdateLocationAdExtensions": "ValueHere",
"UpdateLocationTargets": "ValueHere",
"UpdateLogoAdExtensions": "ValueHere",
"UpdateNegativeKeywordLists": "ValueHere",
"UpdateNegativeSites": "ValueHere",
"UpdatePageFeeds": "ValueHere",
"UpdatePriceAdExtensions": "ValueHere",
"UpdateProductFilters": "ValueHere",
"UpdatePromotionAdExtensions": "ValueHere",
"UpdateReviewAdExtensions": "ValueHere",
"UpdateSitelinkAdExtensions": "ValueHere",
"UpdateSitelinkUrls": "ValueHere",
"UpdateStatusForAdGroups": "ValueHere",
"UpdateStatusForAds": "ValueHere",
"UpdateStatusForCampaigns": "ValueHere",
"UpdateStatusForKeywords": "ValueHere",
"UpdateStructuredSnippetAdExtensions": "ValueHere",
"UpdateUrlOptions": "ValueHere"
},
"LastRunTimeInUTC": "ValueHere",
"Name": "ValueHere",
"NotificationEmail": "ValueHere",
"NotificationType": "ValueHere",
"Status": "ValueHere",
"Type": "FileImportJob",
"FileSource": "ValueHere",
"FileUrl": "ValueHere"
}
],
"PartialErrors": [
{
"Code": IntValueHere,
"Details": "ValueHere",
"ErrorCode": "ValueHere",
"FieldPath": "ValueHere",
"ForwardCompatibilityMap": [
{
"key": "ValueHere",
"value": "ValueHere"
}
],
"Index": IntValueHere,
"Message": "ValueHere",
"Type": "EditorialError",
"Appealable": "ValueHere",
"DisapprovedText": "ValueHere",
"Location": "ValueHere",
"PublisherCountry": "ValueHere",
"ReasonCode": IntValueHere
}
]
}
Code Syntax
To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.
public async Task<GetImportJobsByIdsResponse> GetImportJobsByIdsAsync(
IList<long> importJobIds,
string importType,
ImportAdditionalField? returnAdditionalFields)
{
var request = new GetImportJobsByIdsRequest
{
ImportJobIds = importJobIds,
ImportType = importType,
ReturnAdditionalFields = returnAdditionalFields
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetImportJobsByIdsAsync(r), request));
}
static GetImportJobsByIdsResponse getImportJobsByIds(
ArrayOflong importJobIds,
java.lang.String importType,
ArrayList<ImportAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
GetImportJobsByIdsRequest request = new GetImportJobsByIdsRequest();
request.setImportJobIds(importJobIds);
request.setImportType(importType);
request.setReturnAdditionalFields(returnAdditionalFields);
return CampaignManagementService.getService().getImportJobsByIds(request);
}
static function GetImportJobsByIds(
$importJobIds,
$importType,
$returnAdditionalFields)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetImportJobsByIdsRequest();
$request->ImportJobIds = $importJobIds;
$request->ImportType = $importType;
$request->ReturnAdditionalFields = $returnAdditionalFields;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetImportJobsByIds($request);
}
response=campaignmanagement_service.GetImportJobsByIds(
ImportJobIds=ImportJobIds,
ImportType=ImportType,
ReturnAdditionalFields=ReturnAdditionalFields)