チラシ広告拡張機能レコード - 一括

一括ファイルでダウンロードおよびアップロードできるチラシ広告拡張機能を定義します。

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

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

注:

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

チラシ広告拡張機能をアカウントに関連付けるか、アカウント内のキャンペーンや広告グループに関連付けることができます。 各エンティティ (アカウント、キャンペーン、または広告グループ) は、最大 3 つのチラシ広告表示オプションに関連付けることができます。 アカウント チラシ広告拡張機能、広告グループ チラシ広告拡張機能、キャンペーン チラシ広告拡張機能のレコードを使用して、チラシ広告拡張機能の関連付けを管理します。

アカウント内のすべてのチラシ広告拡張機能レコードをダウンロードできます。DownloadCampaignsByAccountIds または DownloadCampaignsByCampaignIds サービス要求に FlyerAdExtensions の DownloadEntity 値を含めます。 さらに、ダウンロード要求には EntityData スコープを含める必要があります。 ベスト プラクティスを含む一括サービスの詳細については、「 一括ダウンロードとアップロード」を参照してください。

次の一括 CSV の例では、アカウントの共有ライブラリに新しいチラシ広告拡張機能を追加します。

Type,Status,Id,Parent Id,Campaign,Ad Group,Client Id,Modified Time,Start Date,End Date,Store Id,Name,Ad Schedule,Use Searcher Time Zone,Flyer Name,Description,Final Url,Mobile Final Url,Media Ids,Media Urls
Format Version,,,,,,,,,,,6.0,,,,,,
Flyer Ad Extension,Active,-18,0,,,ClientIdGoesHere,,,12/31/2020,,,(Monday[09:00-21:00]),FALSE,Flyer name goes here, Flyer description goes here,https://www.contoso.com/one; https://www.contoso.com/two; https://www.contoso.com/three,https://mobile.contoso.com/one; https://mobile.contoso.com/two; https://mobile.contoso.com/three,12345678,

.NET、Java、または Python 用 の Bing Ads SDK を 使用している場合は、 BulkServiceManager を使用して BulkFlyerAdExtension オブジェクトをアップロードしてダウンロードする時間を節約できます。サービス操作を直接呼び出し、カスタム コードを記述してバルク ファイル内の各フィールドを解析する代わりにします。

// Map properties in the Bulk file to the BulkFlyerAdExtension
var bulkFlyerAdExtension = new BulkFlyerAdExtension
{
    // 'Parent Id' column header in the Bulk file
    AccountId = 0,
    // 'Client Id' column header in the Bulk file
    ClientId = "ClientIdGoesHere",

    // Map properties in the Bulk file to the 
    // FlyerAdExtension object of the Campaign Management service.
    FlyerAdExtension = new FlyerAdExtension
    {
        // 'Description' column header in the Bulk file
        Description = "Flyer description",

        // 'Id' column header in the Bulk file
        Id = flyerAdExtensionIdKey,
                        
        // 'Final Url' column header in the Bulk file
        FinalUrls = new[] {
            // Each Url is delimited by a semicolon (;) in the Bulk file
            "https://www.contoso.com/one",
            "https://www.contoso.com/two",
            "https://www.contoso.com/three"
        },
        // 'Mobile Final Url' column header in the Bulk file
        FinalMobileUrls = new[] {
            // Each Url is delimited by a semicolon (;) in the Bulk file
            "https://mobile.contoso.com/one",
            "https://mobile.contoso.com/two",
            "https://mobile.contoso.com/three"
        },
        // 'Flyer Name' column header in the Bulk file
        FlyerName = "Flyer name",
        // 'Media Ids' column header in the Bulk file
        ImageMediaIds = new[] {
            (long)12345678,
        },
        // 'Media Urls' column header in the Bulk file
        ImageMediaUrls = null,
        // 'Store Id' column header in the Bulk file
        StoreId = 12345678,
        // 'Tracking Template' column header in the Bulk file
        TrackingUrlTemplate = null,
        // 'Custom Parameter' column header in the Bulk file
        UrlCustomParameters = new CustomParameters
        {
            // Each custom parameter is delimited by a semicolon (;) in the Bulk file
            Parameters = new[] {
                new CustomParameter(){
                    Key = "promoCode",
                    Value = "PROMO1"
                },
                new CustomParameter(){
                    Key = "season",
                    Value = "summer"
                },
            }
        },
        // 'Ad Schedule' column header in the Bulk file
        Scheduling = new Schedule
        {
            // Each day and time range is delimited by a semicolon (;) in the Bulk file
            DayTimeRanges = new[]
            {
                // Within each day and time range the format is Day[StartHour:StartMinue-EndHour:EndMinute].
                new DayTime
                {
                    Day = Day.Monday,
                    StartHour = 9,
                    StartMinute = Minute.Zero,
                    EndHour = 21,
                    EndMinute = Minute.Zero,
                },
            },
            // 'End Date' column header in the Bulk file
            EndDate = new Microsoft.BingAds.V13.CampaignManagement.Date
            {
                Month = 12,
                Day = 31,
                Year = DateTime.UtcNow.Year + 1
            },
            // 'Start Date' column header in the Bulk file
            StartDate = null,
            // 'Use Searcher Time Zone' column header in the Bulk file
            UseSearcherTimeZone = false,
        },

        // 'Status' column header in the Bulk file
        Status = AdExtensionStatus.Active,
    },
};

uploadEntities.Add(bulkFlyerAdExtension);

var entityUploadParameters = new EntityUploadParameters
{
    Entities = uploadEntities,
    ResponseMode = ResponseMode.ErrorsAndResults,
    ResultFileDirectory = FileDirectory,
    ResultFileName = DownloadFileName,
    OverwriteResultFile = true,
};

var uploadResultEntities = (await BulkServiceManager.UploadEntitiesAsync(entityUploadParameters)).ToList();

Flyer Ad Extension レコードの場合、一括ファイル スキーマでは次の属性フィールドを使用できます。

• 広告スケジュール
• クライアント ID
• 説明
• 編集場所
• 編集理由コード
• 編集状態
• 編集用語
• 終了日
• 最終 URL
• チラシ名
• Id
• メディア ID
• メディア URL
• モバイルの最終 URL
• 変更時刻
• Parent Id
• 発行元の国
• 開始日
• 状態
• ストア ID
• Searcher タイム ゾーンを使用する
• バージョン

広告スケジュール

広告拡張機能を広告と共に表示する曜日と時間の範囲の一覧。 各曜日と時間範囲には、スケジュールされた曜日、開始時刻/終了時間、開始/終了分が含まれます。 各日と時刻の範囲は左と右のかっこで囲み、他の日と時刻の範囲からセミコロン (;)区切り記号で区切られます。 日付と時刻の範囲内の形式は 、Day[StartHour:StartMinue-EndHour:EndMinute] です。

StartHour の値の範囲は 00 から 23 です。00 は午前 12:00 に相当し、12 は午後 12 時です。

EndHour の値の範囲は 00 から 24 です。00 は午前 12:00 に相当し、12 は午後 12:00 です。

StartMinute と EndMinute の使用可能な値の範囲は 00 から 60 です。

次の例では、平日の午前 9:00 から午後 9:00 までの曜日と時間の範囲を示します 。(月曜日[09:00-21:00]);(火曜日[09:00-21:00]);(水曜日[09:00-21:00]);(木曜日[09:00-21:00]);(金曜日[09:00-21:00])

追加： オプション。 このフィールドを設定しない場合、広告表示オプションはカレンダーの 開始日 と 終了日 の間にいつでもスケジュールを設定できます。
更新： オプション。 個々の日と時刻の範囲を更新することはできません。 前のセットを置き換える必要がある新しいセットを送信することで、日と時刻の範囲を効果的に更新できます。 [広告スケジュール] フィールドと [Searcher タイム ゾーンの使用] フィールドは相互に依存し、まとめて更新されます。 更新中に両方のフィールドを空のままにした場合、どちらも更新されません。 これらのフィールドのいずれかに値を含める場合、これらの各フィールドの以前の値は削除または置換されます。
削除： 読み 取り 専用

クライアント ID

一括アップロード ファイル内のレコードを結果ファイル内のレコードに関連付けるために使用されます。 このフィールドの値は、サーバーによって使用または格納されません。アップロードされたレコードから対応する結果レコードにコピーされます。 最大 100 の長さの任意の有効な文字列を指定できます。

追加： オプション
更新： オプション
削除： 読み 取り 専用

説明

広告主、代理店、またはアカウント マネージャーがチラシ拡張機能の追跡、ラベル付け、管理に使用できる説明。

この説明は、広告や画像には表示されません。

この要素の最大長は 1,024 文字です。

追加： オプション
更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。 このフィールドを delete_value 文字列に設定すると、前の設定は削除されます。
削除： 読み 取り 専用

編集場所

編集レビューに失敗した広告拡張機能のコンポーネントまたはプロパティ。

追加： 読み 取り 専用
更新： 読み 取り 専用
削除： 読み 取り 専用

編集理由コード

エラーの理由を識別するコード。 考えられる理由コードの一覧については、「 編集理由コード」を参照してください。

追加： 読み 取り 専用
更新： 読み 取り 専用
削除： 読み 取り 専用

編集状態

広告拡張機能の編集状態。

使用可能な値については、次の表を参照してください。

値	説明
アクティブ	広告拡張機能が編集レビューに合格しました。
ActiveLimited	広告拡張機能は 1 つ以上の市場で編集レビューに合格し、広告拡張機能の 1 つ以上の要素が別の市場で編集レビューを受けています。 たとえば、広告拡張機能はカナダの編集レビューに合格し、米国でのレビューがまだ保留中です。
不承認	広告拡張機能が編集レビューに失敗しました。
非アクティブ	広告拡張機能の 1 つ以上の要素が編集レビュー中です。

追加： 読み 取り 専用
更新： 読み 取り 専用
削除： 読み 取り 専用

編集用語

編集レビューに失敗した用語。

用語の組み合わせによってエラーが発生した場合、またはポリシー違反に基づいて失敗した場合、このフィールドは設定されません。

追加： 読み 取り 専用
更新： 読み 取り 専用
削除： 読み 取り 専用

終了日

MM/DD/YYYY として書式設定された広告拡張機能のスケジュールされた終了日文字列。

終了日は包括的です。 たとえば、このフィールドを 2020 年 12 月 31 日に設定した場合、広告表示オプションは 2020 年 12 月 31 日午後 11 時 59 分に表示されなくなります。

終了日は開始日から 30 日以内である必要があります。

追加： 必須
更新： オプション。 開始日が設定されていないか、新しい終了日の 30 日前まで発生する限り、終了日は短縮または延長できます。
削除： 読み 取り 専用

最終 URL

ランディング ページの URL。

次の検証規則は、最終 URL と最終モバイル URL に適用されます。

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

追加： 必須
更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。
削除： 読み 取り 専用

チラシ名

チラシ名。

この要素の最大長は 150 文字です。

追加： 必須
更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。
削除： 読み 取り 専用

Id

広告拡張機能のシステム生成識別子。

追加： オプション。 このフィールドは空のままにするか、負の識別子を指定する必要があります。 広告拡張機能に設定された負の識別子は、広告グループチラシ広告拡張機能やキャンペーン チラシ広告拡張機能などの依存レコードタイプの [ID] フィールドで参照できます。 これは、同じ Bulk ファイルに新しい広告表示オプションと新しい依存レコードを追加する場合に推奨されます。 詳細については、「 一括ファイル スキーマ参照キー」を参照してください。
更新： 読み取り専用と必須
削除： 読み取り専用と必須

メディア ID

広告に含める画像の識別子。

メディア ID は 1 つだけ設定できます。

各メディア ID は、"GenericImage" サブタイプの Image に対応します。

イメージの最小幅と高さは 220px、最大ファイル サイズは 3.9 MB である必要があります。

追加： 必須
更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。
削除： 読み 取り 専用

メディア URL

既に追加したメディアの URL。

追加： 読み 取り 専用
更新： 読み 取り 専用
削除： 読み 取り 専用

モバイルの最終 URL

モバイル デバイスのランディング ページ URL。

次の検証規則は、最終 URL と最終モバイル URL に適用されます。

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

追加： オプション
更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。 このフィールドを delete_value 文字列に設定すると、前の設定は削除されます。
削除： 読み 取り 専用

変更時刻

エンティティが最後に更新された日付と時刻。 値は、世界協定時刻 (UTC) です。

注:

日付と時刻の値は、クライアントではなく、サーバーでの日付と時刻を反映します。 日付と時刻の形式については、「 プリミティブ XML データ型」の dateTime エントリを参照してください。

追加： 読み 取り 専用
更新： 読み 取り 専用
削除： 読み 取り 専用

Parent Id

広告拡張機能を含むアカウントのシステム生成識別子。

この一括フィールドは、取引先企業レコードの Id フィールドにマップされます。

追加： 読み 取り 専用
更新： 読み 取り 専用
削除： 読み 取り 専用

発行元の国

編集ガイドラインで指定した 用語が許可されていない発行元の国または地域の一覧。

一括ファイルでは、発行元の国またはリージョンの一覧はセミコロン (;)で区切られます。

追加： 読み 取り 専用
更新： 読み 取り 専用
削除： 読み 取り 専用

開始日

MM/DD/YYYY として書式設定された広告拡張機能のスケジュールされた開始日文字列。

開始日は包括的です。 たとえば、 StartDate を 2020 年 5 月 5 日に設定した場合、広告表示オプションは 2020 年 5 月 5 日午前 12 時に表示されるようになります。

終了日は開始日から 30 日以内である必要があります。

追加： 必須
更新： オプション。 終了日が設定されていないか、新しい開始日から最大 30 日後に発生する限り、開始日を短縮または延長できます。
削除： 読み 取り 専用

状態

広告拡張機能の状態。

使用可能な値は [アクティブ] または [削除済み] です。

追加： オプション。 既定値は [アクティブ] です。
更新： オプション。 更新プログラムに値が設定されていない場合、この設定は変更されません。
削除： 必須。 [状態] を [削除済み] に設定する必要があります。

ストア ID

製品広告に使用される Microsoft Merchant Center ストアの一意識別子。

追加： オプション
更新： 読み 取り 専用。 ストア ID が設定された後は更新できません。
削除： 読み 取り 専用

Searcher タイム ゾーンを使用する

広告を配信できる検索ユーザーのアカウント タイム ゾーンとタイム ゾーンのどちらを使用するかを指定します。

検索ユーザーのタイム ゾーンに広告表示オプションを表示する場合は、このプロパティを TRUE に設定し、それ以外の場合は FALSE に設定 します。

追加： オプション。 このフィールドを指定しない場合、または空のままにした場合は、既定値の FALSE が設定され、アカウントのタイム ゾーンが使用されます。
更新： オプション。 このフィールドを delete_value 文字列に設定すると、実質的に FALSE の既定値にリセットされます。 [広告スケジュール] フィールドと [Searcher タイム ゾーンの使用] フィールドは相互に依存し、まとめて更新されます。 更新中に両方のフィールドを空のままにした場合、どちらも更新されません。 これらのフィールドのいずれかに値を含める場合、これらの各フィールドの以前の値は削除または置換されます。
削除： 読み 取り 専用

バージョン

広告拡張機能の内容が更新された回数。 拡張機能を追加すると、バージョンは 1 に設定され、変更されるたびにインクリメントされます。

追加： 読み 取り 専用
更新： 読み 取り 専用
削除： 読み 取り 専用