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:q43="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalMobileUrls" nillable="true" type="q43:ArrayOfstring" />
<xs:element minOccurs="0" name="FinalUrlSuffix" nillable="true" type="xs:string" />
<xs:element xmlns:q44="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="FinalUrls" nillable="true" type="q44:ArrayOfstring" />
<xs:element xmlns:q45="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="ImageMediaIds" nillable="true" type="q45: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:q46="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="Layouts" nillable="true" type="q46: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、FinalUrlSuffix、ImageMediaIds、Images、Layouts、SourceType、TrackingUrlTemplate、UrlCustomParameters。
元素 | 描述 | 資料類型 |
---|---|---|
AlternativeText | 影像媒體可用性的替代描述。 如果無法顯示影像,則會改用替代文字。 這個專案的最大長度為 35 個字元。 加: 必填 更新: 必填 |
string |
描述 | 廣告商、機構或帳戶管理員可用來追蹤、標記或管理影像媒體的描述。 此描述不會與廣告或影像一起顯示。 這個專案的最大長度是 100 個字元。 加: 自選 更新: 自選。 如果您將此元素設定為 null,則會刪除先前的設定。 |
string |
DestinationUrl | 當使用者按兩下影像時,要帶使用者前往的網頁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。 加: 自選 更新: 自選。 如果未設定更新的值,則會移除先前的設定。 |
字串陣列 |
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。 加: 自選 更新: 自選。 如果未設定更新的值,則會移除先前的設定。 |
字串陣列 |
FinalUrlSuffix | 最終的 URL 後綴可以包含將附加至登陸頁面 URL 結尾的追蹤參數。 建議您在最後的 URL 後綴中放置登陸頁面所需的追蹤參數,讓您的客戶一律傳送至您的登陸頁面。 如需詳細資訊和驗證規則,請參閱技術指南中的 最終 URL 後綴 。 這項功能僅適用於最終 URL 後綴階段 3 試驗中的客戶 (GetCustomerPilotFeatures 會傳回 636) 。 如果您不在試驗中,則會忽略此屬性,而且不會傳回任何錯誤。 加: 自選 更新: 自選。 如果未設定更新的值,則會移除先前的設定。 |
string |
ImageMediaIds | 要包含在廣告中的影像標識碼。 您不能指定相同外觀比例之多個影像的媒體識別碼。 換句話說,每個參考的影像都必須有不同的外觀比例。 您最多可以指定四 (4) 影像媒體識別碼。 雖然最小需求是一個影像媒體標識碼,但若要符合所有廣告位置的資格,您必須提供 四個影 像媒體標識符,其中每個標識符對應至四種支援的 媒體 類型之一的影像, (外觀比例) 。 對象廣告的支持外觀比例為 16:9、1.5:1、4:3 和 1.2:1。 如需詳細資訊,請參閱 影像 數據對象參考檔。 您可以藉由呼叫 AddMedia 作業,在將每個映像新增至映像庫時取得每個映像的標識碼。 否則,將媒體新增至您的映像庫之後,您可以使用 GetMediaMetaDataByAccountId 作業來取得媒體識別碼。 加: 必填 更新: 必填 |
long 陣列 |
影像 | 具有不同大小和外觀比例的影像資產,以便在各種發行者和位置之間靈活顯示。 包含一或多個 AssetLink 物件,其中每個物件都包含具有 SubType 的 ImageAsset,以及符合所需外觀比例的裁剪設定。 加: 必填 更新: 自選。 如果未設定更新的值,則此設定不會變更。 如果您在更新期間包含映像,將會取代任何先前設定的映像。 |
AssetLink 陣 列 |
版面配置 | 合格影像版面配置的清單。 支援的值為 SearchSingle 和 SearchMultiple。 未來可能會新增版面配置,因此您不應該對一組固定的值採取任何相依性。 加: 必填 更新: 自選。 如果未設定更新的值,則此設定不會變更。 如果您在更新期間包含版面配置,將會取代任何先前設定的版面配置。 |
字串陣列 |
SourceType | 來源類型。 | string |
TrackingUrlTemplate | 要作為所有 FinalUrls 和FinalMobileUrls 預設值的追蹤範本。 下列驗證規則適用於追蹤範本。 如需支援的範本和參數的詳細資訊,請參閱 Microsoft Advertising 說明文章 我可以使用哪些追蹤或 URL 參數? - 針對較低層級實體定義的追蹤範本,例如廣告會覆寫針對較高層級實體設定的範本,例如營銷活動。 如需詳細資訊,請參閱 實體限制。 - 追蹤範本的長度限製為 2,048 個字元。 HTTP 或 HTTPS 通訊協定字串確實會計入 2,048 個字元的限制。 - 追蹤範本必須是格式正確的 URL,開頭為下列其中一項: http://、 https://、 {lpurl} 或 {unescapedlpurl}。 - Microsoft Advertising 不會驗證自定義參數是否存在。 如果您在追蹤範本中使用自定義參數,但它們不存在,則登陸頁面 URL 會包含自定義參數的索引鍵和值佔位元,而不需替代。 例如,如果您的追蹤範本是 https://tracker.example.com/?season={_season}&promocode={_promocode}&u={lpurl} ,且 { _season} 或 {_promocode} 都未定義於行銷活動、廣告群組、準則、關鍵詞或廣告層級,則登陸頁面 URL 會相同。加: 自選 更新: 自選。 如果未設定更新的值,則會移除先前的設定。 |
string |
UrlCustomParameters | 用於 URL 追蹤的自訂索引鍵和值參數集合。 Microsoft Advertising 會接受您包含在 CustomParameters 物件內的前 3 個 CustomParameter 物件,並忽略任何其他自定義參數。 每個 CustomParameter 都包含 Key 和 Value 元素。 針對自定義參數限制增加階段 3 試驗的客戶 (GetCustomerPilotFeatures 會傳回 635) ,Microsoft Advertising 會接受您包含的前 8 個自定義參數索引鍵和值組,如果您包含超過 8 個自定義參數,則會傳回錯誤。 加: 自選 更新: 自選。 如果未設定更新的值,則會移除先前的設定。 |
CustomParameters |
ImageAdExtension 物件具有 Inherited Elements。
繼承的專案
從 AdExtension 繼承的專案
ImageAdExtension 物件衍生自 AdExtension 物件,並繼承下列元素:DevicePreference、ForwardCompatibilityMap、Id、Scheduling、Status、Type、Version。 下列描述專屬於 ImageAdExtension,而且可能不適用於從 AdExtension 物件繼承相同元素的其他物件。
元素 | 描述 | 資料類型 |
---|---|---|
DevicePreference | 不支援此廣告延伸模組類型。 | 長 |
ForwardCompatibilityMap | 用於向前相容性的索引鍵和值字串清單,以避免在目前 API 版本中新增新元素時中斷變更。 AdExtension 物件目前沒有向前相容性變更。 加: 唯讀 更新: 唯讀 |
KeyValuePairOfstringstring 陣 列 |
標識碼 | 廣告擴充功能的唯Microsoft廣告標識碼。 加: 唯讀 更新: 唯讀和必要 |
長 |
排程 | 決定廣告延伸模組符合廣告顯示資格的行事曆日期和時間範圍。 加: 自選 更新: 自選。 如果您將此元素設定為 null,廣告延伸模組的任何現有排程集將保持不變。 如果您將此設定為任何非 Null Schedule 物件,則實際上是取代廣告延伸模組的現有排程設定。 若要移除所有排程,請將此項目設定為空的 Schedule 物件。 |
Schedule |
地位 | 廣告延伸模組的狀態。 此值一律為 [作用 中],因為營銷活動管理服務不會傳回已刪除的廣告延伸模組。 加: 唯讀 更新: 唯讀 |
AdExtensionStatus |
類型 | 廣告延伸模組的類型。 當您擷取影像廣告延伸模組時,此值為 ImageAdExtension 。 加: 唯讀 更新: 唯讀 如需廣告延伸模組類型的詳細資訊,請參閱 廣告延伸模組數據物件備註。 |
string |
版本 | 追蹤廣告延伸模組更新的次數。 建立廣告延伸模組時,版本會設定為 1 ,並在每次更新之後遞增一。 加: 不允許 更新: 不允許 |
int |
需求
服務: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13