GetImportJobsByIds サービス操作 - キャンペーン管理
インポート ジョブを型と識別子で取得します。
ヒント
実装の概要については、 Google 広告のインポート に関するテクニカル ガイドを参照してください。
Request 要素
GetImportJobsByIdsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
| 要素 | 説明 | データ型 |
|---|---|---|
| ImportJobIds | 取得するインポート ジョブの識別子。 最大 100 個のインポート ジョブ ID を指定できます。 この要素が指定されていない場合、操作は広告アカウントで最大 500 個のインポート ジョブを返します。 |
long 配列 |
| ImportType | 取得するインポート ジョブの種類。 GoogleImportJob オブジェクトを取得するには、この要素を "GoogleImportJob" に設定します。 |
string |
| ReturnAdditionalFields | 追加のフィールド値を使用すると、現在のバージョンの Campaign Management API を使用して最新の機能を取得できます。次のバージョンでは、対応する要素が既定で含まれます。 この要求要素は省略可能です。 |
ImportAdditionalField |
要求ヘッダー要素
| 要素 | 説明 | データ型 |
|---|---|---|
| AuthenticationToken | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 詳細については、「 OAuth による認証」を参照してください。 |
string |
| CustomerAccountId | 要求のエンティティを所有または関連付けられている広告アカウントの識別子。 両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
| CustomerId | ユーザーがアクセスまたは操作しているマネージャー アカウント (顧客) の識別子。 ユーザーは複数のマネージャー アカウントにアクセスできます。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
| DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
| Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
| UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
GetImportJobsByIdsResponse オブジェクトは、サービス操作応答の本文とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。
応答本文の要素
| 要素 | 説明 | データ型 |
|---|---|---|
| ImportJobs | 要求条件に一致したインポート ジョブ。 | ImportJob 配列 |
| PartialErrors | 成功しなかった要求項目の詳細を含む BatchError オブジェクトの配列。 エラーの一覧は、要求内の項目の一覧に直接対応していません。 エラーがない場合はリストを空にすることも、失敗したリスト 項目ごとに対応する 1 つ以上のエラー オブジェクトを要求に含めることもできます。 |
BatchError 配列 |
応答ヘッダー要素
| 要素 | 説明 | データ型 |
|---|---|---|
| TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
SOAP を要求する
このテンプレートは、SOAP 要求の本文要素とヘッダー要素の順序を示すツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
<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>
応答 SOAP
このテンプレートは、SOAP 応答の 本文 要素と ヘッダー 要素の順序を示すツールによって生成されました。
<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:e459="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e459:KeyValuePairOfstringstring>
<e459:key d4p1:nil="false">ValueHere</e459:key>
<e459:value d4p1:nil="false">ValueHere</e459:value>
</e459: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:e460="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e460:KeyValuePairOfstringstring>
<e460:key d4p1:nil="false">ValueHere</e460:key>
<e460:value d4p1:nil="false">ValueHere</e460:value>
</e460: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>
コード構文
構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
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)
要件
サービス: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
要求 URL
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/ImportJobs/QueryByIds
Request 要素
GetImportJobsByIdsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。
注:
以下に特に記載がない限り、すべての要求要素が必要です。
要求本文要素
| 要素 | 説明 | データ型 |
|---|---|---|
| ImportJobIds | 取得するインポート ジョブの識別子。 最大 100 個のインポート ジョブ ID を指定できます。 この要素が指定されていない場合、操作は広告アカウントで最大 500 個のインポート ジョブを返します。 |
long 配列 |
| ImportType | 取得するインポート ジョブの種類。 GoogleImportJob オブジェクトを取得するには、この要素を "GoogleImportJob" に設定します。 |
string |
| ReturnAdditionalFields | 追加のフィールド値を使用すると、現在のバージョンの Campaign Management API を使用して最新の機能を取得できます。次のバージョンでは、対応する要素が既定で含まれます。 この要求要素は省略可能です。 |
ImportAdditionalField |
要求ヘッダー要素
| 要素 | 説明 | データ型 |
|---|---|---|
| Authorization | Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。 詳細については、「 OAuth による認証」を参照してください。 |
string |
| CustomerAccountId | 要求のエンティティを所有または関連付けられている広告アカウントの識別子。 両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
| CustomerId | ユーザーがアクセスまたは操作しているマネージャー アカウント (顧客) の識別子。 ユーザーは複数のマネージャー アカウントにアクセスできます。 この要素は、ほとんどのサービス操作に必要であり、ベスト プラクティスとして常に設定する必要があります。 詳細については、「 アカウントと顧客 ID を取得する」を参照してください。 |
string |
| DeveloperToken | Bing Ads API へのアクセスに使用される開発者トークン。 詳細については、「 開発者トークンを取得する」を参照してください。 |
string |
| Password | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
| UserName | この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 | string |
Response 要素
GetImportJobsByIdsResponse オブジェクトは、サービス操作応答の本文とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。
応答本文の要素
| 要素 | 説明 | データ型 |
|---|---|---|
| ImportJobs | 要求条件に一致したインポート ジョブ。 | ImportJob 配列 |
| PartialErrors | 成功しなかった要求項目の詳細を含む BatchError オブジェクトの配列。 エラーの一覧は、要求内の項目の一覧に直接対応していません。 エラーがない場合はリストを空にすることも、失敗したリスト 項目ごとに対応する 1 つ以上のエラー オブジェクトを要求に含めることもできます。 |
BatchError 配列 |
応答ヘッダー要素
| 要素 | 説明 | データ型 |
|---|---|---|
| TrackingId | API 呼び出しの詳細を含むログ エントリの識別子。 | string |
JSON を要求する
このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。
{
"ImportJobIds": [
"LongValueHere"
],
"ImportType": "ValueHere",
"ReturnAdditionalFields": "ValueHere"
}
応答 JSON
このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。
ImportJob の種類が FileImportJob、ImportOption が GoogleImportOption、BatchError が 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
}
]
}
コード構文
SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。
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)