Edit

GetDiagnostics Service Operation - Campaign Management

Defines the get diagnostics service operation.

Request Elements

The GetDiagnosticsRequest 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
CallerName Reserved. string
Checks Reserved. DiagnosticsFilter array
Entities Reserved. DiagnosticsEntity array
Settings Reserved. DiagnosticsSettings

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

Response Elements

The GetDiagnosticsResponse 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
Entities Reserved. EntityResult array
RequestStatus Reserved. DiagnosticsRequestStatus

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/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">
      <Entities i:nil="false">
        <DiagnosticsEntity>
          <Id>ValueHere</Id>
          <SubType i:nil="false">ValueHere</SubType>
          <Type i:nil="false">ValueHere</Type>
        </DiagnosticsEntity>
      </Entities>
      <Checks i:nil="false">
        <DiagnosticsFilter>
          <Key i:nil="false">ValueHere</Key>
          <Values i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string>ValueHere</a1:string>
          </Values>
        </DiagnosticsFilter>
      </Checks>
      <Settings i:nil="false">
        <EnableCache>ValueHere</EnableCache>
        <LastCheckTimeUTC i:nil="false">ValueHere</LastCheckTimeUTC>
      </Settings>
      <CallerName i:nil="false">ValueHere</CallerName>
    </GetDiagnosticsRequest>
  </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/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">
      <RequestStatus d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <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>
        <Status d4p1:nil="false">ValueHere</Status>
      </RequestStatus>
      <Entities d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <EntityResult>
          <Categories d4p1:nil="false">
            <CategoryResult>
              <AuditPoints d4p1:nil="false">
                <AuditPointResult>
                  <Description d4p1:nil="false">ValueHere</Description>
                  <Details xmlns:e329="http://schemas.microsoft.com/2003/10/Serialization/Arrays" d4p1:nil="false">
                    <e329:KeyValueOfstringstring>ValueHere</e329:KeyValueOfstringstring>
                    <e329:Key d4p1:nil="false">ValueHere</e329:Key>
                    <e329:Value d4p1:nil="false">ValueHere</e329:Value>
                  </Details>
                  <Key d4p1:nil="false">ValueHere</Key>
                  <Severity d4p1:nil="false">ValueHere</Severity>
                  <Timestamp d4p1:nil="false">ValueHere</Timestamp>
                </AuditPointResult>
              </AuditPoints>
              <Key d4p1:nil="false">ValueHere</Key>
            </CategoryResult>
          </Categories>
          <Id>ValueHere</Id>
          <SubType d4p1:nil="false">ValueHere</SubType>
          <Type d4p1:nil="false">ValueHere</Type>
        </EntityResult>
      </Entities>
    </GetDiagnosticsResponse>
  </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<GetDiagnosticsResponse> GetDiagnosticsAsync(
	IList<DiagnosticsEntity> entities,
	IList<DiagnosticsFilter> checks,
	DiagnosticsSettings settings,
	string callerName)
{
	var request = new GetDiagnosticsRequest
	{
		Entities = entities,
		Checks = checks,
		Settings = settings,
		CallerName = callerName
	};

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

static GetDiagnosticsResponse getDiagnostics(
	ArrayOfDiagnosticsEntity entities,
	ArrayOfDiagnosticsFilter checks,
	DiagnosticsSettings settings,
	java.lang.String callerName) throws RemoteException, Exception
{
	GetDiagnosticsRequest request = new GetDiagnosticsRequest();

	request.setEntities(entities);
	request.setChecks(checks);
	request.setSettings(settings);
	request.setCallerName(callerName);

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

static function GetDiagnostics(
	$entities,
	$checks,
	$settings,
	$callerName)
{

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

	$request = new GetDiagnosticsRequest();

	$request->Entities = $entities;
	$request->Checks = $checks;
	$request->Settings = $settings;
	$request->CallerName = $callerName;

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

response=campaignmanagement_service.GetDiagnostics(
	Entities=Entities,
	Checks=Checks,
	Settings=Settings,
	CallerName=CallerName)

Requirements

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

Request Url

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

Request Elements

The GetDiagnosticsRequest 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
CallerName Reserved. string
Checks Reserved. DiagnosticsFilter array
Entities Reserved. DiagnosticsEntity array
Settings Reserved. DiagnosticsSettings

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

Response Elements

The GetDiagnosticsResponse 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 JSON.

Response Body Elements

Element Description Data Type
Entities Reserved. EntityResult array
RequestStatus Reserved. DiagnosticsRequestStatus

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.

{
  "Entities": [
    {
      "Id": "LongValueHere",
      "SubType": "ValueHere",
      "Type": "ValueHere"
    }
  ],
  "Checks": [
    {
      "Key": "ValueHere",
      "Values": [
        "ValueHere"
      ]
    }
  ],
  "Settings": {
    "EnableCache": "ValueHere",
    "LastCheckTimeUTC": "ValueHere"
  },
  "CallerName": "ValueHere"
}

Response JSON

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

{
  "RequestStatus": {
    "Errors": [
      {
        "Code": IntValueHere,
        "Details": "ValueHere",
        "ErrorCode": "ValueHere",
        "Message": "ValueHere"
      }
    ],
    "Status": "ValueHere"
  },
  "Entities": [
    {
      "Categories": [
        {
          "AuditPoints": [
            {
              "Description": "ValueHere",
              "Details": "ValueHere",
              "Key": "ValueHere",
              "Severity": "ValueHere",
              "Timestamp": "ValueHere"
            }
          ],
          "Key": "ValueHere"
        }
      ],
      "Id": "LongValueHere",
      "SubType": "ValueHere",
      "Type": "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<GetDiagnosticsResponse> GetDiagnosticsAsync(
	IList<DiagnosticsEntity> entities,
	IList<DiagnosticsFilter> checks,
	DiagnosticsSettings settings,
	string callerName)
{
	var request = new GetDiagnosticsRequest
	{
		Entities = entities,
		Checks = checks,
		Settings = settings,
		CallerName = callerName
	};

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

static GetDiagnosticsResponse getDiagnostics(
	ArrayOfDiagnosticsEntity entities,
	ArrayOfDiagnosticsFilter checks,
	DiagnosticsSettings settings,
	java.lang.String callerName) throws RemoteException, Exception
{
	GetDiagnosticsRequest request = new GetDiagnosticsRequest();

	request.setEntities(entities);
	request.setChecks(checks);
	request.setSettings(settings);
	request.setCallerName(callerName);

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

static function GetDiagnostics(
	$entities,
	$checks,
	$settings,
	$callerName)
{

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

	$request = new GetDiagnosticsRequest();

	$request->Entities = $entities;
	$request->Checks = $checks;
	$request->Settings = $settings;
	$request->CallerName = $callerName;

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

response=campaignmanagement_service.GetDiagnostics(
	Entities=Entities,
	Checks=Checks,
	Settings=Settings,
	CallerName=CallerName)
  • Last updated on