Action Ad Extension Record - Bulk

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

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

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

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

Type,Status,Id,Parent Id,ClientId,Language,Start Date,End Date,Name,Ad Schedule,Use Searcher Time Zone,Action Type,Action Text,Final Url,Mobile Final Url,Tracking Template,Final Url Suffix,Custom Parameter
Format Version,,,,,,,,6.0,,,,,,,,,
Action Ad Extension,Active,-10,0,ClientIdGoesHere,English,,12/31/2020,,(Monday[09:00-21:00]);(Tuesday[09:00-21:00]);(Wednesday[09:00-21:00]);(Thursday[09:00-21:00]);(Friday[09:00-21:00]),false,ActNow,,https://www.contoso.com/womenshoesale,https://mobile.contoso.com/womenshoesale,,,{_promoCode}=PROMO1; {_season}=summer

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

var uploadEntities = new List<BulkEntity>();

// Map properties in the Bulk file to the BulkActionAdExtension
var bulkActionAdExtension = new BulkActionAdExtension
{
    // '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 
    // ActionAdExtension object of the Campaign Management service.
    ActionAdExtension = new ActionAdExtension
    {
        // 'Id' column header in the Bulk file
        Id = actionAdExtensionIdKey,
        // 'Action Type' column header in the Bulk file
        ActionType = ActionAdExtensionActionType.ActNow,
        // 'Mobile Final Url' column header in the Bulk file
        FinalMobileUrls = new string[]
        {
            "https://mobile.contoso.com/womenshoesale"
        },
        // 'Final Url' column header in the Bulk file
        FinalUrls = new string[]
        {
            "https://www.contoso.com/womenshoesale"
        },
        // 'Language' column header in the Bulk file
        Language = "English",
        // '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(bulkActionAdExtension);

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

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

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

• アクション テキスト
• アクションの種類
• 広告スケジュール
• クライアント ID
• カスタム パラメーター
• 編集場所
• 編集理由コード
• 編集状態
• 編集用語
• 終了日
• 最終 URL
• 最終 URL サフィックス
• Id
• Language
• モバイルの最終 URL
• 変更時刻
• Parent Id
• 発行元の国
• 開始日
• 状態
• 追跡テンプレート
• Searcher タイム ゾーンを使用する
• バージョン

アクション テキスト

このローカライズされたテキストは、行動喚起ボタンに表示されます。

表示されるアクション テキストは、設定したアクションの 種類 と 言語 によって異なります。 たとえば、アクションの 種類 が "ActNow" で 、言語 が "英語" の場合、表示されるアクション テキストは "Act Now" になります。 言語ごとのローカライズされたアクション テキストの詳細については、「 Action Ad Extensions のアクション テキスト」を参照してください。

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

アクションの種類

ここで選択したアクションの種類と、設定した 言語 によって、アクションの呼び出しボタンに表示されるアクション テキスト が決まります。

このフィールドで使用できる値は、ActNow、ApplyNow、BetNow、BidNow、BookACar、BookHotel、BookNow、BuyNow、ChatNow、Compare、ContactUs、Coupon、Directions、Donate、 ダウンロード、EmailNow、RegisterNow、FileNow、FindJob、FindStore、FreePlay、FreeQuote、FreeTrial、GetDeals、GetOffer、GetQuote、JoinNow、LearnMore、ListenNow、LogIn、OrderNow、PlayGame、PlayNow、PostJob、Register、RenewNow、RentACar、RentNow、予約、販売、SaveNow、Schedule、SeeMenu、SeeOffer、SellNow、ShopNow、Showtimes、Showtimes SignIn、SignUp、StartNow、Subscribe、SwitchNow、TestDrive、TryNow、ViewCars、ViewPlans、VisitStore、VoteNow、Watch、WatchMore、WatchNow。

Microsoft Advertising では、すべての言語のすべてのアクションの種類がサポートされているわけではありません。 サポートされていないアクションの種類と言語の組み合わせを使用しようとすると、エラーが返されます。 詳細については、「 Action Ad Extensions のアクション テキスト」を参照してください。

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

広告スケジュール

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

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

クライアント ID

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

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

カスタム パラメーター

URL 追跡用のキーパラメーターと値パラメーターのカスタム コレクション。

一括ファイルでは、カスタム パラメーターの一覧は次のように書式設定されます。

• 各カスタム パラメーター ペアを Key=Value (例: {_promoCode}=PROMO1) として書式設定します。

• Microsoft Advertising は、含める最初の 3 つのカスタム パラメーター キーと値のペアを受け入れ、追加のカスタム パラメーターは無視されます。 カスタム パラメーターの制限の引き上げフェーズ 3 パイロット (GetCustomerPilotFeatures は 635 を返します) のお客様の場合、Microsoft Advertising は、含める最初の 8 つのカスタム パラメーター キーと値のペアを受け入れ、8 つ以上のカスタム パラメーターを含む場合はエラーが返されます。

• 各キーと値のペアは、セミコロンとスペース ("; ") で区切られます (例: {_promoCode}=PROMO1;{_season}=summer.

• Key にはセミコロンを含めることはできません。 Value にセミコロンが含まれている場合は、'\;' としてエスケープする必要があります。 さらに、Value に円記号が含まれている場合は、'\' としてもエスケープする必要があります。

• キーは 16 UTF-8 バイトを超えることはできません。値は 200 UTF-8 バイトを超えることはできません。 カスタム パラメーターの上限引き上げフェーズ 3 パイロット (GetCustomerPilotFeatures が 635 を返す) のお客様の場合、値の制限は 250 UTF-8 バイトに増加します。 キーは必須であり、値は省略可能です。 Key の最大サイズには、中かっことアンダースコア ('{'、'_'、'}' は含まれません。

  注:

  Bulk サービスでは、Key は周囲の中かっこと先頭のアンダースコアで書式設定する必要があります。たとえば、Key が promoCode の場合は、{_promoCode} として書式設定する必要があります。 キャンペーン管理サービスでは、周囲の中かっことアンダースコアを指定できません。

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

編集場所

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

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

編集理由コード

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

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

編集状態

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

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

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

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

編集用語

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

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

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

終了日

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

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

追加： オプション。 終了日を指定しない場合、関連するキャンペーン、広告グループ、または広告を一時停止しない限り、広告表示オプションは引き続き配信されます。
更新： オプション。 開始日が null であるか、新しい終了日より前に発生する限り、終了日は短縮または延長できます。 このフィールドを delete_value 文字列に設定すると、実質的に終了日が削除されます。 [広告スケジュール]、[終了日]、[開始日]、[検索者のタイム ゾーンを使用する] フィールドは互いに依存し、まとめて更新されます。 更新中にこれらのフィールドをすべて空のままにした場合、更新されません。 これらのフィールドのいずれかに値を含める場合、これらのすべてのフィールドの以前の値が削除または置換されます。 以前のすべてのスケジュール設定を削除するには、これらの各フィールドを delete_valueに設定します。
削除： 読み 取り 専用

最終 URL

これは、アクション テキストに対応する特定の Web ページまたはフォームへのリンクです。

広告拡張機能の最終 URL が指定されていない場合は、広告の最終 URL が使用されます。

URL の長さは 2,048 文字に制限されています。 HTTP または HTTPS プロトコル文字列は、2,048 文字の制限にカウントされます。

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

最終 URL サフィックス

最後の URL サフィックスには、ランディング ページ URL の末尾に追加される追跡パラメーターを含めることができます。 顧客が常にランディング ページに送信されるように、ランディング ページで必要な追跡パラメーターを最終的な URL サフィックスに配置することをお勧めします。 詳細と検証規則については、テクニカル ガイドの 「最終 URL サフィックス」を 参照してください。

注:

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

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

Id

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

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

言語

広告拡張機能が配信される言語。

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

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

Microsoft Advertising では、すべての言語のすべてのアクションの種類がサポートされているわけではありません。 サポートされていないアクションの種類と言語の組み合わせを使用しようとすると、エラーが返されます。 詳細については、「 Action Ad Extensions のアクション テキスト」を参照してください。

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

モバイルの最終 URL

これは、アクション拡張機能がモバイル デバイスで提供されている場合のモバイルフレンドリなランディング ページ URL です。

Mobile Final Url を指定する場合は、 Final Url も指定する必要があります。

URL の長さは 2,048 文字に制限されています。 HTTP または HTTPS プロトコル文字列は、2,048 文字の制限にカウントされます。

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

変更時刻

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

注:

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

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

Parent Id

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

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

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

発行元の国

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

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

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

開始日

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

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

追加： オプション。 開始日を指定しない場合は、広告表示オプションをすぐに スケジュールできます。
更新： オプション。 終了日が null であるか、新しい開始日の後に発生する限り、開始日は短縮または延長できます。 このフィールドを delete_value 文字列に設定すると、実質的に開始日が削除され、広告拡張機能がすぐに スケジュールされる資格があります。 [広告スケジュール]、[終了日]、[開始日]、[検索者のタイム ゾーンを使用する] フィールドは互いに依存し、まとめて更新されます。 更新中にこれらのフィールドをすべて空のままにした場合、更新されません。 これらのフィールドのいずれかに値を含める場合、これらのすべてのフィールドの以前の値が削除または置換されます。 以前のすべてのスケジュール設定を削除するには、これらの各フィールドを delete_valueに設定します。
削除： 読み 取り 専用

状態

広告拡張機能の状態。

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

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

追跡テンプレート

アクション URL に使用する追跡テンプレート。

追跡テンプレートには、次の検証規則が適用されます。 サポートされているテンプレートとパラメーターの詳細については、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 は同じになります。

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

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

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

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

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

バージョン

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

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