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

広告に含めることができるアプリ広告拡張機能を定義します。

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

構文

<xs:complexType name="AppAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:AdExtension">
      <xs:sequence>
        <xs:element minOccurs="0" name="AppPlatform" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="AppStoreId" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DestinationUrl" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DisplayText" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
        <xs:element xmlns:q47="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q47:ArrayOfstring" />
        <xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
        <xs:element xmlns:q48="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q48:ArrayOfstring" />
        <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>

要素

AppAdExtension オブジェクトには、AppPlatform、AppStoreId、DestinationUrl、DisplayText、FinalAppUrls、FinalMobileUrls、FinalUrls、FinalUrlSuffix、TrackingUrlTemplate、UrlCustomParameters という要素があります。

要素	説明	データ型
AppPlatform	アプリケーション プラットフォーム。 使用可能な値には、iOS、Android、および Windows が含まれます。 追加： 必須 更新： 必須	string
AppStoreId	アプリ ストアによって提供されるアプリケーション識別子。 アプリケーションが新しい場合は、広告の配信資格が得られるまで 4 日から 7 日お待ちください。 追加： 必須 更新： 必須	string
DestinationUrl	ユーザーがアプリ拡張機能リンクをクリックしたときに取得されるアプリ ストアのダウンロード Web ページの URL。 URL には、{キーワード (keyword)} などの動的テキスト文字列を含めることができます。 サポートされているパラメーターの一覧については、Microsoft Advertising ヘルプ記事「使用できるパラメーター」セクション「 どのような追跡または URL パラメーターを使用できますか?」を参照してください。 URL には、最大 1,024 文字を含めることができます。 URL でプロトコルが指定されていない場合、ユーザーが広告をクリックすると、システムは HTTP プロトコルを使用します。 広告を追加するときに URL で HTTP プロトコルが指定されている場合、サービスは http:// プロトコル文字列を削除します (HTTP プロトコル文字列は 1,024 文字の制限に対してカウントされません)。ただし、サービスは URL から HTTPS プロトコル文字列 (https://) を削除しません。 追加： 必須 更新： オプション	string
DisplayText	アプリ広告拡張機能に表示されるテキスト。 テキストには、最大 35 文字を含めることができます。 追加： 必須 更新： オプション	string
FinalAppUrls	将来使用するために予約されています。	AppUrl 配列
FinalMobileUrls	将来使用するために予約されています。	string 配列
FinalUrls	将来使用するために予約されています。	string 配列
FinalUrlSuffix	将来使用するために予約されています。	string
TrackingUrlTemplate	将来使用するために予約されています。	string
UrlCustomParameters	将来使用するために予約されています。	CustomParameters

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

継承された要素

AdExtension から継承された要素

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

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

要件

サービス: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13