PriceAdExtension データ オブジェクト - キャンペーン管理
3 行から 8 行の価格表を含む広告拡張機能を定義します。
価格広告拡張機能をアカウントに関連付けるか、アカウント内のキャンペーンや広告グループに関連付けることができます。 各エンティティ (アカウント、キャンペーン、または広告グループ) は、最大 20 個の価格広告表示オプションに関連付けることができます。
構文
<xs:complexType name="PriceAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexContent mixed="false">
<xs:extension base="tns:AdExtension">
<xs:sequence>
<xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Language" nillable="true" type="xs:string" />
<xs:element name="PriceExtensionType" type="tns:PriceExtensionType" />
<xs:element minOccurs="0" name="TableRows" nillable="true" type="tns:ArrayOfPriceTableRow" />
<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>
要素
PriceAdExtension オブジェクトには、FinalUrlSuffix、Language、PriceExtensionType、TableRows、TrackingUrlTemplate、UrlCustomParameters という要素があります。
要素 | 説明 | データ型 |
---|---|---|
FinalUrlSuffix | 最後の URL サフィックスには、ランディング ページ URL の末尾に追加される追跡パラメーターを含めることができます。 顧客が常にランディング ページに送信されるように、ランディング ページで必要な追跡パラメーターを最終的な URL サフィックスに配置することをお勧めします。 詳細と検証規則については、テクニカル ガイドの 「最終 URL サフィックス」を 参照してください。 この機能は、最終 URL サフィックス フェーズ 3 パイロット (GetCustomerPilotFeatures が 636 を返す) のお客様にのみ使用できます。 パイロットにいない場合、このプロパティは無視され、エラーは返されません。 足す: 随意 更新: 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 |
string |
言語 | 価格広告拡張機能の広告コピーの言語。 使用可能な値については、「 広告言語」を参照してください。 足す: 必須 更新: 必須 |
string |
PriceExtensionType | 価格広告拡張機能の種類。 使用可能な値は、 ブランド、 イベント、 場所、 近隣、 ProductCategories、 ProductTiers、 ServiceCategories、 サービス、 ServiceTiers、 および Unknown です。 足す: 必須 更新: 必須 |
PriceExtensionType |
TableRows | 価格テーブルの行。 3 行から 8 行の価格表が必要です。 作成する順序は広告の予想される順序ですが、注文は保証されません。 足す: 必須 更新: 必須 |
PriceTableRow 配列 |
TrackingUrlTemplate | すべてのランディング ページ 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} で、キャンペーン、広告グループ、条件、キーワード (keyword)、または広告レベルで {_season} または {_promocode} が定義されていない場合、ランディング ページの URL は同じになります。足す: 随意 更新: 随意。 この要素を null に設定すると、前の設定が削除されます。 |
string |
UrlCustomParameters | URL 追跡用のキーパラメーターと値パラメーターのカスタム コレクション。 Microsoft Advertising では、 CustomParameters オブジェクトに含める最初の 3 つの CustomParameter オブジェクトが受け入れられ、追加のカスタム パラメーターはすべて無視されます。 各 CustomParameter には、Key 要素と Value 要素が含まれています。 カスタム パラメーターの制限の引き上げフェーズ 3 パイロット (GetCustomerPilotFeatures は 635 を返します) のお客様の場合、Microsoft Advertising は、含める最初の 8 つのカスタム パラメーター キーと値のペアを受け入れ、8 つ以上のカスタム パラメーターを含む場合はエラーが返されます。 足す: 随意 更新: 随意。 この要素を null に設定すると、前の設定が削除されます。 |
CustomParameters |
PriceAdExtension オブジェクトには継承された要素があります。
継承された要素
AdExtension から継承された要素
PriceAdExtension オブジェクトは AdExtension オブジェクトから派生し、DevicePreference、ForwardCompatibilityMap、Id、Scheduling、Status、Type、Version の各要素を継承します。 以下の説明は PriceAdExtension に固有であり、 AdExtension オブジェクトから同じ要素を継承する他のオブジェクトには適用されない場合があります。
要素 | 説明 | データ型 |
---|---|---|
DevicePreference | この広告拡張機能の種類ではサポートされていません。 | long |
ForwardCompatibilityMap | 現在の API バージョンで新しい要素が追加されたときに変更が中断されないように、前方互換性のためのキー文字列と値文字列の一覧。 現在、 AdExtension オブジェクトの前方互換性の変更はありません。 足す: 読み取り専用 更新: 読み取り専用 |
KeyValuePairOfstring 配列 |
身分証明書 | 広告拡張機能の一意の Microsoft Advertising 識別子。 足す: 読み取り専用 更新: 読み取り専用と必須 |
long |
スケジュール設定 | 広告表示オプションが広告に表示される資格があるカレンダーの曜日と時刻の範囲を決定します。 足す: 随意 更新: 随意。 この要素を null に設定した場合、広告拡張機能の既存のスケジュール 設定は変更されません。 これを null 以外の Schedule オブジェクトに設定すると、広告拡張機能の既存のスケジュール設定を実質的に置き換えます。 すべてのスケジュールを削除するには、この要素を空の Schedule オブジェクトに設定します。 |
Schedule |
Status | 広告拡張機能の状態。 キャンペーン管理サービスでは削除された広告表示オプションが返されないため、値は常に アクティブ になります。 足す: 読み取り専用 更新: 読み取り専用 |
AdExtensionStatus |
種類 | 広告拡張機能の種類。 この値は、価格広告拡張機能を取得するときの PriceAdExtension です。 足す: 読み取り専用 更新: 読み取り専用 広告拡張機能の種類の詳細については、「 広告拡張機能データ オブジェクトの備考」を参照してください。 |
string |
バージョン | 広告拡張機能が更新された回数を追跡します。 バージョンは、広告拡張機能の作成時に 1 に設定され、更新のたびに 1 ずつインクリメントされます。 足す: 禁じられた 更新: 禁じられた |
int |
要件
サービス: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13