次の方法で共有

InsertionOrder データ オブジェクト - 顧客の請求

  • [アーティクル]

広告掲載オーダーは、指定された期間にアカウントに費やす最大金額を確立する契約です。 アカウントに月単位の請求書の請求が設定されている場合は、広告が配信の対象となるためにアクティブな挿入注文が必要です。 引き続きキャンペーン予算を使用して支出を管理し、発生した分にのみ課金されます。 たとえば、5,000 ドルの 1 か月間の挿入注文があり、請求期間中に 4,500 ドルの請求のみが発生した場合、挿入注文予算から 4,500 ドルのみが差し引かれます。

警告

挿入注文の予算は広告費用にのみ適用されます。これは、ビジネスがオンライン サービスが課税される国/地域にある場合に重要な違いです。 予算の制限が厳しい場合は、挿入注文予算の税金を考慮する必要がある場合があります。 ビジネス拠点の税要件の詳細については、 税金または VAT の情報 に関するヘルプ記事を参照してください。

このオブジェクトのほとんどの要素は、挿入順序が承認される前にのみ設定できます。 つまり、Status が PendingUserReview に設定されている場合です。 その場合、このオブジェクトの要素を使用して、新しい変更を加えたり、挿入順序を承認または拒否したりできます。 挿入順序 の状態 が [アクティブ]、[枯渇]、[期限切れ]、または [未開始] になったら、 PendingChanges 要素を使用して、新しい変更を行うか、現在保留中の変更を承認または拒否できます。 挿入注文の 状態 が [キャンセル] または [拒否] の場合、挿入順序を更新することはできません。

注:

SearchInsertionOrders 操作は、定期的な系列ごとに最大 24 個の挿入順序を返します。

取得できますが、例外がほとんどない場合は、Bing Ads 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 挿入順序が適用されるアカウントの識別子。

挿入順序を作成した後、アカウント識別子を更新することはできません。

追加： 必須
更新： 読み 取り 専用		 long
AccountNumber Microsoft Advertising Web アプリケーションのアカウントを識別するために使用されるシステム生成のアカウント番号。 アカウント番号は xxxxxxxx という形式で、 xxxxxxxx は 8 文字の英数字の系列です。

追加： 読み 取り 専用
更新： 読み 取り 専用		 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
Id 挿入順序を識別するシステム生成識別子。

追加： 読み 取り 専用
更新： 読み取り専用と必須		 long
IsEndless 挿入順序に終了日がないかどうかを判断します。

値が True の場合、挿入順序には終了日がなく、この挿入順序の EndDate は無視されます。

追加： オプション
更新： オプション		 boolean
IsInSeries 挿入順序が定期的な系列内にあるかどうかを判断します。

値が True の場合、挿入順序は定期的な系列の一部です。 定期的な系列の一部である挿入順序の StartDate または EndDate を更新しようとすると、API からエラーが返されます。 定期的な系列の一部である挿入注文の 状態 を更新すると、その系列のすべての挿入注文に状態更新が適用されます。

追加： 読み 取り 専用
更新： 読み 取り 専用		 boolean
IsUnlimited 挿入順序に無制限の予算があるかどうかを判断します。

値が True の場合、挿入順序には無制限の予算があり、この挿入順序の SpendCapAmount は無視されます。

追加： オプション
更新： オプション		 boolean
LastModifiedByUserId 挿入順序を更新する最後のユーザーの識別子。

追加： 読み 取り 専用
更新： 読み 取り 専用		 long
LastModifiedTime 挿入順序が最後に更新された日付と時刻。

日付は協定世界時 (UTC) に格納されます。

日付と時刻の形式については、「プリミティブ XML データ型」の dateTime エントリを参照してください。

追加： 読み 取り 専用
更新： 読み 取り 専用		 dateTime
名前 この挿入順序を参照するために使用できるフレンドリ名。

名前には、最大 100 文字を含めることができます。

名前は、顧客の他の挿入注文と比較して一意である必要はありません。

追加： オプション
更新： オプション		 string
NotificationThreshold 費やされた予算の割合。 パーセンテージを 0 から 100 の値として指定します。 しきい値に達すると通知が送信されます。 たとえば、しきい値を 70 に設定した場合、課金サービスは予算の 70% を費やしたときに通知を送信します。

通知を受信しない場合は、NULL に設定します。

内部使用のため予約済みです。

追加： オプション
更新： オプション		 ダブル
PendingChanges 状態が [アクティブ]、[期限切れ]、[期限切れ]、または [NotStarted] のいずれかに設定されている承認済みの挿入順序の変更を管理するために使用できます。

追加： 読み 取り 専用
更新： オプション		 InsertionOrderPendingChanges
PurchaseOrder この挿入注文を月次請求書で参照するために使用できる発注書の値。 この値は、毎月の請求書に発注書として出力されます。

購買発注には、最大 50 文字を含めることができます。

追加： オプション
更新： オプション		 string
ReferenceId 内部使用専用に予約済みです。

追加： オプション
更新： オプション		 long
SeriesFrequencyType 系列内で注文がどのように繰り返されるかを決定します。

使用できる値は、Monthly、BiMonthly、Quarterly、Yearly です。

追加： 読み 取り 専用
更新： 読み 取り 専用		 string
SeriesName 定期的な挿入順序の系列の名前。

名前には、最大 100 文字を含めることができます。

挿入順序が後で定期的な系列から削除された場合でも、この要素は作成された系列の名前を反映し続けます。

追加： 読み 取り 専用
更新： 読み 取り 専用		 string
SpendCapAmount この挿入順序の予算。 予算はハード制限です。 アカウントがこの制限に達し、別の挿入順序が使用できない場合、アカウントのライフサイクル状態の値は [一時停止] に設定されます。

挿入順序に無制限の予算がある場合、この要素は空です。 予算は、挿入注文に費やす最大金額です。 予算が無制限の挿入注文の場合、予算は与信限度額によって制限されます。 その場合、各キャンペーンの 1 日の予算によって最大支出が決まります。

注: 無制限の挿入注文の追加または更新はサポートされていません。 SpendCapAmount は読み取り専用モードで動作します。

追加： 必須
更新： オプション		 ダブル
StartDate 挿入注文が請求を開始できる日付。 開始日は、現在の日付より後にする必要があります。

日付は協定世界時 (UTC) に格納されます。 指定した文字列の月、日、年のみが使用されます。 日付の時間、分、秒を指定した場合、それらは無視されます。

日付と時刻の形式については、「プリミティブ XML データ型」の dateTime エントリを参照してください。

追加： 必須
更新： オプション。 [状態] が [PendingUserReview] の場合にのみ、この要素を使用して開始日を更新できます。 開始日が既に経過している場合は、変更できません。

定期的な系列の一部である挿入順序の StartDate または EndDate を更新しようとすると、API からエラーが返されます。		 dateTime
Status 挿入順序の状態。

追加： 読み 取り 専用。 作成した挿入注文は、すぐに [アクティブ]、[未開始]、[拒否] に設定されます。
更新： まだ承認されていない挿入注文を承認または拒否したり、既に承認されている挿入注文を取り消したりするために必要です。 現在の状態が PendingUserReview に設定されている場合にのみ、この要素を使用して承認または拒否できます。 現在の状態が Active、Exhausted、または NotStarted に設定されている場合にのみ、この要素を使用して取り消すことができます。 挿入注文の状態が [アクティブ]、[枯渇]、[期限切れ]、または [未開始] になったら、 PendingChanges 要素を使用して、新しい変更を行うか、現在保留中の変更を承認または拒否できます。

UpdateInsertionOrder を呼び出すときは、この Status 要素を設定するか、このオブジェクトの他の要素を変更できますが、他のプロパティ更新プログラムと並行して状態を変更することはできません。

定期的な系列の一部である挿入注文の状態を更新すると、その系列のすべての挿入注文に状態更新が適用されます。		 InsertionOrderStatus

要件

サービス: CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13/Entities

使用ページ

AddInsertionOrder
SearchInsertionOrders
UpdateInsertionOrder