次の方法で共有

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

  • [アーティクル]

プロモーション拡張機能では、テキスト広告の特別な販売とオファーが強調表示されます。 オファーを目立たせることで、潜在的な顧客が広告をクリックする可能性が高く、より多くの売上を生み出すのに役立ちます。

プロモーション広告拡張機能をアカウントに関連付けるか、アカウント内のキャンペーンや広告グループに関連付けることができます。 各エンティティ (アカウント、キャンペーン、または広告グループ) は、最大 20 個のプロモーション広告表示オプションに関連付けることができます。

注:

プロモーション拡張機能は、AU、CA、DE、FR、米国、英国のお客様が利用できます。

構文

<xs:complexType name="PromotionAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="CurrencyCode" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DiscountModifier" nillable="true" type="tns:PromotionDiscountModifier" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q57="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q57:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q58="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q58:ArrayOfstring" />
        <xs:element minOccurs="0" name="Language" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="MoneyAmountOff" nillable="true" type="xs:double" />
        <xs:element minOccurs="0" name="OrdersOverAmount" nillable="true" type="xs:double" />
        <xs:element minOccurs="0" name="PercentOff" nillable="true" type="xs:double" />
        <xs:element minOccurs="0" name="PromotionCode" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="PromotionEndDate" nillable="true" type="tns:Date" />
        <xs:element minOccurs="0" name="PromotionItem" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="PromotionOccasion" nillable="true" type="tns:PromotionOccasion" />
        <xs:element minOccurs="0" name="PromotionStartDate" nillable="true" type="tns:Date" />
        <xs:element minOccurs="0" name="TrackingUrlTemplate" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="UrlCustomParameters" nillable="true" type="tns:CustomParameters" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

要素

PromotionAdExtension オブジェクトには、CurrencyCode、DiscountModifier、FinalAppUrls、FinalMobileUrls、FinalUrls、FinalUrlSuffix、Language、MoneyAmountOff、OrdersOverAmount、PercentOff、PromotionCode、PromotionEndDate、PromotionItem、PromotionOccasion、PromotionStartDate、TrackingUrlTemplate、UrlCustomParameters。

要素 説明 データ型
CurrencyCode プロモーション価格または割引の通貨コード。

このフィールドは、 MoneyAmountOff または OrdersOverAmount を設定した場合にのみ適用されます。

サポートされている通貨コードは、ARS、AUD、BRL、CAD、CHF、CLP、CNY、COP、DKK、EUR、GBP、HKD、INR、MXN、NZD、PEN、PHP、PLN、SEK、SGD、USD、TWD、VEF です。

足す：MoneyAmountOff または OrdersOverAmount が設定されている場合は必須です。
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 PercentOff または PromotionCode を設定した場合、この設定は適用されなくなり、削除されます。		 string
DiscountModifier プロモーション割引修飾子。

たとえば、割引修飾子が UpTo に設定されるとします。 次に、変更されていないプロモーション割引が "$20 off 靴" の場合、変更されたプロモーションは "靴から最大 20 ドル" になります。

足す： 随意。 この要素を指定しない場合、または空のままにした場合は、既定値の None が設定されます。
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。		 PromotionDiscountModifier
FinalAppUrls 将来の使用のために。 AppUrl 配列
FinalMobileUrls モバイル デバイスのランディング ページ URL。

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

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 この要素を空のリストに設定すると、前の設定が削除されます。		 string 配列
FinalUrls ランディング ページの URL。

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

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

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

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 この要素を空の文字列 ("") に設定すると、前の設定が削除されます。		 string
言語 広告拡張機能が配信される言語。

この拡張機能は、キャンペーンや広告グループの言語設定に関係なく、常にこの言語で提供されます。

サポートされている言語文字列は、デンマーク語、オランダ語、英語、フィンランド語、フランス語、ドイツ語、イタリア語、ノルウェー語、ポルトガル語、スペイン語、スウェーデン語、および TraditionalChinese です。

足す： 必須
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。		 string
MoneyAmountOff プロモーションの価値をオフにお金。

たとえば、"$20 off shoes - 100 ドルを超える注文時" を昇格するには、 PromotionItem を "靴" に設定し、 CurrencyCode を "USD" に設定し、 MoneyAmountOff を 20 に設定し、 OrdersOverAmount を 100 に設定します。

足す： 必須。 MoneyAmountOff または PercentOff を設定する必要がありますが、両方を設定することはできません。
更新： 随意。 MoneyAmountOff または PercentOff を設定できますが、両方を設定することはできません。		 複
OrdersOverAmount プロモーション ターゲットに追加された金額を超える注文。

たとえば、"$20 off shoes - 100 ドルを超える注文時" を昇格するには、 PromotionItem を "靴" に設定し、 CurrencyCode を "USD" に設定し、 MoneyAmountOff を 20 に設定し、 OrdersOverAmount を 100 に設定します。

足す： 随意。 OrdersOverAmount と PromotionCode の両方を設定することはできません。
更新： 随意。 OrdersOverAmount と PromotionCode の両方を設定することはできません。 更新プログラムに値が設定されていない場合、この設定は変更されません。 この要素を '0' (ゼロ) に設定すると、前の設定が削除されます。		 複
PercentOff プロモーション値がオフの割合。

たとえば、10.0 は 10% の割引を表します。

足す： 必須。 MoneyAmountOff または PercentOff を設定する必要がありますが、両方を設定することはできません。
更新： 随意。 MoneyAmountOff または PercentOff を設定できますが、両方を設定することはできません。 このプロパティを設定した場合、 CurrencyCode 設定は適用されなくなり、以前に設定されていた場合は削除されます。		 複
PromotionCode プロモーション ターゲットに追加されたプロモーション コード。

たとえば、"$20 off shoes - Promocode SAVE20" を昇格するには、 PromotionItem を "shoes" に設定し、 CurrencyCode を "USD" に設定し、 MoneyAmountOff を 20 に設定し、 PromotionCode を "SAVE20" に設定します。

文字列には、最大 15 文字を含めることができます。

足す： 随意。 OrdersOverAmount と PromotionCode の両方を設定することはできません。
更新： 随意。 OrdersOverAmount と PromotionCode の両方を設定することはできません。 更新プログラムに値が設定されていない場合、この設定は変更されません。 この要素を空の文字列 ("") に設定すると、前の設定が削除されます。 このプロパティを設定した場合、 CurrencyCode 設定は適用されなくなり、以前に設定されていた場合は削除されます。		 string
PromotionEndDate 終了日は、広告に表示されるプロモーションの日付または日付を通知するのに役立ちます。

たとえば、 PromotionStartDate 日付と PromotionEndDate 日付の両方が 2 月 14 日に設定されている場合は、表示されるプロモーションに "Valid Feb 14" というテキストを含めることができます。

PromotionStartDate の日付は、PromotionEndDate 日付より前またはそれより前である必要があります。

このプロパティは、プロモーションの固有の配信範囲をオーバーライドしません。 プロモーションプロモーションプロモーションとスケジュール設定の両方で、プロモーションが広告に表示される資格を決定します。

現在の年の終了日が既に経過している場合は、翌年の日付に対して各開始日と終了日を設定する必要があります。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 現在の終了日を削除し、実質的に終了日を設定しない場合は、 日、 月、 年 をそれぞれ '0' (ゼロ) に設定します。 次回プロモーション広告拡張機能を取得する場合、この要素は設定されません。		 Date
PromotionItem プロモーションターゲットまたはアイテム。

たとえば、$20 または 20% の割引で "靴" のプロモーションを実行できます。 "最大 $20 off 靴" のプロモーションを実行するには、 PromotionItem を "靴" に設定し、 DiscountModifier を UpTo に設定し、 CurrencyCode を "USD" に設定し、 MoneyAmountOff を 20 に設定します。

文字列には、最大 20 文字を含めることができます。

足す： 必須
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。		 string
PromotionOccasion プロモーションの機会。

PromotionOccasion 要素と Scheduling 要素はどちらも、プロモーションが広告に表示される資格を決定します。

PromotionOccasion は、毎年 2 月 15 日から 3 月 31 日までの WomensDay などの期間または季節性を決定します。 プロモーションは、設定した機会に対応する日付内でのみ実行されます。 各機会の定義された日付範囲の詳細については、「 PromotionOccasion」 を参照してください。

スケジュール設定では、2 月 20 日から 3 月 8 日までのプロモーションの実行を制限するなど、機会の日付範囲内の短い時間枠にプロモーションを制限できます。 スケジュールを使用して、同じプロモーションを複数年実行することもできます。たとえば、2 月 15 日から 3 月 31 日まで、毎年 WomensDay プロモーションを実行します。

足す： 随意。 この要素を指定しない場合、または空のままにした場合は、既定値の None が設定されます。
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 この要素を設定した場合は、以前の設定を保持または更新するために、 PromotionStartDate と PromotionEndDate も設定する必要があります。		 PromotionOccasion
PromotionStartDate 開始日は、広告に表示されるプロモーション日または日付を通知するのに役立ちます。

たとえば、 PromotionStartDate 日付と PromotionEndDate 日付の両方が 2 月 14 日に設定されている場合は、表示されるプロモーションに "Valid Feb 14" というテキストを含めることができます。

PromotionStartDate の日付は、PromotionEndDate 日付より前またはそれより前である必要があります。

このプロパティは、プロモーションの固有の配信範囲をオーバーライドしません。 プロモーションプロモーションプロモーションとスケジュール設定の両方で、プロモーションが広告に表示される資格を決定します。

現在の年の終了日が既に経過している場合は、翌年の日付に対して各開始日と終了日を設定する必要があります。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 現在の終了日を削除し、実質的に終了日を設定しない場合は、 日、 月、 年 をそれぞれ '0' (ゼロ) に設定します。 次回プロモーション広告拡張機能を取得する場合、この要素は設定されません。		 Date
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 は同じになります。

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 この要素を空の文字列 ("") に設定すると、前の設定が削除されます。		 string
UrlCustomParameters URL 追跡用のキーパラメーターと値パラメーターのカスタム コレクション。

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

足す： 随意
更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 既存のカスタム パラメーターを保持するには、 UrlCustomParameters 要素を null または空に設定します。 すべてのカスタム パラメーターを削除するには、CustomParameters オブジェクトの Parameters 要素を null または空に設定します。 カスタム パラメーターのサブセットを削除するには、CustomParameters オブジェクトの Parameters 要素に保持するカスタム パラメーターを指定します。		 CustomParameters

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

継承された要素

AdExtension から継承された要素

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

要素 説明 データ型
DevicePreference この広告拡張機能の種類ではサポートされていません。 long
ForwardCompatibilityMap 現在の API バージョンで新しい要素が追加されたときに変更が中断されないように、前方互換性のためのキー文字列と値文字列の一覧。

現在、 AdExtension オブジェクトの前方互換性の変更はありません。

足す： 読み取り専用
更新： 読み取り専用		 KeyValuePairOfstring 配列
身分証明書 広告拡張機能の一意の Microsoft Advertising 識別子。

足す： 読み取り専用
更新： 読み取り専用と必須		 long
スケジュール設定 広告表示オプションが広告に表示される資格があるカレンダーの曜日と時刻の範囲を決定します。

足す： 随意
更新： 随意。 この要素を null に設定した場合、広告拡張機能の既存のスケジュール 設定は変更されません。 これを null 以外の Schedule オブジェクトに設定すると、広告拡張機能の既存のスケジュール設定を実質的に置き換えます。 すべてのスケジュールを削除するには、この要素を空の Schedule オブジェクトに設定します。		 Schedule
Status 広告拡張機能の状態。 キャンペーン管理サービスでは削除された広告表示オプションが返されないため、値は常に アクティブ になります。

足す： 読み取り専用
更新： 読み取り専用		 AdExtensionStatus
種類 広告拡張機能の種類。 この値は、プロモーション広告拡張機能を取得するときの PromotionAdExtension です。

足す： 読み取り専用
更新： 読み取り専用

広告拡張機能の種類の詳細については、「 広告拡張機能データ オブジェクトの備考」を参照してください。		 string
バージョン 広告拡張機能が更新された回数を追跡します。

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

足す： 禁じられた
更新： 禁じられた		 int

要件

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