GetAccountsInfo サービス操作 - Customer Management

[アーティクル]
10/04/2023

指定した顧客からアクセスできるアカウントの識別子、名前、および数を取得します。

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
Customerid	アカウント情報を取得するために使用される顧客の識別子。この要求要素は省略可能です。設定されていない場合は、ユーザーの資格情報を使用して顧客を特定します。	long
OnlyParentAccounts	顧客に属する広告主アカウントのみを返すか、リンクされた広告主アカウントを他の顧客に返すかを決定します。指定した顧客のすぐ下にある広告主アカウントに結果を制限するには、この要素を true に設定し、それ以外の場合は空のままにするか、プロパティを false に設定します。既定値は false です。	boolean

要求ヘッダー要素

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

Response 要素

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

応答本文の要素

要素	説明	データ型
AccountsInfo	要求条件に一致する広告主アカウントに関する情報の一覧。アカウントの作成から応答にアカウント情報が含まれるまで、最大 5 分の遅延が発生する可能性があることに注意してください。	AccountInfo 配列

応答ヘッダー要素

要素	説明	データ型
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">GetAccountsInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetAccountsInfoRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomerId i:nil="false">ValueHere</CustomerId>
      <OnlyParentAccounts>ValueHere</OnlyParentAccounts>
    </GetAccountsInfoRequest>
  </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>
    <GetAccountsInfoResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <AccountsInfo xmlns:e232="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e232:AccountInfo>
          <e232:Id>ValueHere</e232:Id>
          <e232:Name d4p1:nil="false">ValueHere</e232:Name>
          <e232:Number d4p1:nil="false">ValueHere</e232:Number>
          <e232:AccountLifeCycleStatus>ValueHere</e232:AccountLifeCycleStatus>
          <e232:PauseReason d4p1:nil="false">ValueHere</e232:PauseReason>
        </e232:AccountInfo>
      </AccountsInfo>
    </GetAccountsInfoResponse>
  </s:Body>
</s:Envelope>

コード構文

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

public async Task<GetAccountsInfoResponse> GetAccountsInfoAsync(
	long? customerId,
	bool onlyParentAccounts)
{
	var request = new GetAccountsInfoRequest
	{
		CustomerId = customerId,
		OnlyParentAccounts = onlyParentAccounts
	};

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

static GetAccountsInfoResponse getAccountsInfo(
	java.lang.Long customerId,
	boolean onlyParentAccounts) throws RemoteException, Exception
{
	GetAccountsInfoRequest request = new GetAccountsInfoRequest();

	request.setCustomerId(customerId);
	request.setOnlyParentAccounts(onlyParentAccounts);

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

static function GetAccountsInfo(
	$customerId,
	$onlyParentAccounts)
{

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

	$request = new GetAccountsInfoRequest();

	$request->CustomerId = $customerId;
	$request->OnlyParentAccounts = $onlyParentAccounts;

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

response=customermanagement_service.GetAccountsInfo(
	CustomerId=CustomerId,
	OnlyParentAccounts=OnlyParentAccounts)

要件

サービス: CustomerManagementService.svc v13
名前空間： https://bingads.microsoft.com/Customer/v13

次の方法で共有