GetPerformanceInsightsDetailDataByAccountId サービス操作 - Ad Insight

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

1 つのアカウントのパフォーマンス分析情報の詳細データを取得します。

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
EndDate	パフォーマンス分析情報の終了日範囲。最大日付範囲は 1 か月です。	DayMonthAndYear
EntityType	パフォーマンス分析情報の概要データを要求するエンティティレベル。現在、アカウントレベルとキャンペーンレベルのデータがサポートされています。	EntityType
StartDate	パフォーマンス分析情報の開始日範囲。	DayMonthAndYear

要求ヘッダー要素

要素	説明	データ型
AuthenticationToken	Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセストークン。詳細については、「 OAuth による認証」を参照してください。	string
CustomerAccountId	要求のエンティティを所有または関連付けられている広告アカウントの識別子。両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。この要素は、ほとんどのサービス操作に必要であり、ベストプラクティスとして常に設定する必要があります。詳細については、「アカウントと顧客 ID を取得する」を参照してください。	string
Customerid	ユーザーがアクセスまたは操作しているマネージャーアカウント (顧客) の識別子。ユーザーは複数のマネージャーアカウントにアクセスできます。この要素は、ほとんどのサービス操作に必要であり、ベストプラクティスとして常に設定する必要があります。詳細については、「アカウントと顧客 ID を取得する」を参照してください。	string
DeveloperToken	Bing Ads API へのアクセスに使用される開発者トークン。詳細については、「開発者トークンを取得する」を参照してください。	string
Password	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string
UserName	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string

Response 要素

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

応答本文の要素

要素	説明	データ型
結果	GetPerformanceInsightsDetailDataByAccountId 操作を呼び出すことによるパフォーマンス分析情報の結果を定義します。	PerformanceInsightsDetail 配列

応答ヘッダー要素

要素	説明	データ型
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/AdInsight/v13">
    <Action mustUnderstand="1">GetPerformanceInsightsDetailDataByAccountId</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetPerformanceInsightsDetailDataByAccountIdRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <EntityType>ValueHere</EntityType>
      <StartDate i:nil="false">
        <Day>ValueHere</Day>
        <Month>ValueHere</Month>
        <Year>ValueHere</Year>
      </StartDate>
      <EndDate i:nil="false">
        <Day>ValueHere</Day>
        <Month>ValueHere</Month>
        <Year>ValueHere</Year>
      </EndDate>
    </GetPerformanceInsightsDetailDataByAccountIdRequest>
  </s:Body>
</s:Envelope>

応答 SOAP

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

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/AdInsight/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetPerformanceInsightsDetailDataByAccountIdResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Result d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <PerformanceInsightsDetail>
          <EntityId>ValueHere</EntityId>
          <EntityType>ValueHere</EntityType>
          <KPIType>ValueHere</KPIType>
          <Date d4p1:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </Date>
          <Description d4p1:nil="false">
            <TemplateId>ValueHere</TemplateId>
            <Parameters d4p1:nil="false">
              <PerformanceInsightsMessageParameter d4p1:type="-- derived type specified here with the appropriate prefix --">
                <Type>ValueHere</Type>
                <!--This field is applicable if the derived type attribute is set to TextParameter-->
                <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                <!--These fields are applicable if the derived type attribute is set to UrlParameter-->
                <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                <SuggestedUrl d4p1:nil="false">ValueHere</SuggestedUrl>
                <UrlCategory>ValueHere</UrlCategory>
                <UrlId>ValueHere</UrlId>
                <!--These fields are applicable if the derived type attribute is set to EntityParameter-->
                <EntityCount>ValueHere</EntityCount>
                <EntityDetails d4p1:nil="false">
                  <EntityDetail>
                    <EntityId>ValueHere</EntityId>
                    <EntityName d4p1:nil="false">ValueHere</EntityName>
                  </EntityDetail>
                </EntityDetails>
                <EntityType>ValueHere</EntityType>
                <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
              </PerformanceInsightsMessageParameter>
            </Parameters>
            <IndentationLevel>ValueHere</IndentationLevel>
          </Description>
          <RootCauses d4p1:nil="false">
            <PerformanceInsightsMessage>
              <TemplateId>ValueHere</TemplateId>
              <Parameters d4p1:nil="false">
                <PerformanceInsightsMessageParameter d4p1:type="-- derived type specified here with the appropriate prefix --">
                  <Type>ValueHere</Type>
                  <!--This field is applicable if the derived type attribute is set to TextParameter-->
                  <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                  <!--These fields are applicable if the derived type attribute is set to UrlParameter-->
                  <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                  <SuggestedUrl d4p1:nil="false">ValueHere</SuggestedUrl>
                  <UrlCategory>ValueHere</UrlCategory>
                  <UrlId>ValueHere</UrlId>
                  <!--These fields are applicable if the derived type attribute is set to EntityParameter-->
                  <EntityCount>ValueHere</EntityCount>
                  <EntityDetails d4p1:nil="false">
                    <EntityDetail>
                      <EntityId>ValueHere</EntityId>
                      <EntityName d4p1:nil="false">ValueHere</EntityName>
                    </EntityDetail>
                  </EntityDetails>
                  <EntityType>ValueHere</EntityType>
                  <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                </PerformanceInsightsMessageParameter>
              </Parameters>
              <IndentationLevel>ValueHere</IndentationLevel>
            </PerformanceInsightsMessage>
          </RootCauses>
          <Actions d4p1:nil="false">
            <PerformanceInsightsMessage>
              <TemplateId>ValueHere</TemplateId>
              <Parameters d4p1:nil="false">
                <PerformanceInsightsMessageParameter d4p1:type="-- derived type specified here with the appropriate prefix --">
                  <Type>ValueHere</Type>
                  <!--This field is applicable if the derived type attribute is set to TextParameter-->
                  <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                  <!--These fields are applicable if the derived type attribute is set to UrlParameter-->
                  <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                  <SuggestedUrl d4p1:nil="false">ValueHere</SuggestedUrl>
                  <UrlCategory>ValueHere</UrlCategory>
                  <UrlId>ValueHere</UrlId>
                  <!--These fields are applicable if the derived type attribute is set to EntityParameter-->
                  <EntityCount>ValueHere</EntityCount>
                  <EntityDetails d4p1:nil="false">
                    <EntityDetail>
                      <EntityId>ValueHere</EntityId>
                      <EntityName d4p1:nil="false">ValueHere</EntityName>
                    </EntityDetail>
                  </EntityDetails>
                  <EntityType>ValueHere</EntityType>
                  <SuggestedText d4p1:nil="false">ValueHere</SuggestedText>
                </PerformanceInsightsMessageParameter>
              </Parameters>
              <IndentationLevel>ValueHere</IndentationLevel>
            </PerformanceInsightsMessage>
          </Actions>
        </PerformanceInsightsDetail>
      </Result>
    </GetPerformanceInsightsDetailDataByAccountIdResponse>
  </s:Body>
</s:Envelope>

コード構文

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

public async Task<GetPerformanceInsightsDetailDataByAccountIdResponse> GetPerformanceInsightsDetailDataByAccountIdAsync(
	EntityType entityType,
	DayMonthAndYear startDate,
	DayMonthAndYear endDate)
{
	var request = new GetPerformanceInsightsDetailDataByAccountIdRequest
	{
		EntityType = entityType,
		StartDate = startDate,
		EndDate = endDate
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetPerformanceInsightsDetailDataByAccountIdAsync(r), request));
}

static GetPerformanceInsightsDetailDataByAccountIdResponse getPerformanceInsightsDetailDataByAccountId(
	EntityType entityType,
	DayMonthAndYear startDate,
	DayMonthAndYear endDate) throws RemoteException, Exception
{
	GetPerformanceInsightsDetailDataByAccountIdRequest request = new GetPerformanceInsightsDetailDataByAccountIdRequest();

	request.setEntityType(entityType);
	request.setStartDate(startDate);
	request.setEndDate(endDate);

	return AdInsightService.getService().getPerformanceInsightsDetailDataByAccountId(request);
}

static function GetPerformanceInsightsDetailDataByAccountId(
	$entityType,
	$startDate,
	$endDate)
{

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

	$request = new GetPerformanceInsightsDetailDataByAccountIdRequest();

	$request->EntityType = $entityType;
	$request->StartDate = $startDate;
	$request->EndDate = $endDate;

	return $GLOBALS['AdInsightProxy']->GetService()->GetPerformanceInsightsDetailDataByAccountId($request);
}

response=adinsight_service.GetPerformanceInsightsDetailDataByAccountId(
	EntityType=EntityType,
	StartDate=StartDate,
	EndDate=EndDate)

要件

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

次の方法で共有