GetBillingDocumentsInfo 服務作業 - 客戶計費

取得包含帳單文件識別信息的物件清單，例如計費文件標識碼、金額和帳戶標識碼。

要求專案

GetBillingDocumentsInfoRequest 物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	描述	資料類型
AccountIds	您想要取得其帳單檔資訊之帳戶的識別碼清單。	long 陣列
EndDate	用於指定要取得之計費文件的結束日期。 若要將今天的日期指定為結束日期，請將 EndDate 設定為 NULL。 結束日期不能早於開始日期。 您必須在國際標準時間 (UTC) 中指定日期。	dateTime
ReturnInvoiceNumber	在要求中包含發票號碼。	布爾
StartDate	用於指定要取得之計費檔的開始日期。 開始日期不能晚於結束日期。 您必須在國際標準時間 (UTC) 中指定日期。	dateTime

要求標頭元素

元素	描述	資料類型
AuthenticationToken	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

GetBillingDocumentsInfoResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。

回應本文專案

元素	描述	資料類型
BillingDocumentsInfo	已擷取的計費檔信息物件清單。	BillingDocumentInfo 陣列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 API 呼叫詳細數據的記錄項目識別碼。	string

要求SOAP

此範本是由工具所產生，用來顯示SOAP要求的主體和標頭元素順序。 如需可搭配此服務作業使用的支援類型，請參閱上述 的要求本文項目 參考。

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Billing/v13">
    <Action mustUnderstand="1">GetBillingDocumentsInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetBillingDocumentsInfoRequest xmlns="https://bingads.microsoft.com/Billing/v13">
      <AccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </AccountIds>
      <StartDate>ValueHere</StartDate>
      <EndDate i:nil="false">ValueHere</EndDate>
      <ReturnInvoiceNumber i:nil="false">ValueHere</ReturnInvoiceNumber>
    </GetBillingDocumentsInfoRequest>
  </s:Body>
</s:Envelope>

回應 SOAP

此範本是由工具所產生，用來顯示SOAP回應的 主體 和 標頭 元素順序。

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Billing/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetBillingDocumentsInfoResponse xmlns="https://bingads.microsoft.com/Billing/v13">
      <BillingDocumentsInfo xmlns:e163="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e163:BillingDocumentInfo>
          <e163:AccountId>ValueHere</e163:AccountId>
          <e163:AccountName d4p1:nil="false">ValueHere</e163:AccountName>
          <e163:AccountNumber d4p1:nil="false">ValueHere</e163:AccountNumber>
          <e163:Amount>ValueHere</e163:Amount>
          <e163:CurrencyCode d4p1:nil="false">ValueHere</e163:CurrencyCode>
          <e163:DocumentDate d4p1:nil="false">ValueHere</e163:DocumentDate>
          <e163:DocumentId d4p1:nil="false">ValueHere</e163:DocumentId>
          <e163:CustomerId d4p1:nil="false">ValueHere</e163:CustomerId>
          <e163:CampaignId d4p1:nil="false">ValueHere</e163:CampaignId>
          <e163:DocumentNumber d4p1:nil="false">ValueHere</e163:DocumentNumber>
        </e163:BillingDocumentInfo>
      </BillingDocumentsInfo>
    </GetBillingDocumentsInfoResponse>
  </s:Body>
</s:Envelope>

程序代碼語法

範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

public async Task<GetBillingDocumentsInfoResponse> GetBillingDocumentsInfoAsync(
	IList<long> accountIds,
	DateTime startDate,
	DateTime? endDate,
	bool? returnInvoiceNumber)
{
	var request = new GetBillingDocumentsInfoRequest
	{
		AccountIds = accountIds,
		StartDate = startDate,
		EndDate = endDate,
		ReturnInvoiceNumber = returnInvoiceNumber
	};

	return (await CustomerBillingService.CallAsync((s, r) => s.GetBillingDocumentsInfoAsync(r), request));
}

static GetBillingDocumentsInfoResponse getBillingDocumentsInfo(
	ArrayOflong accountIds,
	Calendar startDate,
	Calendar endDate,
	boolean returnInvoiceNumber) throws RemoteException, Exception
{
	GetBillingDocumentsInfoRequest request = new GetBillingDocumentsInfoRequest();

	request.setAccountIds(accountIds);
	request.setStartDate(startDate);
	request.setEndDate(endDate);
	request.setReturnInvoiceNumber(returnInvoiceNumber);

	return CustomerBillingService.getService().getBillingDocumentsInfo(request);
}

static function GetBillingDocumentsInfo(
	$accountIds,
	$startDate,
	$endDate,
	$returnInvoiceNumber)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];

	$request = new GetBillingDocumentsInfoRequest();

	$request->AccountIds = $accountIds;
	$request->StartDate = $startDate;
	$request->EndDate = $endDate;
	$request->ReturnInvoiceNumber = $returnInvoiceNumber;

	return $GLOBALS['CustomerBillingProxy']->GetService()->GetBillingDocumentsInfo($request);
}

response=customerbilling_service.GetBillingDocumentsInfo(
	AccountIds=AccountIds,
	StartDate=StartDate,
	EndDate=EndDate,
	ReturnInvoiceNumber=ReturnInvoiceNumber)

需求

服務： CustomerBillingService.svc v13
命名空間： https://bingads.microsoft.com/Billing/v13

要求 URL

生產URL

https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/BillingDocumentsInfo/Query

沙箱 URL

https://clientcenter.api.sandbox.bingads.microsoft.com/CustomerBilling/v13/BillingDocumentsInfo/Query

要求專案

GetBillingDocumentsInfoRequest 物件會定義服務作業要求的主體和標頭元素。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	描述	資料類型
AccountIds	您想要取得其帳單檔資訊之帳戶的識別碼清單。	long 陣列
EndDate	用於指定要取得之計費文件的結束日期。 若要將今天的日期指定為結束日期，請將 EndDate 設定為 NULL。 結束日期不能早於開始日期。 您必須在國際標準時間 (UTC) 中指定日期。	dateTime
ReturnInvoiceNumber	在要求中包含發票號碼。	布爾
StartDate	用於指定要取得之計費檔的開始日期。 開始日期不能晚於結束日期。 您必須在國際標準時間 (UTC) 中指定日期。	dateTime

要求標頭元素

元素	描述	資料類型
授權	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ，這是正確驗證的必要專案。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

GetBillingDocumentsInfoResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。

回應本文專案

元素	描述	資料類型
BillingDocumentsInfo	已擷取的計費檔信息物件清單。	BillingDocumentInfo 陣列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 API 呼叫詳細數據的記錄項目識別碼。	string

要求 JSON

此範本是由工具所產生，用來顯示 JSON 要求的 主體 和 標頭 元素。 如需可搭配此服務作業使用的支援類型，請參閱上述 的要求本文項目 參考。

{
  "AccountIds": [
    "LongValueHere"
  ],
  "StartDate": "ValueHere",
  "EndDate": "ValueHere",
  "ReturnInvoiceNumber": "ValueHere"
}

回應 JSON

此範本是由工具所產生，用來顯示 JSON 回應的 主體 和 標頭 元素。

{
  "BillingDocumentsInfo": [
    {
      "AccountId": "LongValueHere",
      "AccountName": "ValueHere",
      "AccountNumber": "ValueHere",
      "Amount": DoubleValueHere,
      "CampaignId": "LongValueHere",
      "CurrencyCode": "ValueHere",
      "CustomerId": IntValueHere,
      "DocumentDate": "ValueHere",
      "DocumentId": "LongValueHere",
      "DocumentNumber": "ValueHere"
    }
  ]
}

程序代碼語法

若要透過 SDK 呼叫 REST API，您必須將 SDK 升級至特定版本並設定系統參數。範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

public async Task<GetBillingDocumentsInfoResponse> GetBillingDocumentsInfoAsync(
	IList<long> accountIds,
	DateTime startDate,
	DateTime? endDate,
	bool? returnInvoiceNumber)
{
	var request = new GetBillingDocumentsInfoRequest
	{
		AccountIds = accountIds,
		StartDate = startDate,
		EndDate = endDate,
		ReturnInvoiceNumber = returnInvoiceNumber
	};

	return (await CustomerBillingService.CallAsync((s, r) => s.GetBillingDocumentsInfoAsync(r), request));
}

static GetBillingDocumentsInfoResponse getBillingDocumentsInfo(
	ArrayOflong accountIds,
	Calendar startDate,
	Calendar endDate,
	boolean returnInvoiceNumber) throws RemoteException, Exception
{
	GetBillingDocumentsInfoRequest request = new GetBillingDocumentsInfoRequest();

	request.setAccountIds(accountIds);
	request.setStartDate(startDate);
	request.setEndDate(endDate);
	request.setReturnInvoiceNumber(returnInvoiceNumber);

	return CustomerBillingService.getService().getBillingDocumentsInfo(request);
}

static function GetBillingDocumentsInfo(
	$accountIds,
	$startDate,
	$endDate,
	$returnInvoiceNumber)
{

	$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];

	$request = new GetBillingDocumentsInfoRequest();

	$request->AccountIds = $accountIds;
	$request->StartDate = $startDate;
	$request->EndDate = $endDate;
	$request->ReturnInvoiceNumber = $returnInvoiceNumber;

	return $GLOBALS['CustomerBillingProxy']->GetService()->GetBillingDocumentsInfo($request);
}

response=customerbilling_service.GetBillingDocumentsInfo(
	AccountIds=AccountIds,
	StartDate=StartDate,
	EndDate=EndDate,
	ReturnInvoiceNumber=ReturnInvoiceNumber)