次の方法で共有

VideoAdExtension データ オブジェクト - キャンペーン管理

  • [アーティクル]

[ビデオ] ボタンと [コール トゥ アクション] ボタンを使用して広告拡張機能を定義します。

構文

<xs:complexType name="VideoAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="ActionText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="AlternativeText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DisplayText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q66="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q66:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q67="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q67:ArrayOfstring" />
        <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="ThumbnailId" nillable="true" type="xs:long" />
        <xs:element minOccurs="0" name="ThumbnailUrl" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="UrlCustomParameters" nillable="true" type="tns:CustomParameters" />
        <xs:element minOccurs="0" name="VideoId" nillable="true" type="xs:long" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

要素

VideoAdExtension オブジェクトには、ActionText、AlternativeText、DisplayText、FinalAppUrls、FinalMobileUrls、FinalUrls、FinalUrlSuffix、Name、ThumbnailId、ThumbnailUrl、TrackingUrlTemplate、UrlCustomParameters、VideoId という要素があります。

要素 説明 データ型
ActionText ビデオ アセットのアクション テキスト。 string
AlternativeText ビデオ アセットの代替テキスト。 string
DisplayText ビデオ アセットの表示テキスト。 string
FinalAppUrls 将来の使用のために。 AppUrl 配列
FinalMobileUrls モバイル デバイスのランディング ページ URL。

次の検証規則は、最終 URL と最終モバイル URL に適用されます。
- URL の長さは 2,048 文字に制限されています。 HTTP または HTTPS プロトコル文字列は、2,048 文字の制限にカウントされます。
- FinalUrls と FinalMobileUrls の両方に最大 10 個のリスト 項目を指定できます。ただし、各一覧の最初の項目のみが配信に使用されます。 このサービスでは、前方互換性の可能性があるリスト アイテムを最大 10 個まで許可します。
- '{' と '}' の使用は、 {lpurl} などのタグのみを示すために許可されます。
- 最終的な URL はそれぞれ、http:// または https:// で始まる整形式の URL である必要があります。
- FinalMobileUrls を指定する場合は、 FinalUrls も指定する必要があります。
- DevicePreference が 30001 (モバイル) に設定されている場合、FinalMobileUrls を指定することはできません。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、以前の設定は削除されます。		 string 配列
FinalUrls ランディング ページの URL。

次の検証規則は、最終 URL と最終モバイル URL に適用されます。
- URL の長さは 2,048 文字に制限されています。 HTTP または HTTPS プロトコル文字列は、2,048 文字の制限にカウントされます。
- FinalUrls と FinalMobileUrls の両方に最大 10 個のリスト 項目を指定できます。ただし、各一覧の最初の項目のみが配信に使用されます。 このサービスでは、前方互換性の可能性があるリスト アイテムを最大 10 個まで許可します。
- '{' と '}' の使用は、 {lpurl} などのタグのみを示すために許可されます。
- 最終的な URL はそれぞれ、http:// または https:// で始まる整形式の URL である必要があります。
- FinalMobileUrls を指定する場合は、 FinalUrls も指定する必要があります。
- DevicePreference が 30001 (モバイル) に設定されている場合、FinalMobileUrls を指定することはできません。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、以前の設定は削除されます。		 string 配列
FinalUrlSuffix 最後の URL サフィックスには、ランディング ページ URL の末尾に追加される追跡パラメーターを含めることができます。 顧客が常にランディング ページに送信されるように、ランディング ページで必要な追跡パラメーターを最終的な URL サフィックスに配置することをお勧めします。 詳細と検証規則については、テクニカル ガイドの 「最終 URL サフィックス」を 参照してください。

この機能は、最終 URL サフィックス フェーズ 3 パイロット (GetCustomerPilotFeatures が 636 を返す) のお客様にのみ使用できます。 パイロットにいない場合、このプロパティは無視され、エラーは返されません。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、以前の設定は削除されます。		 string
名前 ビデオアセットの名前。 string
ThumbnailId サムネイルアセットの ID。 long
ThumbnailUrl ビデオアセットのサムネイル URL。

追加: サポートされていません
更新: サポート対象外		 string
TrackingUrlTemplate すべての FinalUrls と FinalMobileUrls の既定値として使用する追跡テンプレート。

追跡テンプレートには、次の検証規則が適用されます。 サポートされているテンプレートとパラメーターの詳細については、Microsoft Advertising のヘルプ記事「 どのような追跡または URL パラメーターを使用できますか?」を参照してください。
- 低レベルのエンティティに対して定義された追跡テンプレート (広告など) は、キャンペーンなど、上位レベルのエンティティに対して設定されたものをオーバーライドします。 詳細については、「 エンティティの制限」を参照してください。
- 追跡テンプレートの長さは 2,048 文字に制限されています。 HTTP または HTTPS プロトコル文字列は、2,048 文字の制限にカウントされます。
- 追跡テンプレートは、 http://、 https://、 {lpurl}、または {unescapedlpurl} のいずれかで始まる整形式の URL である必要があります。
- Microsoft Advertising では、カスタム パラメーターが存在するかどうかを検証しません。 追跡テンプレートでカスタム パラメーターを使用し、それらが存在しない場合、ランディング ページ URL には、代替なしでカスタム パラメーターのキーと値のプレースホルダーが含まれます。 たとえば、トラッキング テンプレートがhttps://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl}で、キャンペーン、広告グループ、条件、キーワード (keyword)、または広告レベルで {_season} または {_promocode} が定義されていない場合、ランディング ページの URL は同じになります。

足す： 随意
更新： 随意。 この要素を null に設定すると、前の設定が削除されます。		 string
UrlCustomParameters URL 追跡用のキーパラメーターと値パラメーターのカスタム コレクション。

Microsoft Advertising では、 CustomParameters オブジェクトに含める最初の 8 個の CustomParameter オブジェクトを受け入れ、8 つ以上のカスタム パラメーターを含める場合はエラーが返されます。 各 CustomParameter には、Key 要素と Value 要素が含まれています。 カスタム パラメーターの制限の引き上げフェーズ 3 パイロット (GetCustomerPilotFeatures は 635 を返します) のお客様の場合、Microsoft Advertising は、含める最初の 8 つのカスタム パラメーター キーと値のペアを受け入れ、8 つ以上のカスタム パラメーターを含む場合はエラーが返されます。

足す： 随意
更新： 随意。 この要素を null に設定すると、前の設定が削除されます。		 CustomParameters
VideoId ビデオの ID。 long

VideoAdExtension オブジェクトには継承された要素があります。

継承された要素

AdExtension から継承された要素

VideoAdExtension オブジェクトは AdExtension オブジェクトから派生し、DevicePreference、ForwardCompatibilityMap、Id、Scheduling、Status、Type、Version の各要素を継承します。 以下の説明は VideoAdExtension に固有であり、 AdExtension オブジェクトから同じ要素を継承する他のオブジェクトには適用されない場合があります。

要素 説明 データ型
DevicePreference この要素は、広告拡張機能をモバイル デバイスに表示するか、すべてのデバイスに表示するかを決定します。

モバイル デバイスの基本設定を指定するには、この要素を 30001 に設定します。

すべてのデバイスを指定するには、この要素を 0 (ゼロ) に設定するか、要素 nil のままにします。 既定では、この要素は nil になります。

この要素は、 AppAdExtension 型と SitelinkAdExtension 型にのみ適用されます。		 long
ForwardCompatibilityMap 現在の API バージョンで新しい要素が追加されたときに変更が中断されないように、前方互換性のためのキー文字列と値文字列の一覧。

今後のリリースでは、今後の互換性の変更に関するページを参照してください。 現在、このオブジェクトの前方互換性の変更はありません。		 KeyValuePairOfstring 配列
身分証明書 広告拡張機能の一意の Microsoft Advertising 識別子。 long
スケジュール設定 広告表示オプションが広告に表示される資格があるカレンダーの曜日と時刻の範囲を決定します。 Schedule
Status 広告拡張機能の状態。 キャンペーン管理サービスでは削除された広告表示オプションが返されないため、値は常に アクティブ になります。 AdExtensionStatus
種類 広告拡張機能の種類。

詳細については、「解説」を参照してください。		 string
バージョン 広告拡張機能が更新された回数を追跡します。

バージョンは、広告拡張機能の作成時に 1 に設定され、更新のたびに 1 ずつインクリメントされます。		 int

要件

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