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

アクションの呼び出しボタンを使用してアクション広告拡張機能を定義します。

構文

<xs:complexType name="ActionAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element name="ActionType" type="tns:ActionAdExtensionActionType" />
        <xs:element xmlns:q51="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q51:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q52="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q52:ArrayOfstring" />
        <xs:element minOccurs="0" name="Language" 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:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

要素

ActionAdExtension オブジェクトには、ActionType、FinalMobileUrls、FinalUrls、FinalUrlSuffix、Language、TrackingUrlTemplate、UrlCustomParameters という要素があります。

要素	説明	データ型
ActionType	ここで選択したアクションの種類と、設定した 言語 によって、行動喚起ボタンに表示されるテキストが決まります。 Microsoft Advertising では、すべての言語のすべてのアクションの種類がサポートされているわけではありません。 サポートされていないアクションの種類と言語の組み合わせを使用しようとすると、エラーが返されます。 詳細については、「 Action Ad Extensions のアクション テキスト」を参照してください。 追加： 必須 更新： 必須	ActionAdExtensionActionType
FinalMobileUrls	これは、アクション拡張機能がモバイル デバイスで提供されている場合のモバイルフレンドリなランディング ページ URL です。 最終的なモバイル URL を指定する場合は、 FinalUrls も指定する必要があります。 URL の長さは 2,048 文字に制限されています。 HTTP または HTTPS プロトコル文字列は、2,048 文字の制限にカウントされます。 追加： オプション 更新： オプション。 この要素を null に設定すると、前の設定が削除されます。	string 配列
FinalUrls	これは、アクション テキストに対応する特定の Web ページまたはフォームへのリンクです。 アクション URL が指定されていない場合は、広告の最終的な URL が使用されます。 URL の長さは 2,048 文字に制限されています。 HTTP または HTTPS プロトコル文字列は、2,048 文字の制限にカウントされます。 データ型は文字列の一覧ですが、Microsoft Advertising では最初のリスト アイテムのみが使用されます。 追加： オプション 更新： オプション。 この要素を null に設定すると、前の設定が削除されます。	string 配列
FinalUrlSuffix	最後の URL サフィックスには、ランディング ページ URL の末尾に追加される追跡パラメーターを含めることができます。 顧客が常にランディング ページに送信されるように、ランディング ページで必要な追跡パラメーターを最終的な URL サフィックスに配置することをお勧めします。 詳細と検証規則については、テクニカル ガイドの 「最終 URL サフィックス」を 参照してください。 この機能は、最終 URL サフィックス フェーズ 3 パイロット (GetCustomerPilotFeatures が 636 を返す) のお客様にのみ使用できます。 パイロットにいない場合、このプロパティは無視され、エラーは返されません。 追加： オプション 更新： オプション。 この要素を null に設定すると、前の設定が削除されます。	string
言語	広告拡張機能が配信される言語。 この拡張機能は、キャンペーンや広告グループの言語設定に関係なく、常にこの言語で提供されます。 サポートされている言語文字列は、デンマーク語、オランダ語、英語、フィンランド語、フランス語、ドイツ語、イタリア語、ノルウェー語、ポルトガル語、スペイン語、スウェーデン語、および TraditionalChinese です。 Microsoft Advertising では、すべての言語のすべてのアクションの種類がサポートされているわけではありません。 サポートされていないアクションの種類と言語の組み合わせを使用しようとすると、エラーが返されます。 詳細については、「 Action Ad Extensions のアクション テキスト」を参照してください。 追加： 必須 更新： 必須	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} 、キャンペーン、広告グループ、条件、キーワード、または広告レベルで {_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

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

継承された要素

AdExtension から継承された要素

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

要素	説明	データ型
DevicePreference	この広告拡張機能の種類ではサポートされていません。	long
ForwardCompatibilityMap	現在の API バージョンで新しい要素が追加されたときに変更が中断されないように、前方互換性のためのキー文字列と値文字列の一覧。 現在、 AdExtension オブジェクトの前方互換性の変更はありません。 追加： 読み 取り 専用 更新： 読み 取り 専用	KeyValuePairOfstring 配列
Id	広告拡張機能の一意の Microsoft Advertising 識別子。 追加： 読み 取り 専用 更新： 読み取り専用と必須	long
スケジュール設定	広告表示オプションが広告に表示される資格があるカレンダーの曜日と時刻の範囲を決定します。 追加： オプション 更新： オプション。 この要素を null に設定した場合、広告拡張機能の既存のスケジュール 設定は変更されません。 これを null 以外の Schedule オブジェクトに設定すると、広告拡張機能の既存のスケジュール設定を実質的に置き換えます。 すべてのスケジュールを削除するには、この要素を空の Schedule オブジェクトに設定します。	Schedule
Status	広告拡張機能の状態。 キャンペーン管理サービスでは削除された広告表示オプションが返されないため、値は常に アクティブ になります。 追加： 読み 取り 専用 更新： 読み 取り 専用	AdExtensionStatus
型	広告拡張機能の種類。 この値は、アクション広告拡張機能を取得するときの ActionAdExtension です。 追加： 読み 取り 専用 更新： 読み 取り 専用 広告拡張機能の種類の詳細については、「 広告拡張機能データ オブジェクトの備考」を参照してください。	string
バージョン	広告拡張機能が更新された回数を追跡します。 バージョンは、広告拡張機能の作成時に 1 に設定され、更新のたびに 1 ずつインクリメントされます。 追加： 許可されていません 更新： 許可されていません	int

要件

サービス: CampaignManagementService.svc v13
名前 空間： https://bingads.microsoft.com/CampaignManagement/v13