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

[アーティクル]
12/31/2024

ID によって変換値ルールを取得します。

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
Lcid	要求のロケール識別子 (LCID)。既定値は、 EnglishUS の場合は 1033 です。 LCID 値の詳細については、「LCID 値セット」を参照してください。	int
RuleIds	フェッチする変換値ルールの ID。	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 要素

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

応答本文の要素

要素	説明	データ型
ConversionValueRules	正常にフェッチされた変換値ルール。	ConversionValueRule 配列
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">GetConversionValueRulesByIds</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>
    <GetConversionValueRulesByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <RuleIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </RuleIds>
      <Lcid i:nil="false">ValueHere</Lcid>
    </GetConversionValueRulesByIdsRequest>
  </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>
    <GetConversionValueRulesByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ConversionValueRules d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <ConversionValueRule>
          <AudienceCondition d4p1:nil="false">
            <Audiences d4p1:nil="false">
              <AudienceConditionItem>
                <Id>ValueHere</Id>
                <Name d4p1:nil="false">ValueHere</Name>
                <Type d4p1:nil="false">ValueHere</Type>
              </AudienceConditionItem>
            </Audiences>
            <IsPrimary>ValueHere</IsPrimary>
          </AudienceCondition>
          <CurrencyCode d4p1:nil="false">ValueHere</CurrencyCode>
          <DeviceCondition d4p1:nil="false">
            <DeviceTypes>ValueHere</DeviceTypes>
            <IsPrimary>ValueHere</IsPrimary>
          </DeviceCondition>
          <Id d4p1:nil="false">ValueHere</Id>
          <LocationCondition d4p1:nil="false">
            <ExcludedLocationIntent d4p1:nil="false">ValueHere</ExcludedLocationIntent>
            <ExcludedLocations d4p1:nil="false">
              <LocationConditionItem>
                <Id>ValueHere</Id>
                <Name d4p1:nil="false">ValueHere</Name>
                <Type d4p1:nil="false">ValueHere</Type>
              </LocationConditionItem>
            </ExcludedLocations>
            <IncludedLocationIntent d4p1:nil="false">ValueHere</IncludedLocationIntent>
            <IncludedLocations d4p1:nil="false">
              <LocationConditionItem>
                <Id>ValueHere</Id>
                <Name d4p1:nil="false">ValueHere</Name>
                <Type d4p1:nil="false">ValueHere</Type>
              </LocationConditionItem>
            </IncludedLocations>
            <IsPrimary>ValueHere</IsPrimary>
          </LocationCondition>
          <Name d4p1:nil="false">ValueHere</Name>
          <Operation d4p1:nil="false">ValueHere</Operation>
          <Status d4p1:nil="false">ValueHere</Status>
          <Value d4p1:nil="false">ValueHere</Value>
        </ConversionValueRule>
      </ConversionValueRules>
      <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:e445="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e445:KeyValuePairOfstringstring>
              <e445:key d4p1:nil="false">ValueHere</e445:key>
              <e445:value d4p1:nil="false">ValueHere</e445:value>
            </e445: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>
    </GetConversionValueRulesByIdsResponse>
  </s:Body>
</s:Envelope>

コード構文

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

public async Task<GetConversionValueRulesByIdsResponse> GetConversionValueRulesByIdsAsync(
	IList<long> ruleIds,
	int? lcid)
{
	var request = new GetConversionValueRulesByIdsRequest
	{
		RuleIds = ruleIds,
		Lcid = lcid
	};

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

static GetConversionValueRulesByIdsResponse getConversionValueRulesByIds(
	ArrayOflong ruleIds,
	int lcid) throws RemoteException, Exception
{
	GetConversionValueRulesByIdsRequest request = new GetConversionValueRulesByIdsRequest();

	request.setRuleIds(ruleIds);
	request.setLcid(lcid);

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

static function GetConversionValueRulesByIds(
	$ruleIds,
	$lcid)
{

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

	$request = new GetConversionValueRulesByIdsRequest();

	$request->RuleIds = $ruleIds;
	$request->Lcid = $lcid;

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

response=campaignmanagement_service.GetConversionValueRulesByIds(
	RuleIds=RuleIds,
	Lcid=Lcid)

要件

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

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/ConversionValueRules/QueryByIds

https://campaign.api.sandbox.bingads.microsoft.com/CampaignManagement/v13/ConversionValueRules/QueryByIds

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
Lcid	要求のロケール識別子 (LCID)。既定値は、 EnglishUS の場合は 1033 です。	int
RuleIds	フェッチする変換値ルールの ID。	long 配列

要求ヘッダー要素

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

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

応答本文の要素

要素	説明	データ型
ConversionValueRules	正常にフェッチされた変換値ルール。	ConversionValueRule 配列
PartialErrors	成功しなかった要求項目の詳細を含む BatchError オブジェクトの配列。エラーの一覧は、要求内の項目の一覧に直接対応していません。エラーがない場合はリストを空にすることも、失敗したリスト項目ごとに対応する 1 つ以上のエラーオブジェクトを要求に含めることもできます。	BatchError 配列

応答ヘッダー要素

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

JSON を要求する

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

{
  "RuleIds": [
    "LongValueHere"
  ],
  "Lcid": IntValueHere
}

応答 JSON

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

BatchError の種類が EditorialError の場合に適用される例を次に示します。

{
  "ConversionValueRules": [
    {
      "AudienceCondition": {
        "Audiences": [
          {
            "Id": "LongValueHere",
            "Name": "ValueHere",
            "Type": "ValueHere"
          }
        ],
        "IsPrimary": "ValueHere"
      },
      "CurrencyCode": "ValueHere",
      "DeviceCondition": {
        "DeviceTypes": "ValueHere",
        "IsPrimary": "ValueHere"
      },
      "Id": "LongValueHere",
      "LocationCondition": {
        "ExcludedLocationIntent": "ValueHere",
        "ExcludedLocations": [
          {
            "Id": IntValueHere,
            "Name": "ValueHere",
            "Type": "ValueHere"
          }
        ],
        "IncludedLocationIntent": "ValueHere",
        "IncludedLocations": [
          {
            "Id": IntValueHere,
            "Name": "ValueHere",
            "Type": "ValueHere"
          }
        ],
        "IsPrimary": "ValueHere"
      },
      "Name": "ValueHere",
      "Operation": "ValueHere",
      "Status": "ValueHere",
      "Value": DecimalValueHere
    }
  ],
  "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<GetConversionValueRulesByIdsResponse> GetConversionValueRulesByIdsAsync(
	IList<long> ruleIds,
	int? lcid)
{
	var request = new GetConversionValueRulesByIdsRequest
	{
		RuleIds = ruleIds,
		Lcid = lcid
	};

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

static GetConversionValueRulesByIdsResponse getConversionValueRulesByIds(
	ArrayOflong ruleIds,
	int lcid) throws RemoteException, Exception
{
	GetConversionValueRulesByIdsRequest request = new GetConversionValueRulesByIdsRequest();

	request.setRuleIds(ruleIds);
	request.setLcid(lcid);

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

static function GetConversionValueRulesByIds(
	$ruleIds,
	$lcid)
{

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

	$request = new GetConversionValueRulesByIdsRequest();

	$request->RuleIds = $ruleIds;
	$request->Lcid = $lcid;

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

response=campaignmanagement_service.GetConversionValueRulesByIds(
	RuleIds=RuleIds,
	Lcid=Lcid)

次の方法で共有

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

Request 要素

要求本文要素

要求ヘッダー要素

Response 要素

応答本文の要素

応答ヘッダー要素

SOAP を要求する

応答 SOAP

コード構文

要件

要求 URL

Request 要素

要求本文要素

要求ヘッダー要素

Response 要素

応答本文の要素

応答ヘッダー要素

JSON を要求する

応答 JSON

コード構文

フィードバック

その他のリソース