AddConversionGoals 服务操作 - 市场活动管理

项目
11/14/2024

向帐户的共享转换目标库添加新的转换目标。

重要

每次通过 Microsoft Advertising Web 应用程序或市场活动管理 API 添加或更新新的 DurationGoal、EventGoal、OfflineConversionGoal、PagesViewedPerVisitGoal 或 UrlGoal 时，相应 AccountProperty 的 MSCLKIDAutoTaggingEnabled 值会自动设置为 True。如果目标的范围设置为 “客户 级别”，则将设置“客户”下所有帐户的 AccountProperty 。

注意

若要创建增强的转换目标并设置 isEnhancedConversionsEnabled=true，必须通过Microsoft广告 UI 为帐户创建转换目标，并且选中了增强转换设置并选中了关联的复选框。

提示

有关实现概述，请参阅通用事件跟踪技术指南。

请求元素

AddConversionGoalsRequest 对象定义服务操作请求的正文和标头元素。元素的顺序必须与请求 SOAP 中所示的顺序相同。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

元素	说明	数据类型
ConversionGoals	要添加到帐户的共享转换目标库的转换目标列表。每个服务请求最多可以添加 100 个转换目标。帐户由所需的 CustomerAccountId 标头元素确定。	ConversionGoal 数组

请求标头元素

元素	说明	数据类型
AuthenticationToken	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。有关详细信息，请参阅使用 OAuth 进行身份验证。	string
CustomerAccountId	拥有或与请求中的实体关联的广告帐户的标识符。如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。有关详细信息，请参阅获取帐户和客户 ID。	string
CustomerId	用户正在访问或操作的客户) 经理帐户 (标识符。用户可以访问多个经理帐户。此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。有关详细信息，请参阅获取帐户和客户 ID。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。有关详细信息，请参阅获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

AddConversionGoalsResponse 对象定义服务操作响应的正文和标头元素。元素的返回顺序与响应 SOAP 中所示的顺序相同。

响应正文元素

元素	说明	数据类型
ConversionGoalIds	与所添加的转换目标对应的唯一系统标识符列表。标识符列表直接对应于请求中的转换目标列表。列表的项可能返回为 null。对于未添加转换目标的每个列表索引，相应的元素将为 null。	long 数组
PartialErrors	BatchError 对象的数组，其中包含未成功的任何请求项的详细信息。错误列表与请求中的项列表不直接对应。如果没有错误，列表可以为空，也可以包含与请求中每个不成功的列表项对应的一个或多个错误对象。	BatchError 数组

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 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">AddConversionGoals</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>
    <AddConversionGoalsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ConversionGoals i:nil="false">
        <ConversionGoal i:type="-- derived type specified here with the appropriate prefix --">
          <AttributionModelType i:nil="false">ValueHere</AttributionModelType>
          <ConversionWindowInMinutes i:nil="false">ValueHere</ConversionWindowInMinutes>
          <CountType i:nil="false">ValueHere</CountType>
          <ExcludeFromBidding i:nil="false">ValueHere</ExcludeFromBidding>
          <GoalCategory i:nil="false">ValueHere</GoalCategory>
          <Id i:nil="false">ValueHere</Id>
          <IsEnhancedConversionsEnabled i:nil="false">ValueHere</IsEnhancedConversionsEnabled>
          <Name i:nil="false">ValueHere</Name>
          <Revenue i:nil="false">
            <CurrencyCode i:nil="false">ValueHere</CurrencyCode>
            <Type i:nil="false">ValueHere</Type>
            <Value i:nil="false">ValueHere</Value>
          </Revenue>
          <Scope i:nil="false">ValueHere</Scope>
          <Status i:nil="false">ValueHere</Status>
          <TagId i:nil="false">ValueHere</TagId>
          <TrackingStatus i:nil="false">ValueHere</TrackingStatus>
          <Type i:nil="false">ValueHere</Type>
          <ViewThroughConversionWindowInMinutes i:nil="false">ValueHere</ViewThroughConversionWindowInMinutes>
          <!--These fields are applicable if the derived type attribute is set to UrlGoal-->
          <UrlExpression i:nil="false">ValueHere</UrlExpression>
          <UrlOperator i:nil="false">ValueHere</UrlOperator>
          <!--This field is applicable if the derived type attribute is set to DurationGoal-->
          <MinimumDurationInSeconds i:nil="false">ValueHere</MinimumDurationInSeconds>
          <!--This field is applicable if the derived type attribute is set to PagesViewedPerVisitGoal-->
          <MinimumPagesViewed i:nil="false">ValueHere</MinimumPagesViewed>
          <!--These fields are applicable if the derived type attribute is set to EventGoal-->
          <ActionExpression i:nil="false">ValueHere</ActionExpression>
          <ActionOperator i:nil="false">ValueHere</ActionOperator>
          <CategoryExpression i:nil="false">ValueHere</CategoryExpression>
          <CategoryOperator i:nil="false">ValueHere</CategoryOperator>
          <LabelExpression i:nil="false">ValueHere</LabelExpression>
          <LabelOperator i:nil="false">ValueHere</LabelOperator>
          <Value i:nil="false">ValueHere</Value>
          <ValueOperator i:nil="false">ValueHere</ValueOperator>
          <!--These fields are applicable if the derived type attribute is set to AppInstallGoal-->
          <AppPlatform i:nil="false">ValueHere</AppPlatform>
          <AppStoreId i:nil="false">ValueHere</AppStoreId>
          <!--This field is applicable if the derived type attribute is set to OfflineConversionGoal-->
          <IsExternallyAttributed i:nil="false">ValueHere</IsExternallyAttributed>
          <!--No additional fields are applicable if the derived type attribute is set to InStoreTransactionGoal-->
        </ConversionGoal>
      </ConversionGoals>
    </AddConversionGoalsRequest>
  </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>
    <AddConversionGoalsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ConversionGoalIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:long>ValueHere</a1:long>
      </ConversionGoalIds>
      <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:e237="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e237:KeyValuePairOfstringstring>
              <e237:key d4p1:nil="false">ValueHere</e237:key>
              <e237:value d4p1:nil="false">ValueHere</e237:value>
            </e237: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>
    </AddConversionGoalsResponse>
  </s:Body>
</s:Envelope>

代码语法

示例语法可用于必应广告 SDK。有关更多示例，请参阅必应广告 API 代码示例。

public async Task<AddConversionGoalsResponse> AddConversionGoalsAsync(
	IList<ConversionGoal> conversionGoals)
{
	var request = new AddConversionGoalsRequest
	{
		ConversionGoals = conversionGoals
	};

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

static AddConversionGoalsResponse addConversionGoals(
	ArrayOfConversionGoal conversionGoals) throws RemoteException, Exception
{
	AddConversionGoalsRequest request = new AddConversionGoalsRequest();

	request.setConversionGoals(conversionGoals);

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

static function AddConversionGoals(
	$conversionGoals)
{

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

	$request = new AddConversionGoalsRequest();

	$request->ConversionGoals = $conversionGoals;

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

response=campaignmanagement_service.AddConversionGoals(
	ConversionGoals=ConversionGoals)

要求

服务： CampaignManagementService.svc v13
命名空间： https://bingads.microsoft.com/CampaignManagement/v13

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/ConversionGoals

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

请求元素

AddConversionGoalsRequest 对象定义服务操作请求的正文和标头元素。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

元素	说明	数据类型
ConversionGoals	要添加到帐户的共享转换目标库的转换目标列表。每个服务请求最多可以添加 100 个转换目标。帐户由所需的 CustomerAccountId 标头元素确定。	ConversionGoal 数组

请求标头元素

元素	说明	数据类型
Authorization	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。有关详细信息，请参阅使用 OAuth 进行身份验证。	string
CustomerAccountId	拥有或与请求中的实体关联的广告帐户的标识符。如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。有关详细信息，请参阅获取帐户和客户 ID。	string
CustomerId	用户正在访问或操作的客户) 经理帐户 (标识符。用户可以访问多个经理帐户。此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。有关详细信息，请参阅获取帐户和客户 ID。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。有关详细信息，请参阅获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

AddConversionGoalsResponse 对象定义服务操作响应的正文和标头元素。元素的返回顺序与响应 JSON 中所示的顺序相同。

响应正文元素

元素	说明	数据类型
ConversionGoalIds	与所添加的转换目标对应的唯一系统标识符列表。标识符列表直接对应于请求中的转换目标列表。列表的项可能返回为 null。对于未添加转换目标的每个列表索引，相应的元素将为 null。	long 数组
PartialErrors	BatchError 对象的数组，其中包含未成功的任何请求项的详细信息。错误列表与请求中的项列表不直接对应。如果没有错误，列表可以为空，也可以包含与请求中每个不成功的列表项对应的一个或多个错误对象。	BatchError 数组

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 API 调用详细信息的日志条目的标识符。	string

请求 JSON

此模板由显示 JSON 请求的正文和标头元素的工具生成。有关可用于此服务操作的支持类型，请参阅上面的请求正文元素参考。

下面是一个示例，如果 ConversionGoal 的类型为 AppInstallGoal，则适用。

{
  "ConversionGoals": [
    {
      "AttributionModelType": "ValueHere",
      "ConversionWindowInMinutes": IntValueHere,
      "CountType": "ValueHere",
      "ExcludeFromBidding": "ValueHere",
      "GoalCategory": "ValueHere",
      "Id": "LongValueHere",
      "IsEnhancedConversionsEnabled": "ValueHere",
      "Name": "ValueHere",
      "Revenue": {
        "CurrencyCode": "ValueHere",
        "Type": "ValueHere",
        "Value": DecimalValueHere
      },
      "Scope": "ValueHere",
      "Status": "ValueHere",
      "TagId": "LongValueHere",
      "TrackingStatus": "ValueHere",
      "Type": "AppInstall",
      "ViewThroughConversionWindowInMinutes": IntValueHere,
      "AppPlatform": "ValueHere",
      "AppStoreId": "ValueHere"
    }
  ]
}

响应 JSON

此模板由一个工具生成，用于显示 JSON 响应的正文和标头元素。

以下示例适用于 BatchError 的类型为 EditorialError。

{
  "ConversionGoalIds": [
    "LongValueHere"
  ],
  "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 升级到特定版本并配置系统参数。示例语法可用于必应广告 SDK。有关更多示例，请参阅必应广告 API 代码示例。

public async Task<AddConversionGoalsResponse> AddConversionGoalsAsync(
	IList<ConversionGoal> conversionGoals)
{
	var request = new AddConversionGoalsRequest
	{
		ConversionGoals = conversionGoals
	};

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

static AddConversionGoalsResponse addConversionGoals(
	ArrayOfConversionGoal conversionGoals) throws RemoteException, Exception
{
	AddConversionGoalsRequest request = new AddConversionGoalsRequest();

	request.setConversionGoals(conversionGoals);

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

static function AddConversionGoals(
	$conversionGoals)
{

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

	$request = new AddConversionGoalsRequest();

	$request->ConversionGoals = $conversionGoals;

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

response=campaignmanagement_service.AddConversionGoals(
	ConversionGoals=ConversionGoals)

通过

AddConversionGoals 服务操作 - 市场活动管理

请求元素

请求正文元素

请求标头元素

响应元素

响应正文元素

响应标头元素

请求 SOAP

响应 SOAP

代码语法

要求

请求 URL

请求元素

请求正文元素

请求标头元素

响应元素

响应正文元素

响应标头元素

请求 JSON

响应 JSON

代码语法

反馈

其他资源