Operación de servicio DeleteAdGroupCriterions: Administración de campañas

Artículo
11/14/2024

Elimina los criterios de grupo de anuncios especificados.

Elementos Request

El objeto DeleteAdGroupCriterionsRequest define los elementos body y header de la solicitud de operación de servicio. Los elementos deben estar en el mismo orden que se muestra en la solicitud SOAP.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento	Descripción	Tipo de datos
AdGroupCriterionIds	Lista de identificadores únicos que identifican los criterios que se van a eliminar. Puede incluir hasta 1000 identificadores de criterio de grupo de anuncios por solicitud.	matriz larga
AdGroupId	Identificador del grupo de anuncios que tiene los criterios que desea eliminar.	largo
CriterionType	Tipo de criterio que se va a eliminar, por ejemplo, página web. Solo puede especificar un valor de tipo de criterio por llamada. Para agregar, eliminar o actualizar criterios de destino, como la edad, el nombre de la empresa, el día y la hora, el dispositivo, el género, el sector, la función de trabajo, la ubicación, la intención de ubicación y los criterios de radio, debe especificar el valor CriterionType como Destinos. Puede agregar, eliminar y actualizar varios tipos de criterio de destino en la misma operación. Para recuperar estos criterios de destino a través de GetAdGroupCriterionsByIds , debe solicitar el tipo específico individualmente, es decir, Age, CompanyName, DayTime, Device, Gender, Industry, JobFunction, Location, LocationIntent y Radius. Para agregar, eliminar o actualizar criterios de audiencia, es decir, audiencias personalizadas, audiencias en el mercado y listas de remarketing, debe especificar el valor CriterionType como Audiencia. Puede agregar, eliminar y actualizar varios tipos de criterio de destino en la misma operación. Para recuperar estos criterios de audiencia a través de GetAdGroupCriterionsByIds , debe solicitar el tipo específico individualmente, es decir, CustomAudience, InMarketAudience, ProductAudience y RemarketingList. No se puede eliminar una productpartition con esta operación. En su lugar, debe usar ApplyProductPartitionActions.	AdGroupCriterionType

Elementos de encabezado de solicitud

Elemento	Descripción	Tipo de datos
AuthenticationToken	Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Para obtener más información, consulte Autenticación con OAuth.	string
CustomerAccountId	Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.	string
CustomerId	Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.	string
DeveloperToken	Token de desarrollador que se usa para acceder a Bing Ads API. Para obtener más información, consulte Obtención de un token de desarrollador.	string
Password	Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario.	string
UserName	Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario.	string

Elementos de respuesta

El objeto DeleteAdGroupCriterionsResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en soap de respuesta.

Elementos del cuerpo de la respuesta

Elemento	Descripción	Tipo de datos
PartialErrors	Matriz de objetos BatchError que contienen detalles de los elementos de solicitud que no se han realizado correctamente. La lista de errores no se corresponde directamente con la lista de elementos de la solicitud. La lista puede estar vacía si no hay errores o puede incluir uno o varios objetos de error correspondientes a cada elemento de lista incorrecto en la solicitud.	Matriz BatchError

Elementos de encabezado de respuesta

Elemento	Descripción	Tipo de datos
Seguimiento del Id.	Identificador de la entrada de registro que contiene los detalles de la llamada API.	string

Solicitud de SOAP

Esta plantilla se generó mediante una herramienta para mostrar el orden del cuerpo y los elementos de encabezado de la solicitud SOAP. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

<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">DeleteAdGroupCriterions</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>
    <DeleteAdGroupCriterionsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AdGroupCriterionIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </AdGroupCriterionIds>
      <AdGroupId>ValueHere</AdGroupId>
      <CriterionType>ValueHere</CriterionType>
    </DeleteAdGroupCriterionsRequest>
  </s:Body>
</s:Envelope>

SOAP de respuesta

Esta plantilla se generó mediante una herramienta para mostrar el orden de los elementos body y header para la respuesta 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>
    <DeleteAdGroupCriterionsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <FieldPath d4p1:nil="false">ValueHere</FieldPath>
          <ForwardCompatibilityMap xmlns:e155="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e155:KeyValuePairOfstringstring>
              <e155:key d4p1:nil="false">ValueHere</e155:key>
              <e155:value d4p1:nil="false">ValueHere</e155:value>
            </e155:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Index>ValueHere</Index>
          <Message d4p1:nil="false">ValueHere</Message>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to EditorialError-->
          <Appealable d4p1:nil="false">ValueHere</Appealable>
          <DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
          <Location d4p1:nil="false">ValueHere</Location>
          <PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
          <ReasonCode>ValueHere</ReasonCode>
        </BatchError>
      </PartialErrors>
    </DeleteAdGroupCriterionsResponse>
  </s:Body>
</s:Envelope>

Sintaxis de código

La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

public async Task<DeleteAdGroupCriterionsResponse> DeleteAdGroupCriterionsAsync(
	IList<long> adGroupCriterionIds,
	long adGroupId,
	AdGroupCriterionType criterionType)
{
	var request = new DeleteAdGroupCriterionsRequest
	{
		AdGroupCriterionIds = adGroupCriterionIds,
		AdGroupId = adGroupId,
		CriterionType = criterionType
	};

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

static DeleteAdGroupCriterionsResponse deleteAdGroupCriterions(
	ArrayOflong adGroupCriterionIds,
	java.lang.Long adGroupId,
	ArrayList<AdGroupCriterionType> criterionType) throws RemoteException, Exception
{
	DeleteAdGroupCriterionsRequest request = new DeleteAdGroupCriterionsRequest();

	request.setAdGroupCriterionIds(adGroupCriterionIds);
	request.setAdGroupId(adGroupId);
	request.setCriterionType(criterionType);

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

static function DeleteAdGroupCriterions(
	$adGroupCriterionIds,
	$adGroupId,
	$criterionType)
{

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

	$request = new DeleteAdGroupCriterionsRequest();

	$request->AdGroupCriterionIds = $adGroupCriterionIds;
	$request->AdGroupId = $adGroupId;
	$request->CriterionType = $criterionType;

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

response=campaignmanagement_service.DeleteAdGroupCriterions(
	AdGroupCriterionIds=AdGroupCriterionIds,
	AdGroupId=AdGroupId,
	CriterionType=CriterionType)

Requisitos

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

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/AdGroupCriterions

https://campaign.api.sandbox.bingads.microsoft.com/CampaignManagement/v13/AdGroupCriterions

Elementos Request

El objeto DeleteAdGroupCriterionsRequest define los elementos body y header de la solicitud de operación de servicio.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento	Descripción	Tipo de datos
AdGroupCriterionIds	Lista de identificadores únicos que identifican los criterios que se van a eliminar. Puede incluir hasta 1000 identificadores de criterio de grupo de anuncios por solicitud.	matriz larga
AdGroupId	Identificador del grupo de anuncios que tiene los criterios que desea eliminar.	largo
CriterionType	Tipo de criterio que se va a eliminar, por ejemplo, página web. Solo puede especificar un valor de tipo de criterio por llamada. Para agregar, eliminar o actualizar criterios de destino, como la edad, el nombre de la empresa, el día y la hora, el dispositivo, el género, el sector, la función de trabajo, la ubicación, la intención de ubicación y los criterios de radio, debe especificar el valor CriterionType como Destinos. Puede agregar, eliminar y actualizar varios tipos de criterio de destino en la misma operación. Para recuperar estos criterios de destino a través de GetAdGroupCriterionsByIds , debe solicitar el tipo específico individualmente, es decir, Age, CompanyName, DayTime, Device, Gender, Industry, JobFunction, Location, LocationIntent y Radius. Para agregar, eliminar o actualizar criterios de audiencia, es decir, audiencias personalizadas, audiencias en el mercado y listas de remarketing, debe especificar el valor CriterionType como Audiencia. Puede agregar, eliminar y actualizar varios tipos de criterio de destino en la misma operación. Para recuperar estos criterios de audiencia a través de GetAdGroupCriterionsByIds , debe solicitar el tipo específico individualmente, es decir, CustomAudience, InMarketAudience, ProductAudience y RemarketingList. No se puede eliminar una productpartition con esta operación. En su lugar, debe usar ApplyProductPartitionActions.	AdGroupCriterionType

Elementos de encabezado de solicitud

Elemento	Descripción	Tipo de datos
Autorización	Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Asegúrese de que el token tiene el prefijo "Portador", esto es necesario para la autenticación adecuada. Para obtener más información, consulte Autenticación con OAuth.	string
CustomerAccountId	Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.	string
CustomerId	Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.	string
DeveloperToken	Token de desarrollador que se usa para acceder a Bing Ads API. Para obtener más información, consulte Obtención de un token de desarrollador.	string
Password	Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario.	string
UserName	Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario.	string

Elementos de respuesta

Elementos del cuerpo de la respuesta

Elemento	Descripción	Tipo de datos
PartialErrors	Matriz de objetos BatchError que contienen detalles de los elementos de solicitud que no se han realizado correctamente. La lista de errores no se corresponde directamente con la lista de elementos de la solicitud. La lista puede estar vacía si no hay errores o puede incluir uno o varios objetos de error correspondientes a cada elemento de lista incorrecto en la solicitud.	Matriz BatchError

Elementos de encabezado de respuesta

Elemento	Descripción	Tipo de datos
Seguimiento del Id.	Identificador de la entrada de registro que contiene los detalles de la llamada API.	string

Solicitud de JSON

Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la solicitud JSON. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

{
  "AdGroupCriterionIds": [
    "LongValueHere"
  ],
  "AdGroupId": "LongValueHere",
  "CriterionType": "ValueHere"
}

JSON de respuesta

Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta JSON.

A continuación se muestra un ejemplo que es aplicable si el tipo de BatchError es EditorialError.

{
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "FieldPath": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Index": IntValueHere,
      "Message": "ValueHere",
      "Type": "EditorialError",
      "Appealable": "ValueHere",
      "DisapprovedText": "ValueHere",
      "Location": "ValueHere",
      "PublisherCountry": "ValueHere",
      "ReasonCode": IntValueHere
    }
  ]
}

Sintaxis de código

Para llamar a la API REST a través de SDK, debe actualizar el SDK a una versión determinada y configurar los parámetros del sistema. La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

public async Task<DeleteAdGroupCriterionsResponse> DeleteAdGroupCriterionsAsync(
	IList<long> adGroupCriterionIds,
	long adGroupId,
	AdGroupCriterionType criterionType)
{
	var request = new DeleteAdGroupCriterionsRequest
	{
		AdGroupCriterionIds = adGroupCriterionIds,
		AdGroupId = adGroupId,
		CriterionType = criterionType
	};

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

static DeleteAdGroupCriterionsResponse deleteAdGroupCriterions(
	ArrayOflong adGroupCriterionIds,
	java.lang.Long adGroupId,
	ArrayList<AdGroupCriterionType> criterionType) throws RemoteException, Exception
{
	DeleteAdGroupCriterionsRequest request = new DeleteAdGroupCriterionsRequest();

	request.setAdGroupCriterionIds(adGroupCriterionIds);
	request.setAdGroupId(adGroupId);
	request.setCriterionType(criterionType);

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

static function DeleteAdGroupCriterions(
	$adGroupCriterionIds,
	$adGroupId,
	$criterionType)
{

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

	$request = new DeleteAdGroupCriterionsRequest();

	$request->AdGroupCriterionIds = $adGroupCriterionIds;
	$request->AdGroupId = $adGroupId;
	$request->CriterionType = $criterionType;

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

response=campaignmanagement_service.DeleteAdGroupCriterions(
	AdGroupCriterionIds=AdGroupCriterionIds,
	AdGroupId=AdGroupId,
	CriterionType=CriterionType)

Compartir a través de

Operación de servicio DeleteAdGroupCriterions: Administración de campañas

Elementos Request

Elementos del cuerpo de la solicitud

Elementos de encabezado de solicitud

Elementos de respuesta

Elementos del cuerpo de la respuesta

Elementos de encabezado de respuesta

Solicitud de SOAP

SOAP de respuesta

Sintaxis de código

Requisitos

Dirección URL de solicitud

Elementos Request

Elementos del cuerpo de la solicitud

Elementos de encabezado de solicitud

Elementos de respuesta

Elementos del cuerpo de la respuesta

Elementos de encabezado de respuesta

Solicitud de JSON

JSON de respuesta

Sintaxis de código

Comentarios

Recursos adicionales