Opération de service GetPerformanceInsightsDetailDataByAccountId - Ad Insight

Article
11/14/2024

Obtient les données détaillées d’insights sur les performances pour un seul compte.

Éléments de demande

L’objet GetPerformanceInsightsDetailDataByAccountIdRequest définit les éléments body et header de la demande d’opération de service. Les éléments doivent être dans le même ordre que celui indiqué dans la requête SOAP.

Remarque

Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.

Éléments du corps de la requête

Élément	Description	Type de données
EndDate	Plage de dates de fin pour les insights sur les performances. La plage de dates maximale est d’un mois.	DayMonthAndYear
EntityType	Niveau d’entité à partir duquel vous souhaitez demander des données récapitulatives d’insights sur les performances. Nous prenons actuellement en charge les données au niveau du compte et de la campagne .	EntityType
StartDate	Plage de dates de début pour les insights sur les performances.	DayMonthAndYear

Éléments d’en-tête de requête

Élément	Description	Type de données
AuthenticationToken	Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Pour plus d’informations, consultez Authentification avec OAuth.	chaîne
CustomerAccountId	Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client.	chaîne
CustomerId	Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client.	chaîne
DeveloperToken	Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur.	chaîne
Mot de passe	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne
UserName	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne

Éléments Response

L’objet GetPerformanceInsightsDetailDataByAccountIdResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans la réponse SOAP.

Response Body, éléments

Élément	Description	Type de données
Résultat	Définit les résultats des insights sur les performances de l’appel de l’opération GetPerformanceInsightsDetailDataByAccountId .	Tableau PerformanceInsightsDetail

Éléments d’en-tête de réponse

Élément	Description	Type de données
TrackingId	Identificateur de l’entrée de journal qui contient les détails de l’appel d’API.	chaîne

Requête SOAP

Ce modèle a été généré par un outil pour afficher l’ordre des éléments body et header pour la requête SOAP. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.

<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 de réponse

Ce modèle a été généré par un outil pour afficher l’ordre des éléments de corps et d’en-tête pour la réponse 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>

Syntaxe du code

L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .

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)

Configuration requise

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

Éléments de demande

L’objet GetPerformanceInsightsDetailDataByAccountIdRequest définit les éléments body et header de la demande d’opération de service.

Remarque

Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.

Éléments du corps de la requête

Élément	Description	Type de données
EndDate	Plage de dates de fin pour les insights sur les performances. La plage de dates maximale est d’un mois.	DayMonthAndYear
EntityType	Niveau d’entité à partir duquel vous souhaitez demander des données récapitulatives d’insights sur les performances. Nous prenons actuellement en charge les données au niveau du compte et de la campagne .	EntityType
StartDate	Plage de dates de début pour les insights sur les performances.	DayMonthAndYear

Éléments d’en-tête de requête

Élément	Description	Type de données
Autorisation	Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Vérifiez que le jeton est précédé de « Porteur », ce qui est nécessaire pour une authentification appropriée. Pour plus d’informations, consultez Authentification avec OAuth.	chaîne
CustomerAccountId	Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client.	chaîne
CustomerId	Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client.	chaîne
DeveloperToken	Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur.	chaîne
Mot de passe	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne
UserName	Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur.	chaîne

Éléments Response

Response Body, éléments

Élément	Description	Type de données
Résultat	Définit les résultats des insights sur les performances de l’appel de l’opération GetPerformanceInsightsDetailDataByAccountId .	Tableau PerformanceInsightsDetail

Éléments d’en-tête de réponse

Élément	Description	Type de données
TrackingId	Identificateur de l’entrée de journal qui contient les détails de l’appel d’API.	chaîne

Requête JSON

Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la requête JSON. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.

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

JSON de réponse

Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la réponse JSON.

Voici un exemple qui s’applique si le type de PerformanceInsightsMessageParameter est 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"
        }
      ]
    }
  ]
}

Syntaxe du code

Pour appeler l’API REST via des kits SDK, vous devez mettre à niveau le KIT de développement logiciel (SDK) vers une certaine version et configurer les paramètres système. L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .

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)

Partager via

Opération de service GetPerformanceInsightsDetailDataByAccountId - Ad Insight

Éléments de demande

Éléments du corps de la requête

Éléments d’en-tête de requête

Éléments Response

Response Body, éléments

Éléments d’en-tête de réponse

Requête SOAP

Soap de réponse

Syntaxe du code

Configuration requise

URL de la demande

Éléments de demande

Éléments du corps de la requête

Éléments d’en-tête de requête

Éléments Response

Response Body, éléments

Éléments d’en-tête de réponse

Requête JSON

JSON de réponse

Syntaxe du code

Commentaires

Ressources supplémentaires