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

指定したクリップ チャンピオン テンプレートを取得します。

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
ロケール	予約済み。	string
MaxAdsCount	予約済み。	int
嘲る	予約済み。	boolean
TemplateFilter	予約済み。	VideoTemplateFilter

要求ヘッダー要素

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

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

応答本文の要素

要素	説明	データ型
テンプレート	予約済み。	ClipchampTemplateInfo 配列

応答ヘッダー要素

要素	説明	データ型
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">GetClipchampTemplates</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>
    <GetClipchampTemplatesRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Mock i:nil="false">ValueHere</Mock>
      <MaxAdsCount i:nil="false">ValueHere</MaxAdsCount>
      <TemplateFilter i:nil="false">
        <AspectRatios i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <a1:string>ValueHere</a1:string>
        </AspectRatios>
        <Durations i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <a1:int>ValueHere</a1:int>
        </Durations>
        <MaxMediaAssetCount>ValueHere</MaxMediaAssetCount>
        <MaxTextAssetCount>ValueHere</MaxTextAssetCount>
        <TemplateIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <a1:string>ValueHere</a1:string>
        </TemplateIds>
        <Themes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <a1:string>ValueHere</a1:string>
        </Themes>
      </TemplateFilter>
      <Locale i:nil="false">ValueHere</Locale>
    </GetClipchampTemplatesRequest>
  </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>
    <GetClipchampTemplatesResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Templates d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <ClipchampTemplateInfo>
          <AspectRatio d4p1:nil="false">ValueHere</AspectRatio>
          <Duration>ValueHere</Duration>
          <NumberOfImages>ValueHere</NumberOfImages>
          <NumberOfLogos>ValueHere</NumberOfLogos>
          <NumberOfText>ValueHere</NumberOfText>
          <TemplateDescription d4p1:nil="false">ValueHere</TemplateDescription>
          <TemplateId d4p1:nil="false">ValueHere</TemplateId>
          <TemplateName d4p1:nil="false">ValueHere</TemplateName>
          <TemplatePreviewUrl d4p1:nil="false">ValueHere</TemplatePreviewUrl>
          <TemplateThumbnailUrl d4p1:nil="false">ValueHere</TemplateThumbnailUrl>
          <Themes d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string>ValueHere</a1:string>
          </Themes>
        </ClipchampTemplateInfo>
      </Templates>
    </GetClipchampTemplatesResponse>
  </s:Body>
</s:Envelope>

コード構文

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

public async Task<GetClipchampTemplatesResponse> GetClipchampTemplatesAsync(
	bool? mock,
	int? maxAdsCount,
	VideoTemplateFilter templateFilter,
	string locale)
{
	var request = new GetClipchampTemplatesRequest
	{
		Mock = mock,
		MaxAdsCount = maxAdsCount,
		TemplateFilter = templateFilter,
		Locale = locale
	};

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

static GetClipchampTemplatesResponse getClipchampTemplates(
	boolean mock,
	int maxAdsCount,
	VideoTemplateFilter templateFilter,
	java.lang.String locale) throws RemoteException, Exception
{
	GetClipchampTemplatesRequest request = new GetClipchampTemplatesRequest();

	request.setMock(mock);
	request.setMaxAdsCount(maxAdsCount);
	request.setTemplateFilter(templateFilter);
	request.setLocale(locale);

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

static function GetClipchampTemplates(
	$mock,
	$maxAdsCount,
	$templateFilter,
	$locale)
{

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

	$request = new GetClipchampTemplatesRequest();

	$request->Mock = $mock;
	$request->MaxAdsCount = $maxAdsCount;
	$request->TemplateFilter = $templateFilter;
	$request->Locale = $locale;

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

response=campaignmanagement_service.GetClipchampTemplates(
	Mock=Mock,
	MaxAdsCount=MaxAdsCount,
	TemplateFilter=TemplateFilter,
	Locale=Locale)

要件

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

要求 URL

運用 URL

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/ClipchampTemplates/Query

サンドボックス URL

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

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
ロケール	予約済み。	string
MaxAdsCount	予約済み。	int
嘲る	予約済み。	boolean
TemplateFilter	予約済み。	VideoTemplateFilter

要求ヘッダー要素

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

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

応答本文の要素

要素	説明	データ型
テンプレート	予約済み。	ClipchampTemplateInfo 配列

応答ヘッダー要素

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

JSON を要求する

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

{
  "Mock": "ValueHere",
  "MaxAdsCount": IntValueHere,
  "TemplateFilter": {
    "AspectRatios": [
      "ValueHere"
    ],
    "Durations": [
      IntValueHere
    ],
    "MaxMediaAssetCount": IntValueHere,
    "MaxTextAssetCount": IntValueHere,
    "TemplateIds": [
      "ValueHere"
    ],
    "Themes": [
      "ValueHere"
    ]
  },
  "Locale": "ValueHere"
}

応答 JSON

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

{
  "Templates": [
    {
      "AspectRatio": "ValueHere",
      "Duration": IntValueHere,
      "NumberOfImages": IntValueHere,
      "NumberOfLogos": IntValueHere,
      "NumberOfText": IntValueHere,
      "TemplateDescription": "ValueHere",
      "TemplateId": "ValueHere",
      "TemplateName": "ValueHere",
      "TemplatePreviewUrl": "ValueHere",
      "TemplateThumbnailUrl": "ValueHere",
      "Themes": [
        "ValueHere"
      ]
    }
  ]
}

コード構文

SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。

public async Task<GetClipchampTemplatesResponse> GetClipchampTemplatesAsync(
	bool? mock,
	int? maxAdsCount,
	VideoTemplateFilter templateFilter,
	string locale)
{
	var request = new GetClipchampTemplatesRequest
	{
		Mock = mock,
		MaxAdsCount = maxAdsCount,
		TemplateFilter = templateFilter,
		Locale = locale
	};

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

static GetClipchampTemplatesResponse getClipchampTemplates(
	boolean mock,
	int maxAdsCount,
	VideoTemplateFilter templateFilter,
	java.lang.String locale) throws RemoteException, Exception
{
	GetClipchampTemplatesRequest request = new GetClipchampTemplatesRequest();

	request.setMock(mock);
	request.setMaxAdsCount(maxAdsCount);
	request.setTemplateFilter(templateFilter);
	request.setLocale(locale);

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

static function GetClipchampTemplates(
	$mock,
	$maxAdsCount,
	$templateFilter,
	$locale)
{

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

	$request = new GetClipchampTemplatesRequest();

	$request->Mock = $mock;
	$request->MaxAdsCount = $maxAdsCount;
	$request->TemplateFilter = $templateFilter;
	$request->Locale = $locale;

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

response=campaignmanagement_service.GetClipchampTemplates(
	Mock=Mock,
	MaxAdsCount=MaxAdsCount,
	TemplateFilter=TemplateFilter,
	Locale=Locale)