GetMediaMetaDataByAccountId 服務作業 - 營銷活動管理

發行項
10/17/2024

從帳戶的媒體櫃取得指定實體類型的媒體中繼數據。

要求專案

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

注意事項

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

要求本文專案

元素	描述	資料類型
MediaEnabledEntities	決定已啟用媒體的實體類型，以取得中繼數據。支援的值為 ImageAdExtension 和 ResponsiveAd。您可以將多個值包含為旗標。指定多個旗標的方式取決於您使用的程式設計語言。例如，C# 會將這些值視為旗標值，而 Java 會將它們視為字串數位。 SOAP 應該包含字串，其中包含以空白分隔的值清單， `<MediaEnabledEntities>ImageAdExtension ResponsiveAd</MediaEnabledEntities>`例如。	MediaEnabledEntityFilter
PageInfo	決定每頁媒體中繼數據結果的索引和大小。根據預設，如果未指定此元素，則 Defaut 頁面 Index 為 0，而預設的 Size 為 1,000。	分頁
ReturnAdditionalFields	您要包含在每個傳回的深入解析 KPI 中的其他屬性清單。其他域值可讓您使用目前版本的 Ad Insight API 取得最新功能，而在下一個版本中，預設會包含對應的元素。此要求項目是選擇性的。	MediaAdditionalField

要求標頭元素

元素	描述	資料類型
AuthenticationToken	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。如需詳細資訊，請參閱使用 OAuth 進行驗證。	string
CustomerAccountId	擁有或與要求中實體相關聯之廣告帳戶的標識碼。當兩者都需要時，此標頭元素必須具有與 AccountId body 元素相同的值。此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。如需詳細資訊，請參閱取得您的帳戶和客戶標識符。	string
CustomerId	(使用者存取或操作之使用者) 客戶的管理員帳戶標識碼。用戶可以存取多個管理員帳戶。此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。如需詳細資訊，請參閱取得您的帳戶和客戶標識符。	string
DeveloperToken	用來存取Bing Ads API 的開發人員令牌。如需詳細資訊，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

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

回應本文專案

元素	描述	資料類型
MediaMetaData	來自連結庫的指定媒體中繼數據。中繼數據報含一或多個媒體表示法的下載 URL。	MediaMetaData 陣列

回應標頭元素

元素	描述	資料類型
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">GetMediaMetaDataByAccountId</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>
    <GetMediaMetaDataByAccountIdRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <MediaEnabledEntities>ValueHere</MediaEnabledEntities>
      <PageInfo i:nil="false">
        <Index>ValueHere</Index>
        <Size>ValueHere</Size>
      </PageInfo>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </GetMediaMetaDataByAccountIdRequest>
  </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>
    <GetMediaMetaDataByAccountIdResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <MediaMetaData d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <MediaMetaData>
          <Id>ValueHere</Id>
          <MediaType d4p1:nil="false">ValueHere</MediaType>
          <Representations d4p1:nil="false">
            <MediaRepresentation d4p1:type="-- derived type specified here with the appropriate prefix --">
              <Name d4p1:nil="false">ValueHere</Name>
              <Type d4p1:nil="false">ValueHere</Type>
              <Url d4p1:nil="false">ValueHere</Url>
              <!--These fields are applicable if the derived type attribute is set to ImageMediaRepresentation-->
              <Height>ValueHere</Height>
              <Width>ValueHere</Width>
            </MediaRepresentation>
          </Representations>
          <Text d4p1:nil="false">ValueHere</Text>
          <Type d4p1:nil="false">ValueHere</Type>
        </MediaMetaData>
      </MediaMetaData>
    </GetMediaMetaDataByAccountIdResponse>
  </s:Body>
</s:Envelope>

程序代碼語法

範例語法可以與 Bing Ads SDK 搭配使用。如需詳細範例，請參閱Bing Ads API 程式代碼範例。

public async Task<GetMediaMetaDataByAccountIdResponse> GetMediaMetaDataByAccountIdAsync(
	MediaEnabledEntityFilter mediaEnabledEntities,
	Paging pageInfo,
	MediaAdditionalField? returnAdditionalFields)
{
	var request = new GetMediaMetaDataByAccountIdRequest
	{
		MediaEnabledEntities = mediaEnabledEntities,
		PageInfo = pageInfo,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static GetMediaMetaDataByAccountIdResponse getMediaMetaDataByAccountId(
	ArrayList<MediaEnabledEntityFilter> mediaEnabledEntities,
	Paging pageInfo,
	ArrayList<MediaAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetMediaMetaDataByAccountIdRequest request = new GetMediaMetaDataByAccountIdRequest();

	request.setMediaEnabledEntities(mediaEnabledEntities);
	request.setPageInfo(pageInfo);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function GetMediaMetaDataByAccountId(
	$mediaEnabledEntities,
	$pageInfo,
	$returnAdditionalFields)
{

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

	$request = new GetMediaMetaDataByAccountIdRequest();

	$request->MediaEnabledEntities = $mediaEnabledEntities;
	$request->PageInfo = $pageInfo;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=campaignmanagement_service.GetMediaMetaDataByAccountId(
	MediaEnabledEntities=MediaEnabledEntities,
	PageInfo=PageInfo,
	ReturnAdditionalFields=ReturnAdditionalFields)

需求

服務： CampaignManagementService.svc v13
Namespace： https://bingads.microsoft.com/CampaignManagement/v13

共用方式為