次の方法で共有

GetAccount サービス操作 - 顧客管理

  • [アーティクル]

アカウントの詳細を取得します。

Request 要素

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

注:

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

要求本文要素

要素 説明 データ型
AccountId 取得するアカウントの識別子。 long
ReturnAdditionalFields 返された各アカウントに含めたい追加のプロパティの一覧。 追加のフィールド値を使用すると、現在のバージョンの Customer Management API を使用して最新の機能を取得できます。次のバージョンでは、対応する要素が既定で含まれます。

この要求要素は省略可能です。		 AccountAdditionalField

要求ヘッダー要素

要素 説明 データ型
AuthenticationToken Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。

詳細については、「 OAuth による認証」を参照してください。		 string
DeveloperToken Bing Ads API へのアクセスに使用される開発者トークン。

詳細については、「 開発者トークンを取得する」を参照してください。		 string
Password この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string
UserName この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string

Response 要素

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

応答本文の要素

要素 説明 データ型
アカウント 支払い方法、アカウントの種類、親顧客など、アカウントに関する情報を含むアカウント オブジェクト。 AdvertiserAccount

応答ヘッダー要素

要素 説明 データ型
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/Customer/v13">
    <Action mustUnderstand="1">GetAccount</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetAccountRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <AccountId>ValueHere</AccountId>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </GetAccountRequest>
  </s:Body>
</s:Envelope>

応答 SOAP

このテンプレートは、SOAP 応答の 本文 要素と ヘッダー 要素の順序を示すツールによって生成されました。

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetAccountResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <Account xmlns:e487="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e487:BillToCustomerId d4p1:nil="false">ValueHere</e487:BillToCustomerId>
        <e487:CurrencyCode d4p1:nil="false">ValueHere</e487:CurrencyCode>
        <e487:AccountFinancialStatus d4p1:nil="false">ValueHere</e487:AccountFinancialStatus>
        <e487:Id d4p1:nil="false">ValueHere</e487:Id>
        <e487:Language d4p1:nil="false">ValueHere</e487:Language>
        <e487:LastModifiedByUserId d4p1:nil="false">ValueHere</e487:LastModifiedByUserId>
        <e487:LastModifiedTime d4p1:nil="false">ValueHere</e487:LastModifiedTime>
        <e487:Name d4p1:nil="false">ValueHere</e487:Name>
        <e487:Number d4p1:nil="false">ValueHere</e487:Number>
        <e487:ParentCustomerId>ValueHere</e487:ParentCustomerId>
        <e487:PaymentMethodId d4p1:nil="false">ValueHere</e487:PaymentMethodId>
        <e487:PaymentMethodType d4p1:nil="false">ValueHere</e487:PaymentMethodType>
        <e487:PrimaryUserId d4p1:nil="false">ValueHere</e487:PrimaryUserId>
        <e487:AccountLifeCycleStatus d4p1:nil="false">ValueHere</e487:AccountLifeCycleStatus>
        <e487:TimeStamp d4p1:nil="false">ValueHere</e487:TimeStamp>
        <e487:TimeZone d4p1:nil="false">ValueHere</e487:TimeZone>
        <e487:PauseReason d4p1:nil="false">ValueHere</e487:PauseReason>
        <e487:ForwardCompatibilityMap xmlns:e488="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
          <e488:KeyValuePairOfstringstring>
            <e488:key d4p1:nil="false">ValueHere</e488:key>
            <e488:value d4p1:nil="false">ValueHere</e488:value>
          </e488:KeyValuePairOfstringstring>
        </e487:ForwardCompatibilityMap>
        <e487:LinkedAgencies d4p1:nil="false">
          <e487:CustomerInfo>
            <e487:Id d4p1:nil="false">ValueHere</e487:Id>
            <e487:Name d4p1:nil="false">ValueHere</e487:Name>
          </e487:CustomerInfo>
        </e487:LinkedAgencies>
        <e487:SalesHouseCustomerId d4p1:nil="false">ValueHere</e487:SalesHouseCustomerId>
        <e487:TaxInformation xmlns:e489="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
          <e489:KeyValuePairOfstringstring>
            <e489:key d4p1:nil="false">ValueHere</e489:key>
            <e489:value d4p1:nil="false">ValueHere</e489:value>
          </e489:KeyValuePairOfstringstring>
        </e487:TaxInformation>
        <e487:BackUpPaymentInstrumentId d4p1:nil="false">ValueHere</e487:BackUpPaymentInstrumentId>
        <e487:BillingThresholdAmount d4p1:nil="false">ValueHere</e487:BillingThresholdAmount>
        <e487:BusinessAddress d4p1:nil="false">
          <e487:City d4p1:nil="false">ValueHere</e487:City>
          <e487:CountryCode d4p1:nil="false">ValueHere</e487:CountryCode>
          <e487:Id d4p1:nil="false">ValueHere</e487:Id>
          <e487:Line1 d4p1:nil="false">ValueHere</e487:Line1>
          <e487:Line2 d4p1:nil="false">ValueHere</e487:Line2>
          <e487:Line3 d4p1:nil="false">ValueHere</e487:Line3>
          <e487:Line4 d4p1:nil="false">ValueHere</e487:Line4>
          <e487:PostalCode d4p1:nil="false">ValueHere</e487:PostalCode>
          <e487:StateOrProvince d4p1:nil="false">ValueHere</e487:StateOrProvince>
          <e487:TimeStamp d4p1:nil="false">ValueHere</e487:TimeStamp>
          <e487:BusinessName d4p1:nil="false">ValueHere</e487:BusinessName>
        </e487:BusinessAddress>
        <e487:AutoTagType d4p1:nil="false">ValueHere</e487:AutoTagType>
        <e487:SoldToPaymentInstrumentId d4p1:nil="false">ValueHere</e487:SoldToPaymentInstrumentId>
        <e487:TaxCertificate d4p1:nil="false">
          <e487:TaxCertificateBlobContainerName d4p1:nil="false">ValueHere</e487:TaxCertificateBlobContainerName>
          <e487:TaxCertificates xmlns:e490="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e490:KeyValuePairOfstringbase64Binary>
              <e490:key d4p1:nil="false">ValueHere</e490:key>
              <e490:value d4p1:nil="false">ValueHere</e490:value>
            </e490:KeyValuePairOfstringbase64Binary>
          </e487:TaxCertificates>
          <e487:Status d4p1:nil="false">ValueHere</e487:Status>
        </e487:TaxCertificate>
        <e487:AccountMode d4p1:nil="false">ValueHere</e487:AccountMode>
      </Account>
    </GetAccountResponse>
  </s:Body>
</s:Envelope>

コード構文

構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。

public async Task<GetAccountResponse> GetAccountAsync(
	long accountId,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new GetAccountRequest
	{
		AccountId = accountId,
		ReturnAdditionalFields = returnAdditionalFields
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.GetAccountAsync(r), request));
}

static GetAccountResponse getAccount(
	java.lang.Long accountId,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetAccountRequest request = new GetAccountRequest();

	request.setAccountId(accountId);
	request.setReturnAdditionalFields(returnAdditionalFields);

	return CustomerManagementService.getService().getAccount(request);
}

static function GetAccount(
	$accountId,
	$returnAdditionalFields)
{

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

	$request = new GetAccountRequest();

	$request->AccountId = $accountId;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

	return $GLOBALS['CustomerManagementProxy']->GetService()->GetAccount($request);
}

response=customermanagement_service.GetAccount(
	AccountId=AccountId,
	ReturnAdditionalFields=ReturnAdditionalFields)

要件

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

要求 URL

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Account/Query

Request 要素

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

注:

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

要求本文要素

要素 説明 データ型
AccountId 取得するアカウントの識別子。 long
ReturnAdditionalFields 返された各アカウントに含めたい追加のプロパティの一覧。 追加のフィールド値を使用すると、現在のバージョンの Customer Management API を使用して最新の機能を取得できます。次のバージョンでは、対応する要素が既定で含まれます。

この要求要素は省略可能です。		 AccountAdditionalField

要求ヘッダー要素

要素 説明 データ型
Authorization Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。

詳細については、「 OAuth による認証」を参照してください。		 string
DeveloperToken Bing Ads API へのアクセスに使用される開発者トークン。

詳細については、「 開発者トークンを取得する」を参照してください。		 string
Password この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string
UserName この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string

Response 要素

GetAccountResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 Response JSON に示されている順序と同じ順序で返されます。

応答本文の要素

要素 説明 データ型
アカウント 支払い方法、アカウントの種類、親顧客など、アカウントに関する情報を含むアカウント オブジェクト。 AdvertiserAccount

応答ヘッダー要素

要素 説明 データ型
TrackingId API 呼び出しの詳細を含むログ エントリの識別子。 string

JSON を要求する

このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。

{
  "AccountId": "LongValueHere",
  "ReturnAdditionalFields": "ValueHere"
}

応答 JSON

このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。

{
  "Account": {
    "AccountFinancialStatus": "ValueHere",
    "AccountLifeCycleStatus": "ValueHere",
    "AccountMode": "ValueHere",
    "AutoTagType": "ValueHere",
    "BackUpPaymentInstrumentId": "LongValueHere",
    "BillingThresholdAmount": DecimalValueHere,
    "BillToCustomerId": "LongValueHere",
    "BusinessAddress": {
      "BusinessName": "ValueHere",
      "City": "ValueHere",
      "CountryCode": "ValueHere",
      "Id": "LongValueHere",
      "Line1": "ValueHere",
      "Line2": "ValueHere",
      "Line3": "ValueHere",
      "Line4": "ValueHere",
      "PostalCode": "ValueHere",
      "StateOrProvince": "ValueHere",
      "TimeStamp": "ValueHere"
    },
    "CurrencyCode": "ValueHere",
    "ForwardCompatibilityMap": [
      {
        "key": "ValueHere",
        "value": "ValueHere"
      }
    ],
    "Id": "LongValueHere",
    "Language": "ValueHere",
    "LastModifiedByUserId": "LongValueHere",
    "LastModifiedTime": "ValueHere",
    "LinkedAgencies": [
      {
        "Id": "LongValueHere",
        "Name": "ValueHere"
      }
    ],
    "Name": "ValueHere",
    "Number": "ValueHere",
    "ParentCustomerId": "LongValueHere",
    "PauseReason": "ValueHere",
    "PaymentMethodId": "LongValueHere",
    "PaymentMethodType": "ValueHere",
    "PrimaryUserId": "LongValueHere",
    "SalesHouseCustomerId": "LongValueHere",
    "SoldToPaymentInstrumentId": "LongValueHere",
    "TaxCertificate": {
      "Status": "ValueHere",
      "TaxCertificateBlobContainerName": "ValueHere",
      "TaxCertificates": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ]
    },
    "TaxInformation": [
      {
        "key": "ValueHere",
        "value": "ValueHere"
      }
    ],
    "TimeStamp": "ValueHere",
    "TimeZone": "ValueHere"
  }
}

コード構文

SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。

public async Task<GetAccountResponse> GetAccountAsync(
	long accountId,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new GetAccountRequest
	{
		AccountId = accountId,
		ReturnAdditionalFields = returnAdditionalFields
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.GetAccountAsync(r), request));
}

static GetAccountResponse getAccount(
	java.lang.Long accountId,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	GetAccountRequest request = new GetAccountRequest();

	request.setAccountId(accountId);
	request.setReturnAdditionalFields(returnAdditionalFields);

	return CustomerManagementService.getService().getAccount(request);
}

static function GetAccount(
	$accountId,
	$returnAdditionalFields)
{

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

	$request = new GetAccountRequest();

	$request->AccountId = $accountId;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

	return $GLOBALS['CustomerManagementProxy']->GetService()->GetAccount($request);
}

response=customermanagement_service.GetAccount(
	AccountId=AccountId,
	ReturnAdditionalFields=ReturnAdditionalFields)