アプリ広告拡張機能レコード - 一括

[アーティクル]
10/04/2023

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

アプリ広告拡張機能をアカウントに関連付けるか、アカウント内のキャンペーンや広告グループに関連付けることができます。各エンティティ (アカウント、キャンペーン、または広告グループ) は、アカウント内のアプリ広告表示オプションの合計数まで、決定した数だけアプリ広告表示オプションに関連付けることができます。アプリ広告拡張機能の関連付けを管理するには、アカウントアプリ広告拡張機能、広告グループアプリ広告拡張機能、およびキャンペーンアプリ広告拡張機能のレコードを使用します。

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

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

Type,Status,Id,Parent Id,Campaign,Ad Group,Client Id,Modified Time,Start Date,End Date,Text,Destination Url,Device Preference,Name,Ad Schedule,Use Searcher Time Zone,App Platform,App Id,Final Url Suffix
Format Version,,,,,,,,,,,,,6.0,,,,,
App Ad Extension,Active,-11,0,,,ClientIdGoesHere,,,12/31/2020,Contoso,DestinationUrlGoesHere,,,(Monday[09:00-21:00]),FALSE,Windows,AppStoreIdGoesHere,

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

var uploadEntities = new List<BulkEntity>();

// Map properties in the Bulk file to the BulkAppAdExtension
var bulkAppAdExtension = new BulkAppAdExtension
{
    // '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 
    // AppAdExtension object of the Campaign Management service.
    AppAdExtension = new AppAdExtension
    {
        // 'App Platform' column header in the Bulk file
        AppPlatform = "Windows",
        // 'App Id' column header in the Bulk file
        AppStoreId = "AppStoreIdGoesHere",
        // 'Destination Url' column header in the Bulk file
        DestinationUrl = "DestinationUrlGoesHere",
        // 'Device Preference' column header in the Bulk file
        DevicePreference = null,
        // 'Text' column header in the Bulk file
        DisplayText = "Contoso",
        // 'Id' column header in the Bulk file
        Id = appAdExtensionIdKey,
        // '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(bulkAppAdExtension);

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

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

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

広告スケジュール
アプリ ID
アプリプラットフォーム
クライアント ID
宛先 URL
デバイスの基本設定
編集場所
編集理由コード
編集状態
編集用語
終了日
Id
変更時刻
Parent 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])

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

アプリ ID

アプリストアによって提供されるアプリケーション識別子。

アプリケーションが新しい場合は、広告の配信資格が得られるまで 4 日から 7 日お待ちください。

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

アプリプラットフォーム

アプリケーションプラットフォーム。

使用可能な値には、 iOS、 Android、 および Windows が含まれます。

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

クライアント ID

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

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

宛先 URL

ユーザーがアプリ拡張機能リンクをクリックしたときに取得されるアプリストアのダウンロード Web ページの URL。

URL には、{キーワード (keyword)} などの動的テキスト文字列を含めることができます。サポートされているパラメーターの一覧については、Microsoft Advertising ヘルプ記事「使用できるパラメーター」セクション「どのような追跡または URL パラメーターを使用できますか?」を参照してください。

URL には、最大 1,024 文字を含めることができます。 URL でプロトコルが指定されていない場合、ユーザーが広告をクリックすると、システムは HTTP プロトコルを使用します。広告を追加するときに URL で HTTP プロトコルが指定されている場合、サービスは http:// プロトコル文字列を削除します (HTTP プロトコル文字列は 1,024 文字の制限に対してカウントされません)。ただし、サービスは URL から HTTPS プロトコル文字列 (https://) を削除しません。

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

デバイスの基本設定

このフィールドは、広告拡張機能をモバイルデバイスに表示するか、すべてのデバイスに表示するかを設定します。

使用可能な値は All と Mobile で、キャンペーン管理サービスで使用される値とは異なります。

既定値は All です。

一括ダウンロードとアップロードの結果ファイルでは、このフィールドが空になることはありません。デバイスの基本設定を指定しなかった場合は、 既定値の All が返されます。

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

編集場所

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

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

編集理由コード

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

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

編集状態

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

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

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

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

編集用語

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

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

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

終了日

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

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

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

Id

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

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

変更時刻

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

注:

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

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

Parent Id

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

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

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

発行元の国

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

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

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

開始日

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

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

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

状態

広告拡張機能の状態。

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

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

テキスト

アプリ広告拡張機能に表示されるテキスト。

テキストには、最大 35 文字を含めることができます。

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

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

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

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

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

バージョン

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

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

次の方法で共有

アプリ広告拡張機能レコード - 一括

広告スケジュール

アプリ ID

アプリプラットフォーム

クライアント ID

宛先 URL

デバイスの基本設定

編集場所

編集理由コード

編集状態

編集用語

終了日

Id

変更時刻

Parent Id

発行元の国

開始日

状態

テキスト

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

バージョン

その他のリソース

次の方法で共有

アプリ広告拡張機能レコード - 一括

広告スケジュール

アプリ ID

アプリ プラットフォーム

クライアント ID

宛先 URL

デバイスの基本設定

編集場所

編集理由コード

編集状態

編集用語

終了日

Id

変更時刻

Parent Id

発行元の国

開始日

状態

テキスト

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

バージョン

その他のリソース

アプリプラットフォーム

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