GetNegativeSitesByCampaignIds サービス操作 - キャンペーン管理

[アーティクル]
10/04/2023

キャンペーンに直接割り当てられている除外サイト URL を取得します。

この操作では、共有 Web サイトの除外リストの負のサイトは返されません。詳細については、「 GetListItemsBySharedList」を参照してください。

ヒント

概要については、「 Negative Sites テクニカルガイド」を参照してください。

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
AccountId	キャンペーンを含むアカウントの識別子。	long
CampaignIds	取得する除外サイト URL を含むキャンペーンの識別子の配列。指定したキャンペーンの一覧で定義されているすべての除外サイト URL の合計が 30,000 URL を超えると、呼び出しは失敗します。呼び出しが成功することを確認するには、キャンペーンの数を 15 に制限することを検討してください。	long 配列

要求ヘッダー要素

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

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

応答本文の要素

要素	説明	データ型
CampaignNegativeSites	要求で指定したキャンペーン識別子に直接対応する CampaignNegativeSites の配列。リストの項目は null として返される場合があります。 CampaignNegativeSites が取得されなかったリストインデックスごとに、対応する要素は null になります。	CampaignNegativeSites 配列
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">GetNegativeSitesByCampaignIds</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>
    <GetNegativeSitesByCampaignIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AccountId>ValueHere</AccountId>
      <CampaignIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </CampaignIds>
    </GetNegativeSitesByCampaignIdsRequest>
  </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>
    <GetNegativeSitesByCampaignIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <CampaignNegativeSites d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <CampaignNegativeSites>
          <CampaignId>ValueHere</CampaignId>
          <NegativeSites d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string>ValueHere</a1:string>
          </NegativeSites>
        </CampaignNegativeSites>
      </CampaignNegativeSites>
      <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:e163="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e163:KeyValuePairOfstringstring>
              <e163:key d4p1:nil="false">ValueHere</e163:key>
              <e163:value d4p1:nil="false">ValueHere</e163:value>
            </e163: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>
    </GetNegativeSitesByCampaignIdsResponse>
  </s:Body>
</s:Envelope>

コード構文

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

public async Task<GetNegativeSitesByCampaignIdsResponse> GetNegativeSitesByCampaignIdsAsync(
	long accountId,
	IList<long> campaignIds)
{
	var request = new GetNegativeSitesByCampaignIdsRequest
	{
		AccountId = accountId,
		CampaignIds = campaignIds
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetNegativeSitesByCampaignIdsAsync(r), request));
}

static GetNegativeSitesByCampaignIdsResponse getNegativeSitesByCampaignIds(
	java.lang.Long accountId,
	ArrayOflong campaignIds) throws RemoteException, Exception
{
	GetNegativeSitesByCampaignIdsRequest request = new GetNegativeSitesByCampaignIdsRequest();

	request.setAccountId(accountId);
	request.setCampaignIds(campaignIds);

	return CampaignManagementService.getService().getNegativeSitesByCampaignIds(request);
}

static function GetNegativeSitesByCampaignIds(
	$accountId,
	$campaignIds)
{

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

	$request = new GetNegativeSitesByCampaignIdsRequest();

	$request->AccountId = $accountId;
	$request->CampaignIds = $campaignIds;

	return $GLOBALS['CampaignManagementProxy']->GetService()->GetNegativeSitesByCampaignIds($request);
}

response=campaignmanagement_service.GetNegativeSitesByCampaignIds(
	AccountId=AccountId,
	CampaignIds=CampaignIds)

要件

サービス: CampaignManagementService.svc v13
名前空間： https://bingads.microsoft.com/CampaignManagement/v13

次の方法で共有