GetBillingDocuments 服務作業 - 客戶計費
取得指定的計費檔。
要求專案
GetBillingDocumentsRequest 物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 描述 | 資料類型 |
---|---|---|
BillingDocumentsInfo | 識別您想要取得的計費檔案清單。 清單中的每個 BillingDocumentInfo 物件都必須包含 CustomerId 和 DocumentId。 其他屬性會被忽略。 您最多可以在清單中包含 25 個專案。 |
BillingDocumentInfo 陣列 |
類型 | 用來產生計費檔的格式。 例如,您可以使用 PDF 或 XML 格式產生計費檔。 | DataType |
要求標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
AuthenticationToken | OAuth 存取令牌,代表有權Microsoft Advertising 帳戶之用戶的認證。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ,請參閱取得開發人員令牌。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
Response 元素
GetBillingDocumentsResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。
回應本文專案
元素 | 描述 | 資料類型 |
---|---|---|
BillingDocuments | 已擷取的計費檔案清單。 | BillingDocument 陣 列 |
回應標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
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">GetBillingDocuments</Action>
<AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
<DeveloperToken i:nil="false">ValueHere</DeveloperToken>
</s:Header>
<s:Body>
<GetBillingDocumentsRequest xmlns="https://bingads.microsoft.com/Billing/v13">
<BillingDocumentsInfo xmlns:e13="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
<e13:BillingDocumentInfo>
<e13:AccountId>ValueHere</e13:AccountId>
<e13:AccountName i:nil="false">ValueHere</e13:AccountName>
<e13:AccountNumber i:nil="false">ValueHere</e13:AccountNumber>
<e13:Amount>ValueHere</e13:Amount>
<e13:CurrencyCode i:nil="false">ValueHere</e13:CurrencyCode>
<e13:DocumentDate i:nil="false">ValueHere</e13:DocumentDate>
<e13:DocumentId i:nil="false">ValueHere</e13:DocumentId>
<e13:CustomerId i:nil="false">ValueHere</e13:CustomerId>
<e13:CampaignId i:nil="false">ValueHere</e13:CampaignId>
<e13:DocumentNumber i:nil="false">ValueHere</e13:DocumentNumber>
</e13:BillingDocumentInfo>
</BillingDocumentsInfo>
<Type>ValueHere</Type>
</GetBillingDocumentsRequest>
</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>
<GetBillingDocumentsResponse xmlns="https://bingads.microsoft.com/Billing/v13">
<BillingDocuments xmlns:e14="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<e14:BillingDocument>
<e14:Data d4p1:nil="false">ValueHere</e14:Data>
<e14:Id>ValueHere</e14:Id>
<e14:Type>ValueHere</e14:Type>
<e14:Number d4p1:nil="false">ValueHere</e14:Number>
</e14:BillingDocument>
</BillingDocuments>
</GetBillingDocumentsResponse>
</s:Body>
</s:Envelope>
程序代碼語法
範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例,請參閱 Bing 廣告 API 程式代碼範 例。
public async Task<GetBillingDocumentsResponse> GetBillingDocumentsAsync(
IList<BillingDocumentInfo> billingDocumentsInfo,
DataType type)
{
var request = new GetBillingDocumentsRequest
{
BillingDocumentsInfo = billingDocumentsInfo,
Type = type
};
return (await CustomerBillingService.CallAsync((s, r) => s.GetBillingDocumentsAsync(r), request));
}
static GetBillingDocumentsResponse getBillingDocuments(
ArrayOfBillingDocumentInfo billingDocumentsInfo,
DataType type) throws RemoteException, Exception
{
GetBillingDocumentsRequest request = new GetBillingDocumentsRequest();
request.setBillingDocumentsInfo(billingDocumentsInfo);
request.setType(type);
return CustomerBillingService.getService().getBillingDocuments(request);
}
static function GetBillingDocuments(
$billingDocumentsInfo,
$type)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];
$request = new GetBillingDocumentsRequest();
$request->BillingDocumentsInfo = $billingDocumentsInfo;
$request->Type = $type;
return $GLOBALS['CustomerBillingProxy']->GetService()->GetBillingDocuments($request);
}
response=customerbilling_service.GetBillingDocuments(
BillingDocumentsInfo=BillingDocumentsInfo,
Type=Type)
需求
服務: CustomerBillingService.svc v13
命名空間: https://bingads.microsoft.com/Billing/v13
要求 URL
https://clientcenter.api.bingads.microsoft.com/CustomerBilling/v13/BillingDocuments/Query
要求專案
GetBillingDocumentsRequest 物件會定義服務作業要求的主體和標頭元素。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 描述 | 資料類型 |
---|---|---|
BillingDocumentsInfo | 識別您想要取得的計費檔案清單。 清單中的每個 BillingDocumentInfo 物件都必須包含 CustomerId 和 DocumentId。 其他屬性會被忽略。 您最多可以在清單中包含 25 個專案。 |
BillingDocumentInfo 陣列 |
類型 | 用來產生計費檔的格式。 例如,您可以使用 PDF 或 XML 格式產生計費檔。 | DataType |
要求標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
授權 | OAuth 存取令牌,代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ,這是正確驗證的必要專案。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ,請參閱取得開發人員令牌。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
Response 元素
GetBillingDocumentsResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。
回應本文專案
元素 | 描述 | 資料類型 |
---|---|---|
BillingDocuments | 已擷取的計費檔案清單。 | BillingDocument 陣 列 |
回應標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
TrackingId | 包含 API 呼叫詳細數據的記錄項目識別碼。 | string |
要求 JSON
此範本是由工具所產生,用來顯示 JSON 要求的 主體 和 標頭 元素。 如需可搭配此服務作業使用的支援類型,請參閱上述 的要求本文項目 參考。
{
"BillingDocumentsInfo": [
{
"AccountId": "LongValueHere",
"AccountName": "ValueHere",
"AccountNumber": "ValueHere",
"Amount": DoubleValueHere,
"CampaignId": "LongValueHere",
"CurrencyCode": "ValueHere",
"CustomerId": IntValueHere,
"DocumentDate": "ValueHere",
"DocumentId": "LongValueHere",
"DocumentNumber": "ValueHere"
}
],
"Type": "ValueHere"
}
回應 JSON
此範本是由工具所產生,用來顯示 JSON 回應的 主體 和 標頭 元素。
{
"BillingDocuments": [
{
"Data": "ValueHere",
"Id": "LongValueHere",
"Number": "ValueHere",
"Type": "ValueHere"
}
]
}
程序代碼語法
若要透過 SDK 呼叫 REST API,您必須將 SDK 升級至特定版本並設定系統參數。範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例,請參閱 Bing 廣告 API 程式代碼範 例。
public async Task<GetBillingDocumentsResponse> GetBillingDocumentsAsync(
IList<BillingDocumentInfo> billingDocumentsInfo,
DataType type)
{
var request = new GetBillingDocumentsRequest
{
BillingDocumentsInfo = billingDocumentsInfo,
Type = type
};
return (await CustomerBillingService.CallAsync((s, r) => s.GetBillingDocumentsAsync(r), request));
}
static GetBillingDocumentsResponse getBillingDocuments(
ArrayOfBillingDocumentInfo billingDocumentsInfo,
DataType type) throws RemoteException, Exception
{
GetBillingDocumentsRequest request = new GetBillingDocumentsRequest();
request.setBillingDocumentsInfo(billingDocumentsInfo);
request.setType(type);
return CustomerBillingService.getService().getBillingDocuments(request);
}
static function GetBillingDocuments(
$billingDocumentsInfo,
$type)
{
$GLOBALS['Proxy'] = $GLOBALS['CustomerBillingProxy'];
$request = new GetBillingDocumentsRequest();
$request->BillingDocumentsInfo = $billingDocumentsInfo;
$request->Type = $type;
return $GLOBALS['CustomerBillingProxy']->GetService()->GetBillingDocuments($request);
}
response=customerbilling_service.GetBillingDocuments(
BillingDocumentsInfo=BillingDocumentsInfo,
Type=Type)