共用方式為

GetConversionGoalsByTagIds 服務作業 - 活動管理

  • 發行項

取得使用指定 UET 標記的轉換目標。

提示

如需實作概觀，請參閱 通用事件追蹤 技術指南。

要求專案

GetConversionGoalsByTagIdsRequest 物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素 描述 資料類型
ConversionGoalTypes 要傳回的轉換目標類型。

您可以將多個值包含為旗標。 指定多個旗標的方式取決於您使用的程式設計語言。 例如，C# 會將這些值視為旗標值，而 Java 會將它們視為字串數位。 SOAP 應該包含字串，其中包含以空白分隔的值清單， <ConversionGoalTypes>Url Duration</ConversionGoalTypes>例如 。		 ConversionGoalType
ReturnAdditionalFields 您要包含在每個傳回轉換目標中的其他屬性清單。 其他域值可讓您使用目前版本的營銷活動管理 API 取得最新功能，而在下一個版本中，預設會包含對應的元素。

此要求項目是選擇性的。		 ConversionGoalAdditionalField
TagIds 傳回的轉換目標最多使用100個標記標識碼。 long 陣列

要求標頭元素

元素 描述 資料類型
AuthenticationToken OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。

如需詳細資訊，請 參閱使用 OAuth 進行驗證。		 string
CustomerAccountId 擁有或與要求中實體相關聯之廣告帳戶的標識碼。 當兩者都需要時，此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。

如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。		 string
CustomerId (使用者存取或操作之使用者) 客戶的管理員帳戶標識碼。 用戶可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。

如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。		 string
DeveloperToken 用來存取 Bing 廣告 API 的開發人員令牌。

如需詳細資訊 ，請參閱取得開發人員令牌。		 string
密碼 此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 string
UserName 此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 string

Response 元素

GetConversionGoalsByTagIdsResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。

回應本文專案

元素 描述 資料類型
ConversionGoals 轉換目標清單不會直接對應至要求中指定的標記標識碼，因為可以有多個轉換目標使用要求中指定的相同標記標識符。 ConversionGoal 陣 列
PartialErrors BatchError 物件的陣列，其中包含任何未成功要求專案的詳細數據。

錯誤清單不會直接對應至要求中的項目清單。 如果沒有錯誤，清單可以是空的，或者可以包含一或多個對應到要求中每個不成功清單項目的錯誤物件。		 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">GetConversionGoalsByTagIds</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>
    <GetConversionGoalsByTagIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <TagIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </TagIds>
      <ConversionGoalTypes>ValueHere</ConversionGoalTypes>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </GetConversionGoalsByTagIdsRequest>
  </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>
    <GetConversionGoalsByTagIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ConversionGoals d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <ConversionGoal d4p1:type="-- derived type specified here with the appropriate prefix --">
          <AttributionModelType d4p1:nil="false">ValueHere</AttributionModelType>
          <ConversionWindowInMinutes d4p1:nil="false">ValueHere</ConversionWindowInMinutes>
          <CountType d4p1:nil="false">ValueHere</CountType>
          <ExcludeFromBidding d4p1:nil="false">ValueHere</ExcludeFromBidding>
          <GoalCategory d4p1:nil="false">ValueHere</GoalCategory>
          <Id d4p1:nil="false">ValueHere</Id>
          <IsEnhancedConversionsEnabled d4p1:nil="false">ValueHere</IsEnhancedConversionsEnabled>
          <Name d4p1:nil="false">ValueHere</Name>
          <Revenue d4p1:nil="false">
            <CurrencyCode d4p1:nil="false">ValueHere</CurrencyCode>
            <Type d4p1:nil="false">ValueHere</Type>
            <Value d4p1:nil="false">ValueHere</Value>
          </Revenue>
          <Scope d4p1:nil="false">ValueHere</Scope>
          <Status d4p1:nil="false">ValueHere</Status>
          <TagId d4p1:nil="false">ValueHere</TagId>
          <TrackingStatus d4p1:nil="false">ValueHere</TrackingStatus>
          <Type d4p1:nil="false">ValueHere</Type>
          <ViewThroughConversionWindowInMinutes d4p1:nil="false">ValueHere</ViewThroughConversionWindowInMinutes>
          <!--These fields are applicable if the derived type attribute is set to UrlGoal-->
          <UrlExpression d4p1:nil="false">ValueHere</UrlExpression>
          <UrlOperator d4p1:nil="false">ValueHere</UrlOperator>
          <!--This field is applicable if the derived type attribute is set to DurationGoal-->
          <MinimumDurationInSeconds d4p1:nil="false">ValueHere</MinimumDurationInSeconds>
          <!--This field is applicable if the derived type attribute is set to PagesViewedPerVisitGoal-->
          <MinimumPagesViewed d4p1:nil="false">ValueHere</MinimumPagesViewed>
          <!--These fields are applicable if the derived type attribute is set to EventGoal-->
          <ActionExpression d4p1:nil="false">ValueHere</ActionExpression>
          <ActionOperator d4p1:nil="false">ValueHere</ActionOperator>
          <CategoryExpression d4p1:nil="false">ValueHere</CategoryExpression>
          <CategoryOperator d4p1:nil="false">ValueHere</CategoryOperator>
          <LabelExpression d4p1:nil="false">ValueHere</LabelExpression>
          <LabelOperator d4p1:nil="false">ValueHere</LabelOperator>
          <Value d4p1:nil="false">ValueHere</Value>
          <ValueOperator d4p1:nil="false">ValueHere</ValueOperator>
          <!--These fields are applicable if the derived type attribute is set to AppInstallGoal-->
          <AppPlatform d4p1:nil="false">ValueHere</AppPlatform>
          <AppStoreId d4p1:nil="false">ValueHere</AppStoreId>
          <!--This field is applicable if the derived type attribute is set to OfflineConversionGoal-->
          <IsExternallyAttributed d4p1:nil="false">ValueHere</IsExternallyAttributed>
          <!--No additional fields are applicable if the derived type attribute is set to InStoreTransactionGoal-->
        </ConversionGoal>
      </ConversionGoals>
      <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:e295="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e295:KeyValuePairOfstringstring>
              <e295:key d4p1:nil="false">ValueHere</e295:key>
              <e295:value d4p1:nil="false">ValueHere</e295:value>
            </e295: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>
    </GetConversionGoalsByTagIdsResponse>
  </s:Body>
</s:Envelope>

程序代碼語法

範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

public async Task<GetConversionGoalsByTagIdsResponse> GetConversionGoalsByTagIdsAsync(
	IList<long> tagIds,
	ConversionGoalType conversionGoalTypes,
	ConversionGoalAdditionalField? returnAdditionalFields)
{
	var request = new GetConversionGoalsByTagIdsRequest
	{
		TagIds = tagIds,
		ConversionGoalTypes = conversionGoalTypes,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static GetConversionGoalsByTagIdsResponse getConversionGoalsByTagIds(
	ArrayOflong tagIds,
	ArrayList<ConversionGoalType> conversionGoalTypes,
	ArrayList<ConversionGoalAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetConversionGoalsByTagIdsRequest request = new GetConversionGoalsByTagIdsRequest();

	request.setTagIds(tagIds);
	request.setConversionGoalTypes(conversionGoalTypes);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function GetConversionGoalsByTagIds(
	$tagIds,
	$conversionGoalTypes,
	$returnAdditionalFields)
{

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

	$request = new GetConversionGoalsByTagIdsRequest();

	$request->TagIds = $tagIds;
	$request->ConversionGoalTypes = $conversionGoalTypes;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=campaignmanagement_service.GetConversionGoalsByTagIds(
	TagIds=TagIds,
	ConversionGoalTypes=ConversionGoalTypes,
	ReturnAdditionalFields=ReturnAdditionalFields)

需求

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

要求 URL

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

要求專案

GetConversionGoalsByTagIdsRequest 物件會定義服務作業要求的主體和標頭元素。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素 描述 資料類型
ConversionGoalTypes 要傳回的轉換目標類型。

您可以將多個值包含為旗標。 指定多個旗標的方式取決於您使用的程式設計語言。 例如，C# 會將這些值視為旗標值，而 Java 會將它們視為字串數位。 SOAP 應該包含字串，其中包含以空白分隔的值清單， <ConversionGoalTypes>Url Duration</ConversionGoalTypes>例如 。		 ConversionGoalType
ReturnAdditionalFields 您要包含在每個傳回轉換目標中的其他屬性清單。 其他域值可讓您使用目前版本的營銷活動管理 API 取得最新功能，而在下一個版本中，預設會包含對應的元素。

此要求項目是選擇性的。		 ConversionGoalAdditionalField
TagIds 傳回的轉換目標最多使用100個標記標識碼。 long 陣列

要求標頭元素

元素 描述 資料類型
授權 OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ，這是正確驗證的必要專案。

如需詳細資訊，請 參閱使用 OAuth 進行驗證。		 string
CustomerAccountId 擁有或與要求中實體相關聯之廣告帳戶的標識碼。 當兩者都需要時，此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。

如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。		 string
CustomerId (使用者存取或操作之使用者) 客戶的管理員帳戶標識碼。 用戶可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。

如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。		 string
DeveloperToken 用來存取 Bing 廣告 API 的開發人員令牌。

如需詳細資訊 ，請參閱取得開發人員令牌。		 string
密碼 此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 string
UserName 此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 string

Response 元素

GetConversionGoalsByTagIdsResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。

回應本文專案

元素 描述 資料類型
ConversionGoals 轉換目標清單不會直接對應至要求中指定的標記標識碼，因為可以有多個轉換目標使用要求中指定的相同標記標識符。 ConversionGoal 陣 列
PartialErrors BatchError 物件的陣列，其中包含任何未成功要求專案的詳細數據。

錯誤清單不會直接對應至要求中的項目清單。 如果沒有錯誤，清單可以是空的，或者可以包含一或多個對應到要求中每個不成功清單項目的錯誤物件。		 BatchError 陣 列

回應標頭元素

元素 描述 資料類型
TrackingId 包含 API 呼叫詳細數據的記錄項目識別碼。 string

要求 JSON

此範本是由工具所產生，用來顯示 JSON 要求的 主體 和 標頭 元素。 如需可搭配此服務作業使用的支援類型，請參閱上述 的要求本文項目 參考。

{
  "TagIds": [
    "LongValueHere"
  ],
  "ConversionGoalTypes": "ValueHere",
  "ReturnAdditionalFields": "ValueHere"
}

回應 JSON

此範本是由工具所產生，用來顯示 JSON 回應的 主體 和 標頭 元素。

以下範例適用於 ConversionGoal 的類型為 AppInstallGoal，BatchError 為編輯器。

{
  "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"
    }
  ],
  "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<GetConversionGoalsByTagIdsResponse> GetConversionGoalsByTagIdsAsync(
	IList<long> tagIds,
	ConversionGoalType conversionGoalTypes,
	ConversionGoalAdditionalField? returnAdditionalFields)
{
	var request = new GetConversionGoalsByTagIdsRequest
	{
		TagIds = tagIds,
		ConversionGoalTypes = conversionGoalTypes,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static GetConversionGoalsByTagIdsResponse getConversionGoalsByTagIds(
	ArrayOflong tagIds,
	ArrayList<ConversionGoalType> conversionGoalTypes,
	ArrayList<ConversionGoalAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetConversionGoalsByTagIdsRequest request = new GetConversionGoalsByTagIdsRequest();

	request.setTagIds(tagIds);
	request.setConversionGoalTypes(conversionGoalTypes);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function GetConversionGoalsByTagIds(
	$tagIds,
	$conversionGoalTypes,
	$returnAdditionalFields)
{

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

	$request = new GetConversionGoalsByTagIdsRequest();

	$request->TagIds = $tagIds;
	$request->ConversionGoalTypes = $conversionGoalTypes;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=campaignmanagement_service.GetConversionGoalsByTagIds(
	TagIds=TagIds,
	ConversionGoalTypes=ConversionGoalTypes,
	ReturnAdditionalFields=ReturnAdditionalFields)