Partager via

Opération du service GetDiagnostics - Gestion des campagnes

Définit l’opération get diagnostics service.

Éléments de demande

L’objet GetDiagnosticsRequest 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
HealthCheckEntities Réservé. Tableau HealthCheckEntity
HealthCheckTypes Réservé. tableau de chaînes

É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 GetDiagnosticsResponse 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
DiagnosticCardData Réservé. Tableau DiagnosticCardData
DiagnosticCategoryData Réservé. Tableau DiagnosticCategoryData
DiagnosticErrors Réservé. Tableau HealthCheckError
DiagnosticTileData Réservé. DiagnosticTileData

É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/CampaignManagement/v13">
    <Action mustUnderstand="1">GetDiagnostics</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>
    <GetDiagnosticsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <HealthCheckEntities i:nil="false">
        <HealthCheckEntity>
          <HealthCheckEntityId>ValueHere</HealthCheckEntityId>
          <HealthCheckEntityLevel i:nil="false">ValueHere</HealthCheckEntityLevel>
        </HealthCheckEntity>
      </HealthCheckEntities>
      <HealthCheckTypes i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </HealthCheckTypes>
    </GetDiagnosticsRequest>
  </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/CampaignManagement/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetDiagnosticsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <DiagnosticTileData d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <Description d4p1:nil="false">ValueHere</Description>
        <Headline d4p1:nil="false">ValueHere</Headline>
        <ProgressPercent>ValueHere</ProgressPercent>
        <Title d4p1:nil="false">ValueHere</Title>
      </DiagnosticTileData>
      <DiagnosticCategoryData d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <DiagnosticCategoryData>
          <ActionLinks d4p1:nil="false">
            <HealthCheckActionLinkMetadata>
              <LinkName d4p1:nil="false">ValueHere</LinkName>
              <LinkTemplate d4p1:nil="false">ValueHere</LinkTemplate>
              <LinkType d4p1:nil="false">ValueHere</LinkType>
            </HealthCheckActionLinkMetadata>
          </ActionLinks>
          <CategoryDisplayName d4p1:nil="false">ValueHere</CategoryDisplayName>
          <CategoryKey d4p1:nil="false">ValueHere</CategoryKey>
          <CategorySeverity d4p1:nil="false">ValueHere</CategorySeverity>
          <CategoryStatus d4p1:nil="false">ValueHere</CategoryStatus>
          <Description d4p1:nil="false">ValueHere</Description>
        </DiagnosticCategoryData>
      </DiagnosticCategoryData>
      <DiagnosticCardData d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <DiagnosticCardData>
          <CheckpointsData d4p1:nil="false">
            <HealthCheckData>
              <HealthCheckDataVersion d4p1:nil="false">ValueHere</HealthCheckDataVersion>
              <HealthCheckEntity d4p1:nil="false">
                <HealthCheckEntityId>ValueHere</HealthCheckEntityId>
                <HealthCheckEntityLevel d4p1:nil="false">ValueHere</HealthCheckEntityLevel>
              </HealthCheckEntity>
              <HealthCheckJsonData d4p1:nil="false">ValueHere</HealthCheckJsonData>
              <HealthCheckName d4p1:nil="false">ValueHere</HealthCheckName>
              <HealthCheckSubEntityResults d4p1:nil="false">
                <SubEntityHealthIssueCount>ValueHere</SubEntityHealthIssueCount>
                <SubEntityIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <a1:long>ValueHere</a1:long>
                </SubEntityIds>
                <SubEntityLevel d4p1:nil="false">ValueHere</SubEntityLevel>
              </HealthCheckSubEntityResults>
            </HealthCheckData>
          </CheckpointsData>
          <Metadata d4p1:nil="false">
            <HealthCheckCategory d4p1:nil="false">ValueHere</HealthCheckCategory>
            <HealthCheckCategoryDisplayName d4p1:nil="false">ValueHere</HealthCheckCategoryDisplayName>
            <HealthCheckColumnsMetadata d4p1:nil="false">
              <HealthCheckColumnMetadata>
                <HealthCheckActionLinksMetadata d4p1:nil="false">
                  <HealthCheckActionLinkMetadata>
                    <LinkName d4p1:nil="false">ValueHere</LinkName>
                    <LinkTemplate d4p1:nil="false">ValueHere</LinkTemplate>
                    <LinkType d4p1:nil="false">ValueHere</LinkType>
                  </HealthCheckActionLinkMetadata>
                </HealthCheckActionLinksMetadata>
                <Key d4p1:nil="false">ValueHere</Key>
                <Title d4p1:nil="false">ValueHere</Title>
                <Type d4p1:nil="false">ValueHere</Type>
              </HealthCheckColumnMetadata>
            </HealthCheckColumnsMetadata>
            <HealthCheckDescription d4p1:nil="false">ValueHere</HealthCheckDescription>
            <HealthCheckDisplayName d4p1:nil="false">ValueHere</HealthCheckDisplayName>
            <HealthCheckName d4p1:nil="false">ValueHere</HealthCheckName>
            <HealthCheckSeverity d4p1:nil="false">ValueHere</HealthCheckSeverity>
            <HealthCheckSubType d4p1:nil="false">ValueHere</HealthCheckSubType>
          </Metadata>
        </DiagnosticCardData>
      </DiagnosticCardData>
      <DiagnosticErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <HealthCheckError>
          <Errors d4p1:nil="false">
            <OperationError>
              <Code>ValueHere</Code>
              <Details d4p1:nil="false">ValueHere</Details>
              <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
              <Message d4p1:nil="false">ValueHere</Message>
            </OperationError>
          </Errors>
          <HealthCheckEntity d4p1:nil="false">
            <HealthCheckEntityId>ValueHere</HealthCheckEntityId>
            <HealthCheckEntityLevel d4p1:nil="false">ValueHere</HealthCheckEntityLevel>
          </HealthCheckEntity>
          <HealthCheckName d4p1:nil="false">ValueHere</HealthCheckName>
        </HealthCheckError>
      </DiagnosticErrors>
    </GetDiagnosticsResponse>
  </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<GetDiagnosticsResponse> GetDiagnosticsAsync(
	IList<HealthCheckEntity> healthCheckEntities,
	IList<string> healthCheckTypes)
{
	var request = new GetDiagnosticsRequest
	{
		HealthCheckEntities = healthCheckEntities,
		HealthCheckTypes = healthCheckTypes
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetDiagnosticsAsync(r), request));
}

static GetDiagnosticsResponse getDiagnostics(
	ArrayOfHealthCheckEntity healthCheckEntities,
	ArrayOfstring healthCheckTypes) throws RemoteException, Exception
{
	GetDiagnosticsRequest request = new GetDiagnosticsRequest();

	request.setHealthCheckEntities(healthCheckEntities);
	request.setHealthCheckTypes(healthCheckTypes);

	return CampaignManagementService.getService().getDiagnostics(request);
}

static function GetDiagnostics(
	$healthCheckEntities,
	$healthCheckTypes)
{

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

	$request = new GetDiagnosticsRequest();

	$request->HealthCheckEntities = $healthCheckEntities;
	$request->HealthCheckTypes = $healthCheckTypes;

	return $GLOBALS['CampaignManagementProxy']->GetService()->GetDiagnostics($request);
}

response=campaignmanagement_service.GetDiagnostics(
	HealthCheckEntities=HealthCheckEntities,
	HealthCheckTypes=HealthCheckTypes)

Configuration requise

Service : CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

URL de la demande

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/Diagnostics/Query

Éléments de demande

L’objet GetDiagnosticsRequest 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
HealthCheckEntities Réservé. Tableau HealthCheckEntity
HealthCheckTypes Réservé. tableau de chaînes

É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

L’objet GetDiagnosticsResponse 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 le json de réponse.

Response Body, éléments

Élément Description Type de données
DiagnosticCardData Réservé. Tableau DiagnosticCardData
DiagnosticCategoryData Réservé. Tableau DiagnosticCategoryData
DiagnosticErrors Réservé. Tableau HealthCheckError
DiagnosticTileData Réservé. DiagnosticTileData

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

{
  "HealthCheckEntities": [
    {
      "HealthCheckEntityId": "LongValueHere",
      "HealthCheckEntityLevel": "ValueHere"
    }
  ],
  "HealthCheckTypes": [
    "ValueHere"
  ]
}

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.

{
  "DiagnosticTileData": {
    "Description": "ValueHere",
    "Headline": "ValueHere",
    "ProgressPercent": IntValueHere,
    "Title": "ValueHere"
  },
  "DiagnosticCategoryData": [
    {
      "ActionLinks": [
        {
          "LinkName": "ValueHere",
          "LinkTemplate": "ValueHere",
          "LinkType": "ValueHere"
        }
      ],
      "CategoryDisplayName": "ValueHere",
      "CategoryKey": "ValueHere",
      "CategorySeverity": "ValueHere",
      "CategoryStatus": "ValueHere",
      "Description": "ValueHere"
    }
  ],
  "DiagnosticCardData": [
    {
      "CheckpointsData": [
        {
          "HealthCheckDataVersion": "ValueHere",
          "HealthCheckEntity": {
            "HealthCheckEntityId": "LongValueHere",
            "HealthCheckEntityLevel": "ValueHere"
          },
          "HealthCheckJsonData": "ValueHere",
          "HealthCheckName": "ValueHere",
          "HealthCheckSubEntityResults": {
            "SubEntityHealthIssueCount": IntValueHere,
            "SubEntityIds": [
              "LongValueHere"
            ],
            "SubEntityLevel": "ValueHere"
          }
        }
      ],
      "Metadata": {
        "HealthCheckCategory": "ValueHere",
        "HealthCheckCategoryDisplayName": "ValueHere",
        "HealthCheckColumnsMetadata": [
          {
            "HealthCheckActionLinksMetadata": [
              {
                "LinkName": "ValueHere",
                "LinkTemplate": "ValueHere",
                "LinkType": "ValueHere"
              }
            ],
            "Key": "ValueHere",
            "Title": "ValueHere",
            "Type": "ValueHere"
          }
        ],
        "HealthCheckDescription": "ValueHere",
        "HealthCheckDisplayName": "ValueHere",
        "HealthCheckName": "ValueHere",
        "HealthCheckSeverity": "ValueHere",
        "HealthCheckSubType": "ValueHere"
      }
    }
  ],
  "DiagnosticErrors": [
    {
      "Errors": [
        {
          "Code": IntValueHere,
          "Details": "ValueHere",
          "ErrorCode": "ValueHere",
          "Message": "ValueHere"
        }
      ],
      "HealthCheckEntity": {
        "HealthCheckEntityId": "LongValueHere",
        "HealthCheckEntityLevel": "ValueHere"
      },
      "HealthCheckName": "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<GetDiagnosticsResponse> GetDiagnosticsAsync(
	IList<HealthCheckEntity> healthCheckEntities,
	IList<string> healthCheckTypes)
{
	var request = new GetDiagnosticsRequest
	{
		HealthCheckEntities = healthCheckEntities,
		HealthCheckTypes = healthCheckTypes
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetDiagnosticsAsync(r), request));
}

static GetDiagnosticsResponse getDiagnostics(
	ArrayOfHealthCheckEntity healthCheckEntities,
	ArrayOfstring healthCheckTypes) throws RemoteException, Exception
{
	GetDiagnosticsRequest request = new GetDiagnosticsRequest();

	request.setHealthCheckEntities(healthCheckEntities);
	request.setHealthCheckTypes(healthCheckTypes);

	return CampaignManagementService.getService().getDiagnostics(request);
}

static function GetDiagnostics(
	$healthCheckEntities,
	$healthCheckTypes)
{

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

	$request = new GetDiagnosticsRequest();

	$request->HealthCheckEntities = $healthCheckEntities;
	$request->HealthCheckTypes = $healthCheckTypes;

	return $GLOBALS['CampaignManagementProxy']->GetService()->GetDiagnostics($request);
}

response=campaignmanagement_service.GetDiagnostics(
	HealthCheckEntities=HealthCheckEntities,
	HealthCheckTypes=HealthCheckTypes)