次の方法で共有

DownloadCampaignsByAccountIds サービス操作 - 一括

  • [アーティクル]

アカウントのすべてのキャンペーンの設定とパフォーマンス データをダウンロードします。 すべてのキャンペーン データ、またはアカウントを最後にダウンロードした後に変更されたデータのみを要求できます。

ダウンロード要求操作 ( DownloadCampaignsByAccountIds または DownloadCampaignsByCampaignIds) と GetBulkDownloadStatus ポーリング操作に同じユーザー資格情報を使用する必要があります。

ヒント

一括ファイル スキーマでは、ダウンロードおよびアップロードできるレコードの詳細が提供されます。 ベスト プラクティスに従って、自分自身とすべての Microsoft Advertising クライアントの公平な使用を確保してください。 詳細については、「 一括ダウンロードのベスト プラクティス 」と「 一括アップロードのベスト プラクティス」を参照してください。

Request 要素

DownloadCampaignsByAccountIdsRequest オブジェクトは、サービス操作要求の本文とヘッダー要素を定義します。 要素は、 要求 SOAP に示されている順序と同じ順序である必要があります。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素 説明 データ型
AccountIds ダウンロードするキャンペーン データを含むアカウントの識別子。 指定できるアカウントの最大数は 1 です。

ダウンロードできるアカウントのサイズは、400 万個のキーワードに制限されています。 400 万を超えるキーワードを含むアカウントをダウンロードしようとすると、呼び出しはエラー 3207 (AccountTooBigToDownload) で失敗します。 通話が失敗した場合は、 DownloadCampaignsByCampaignIds 操作を呼び出して、キャンペーン別にアカウントをダウンロードしてください。 エラーの Details 要素には、アカウントが所有するキャンペーン ID のコンマ区切りのリストが含まれています。		 long 配列
CompressionType ダウンロード ファイルの圧縮の種類。 使用可能な値については、「 CompressionType」を参照してください。 既定の圧縮の種類は Zip です。 CompressionType
DataScope キャンペーン設定などのエンティティ データに加えて、広告の関連性などの品質スコア データを含めることができます。 既定値は EntityData です。

フラグとして複数の値を含めることができます。 複数のフラグを指定する方法は、使用するプログラミング言語によって異なります。 たとえば、C# はこれらの値をフラグ値として扱い、Java はそれらを文字列の配列として扱います。 SOAP には、スペース区切りの値の一覧 (たとえば、 <DataScope>EntityData QualityScoreData</DataScope>) を含む文字列を含める必要があります。

BidSuggestionsData または QualityScoreData が含まれている場合は、完全同期を要求する必要があります。完全同期を実行するには、LastSyncTimeInUTC を設定しないでください。つまり、そのままにします。		 DataScope
DownloadEntities ダウンロードに含めるエンティティ。 ダウンロードできるエンティティの一覧については、 DownloadEntity 値セットを参照してください。

少なくとも 1 つのダウンロード エンティティを指定する必要があります。それ以外の場合、操作はエラーになります。		 DownloadEntity 配列
DownloadFileType ダウンロード ファイルのファイルの種類。 使用可能な値については、「 DownloadFileType」を参照してください。 既定値は CSV です。 DownloadFileType
FormatVersion ダウンロード ファイルのレコードの形式。

ベスト プラクティスとして、常に最新の形式バージョンを指定する必要があります。 現在、Bing Ads API バージョン 13 でサポートされている唯一のフォーマット バージョンは 6.0 です。

対応する形式バージョンの 一括ファイル スキーマ に従ってレコードを管理する必要があります。		 string
LastSyncTimeInUTC 最後にダウンロードを要求した時刻。 日付と時刻は協定世界時 (UTC) で表されます。

最後の同期時刻を指定すると、指定した日時以降に変更 (追加、更新、または削除) されたエンティティのみがダウンロードされます。 指定した最終同期時刻以降に親キャンペーンまたは広告グループが削除された場合、削除された親キャンペーンまたは広告グループの削除済みレコードのみが表示されます。 たとえば、キャンペーンが削除された場合、一括ファイルには、キャンペーンにあった広告グループ、条件、広告、キーワードの削除されたレコードは含まれません。

ターゲット条件は、他のエンティティとは若干異なる処理が行われ、削除されたレコードは返されません。 キャンペーンまたは広告グループのターゲットに変更が加えられた場合は、現在アクティブなすべてのサブターゲット条件レコードが返されます。

通常、この要素を null に設定して、操作を初めて呼び出す際にフル ダウンロードを要求します。 それ以降のすべての呼び出しで、前回の同期時刻を前のダウンロードのタイム スタンプに設定します。

ダウンロード ファイルには、アカウント レコードの [同期時間] 列にダウンロードのタイム スタンプが含まれています。 アカウント同期 時間 を使用して、次回ダウンロードを要求するときにこの要素を設定する必要があります。

30 日以上前の日付と時刻を設定すると、エラーが返されます。		 dateTime

要求ヘッダー要素

要素 説明 データ型
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 要素

DownloadCampaignsByAccountIdsResponse オブジェクトは、サービス操作応答の本文とヘッダー要素を定義します。 要素は、 応答 SOAP に示されている順序と同じ順序で返されます。

応答本文の要素

要素 説明 データ型
DownloadRequestId ダウンロード要求の識別子。

識別子を使用して GetBulkDownloadStatus 操作を呼び出して、ダウンロードの状態をチェックします。

識別子は最大 2 日間有効です。 この期間内にファイルが正常にダウンロードされていない場合は、ダウンロード サイトから削除され、新しいダウンロード要求識別子を取得する必要があります。

文字列の長さは最大 40 で、任意の文字を含めることができます。		 string

応答ヘッダー要素

要素 説明 データ型
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">DownloadCampaignsByAccountIds</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>
    <DownloadCampaignsByAccountIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </AccountIds>
      <CompressionType i:nil="false">ValueHere</CompressionType>
      <DataScope>ValueHere</DataScope>
      <DownloadEntities i:nil="false">
        <DownloadEntity>ValueHere</DownloadEntity>
      </DownloadEntities>
      <DownloadFileType i:nil="false">ValueHere</DownloadFileType>
      <FormatVersion i:nil="false">ValueHere</FormatVersion>
      <LastSyncTimeInUTC i:nil="false">ValueHere</LastSyncTimeInUTC>
    </DownloadCampaignsByAccountIdsRequest>
  </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>
    <DownloadCampaignsByAccountIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <DownloadRequestId d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</DownloadRequestId>
    </DownloadCampaignsByAccountIdsResponse>
  </s:Body>
</s:Envelope>

コード構文

構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。

public async Task<DownloadCampaignsByAccountIdsResponse> DownloadCampaignsByAccountIdsAsync(
	IList<long> accountIds,
	CompressionType? compressionType,
	DataScope dataScope,
	IList<DownloadEntity> downloadEntities,
	DownloadFileType? downloadFileType,
	string formatVersion,
	DateTime? lastSyncTimeInUTC)
{
	var request = new DownloadCampaignsByAccountIdsRequest
	{
		AccountIds = accountIds,
		CompressionType = compressionType,
		DataScope = dataScope,
		DownloadEntities = downloadEntities,
		DownloadFileType = downloadFileType,
		FormatVersion = formatVersion,
		LastSyncTimeInUTC = lastSyncTimeInUTC
	};

	return (await BulkService.CallAsync((s, r) => s.DownloadCampaignsByAccountIdsAsync(r), request));
}

static DownloadCampaignsByAccountIdsResponse downloadCampaignsByAccountIds(
	ArrayOflong accountIds,
	CompressionType compressionType,
	ArrayList<DataScope> dataScope,
	ArrayOfDownloadEntity downloadEntities,
	DownloadFileType downloadFileType,
	java.lang.String formatVersion,
	Calendar lastSyncTimeInUTC) throws RemoteException, Exception
{
	DownloadCampaignsByAccountIdsRequest request = new DownloadCampaignsByAccountIdsRequest();

	request.setAccountIds(accountIds);
	request.setCompressionType(compressionType);
	request.setDataScope(dataScope);
	request.setDownloadEntities(downloadEntities);
	request.setDownloadFileType(downloadFileType);
	request.setFormatVersion(formatVersion);
	request.setLastSyncTimeInUTC(lastSyncTimeInUTC);

	return BulkService.getService().downloadCampaignsByAccountIds(request);
}

static function DownloadCampaignsByAccountIds(
	$accountIds,
	$compressionType,
	$dataScope,
	$downloadEntities,
	$downloadFileType,
	$formatVersion,
	$lastSyncTimeInUTC)
{

	$GLOBALS['Proxy'] = $GLOBALS['BulkProxy'];

	$request = new DownloadCampaignsByAccountIdsRequest();

	$request->AccountIds = $accountIds;
	$request->CompressionType = $compressionType;
	$request->DataScope = $dataScope;
	$request->DownloadEntities = $downloadEntities;
	$request->DownloadFileType = $downloadFileType;
	$request->FormatVersion = $formatVersion;
	$request->LastSyncTimeInUTC = $lastSyncTimeInUTC;

	return $GLOBALS['BulkProxy']->GetService()->DownloadCampaignsByAccountIds($request);
}

response=bulk_service.DownloadCampaignsByAccountIds(
	AccountIds=AccountIds,
	CompressionType=CompressionType,
	DataScope=DataScope,
	DownloadEntities=DownloadEntities,
	DownloadFileType=DownloadFileType,
	FormatVersion=FormatVersion,
	LastSyncTimeInUTC=LastSyncTimeInUTC)

要件

サービス: BulkService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

要求 URL

https://bulk.api.bingads.microsoft.com/Bulk/v13/Campaigns/DownloadByAccountIds

Request 要素

DownloadCampaignsByAccountIdsRequest オブジェクトは、サービス操作要求の本文とヘッダー要素を定義します。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素 説明 データ型
AccountIds ダウンロードするキャンペーン データを含むアカウントの識別子。 指定できるアカウントの最大数は 1 です。

ダウンロードできるアカウントのサイズは、400 万個のキーワードに制限されています。 400 万を超えるキーワードを含むアカウントをダウンロードしようとすると、呼び出しはエラー 3207 (AccountTooBigToDownload) で失敗します。 通話が失敗した場合は、 DownloadCampaignsByCampaignIds 操作を呼び出して、キャンペーン別にアカウントをダウンロードしてください。 エラーの Details 要素には、アカウントが所有するキャンペーン ID のコンマ区切りのリストが含まれています。		 long 配列
CompressionType ダウンロード ファイルの圧縮の種類。 使用可能な値については、「 CompressionType」を参照してください。 既定の圧縮の種類は Zip です。 CompressionType
DataScope キャンペーン設定などのエンティティ データに加えて、広告の関連性などの品質スコア データを含めることができます。 既定値は EntityData です。

フラグとして複数の値を含めることができます。 複数のフラグを指定する方法は、使用するプログラミング言語によって異なります。 たとえば、C# はこれらの値をフラグ値として扱い、Java はそれらを文字列の配列として扱います。 SOAP には、スペース区切りの値の一覧 (たとえば、 <DataScope>EntityData QualityScoreData</DataScope>) を含む文字列を含める必要があります。

BidSuggestionsData または QualityScoreData が含まれている場合は、完全同期を要求する必要があります。完全同期を実行するには、LastSyncTimeInUTC を設定しないでください。つまり、そのままにします。		 DataScope
DownloadEntities ダウンロードに含めるエンティティ。 ダウンロードできるエンティティの一覧については、 DownloadEntity 値セットを参照してください。

少なくとも 1 つのダウンロード エンティティを指定する必要があります。それ以外の場合、操作はエラーになります。		 DownloadEntity 配列
DownloadFileType ダウンロード ファイルのファイルの種類。 使用可能な値については、「 DownloadFileType」を参照してください。 既定値は CSV です。 DownloadFileType
FormatVersion ダウンロード ファイルのレコードの形式。

ベスト プラクティスとして、常に最新の形式バージョンを指定する必要があります。 現在、Bing Ads API バージョン 13 でサポートされている唯一のフォーマット バージョンは 6.0 です。

対応する形式バージョンの 一括ファイル スキーマ に従ってレコードを管理する必要があります。		 string
LastSyncTimeInUTC 最後にダウンロードを要求した時刻。 日付と時刻は協定世界時 (UTC) で表されます。

最後の同期時刻を指定すると、指定した日時以降に変更 (追加、更新、または削除) されたエンティティのみがダウンロードされます。 指定した最終同期時刻以降に親キャンペーンまたは広告グループが削除された場合、削除された親キャンペーンまたは広告グループの削除済みレコードのみが表示されます。 たとえば、キャンペーンが削除された場合、一括ファイルには、キャンペーンにあった広告グループ、条件、広告、キーワードの削除されたレコードは含まれません。

ターゲット条件は、他のエンティティとは若干異なる処理が行われ、削除されたレコードは返されません。 キャンペーンまたは広告グループのターゲットに変更が加えられた場合は、現在アクティブなすべてのサブターゲット条件レコードが返されます。

通常、この要素を null に設定して、操作を初めて呼び出す際にフル ダウンロードを要求します。 それ以降のすべての呼び出しで、前回の同期時刻を前のダウンロードのタイム スタンプに設定します。

ダウンロード ファイルには、アカウント レコードの [同期時間] 列にダウンロードのタイム スタンプが含まれています。 アカウント同期 時間 を使用して、次回ダウンロードを要求するときにこの要素を設定する必要があります。

30 日以上前の日付と時刻を設定すると、エラーが返されます。		 dateTime

要求ヘッダー要素

要素 説明 データ型
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 要素

DownloadCampaignsByAccountIdsResponse オブジェクトは、サービス操作応答の本文とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。

応答本文の要素

要素 説明 データ型
DownloadRequestId ダウンロード要求の識別子。

識別子を使用して GetBulkDownloadStatus 操作を呼び出して、ダウンロードの状態をチェックします。

識別子は最大 2 日間有効です。 この期間内にファイルが正常にダウンロードされていない場合は、ダウンロード サイトから削除され、新しいダウンロード要求識別子を取得する必要があります。

文字列の長さは最大 40 で、任意の文字を含めることができます。		 string

応答ヘッダー要素

要素 説明 データ型
TrackingId API 呼び出しの詳細を含むログ エントリの識別子。 string

JSON を要求する

このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。

{
  "AccountIds": [
    "LongValueHere"
  ],
  "CompressionType": "ValueHere",
  "DataScope": "ValueHere",
  "DownloadEntities": [
    "ValueHere"
  ],
  "DownloadFileType": "ValueHere",
  "FormatVersion": "ValueHere",
  "LastSyncTimeInUTC": "ValueHere"
}

応答 JSON

このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。

{
  "DownloadRequestId": "ValueHere"
}

コード構文

SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。

public async Task<DownloadCampaignsByAccountIdsResponse> DownloadCampaignsByAccountIdsAsync(
	IList<long> accountIds,
	CompressionType? compressionType,
	DataScope dataScope,
	IList<DownloadEntity> downloadEntities,
	DownloadFileType? downloadFileType,
	string formatVersion,
	DateTime? lastSyncTimeInUTC)
{
	var request = new DownloadCampaignsByAccountIdsRequest
	{
		AccountIds = accountIds,
		CompressionType = compressionType,
		DataScope = dataScope,
		DownloadEntities = downloadEntities,
		DownloadFileType = downloadFileType,
		FormatVersion = formatVersion,
		LastSyncTimeInUTC = lastSyncTimeInUTC
	};

	return (await BulkService.CallAsync((s, r) => s.DownloadCampaignsByAccountIdsAsync(r), request));
}

static DownloadCampaignsByAccountIdsResponse downloadCampaignsByAccountIds(
	ArrayOflong accountIds,
	CompressionType compressionType,
	ArrayList<DataScope> dataScope,
	ArrayOfDownloadEntity downloadEntities,
	DownloadFileType downloadFileType,
	java.lang.String formatVersion,
	Calendar lastSyncTimeInUTC) throws RemoteException, Exception
{
	DownloadCampaignsByAccountIdsRequest request = new DownloadCampaignsByAccountIdsRequest();

	request.setAccountIds(accountIds);
	request.setCompressionType(compressionType);
	request.setDataScope(dataScope);
	request.setDownloadEntities(downloadEntities);
	request.setDownloadFileType(downloadFileType);
	request.setFormatVersion(formatVersion);
	request.setLastSyncTimeInUTC(lastSyncTimeInUTC);

	return BulkService.getService().downloadCampaignsByAccountIds(request);
}

static function DownloadCampaignsByAccountIds(
	$accountIds,
	$compressionType,
	$dataScope,
	$downloadEntities,
	$downloadFileType,
	$formatVersion,
	$lastSyncTimeInUTC)
{

	$GLOBALS['Proxy'] = $GLOBALS['BulkProxy'];

	$request = new DownloadCampaignsByAccountIdsRequest();

	$request->AccountIds = $accountIds;
	$request->CompressionType = $compressionType;
	$request->DataScope = $dataScope;
	$request->DownloadEntities = $downloadEntities;
	$request->DownloadFileType = $downloadFileType;
	$request->FormatVersion = $formatVersion;
	$request->LastSyncTimeInUTC = $lastSyncTimeInUTC;

	return $GLOBALS['BulkProxy']->GetService()->DownloadCampaignsByAccountIds($request);
}

response=bulk_service.DownloadCampaignsByAccountIds(
	AccountIds=AccountIds,
	CompressionType=CompressionType,
	DataScope=DataScope,
	DownloadEntities=DownloadEntities,
	DownloadFileType=DownloadFileType,
	FormatVersion=FormatVersion,
	LastSyncTimeInUTC=LastSyncTimeInUTC)