GetBillingDocumentsInfo サービス操作 - 顧客の課金

[アーティクル]
11/14/2024

請求伝票 ID、金額、勘定 ID など、請求伝票識別情報を含むオブジェクトの一覧を取得します。

Request 要素

GetBillingDocumentsInfoRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。要素は、要求 SOAP に示されている順序と同じ順序である必要があります。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素	説明	データ型
AccountIds	課金ドキュメント情報を取得するアカウントの識別子の一覧。	long 配列
EndDate	取得する請求伝票の指定に使用する終了日。今日の日付を終了日として指定するには、 EndDate を NULL に設定します。終了日を開始日より前に指定することはできません。日付は協定世界時 (UTC) で指定する必要があります。	dateTime
ReturnInvoiceNumber	要求に請求書番号を含めます。	boolean
StartDate	取得する請求伝票の指定に使用する開始日。開始日を終了日より後にすることはできません。日付は協定世界時 (UTC) で指定する必要があります。	dateTime

要求ヘッダー要素

要素	説明	データ型
AuthenticationToken	Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセストークン。詳細については、「 OAuth による認証」を参照してください。	string
DeveloperToken	Bing Ads API へのアクセスに使用される開発者トークン。詳細については、「開発者トークンを取得する」を参照してください。	string
Password	この要素は内部使用のために予約されており、今後のバージョンの 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
Namespace: https://bingads.microsoft.com/Billing/v13

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

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

Request 要素

GetBillingDocumentsInfoRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素	説明	データ型
AccountIds	課金ドキュメント情報を取得するアカウントの識別子の一覧。	long 配列
EndDate	取得する請求伝票の指定に使用する終了日。今日の日付を終了日として指定するには、 EndDate を NULL に設定します。終了日を開始日より前に指定することはできません。日付は協定世界時 (UTC) で指定する必要があります。	dateTime
ReturnInvoiceNumber	要求に請求書番号を含めます。	boolean
StartDate	取得する請求伝票の指定に使用する開始日。開始日を終了日より後にすることはできません。日付は協定世界時 (UTC) で指定する必要があります。	dateTime

要求ヘッダー要素

要素	説明	データ型
Authorization	Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセストークン。トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。詳細については、「 OAuth による認証」を参照してください。	string
DeveloperToken	Bing Ads API へのアクセスに使用される開発者トークン。詳細については、「開発者トークンを取得する」を参照してください。	string
Password	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string
UserName	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string

Response 要素

GetBillingDocumentsInfoResponse オブジェクトは、サービス操作応答の本文とヘッダー要素を定義します。要素は、 Response 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)

次の方法で共有

GetBillingDocumentsInfo サービス操作 - 顧客の課金

Request 要素

要求本文要素

要求ヘッダー要素

Response 要素

応答本文の要素

応答ヘッダー要素

SOAP を要求する

応答 SOAP

コード構文

要件

要求 URL

Request 要素

要求本文要素

要求ヘッダー要素

Response 要素

応答本文の要素

応答ヘッダー要素

JSON を要求する

応答 JSON

コード構文

フィードバック

その他のリソース