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

チラシ拡張機能を使用すると、広告主は潜在的な顧客に製品カタログまたは店舗カタログ (チラシ) を配布できます。

「毎週のお得な情報」や「毎週の売上」などの広範なクエリに目立つように表示できるため、買い物客はコンペティションの代わりに広告をクリックするよう促すことができます。 その性質上、検索者への通知を改善し、その結果、クリック率などのユーザー エンゲージメントを高めるのに役立ちます。

注:

機能パイロットのお客様は、チラシ拡張機能を利用できます (GetCustomerPilotFeatures は 802 を返します)。

構文

<xs:complexType name="FlyerAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q61="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q61:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q62="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q62:ArrayOfstring" />
        <xs:element minOccurs="0" name="FlyerName" nillable="true" type="xs:string" />
        <xs:element xmlns:q63="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="ImageMediaIds" nillable="true" type="q63:ArrayOflong" />
        <xs:element xmlns:q64="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="ImageMediaUrls" nillable="true" type="q64:ArrayOfstring" />
        <xs:element minOccurs="0" name="StoreId" nillable="true" type="xs:long" />
        <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>

要素

FlyerAdExtension オブジェクトには、Description、FinalAppUrls、FinalMobileUrls、FinalUrls、FinalUrlSuffix、FlyerName、ImageMediaIds、ImageMediaUrls、StoreId、TrackingUrlTemplate、UrlCustomParameters という要素があります。

要素	説明	データ型
説明	広告主、代理店、またはアカウント マネージャーがチラシ拡張機能の追跡、ラベル付け、管理に使用できる説明。 この説明は、広告や画像には表示されません。 この要素の最大長は 1,024 文字です。 追加： オプション 更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。	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 も指定する必要があります。 追加： オプション 更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。 この要素を空のリストに設定すると、前の設定が削除されます。	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
FlyerName	チラシ名。 この要素の最大長は 150 文字です。 追加： 必須 更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。	string
ImageMediaIds	広告に含める画像の識別子。 メディア ID は 1 つだけ設定できます。 データ型は、複数のイメージのサポートが後で追加された場合の長い値の一覧です。 各メディア ID は、"GenericImage" Media サブタイプの Image に対応します。 各 Image の識別子は、 AddMedia 操作を呼び出してイメージ ライブラリに追加するときに取得できます。 それ以外の場合は、メディアがイメージ ライブラリに追加された後、 GetMediaMetaDataByAccountId 操作を使用してメディア識別子を取得できます。 イメージの最小幅と高さは 220px、最大ファイル サイズは 3.9 MB である必要があります。 追加： 必須 更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。	long 配列
ImageMediaUrls	既に追加したメディアの URL。 追加： 読み 取り 専用 更新： 読み 取り 専用	string 配列
Storeid	製品広告に使用される Microsoft Merchant Center ストアの一意識別子。 追加： オプション 更新： 読み 取り 専用。 ストア ID が設定された後は更新できません。	long
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 は同じになります。 追加： オプション 更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。 この要素を空の文字列 ("") に設定すると、前の設定が削除されます。	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

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

継承された要素

AdExtension から継承された要素

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

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

要件

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