BillingSetup

帳單設定,用於將付款帳戶和廣告客戶建立關聯。帳單設定僅供單一廣告客戶使用。

JSON 表示法
{
  "resourceName": string,
  "status": enum (BillingSetupStatus),
  "paymentsAccountInfo": {
    object (PaymentsAccountInfo)
  },
  "id": string,
  "paymentsAccount": string,

  // Union field start_time can be only one of the following:
  "startDateTime": string,
  "startTimeType": enum (TimeType)
  // End of list of possible types for union field start_time.

  // Union field end_time can be only one of the following:
  "endDateTime": string,
  "endTimeType": enum (TimeType)
  // End of list of possible types for union field end_time.
}
欄位
resourceName

string

不可變動。帳單設定的資源名稱。帳單設定資源名稱的格式如下:

customers/{customerId}/billingSetups/{billing_setup_id}

status

enum (BillingSetupStatus)

僅供輸出。帳單設定狀態。

paymentsAccountInfo

object (PaymentsAccountInfo)

不可變動。與此帳單設定相關聯的付款帳戶資訊。設定帳單時,這項資訊會用於註冊新的付款帳戶 (此時不應設定 paymentsAccount)。取得帳單設定時,系統會填入這個值和 paymentsAccount。

id

string (int64 format)

僅供輸出。帳單設定的 ID。

paymentsAccount

string

不可變動。與此帳單設定相關聯的付款帳戶資源名稱。付款資源名稱的格式如下:

customers/{customerId}/paymentsAccounts/{paymentsAccountId} 設定帳單時,這個值會用於使用現有付款帳戶註冊 (此時不應設定 paymentsAccountInfo)。取得帳單設定時,系統會填入這項資訊和 paymentsAccountInfo。

聯集欄位 start_time。建立新的帳單設定時,這就是設定生效的時間點。如果客戶沒有任何已核准的設定,則「現在」是唯一可接受的開始時間。

擷取現有帳單設定時,這是要求的開始時間。不過,如果設定在要求的開始時間後才獲得核准 (請查看狀態),則核准時間即為此時。start_time 只能是下列其中一項:

startDateTime

string

不可變動。開始日期時間,格式為 yyyy-MM-dd 或 yyyy-MM-dd HH:mm:ss。只能設定日後的時間。

startTimeType

enum (TimeType)

不可變動。開始時間的類型。僅允許「NOW」。

聯集欄位 end_time。帳單設定結束時 / 結束。這個值可以是「永久」或下一個排定帳單設定的開始時間。end_time 只能是下列其中一項:
endDateTime

string

僅供輸出。結束日期時間,格式為 yyyy-MM-dd 或 yyyy-MM-dd HH:mm:ss。

endTimeType

enum (TimeType)

僅供輸出。結束時間的類型。唯一可用的值為 FOREVER。

BillingSetupStatus

BillingSetup 的可能狀態。

列舉
UNSPECIFIED 不指定。
UNKNOWN 僅用於傳回值。代表這個版本中的不明值。
PENDING 帳單設定處於待核准狀態。
APPROVED_HELD 帳單設定已通過核准,但對應的第一筆預算尚未核准。這項設定只適用於月結付款的帳單。
APPROVED 帳單設定已通過核准。
CANCELLED 使用者在帳單設定獲得核准前取消了設定。

PaymentsAccountInfo

這個帳單的付款帳戶資訊容器。

JSON 表示法
{
  "paymentsAccountId": string,
  "paymentsAccountName": string,
  "paymentsProfileId": string,
  "paymentsProfileName": string,
  "secondaryPaymentsProfileId": string
}
欄位
paymentsAccountId

string

僅供輸出。16 位數 ID,用於識別與帳單設定相關聯的付款帳戶。

這個值必須以連字號分隔的字串形式傳遞,例如「1234-5678-9012-3456」。

paymentsAccountName

string

不可變動。與帳單設定相關聯的付款帳戶名稱。

這樣一來,使用者就能為付款帳戶指定有意義的名稱,方便對帳月結單。

這個名稱會列在每月月結單中。

paymentsProfileId

string

不可變動。12 位數 ID,用來識別與帳單設定相關聯的付款資料。

這個值必須以連字號分隔的字串形式傳入,例如「1234-5678-9012」。

paymentsProfileName

string

僅供輸出。與帳單設定相關聯的付款資料名稱。

secondaryPaymentsProfileId

string

僅供輸出。不常見的情況 (例如已擬定連帶責任協議) 時的次要付款資料 ID。