InsertionOrder 資料物件 - 客戶計費
插入順序是合約,可建立您在指定期間內將花在帳戶上的最大金額。 如果您的帳戶已設定每月發票計費,則必須有作用中的插入順序,廣告才符合傳遞資格。 您仍可使用營銷活動預算來控制支出,而您只需支付所累算的費用。 例如,如果您有一個月 5,000 元的插入訂單,而且在計費期間只累積 $4,500 美元的費用,則我們只會從您的插入訂單預算中扣除 $4,500 美元。
警告
插入訂單預算僅適用於廣告支出,如果您的企業位於 線上服務 稅的國家/地區,這是一個重要的區別。 如果您有嚴格的預算限制,您可能需要在插入順序預算中考慮稅金。 若要深入瞭解您所在位置的稅務需求,請參閱 稅務或加值稅資訊 說明文章。
這個物件的大部分元素只能在插入順序獲得核准之前設定,也就是 Status 設定為 PendingUserReview 時。 在此情況下,您可以進行新的變更,或核准或拒絕透過這個 對象的元素插入順序。 一旦插入順序 Status 為 Active、Exhausted、Expired 或 NotStarted,您就可以透過 PendingChanges 元素進行新的變更,或核准或拒絕目前擱置中的變更。 如果插入順序 Status 為 Canceled 或 Declined,則您無法更新插入順序。
注意事項
SearchInsertionOrders 作業會針對每個週期性數列傳回最多 24 個插入訂單。
您可以擷取,但極少數例外狀況無法透過 Bing 廣告 API 新增或更新插入順序系列。 使用 IsInSeries 元素來判斷插入順序是否在週期性數列中。
- 如果您嘗試更新屬於週期性數列一部分之插入順序的 StartDate 或 EndDate,API 將會傳回錯誤。
- 如果您更新屬於週期性數列一部分之插入順序的 狀態 ,狀態更新將會套用至數列中的所有插入順序。
若要管理 Microsoft Advertising Web 應用程式中的週期性插入訂單,請參閱 如何? 建立和編輯插入順序?說明一文。
<xs:complexType name="InsertionOrder" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:sequence>
<xs:element minOccurs="0" name="AccountId" type="xs:long" />
<xs:element minOccurs="0" name="BookingCountryCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Comment" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="EndDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="LastModifiedByUserId" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="LastModifiedTime" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="NotificationThreshold" nillable="true" type="xs:double" />
<xs:element minOccurs="0" name="ReferenceId" nillable="true" type="xs:long" />
<xs:element minOccurs="0" name="SpendCapAmount" nillable="true" type="xs:double" />
<xs:element minOccurs="0" name="StartDate" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Status" nillable="true" type="tns:InsertionOrderStatus" />
<xs:element minOccurs="0" name="PurchaseOrder" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="PendingChanges" nillable="true" type="tns:InsertionOrderPendingChanges" />
<xs:element minOccurs="0" name="AccountNumber" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="BudgetRemaining" nillable="true" type="xs:double" />
<xs:element minOccurs="0" name="BudgetSpent" nillable="true" type="xs:double" />
<xs:element minOccurs="0" name="BudgetRemainingPercent" nillable="true" type="xs:double" />
<xs:element minOccurs="0" name="BudgetSpentPercent" nillable="true" type="xs:double" />
<xs:element minOccurs="0" name="SeriesName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="IsInSeries" nillable="true" type="xs:boolean" />
<xs:element minOccurs="0" name="SeriesFrequencyType" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="IsUnlimited" nillable="true" type="xs:boolean">
<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="IsEndless" nillable="true" type="xs:boolean">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
元素
InsertionOrder 物件具有下列元素:AccountId、AccountNumber、BookingCountryCode、BudgetRemaining、BudgetRemainingPercent、BudgetSpent、BudgetSpentPercent、Comment、EndDate、Id、IsEndless、IsInSeries、IsUnlimited、LastModifiedByUserId、LastModifiedTime、Name、NotificationThreshold、PendingChanges、PurchaseOrder、ReferenceId、SeriesFrequencyType、SeriesName、SpendCapAmount、StartDate、Status。
元素 | 描述 | 資料類型 |
---|---|---|
AccountId | 套用插入順序之帳戶的標識碼。 建立插入順序之後,您無法更新帳戶標識碼。 加: 必填 更新: 唯讀 |
長 |
AccountNumber | 系統產生的帳戶號碼,用來識別 Microsoft Advertising Web 應用程式中的帳戶。 帳戶編號的格式為 xxxxxxxxxx,其中 xxxxxxxxxx 是任何八個英數位元數的序列。 加: 唯讀 更新: 唯讀 |
string |
BookingCountryCode | 保留給內部使用。 加: 某些帳戶需要;某些帳戶的選擇性。 更新: 唯讀 |
string |
BudgetRemaining | 插入順序的執行平衡。 執行中的餘額值一開始與 SpendCapAmount 相同,然後在每次提供帳戶中的廣告時減少。 如果插入順序有無限制的預算,則此元素是空的。 加: 唯讀 更新: 唯讀 |
雙 |
BudgetRemainingPercent | 插入順序剩餘預算的百分比。 此值會計算為 BudgetRemaining / SpendCapAmount。 如果插入順序有無限制的預算,則此元素是空的。 加: 唯讀 更新: 唯讀 |
雙 |
BudgetSpent | 插入順序的剩餘餘額。 剩餘餘額一開始為 0 (零) ,然後在每次提供帳戶中的廣告時增加至 SpendCapAmount 。 如果插入順序有無限制的預算,則此元素是空的。 加: 唯讀 更新: 唯讀 |
雙 |
BudgetSpentPercent | 用於插入順序的預算百分比。 此值會計算為 BudgetSpent / SpendCapAmount。 如果插入順序有無限制的預算,則此元素是空的。 加: 唯讀 更新: 唯讀 |
雙 |
註解 | 插入順序的描述。 描述限制為100個字元。 加: 自選 更新: 自選 |
string |
EndDate | 插入順序到期的日期。 結束日期必須晚於開始日期。 日期會儲存在國際標準時間 (UTC) 。 只會使用指定字串的月份、日期和年份。 如果您指定日期的小時、分鐘和秒,則會忽略它們。 如需日期和時間格式的相關信息,請參閱基本 XML 數據類型中的 dateTime 專案。 注意:如果插入順序沒有結束日期, EndDate 就是空的。 不支援新增或更新無限制的插入訂單。 EndDate 會以唯讀模式運作。 加: 必填 更新: 自選。 如果您嘗試更新屬於週期性數列一部分之插入順序的 StartDate 或 EndDate,API 將會傳回錯誤。 |
dateTime |
標識碼 | 系統產生的標識碼,可識別插入順序。 加: 唯讀 更新: 唯讀和必要 |
長 |
IsEndless | 判斷插入順序是否沒有結束日期。 如果值為 True,插入順序就不會有結束日期,而且會忽略此插入順序的 EndDate 。 加: 自選 更新: 自選 |
布爾 |
IsInSeries | 判斷插入順序是否在週期性數列中。 如果值為 True,則插入順序是週期性數列的一部分。 如果您嘗試更新屬於週期性數列一部分之插入順序的 StartDate 或 EndDate,API 將會傳回錯誤。 如果您更新屬於週期性數列一部分之插入順序的 狀態 ,狀態更新將會套用至數列中的所有插入順序。 加: 唯讀 更新: 唯讀 |
布爾 |
IsUnlimited | 判斷插入順序是否有無限制的預算。 如果值為 True,則插入順序會有無限制的預算,而且會忽略此插入順序的 SpendCapAmount 。 加: 自選 更新: 自選 |
布爾 |
LastModifiedByUserId | 要更新插入順序之最後一個使用者的標識碼。 加: 唯讀 更新: 唯讀 |
長 |
LastModifiedTime | 上次更新插入順序的日期和時間。 日期會儲存在國際標準時間 (UTC) 。 如需日期和時間格式的相關信息,請參閱基本 XML 數據類型中的 dateTime 專案。 加: 唯讀 更新: 唯讀 |
dateTime |
名稱 | 可用來參考此插入順序的易記名稱。 名稱最多可以包含100個字元。 相較於客戶的其他插入訂單,此名稱不需要是唯一的。 加: 自選 更新: 自選 |
string |
NotificationThreshold | 已花費預算的百分比。 將百分比指定為從 0 到 100 的值。 達到臨界值時會傳送通知。 例如,如果您將閾值設定為 70,計費服務會在您花費預算的 70% 時傳送通知。 如果您不想要接收通知,請將 設定為 NULL。 保留給內部使用。 加: 自選 更新: 自選 |
雙 |
PendingChanges | 可用來管理已核准插入順序的變更,其狀態設定為 [作用中]、[已耗盡]、[已過期] 或 [NotStarted]。 加: 唯讀 更新: 自選 |
InsertionOrderPendingChanges |
PurchaseOrder | 採購單值,可用來在每月發票中參考此插入訂單。 此值會列印為每月發票中的採購單。 採購單最多可以包含 50 個字元。 加: 自選 更新: 自選 |
string |
ReferenceId | 僅保留供內部使用。 加: 自選 更新: 自選 |
長 |
SeriesFrequencyType | 決定順序在數列中的遞歸方式。 可能的值為 Monthly、BiMonthly、Quarterly 和 Yearly。 加: 唯讀 更新: 唯讀 |
string |
SeriesName | 週期性插入順序數列的名稱。 名稱最多可以包含100個字元。 即使稍後會從週期性數列中移除插入順序,此元素仍會繼續反映在其中建立的數列名稱。 加: 唯讀 更新: 唯讀 |
string |
SpendCapAmount | 此插入順序的預算。 預算是硬性限制。 當帳戶達到此限制且沒有其他插入順序可用時,帳戶的生命週期狀態值會設定為 [暫停]。 如果插入順序有無限制的預算,則此元素是空的。 預算是您想要用於插入順序的最大金額。 對於具有無限制預算的插入訂單,您的預算會受限於您的信用額度限制。 在此情況下,每個營銷活動的每日預算會決定支出上限。 注意:不支援新增或更新無限制的插入訂單。 SpendCapAmount 會以唯讀模式運作。 加: 必填 更新: 自選 |
雙 |
StartDate | 插入順序可以開始產生費用的日期。 開始日期必須晚於目前的日期。 日期會儲存在國際標準時間 (UTC) 。 只會使用指定字串的月份、日期和年份。 如果您指定日期的小時、分鐘和秒,則會忽略它們。 如需日期和時間格式的相關信息,請參閱基本 XML 數據類型中的 dateTime 專案。 加: 必填 更新: 自選。 如果 Status 為 PendingUserReview,您只能透過此元素更新開始日期。 如果開始日期已經過,您就無法加以變更。 如果您嘗試更新屬於週期性數列一部分之插入順序的 StartDate 或 EndDate,API 將會傳回錯誤。 |
dateTime |
地位 | 插入順序的狀態。 加: 唯讀。 您建立的插入訂單會立即設定為 [作用中]、[NotStarted] 或 [已拒絕]。 更新: 必須核准或拒絕尚未核准的插入順序,或取消已核准的插入順序。 如果目前的狀態設定為PendingUserReview,您只能透過此元素核准或拒絕。 如果目前的狀態設定為 [作用中]、[已耗盡] 或 [NotStarted],您只能透過此元素取消。 一旦插入順序狀態為 [作用中]、[已耗盡]、[已過期] 或 [NotStarted],您就可以透過 PendingChanges 元素進行新的變更,或核准或拒絕目前擱置中的變更。 當您呼叫 UpdateInsertionOrder 時,您可以設定此 Status 元素或修改這個物件的其他元素,但無法與其他屬性更新平行變更狀態。 如果您更新屬於週期性數列一部分之插入順序的狀態,狀態更新將會套用至數列中的所有插入順序。 |
InsertionOrderStatus |
需求
服務: CustomerBillingService.svc v13
命名空間: https://bingads.microsoft.com/Customer/v13/Entities
消費者
AddInsertionOrder
SearchInsertionOrders
UpdateInsertionOrder