ImageAdExtension データ オブジェクト - キャンペーン管理
拡張テキスト広告に含める代替テキストを含む画像を指定する広告拡張機能を定義します。
画像広告拡張機能をアカウントに関連付けたり、アカウント内のキャンペーンや広告グループに関連付けたりすることができます。 アカウントごとに、1,000 個のキャンペーンと 1,000 個の広告グループのみを画像広告表示オプションに関連付けることができます。 各エンティティ (アカウント、キャンペーン、または広告グループ) は、最大 6 つの画像広告表示オプションに関連付けることができます。
構文
<xs:complexType name="ImageAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexContent mixed="false">
<xs:extension base="tns:AdExtension">
<xs:sequence>
<xs:element minOccurs="0" name="AlternativeText" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Description" 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:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="FinalAppUrls" nillable="true" type="tns:ArrayOfAppUrl" />
<xs:element xmlns:q44="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q44:ArrayOfstring" />
<xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
<xs:element xmlns:q45="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q45:ArrayOfstring" />
<xs:element xmlns:q46="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="ImageMediaIds" nillable="true" type="q46:ArrayOflong" />
<xs:element minOccurs="0" name="Images" nillable="true" type="tns:ArrayOfAssetLink">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element xmlns:q47="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="Layouts" nillable="true" type="q47:ArrayOfstring">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="SourceType" nillable="true" type="xs:string">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
<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>
要素
ImageAdExtension オブジェクトには、AlternativeText、Description、DestinationUrl、DisplayText、FinalAppUrls、FinalMobileUrls、FinalUrls、FinalUrls、FinalUrlSuffix、ImageMediaIds、Images、Layouts、SourceType、TrackingUrlTemplate、UrlCustomParameters という要素があります。
| 要素 | 説明 | データ型 |
|---|---|---|
| AlternativeText | 使いやすさのためのイメージ メディアの別の説明。 画像を表示できない場合は、代わりに代替テキストが使用されます。 この要素の最大長は 35 文字です。 足す： 必須 更新： 必須 |
string |
| 説明 | 広告主、代理店、またはアカウント マネージャーが画像メディアの追跡、ラベル付け、管理に使用できる説明。 この説明は、広告や画像には表示されません。 この要素の最大長は 100 文字です。 足す： 随意 更新： 随意。 この要素を null に設定すると、前の設定が削除されます。 |
string |
| DestinationUrl | ユーザーが画像をクリックしたときにアクセスする Web ページの URL。 URL には、{キーワード (keyword)} などの動的テキスト文字列を含めることができます。 詳細については、「 使用できる追跡パラメーターまたは URL パラメーター」を参照してください。 URL には、最大 1,024 文字を含めることができます。 URL でプロトコルが指定されていない場合、ユーザーが広告をクリックすると、システムは HTTP プロトコルを使用します。 広告を追加するときに URL で HTTP プロトコルが指定されている場合、サービスは http:// プロトコル文字列を削除します (HTTP プロトコル文字列は 1,024 文字の制限に対してカウントされません)。ただし、サービスは URL から HTTPS プロトコル文字列 (https://) を削除しません。 イメージ広告拡張機能に URL が指定されていない場合は、広告の URL が使用されます。 足す： 随意 更新： 随意。 この要素を null に設定すると、前の設定が削除されます。 |
string |
| DisplayText | 画像拡張機能の表示テキスト。 この要素の最大長は 35 文字です。 足す：レイアウトに SearchMultiple が含まれている場合は必須。それ以外の場合は省略可能です。 更新：レイアウトに SearchMultiple が含まれている場合は必須。それ以外の場合は省略可能です。 この要素を null に設定すると、前の設定が削除されます。 |
string |
| FinalAppUrls | 将来の使用のために。 | AppUrl 配列 |
| FinalMobileUrls | モバイル デバイスのランディング ページ URL。 次の検証規則は、最終 URL と最終モバイル URL に適用されます。 - URL の長さは 2,048 文字に制限されています。 HTTP または HTTPS プロトコル文字列は、2,048 文字の制限にカウントされます。 - FinalUrls と FinalMobileUrls の両方に最大 10 個のリスト 項目を指定できます。ただし、各一覧の最初の項目のみが配信に使用されます。 このサービスでは、前方互換性の可能性があるリスト アイテムを最大 10 個まで許可します。 - '{' と '}' の使用は、 {lpurl} などのタグのみを示すために許可されます。 - 最終的な URL はそれぞれ、http:// または https:// で始まる整形式の URL である必要があります。 - FinalMobileUrls を指定する場合は、 FinalUrls も指定する必要があります。 - DevicePreference が 30001 (モバイル) に設定されている場合、FinalMobileUrls を指定することはできません。 足す： 随意 更新： 随意。 更新プログラムに値が設定されていない場合、以前の設定は削除されます。 |
string 配列 |
| FinalUrls | ランディング ページの URL。 次の検証規則は、最終 URL と最終モバイル URL に適用されます。 - URL の長さは 2,048 文字に制限されています。 HTTP または HTTPS プロトコル文字列は、2,048 文字の制限にカウントされます。 - FinalUrls と FinalMobileUrls の両方に最大 10 個のリスト 項目を指定できます。ただし、各一覧の最初の項目のみが配信に使用されます。 このサービスでは、前方互換性の可能性があるリスト アイテムを最大 10 個まで許可します。 - '{' と '}' の使用は、 {lpurl} などのタグのみを示すために許可されます。 - 最終的な URL はそれぞれ、http:// または https:// で始まる整形式の URL である必要があります。 - FinalMobileUrls を指定する場合は、 FinalUrls も指定する必要があります。 - DevicePreference が 30001 (モバイル) に設定されている場合、FinalMobileUrls を指定することはできません。 足す： 随意 更新： 随意。 更新プログラムに値が設定されていない場合、以前の設定は削除されます。 |
string 配列 |
| FinalUrlSuffix | 最後の URL サフィックスには、ランディング ページ URL の末尾に追加される追跡パラメーターを含めることができます。 顧客が常にランディング ページに送信されるように、ランディング ページで必要な追跡パラメーターを最終的な URL サフィックスに配置することをお勧めします。 詳細と検証規則については、テクニカル ガイドの 「最終 URL サフィックス」を 参照してください。 この機能は、最終 URL サフィックス フェーズ 3 パイロット (GetCustomerPilotFeatures が 636 を返す) のお客様にのみ使用できます。 パイロットにいない場合、このプロパティは無視され、エラーは返されません。 足す： 随意 更新： 随意。 更新プログラムに値が設定されていない場合、以前の設定は削除されます。 |
string |
| ImageMediaIds | 広告に含める画像の識別子。 同じ縦横比の複数の画像にメディア識別子を指定することはできません。 つまり、参照される各イメージの縦横比が異なる必要があります。 最大 4 つのイメージ メディア識別子を指定できます。 最低限必要なのは 1 つのイメージ メディア ID ですが、すべての広告配置を対象にするには、4 つのイメージ メディア識別子を指定する必要があります。各 ID は、サポートされている 4 種類のメディアの種類 (縦横比) のうちの 1 つの画像に対応します。 対象ユーザー広告でサポートされている縦横比は、16:9、1.5:1、4:3、1.2:1 です。 詳細については、 Image データ オブジェクトのリファレンス ドキュメントを参照してください。 各 Image の識別子は、 AddMedia 操作を呼び出してイメージ ライブラリに追加するときに取得できます。 それ以外の場合は、メディアがイメージ ライブラリに追加された後、 GetMediaMetaDataByAccountId 操作を使用してメディア識別子を取得できます。 足す： 必須 更新： 必須 |
long 配列 |
| Images | さまざまなサイズと縦横比を持つ画像アセットを使用して、さまざまな発行元や配置に対して柔軟に表示できるようにします。 それぞれ SubType とトリミング設定を持つ ImageAsset を含む 1 つ以上の AssetLink オブジェクトを含め、目的の縦横比に一致します。 足す： 必須 更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 更新中にイメージを含める場合、以前に設定したイメージはすべて置き換えられます。 |
AssetLink 配列 |
| レイアウト | 対象となるイメージ レイアウトの一覧。 サポートされる値は SearchSingle と SearchMultiple です。 今後、新しいレイアウトが追加される可能性があるため、固定の値セットに依存しないようにしてください。 足す： 必須 更新： 随意。 更新プログラムに値が設定されていない場合、この設定は変更されません。 更新中にレイアウトを含める場合、以前に設定したレイアウトはすべて置き換えられます。 |
string 配列 |
| SourceType | ソースの種類を指定します。 | string |
| TrackingUrlTemplate | すべての FinalUrls と FinalMobileUrls の既定値として使用する追跡テンプレート。 追跡テンプレートには、次の検証規則が適用されます。 サポートされているテンプレートとパラメーターの詳細については、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 は同じになります。足す： 随意 更新： 随意。 更新プログラムに値が設定されていない場合、以前の設定は削除されます。 |
string |
| UrlCustomParameters | URL 追跡用のキーパラメーターと値パラメーターのカスタム コレクション。 Microsoft Advertising では、 CustomParameters オブジェクトに含める最初の 3 つの CustomParameter オブジェクトが受け入れられ、追加のカスタム パラメーターはすべて無視されます。 各 CustomParameter には、Key 要素と Value 要素が含まれています。 カスタム パラメーターの制限の引き上げフェーズ 3 パイロット (GetCustomerPilotFeatures は 635 を返します) のお客様の場合、Microsoft Advertising は、含める最初の 8 つのカスタム パラメーター キーと値のペアを受け入れ、8 つ以上のカスタム パラメーターを含む場合はエラーが返されます。 足す： 随意 更新： 随意。 更新プログラムに値が設定されていない場合、以前の設定は削除されます。 |
CustomParameters |
ImageAdExtension オブジェクトには継承された要素があります。
継承された要素
AdExtension から継承された要素
ImageAdExtension オブジェクトは AdExtension オブジェクトから派生し、DevicePreference、ForwardCompatibilityMap、Id、Scheduling、Status、Type、Version の各要素を継承します。 以下の説明は ImageAdExtension に固有であり、 AdExtension オブジェクトから同じ要素を継承する他のオブジェクトには適用されない場合があります。
| 要素 | 説明 | データ型 |
|---|---|---|
| DevicePreference | この広告拡張機能の種類ではサポートされていません。 | long |
| ForwardCompatibilityMap | 現在の API バージョンで新しい要素が追加されたときに変更が中断されないように、前方互換性のためのキー文字列と値文字列の一覧。 現在、 AdExtension オブジェクトの前方互換性の変更はありません。 足す： 読み取り専用 更新： 読み取り専用 |
KeyValuePairOfstring 配列 |
| 身分証明書 | 広告拡張機能の一意の Microsoft Advertising 識別子。 足す： 読み取り専用 更新： 読み取り専用と必須 |
long |
| スケジュール設定 | 広告表示オプションが広告に表示される資格があるカレンダーの曜日と時刻の範囲を決定します。 足す： 随意 更新： 随意。 この要素を null に設定した場合、広告拡張機能の既存のスケジュール 設定は変更されません。 これを null 以外の Schedule オブジェクトに設定すると、広告拡張機能の既存のスケジュール設定を実質的に置き換えます。 すべてのスケジュールを削除するには、この要素を空の Schedule オブジェクトに設定します。 |
Schedule |
| Status | 広告拡張機能の状態。 キャンペーン管理サービスでは削除された広告表示オプションが返されないため、値は常に アクティブ になります。 足す： 読み取り専用 更新： 読み取り専用 |
AdExtensionStatus |
| 種類 | 広告拡張機能の種類。 この値は、イメージ広告拡張機能を取得するときの ImageAdExtension です。 足す： 読み取り専用 更新： 読み取り専用 広告拡張機能の種類の詳細については、「 広告拡張機能データ オブジェクトの備考」を参照してください。 |
string |
| バージョン | 広告拡張機能が更新された回数を追跡します。 バージョンは、広告拡張機能の作成時に 1 に設定され、更新のたびに 1 ずつインクリメントされます。 足す： 禁じられた 更新： 禁じられた |
int |
要件
サービス: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13