GetPerformanceInsightsDetailDataByAccountId Service Operation - Ad Insight

Artikkeli
11/13/2024

Gets the performance insights detail data for a single account.

Request Elements

The GetPerformanceInsightsDetailDataByAccountIdRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
EndDate	The end date range for performance insights. The maximum date range is one month.	DayMonthAndYear
EntityType	The entity level that you want to request performance insights summary data from. We currently support account and campaign level data.	EntityType
StartDate	The start date range for performance insights.	DayMonthAndYear

Request Header Elements

Element	Description	Data Type
AuthenticationToken	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth.	string
CustomerAccountId	The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
CustomerId	The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

The GetPerformanceInsightsDetailDataByAccountIdResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element	Description	Data Type
Result	Defines the performance insight results from calling the GetPerformanceInsightsDetailDataByAccountId operation.	PerformanceInsightsDetail array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<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>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<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>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

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)

Requirements

Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/PerformanceInsightsDetailData/QueryByAccountId

https://adinsight.api.sandbox.bingads.microsoft.com/AdInsight/v13/PerformanceInsightsDetailData/QueryByAccountId

Request Elements

The GetPerformanceInsightsDetailDataByAccountIdRequest object defines the body and header elements of the service operation request.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
EndDate	The end date range for performance insights. The maximum date range is one month.	DayMonthAndYear
EntityType	The entity level that you want to request performance insights summary data from. We currently support account and campaign level data.	EntityType
StartDate	The start date range for performance insights.	DayMonthAndYear

Request Header Elements

Element	Description	Data Type
Authorization	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth.	string
CustomerAccountId	The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
CustomerId	The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

Response Body Elements

Element	Description	Data Type
Result	Defines the performance insight results from calling the GetPerformanceInsightsDetailDataByAccountId operation.	PerformanceInsightsDetail array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request JSON

This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

{
  "EntityType": "ValueHere",
  "StartDate": {
    "Day": IntValueHere,
    "Month": IntValueHere,
    "Year": IntValueHere
  },
  "EndDate": {
    "Day": IntValueHere,
    "Month": IntValueHere,
    "Year": IntValueHere
  }
}

Response JSON

This template was generated by a tool to show the body and header elements for the JSON response.

Below is an example that is applicable if the type of PerformanceInsightsMessageParameter is EntityParameter.

{
  "Result": [
    {
      "Actions": [
        {
          "IndentationLevel": IntValueHere,
          "Parameters": [
            {
              "Type": "Entities",
              "EntityCount": IntValueHere,
              "EntityDetails": [
                {
                  "EntityId": "LongValueHere",
                  "EntityName": "ValueHere"
                }
              ],
              "EntityType": "ValueHere",
              "SuggestedText": "ValueHere"
            }
          ],
          "TemplateId": "ValueHere"
        }
      ],
      "Date": {
        "Day": IntValueHere,
        "Month": IntValueHere,
        "Year": IntValueHere
      },
      "Description": {
        "IndentationLevel": IntValueHere,
        "Parameters": [
          {
            "Type": "Entities",
            "EntityCount": IntValueHere,
            "EntityDetails": [
              {
                "EntityId": "LongValueHere",
                "EntityName": "ValueHere"
              }
            ],
            "EntityType": "ValueHere",
            "SuggestedText": "ValueHere"
          }
        ],
        "TemplateId": "ValueHere"
      },
      "EntityId": "LongValueHere",
      "EntityType": "ValueHere",
      "KPIType": "ValueHere",
      "RootCauses": [
        {
          "IndentationLevel": IntValueHere,
          "Parameters": [
            {
              "Type": "Entities",
              "EntityCount": IntValueHere,
              "EntityDetails": [
                {
                  "EntityId": "LongValueHere",
                  "EntityName": "ValueHere"
                }
              ],
              "EntityType": "ValueHere",
              "SuggestedText": "ValueHere"
            }
          ],
          "TemplateId": "ValueHere"
        }
      ]
    }
  ]
}

Code Syntax

To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

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)

Jaa

GetPerformanceInsightsDetailDataByAccountId Service Operation - Ad Insight

Request Elements

Request Body Elements

Request Header Elements

Response Elements

Response Body Elements

Response Header Elements

Request SOAP

Response SOAP

Code Syntax

Requirements

Request Url

Request Elements

Request Body Elements

Request Header Elements

Response Elements

Response Body Elements

Response Header Elements

Request JSON

Response JSON

Code Syntax

Palaute

Lisäresursseja