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

[アーティクル]
10/17/2024

アカウントのメディアライブラリから、指定したエンティティ型のメディアメタデータを取得します。

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
MediaEnabledEntities	メタデータを取得するメディア対応エンティティの種類を決定します。サポートされる値は、ImageAdExtension と ResponsiveAd です。フラグとして複数の値を含めることができます。複数のフラグを指定する方法は、使用するプログラミング言語によって異なります。たとえば、C# はこれらの値をフラグ値として扱い、Java はそれらを文字列の配列として扱います。 SOAP には、 `<MediaEnabledEntities>ImageAdExtension ResponsiveAd</MediaEnabledEntities>`スペース区切りの値の一覧 (例: ) を含む文字列を含める必要があります。	MediaEnabledEntityFilter
PageInfo	ページごとのメディアメタデータの結果のインデックスとサイズを決定します。既定では、この要素が指定されていない場合、defaut ページのインデックスは 0、既定の Size は 1,000 です。	Paging
ReturnAdditionalFields	返された各オークション分析情報 KPI に含めたい追加のプロパティの一覧。追加のフィールド値を使用すると、現在のバージョンの Ad Insight API を使用して最新の機能を取得できます。次のバージョンでは、対応する要素が既定で含まれます。この要求要素は省略可能です。	MediaAdditionalField

要求ヘッダー要素

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

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

応答本文の要素

要素	説明	データ型
MediaMetaData	ライブラリから指定されたメディアメタデータ。メタデータには、1 つ以上のメディア表現のダウンロード 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

次の方法で共有