Compartir a través de

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

  • Artículo

Obtiene las palabras clave negativas de una lista de palabras clave negativas o sitios negativos de una lista de exclusión de sitios web.

La operación solo se usa para palabras clave negativas y sitios negativos a través de listas compartidas. Para obtener palabras clave negativas que se asignan directamente a campañas o grupos de anuncios, consulte GetNegativeKeywordsByEntityIds. Para obtener sitios negativos que se asignan directamente a campañas o grupos de anuncios, vea GetNegativeSitesByCampaignIds y GetNegativeSitesByAdGroupIds.

Sugerencia

Para obtener información general, consulte las guías técnicas Palabras clave negativas y Sitios negativos .

Importante

Solo los usuarios de la cuenta de administrador (cliente) propietaria de una lista de exclusión del sitio web (PlacementExclusionList) pueden actualizar o eliminar la lista, agregar o eliminar elementos de lista y asociar la lista a cuentas de anuncios. Si su cuenta publicitaria está asociada a una lista de exclusión del sitio web que no posee, puede desasociar la lista de su cuenta, pero la lista y los elementos de lista son de solo lectura. El propietario de la lista viene determinado por el elemento SharedEntityCustomerId de la asociación.

Si tiene acceso a varias cuentas de administrador en una jerarquía de cuentas, los resultados de la operación pueden variar en función del elemento de encabezado de solicitud CustomerId que establezca.

Elementos Request

El objeto GetListItemsBySharedListRequest 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
SharedEntityScope Indica si la entidad compartida está disponible en el nivel de cuenta de anuncio (cuenta) o de administrador (cliente).

Este elemento es opcional y el valor predeterminado es Ámbito de cuenta . El ámbito de la cuenta de anuncios solo es aplicable a las listas de palabras clave negativas.

Establezca este elemento en Customer para obtener los sitios negativos de una lista de exclusión de sitios web en la biblioteca compartida de la cuenta de administrador (cliente).		 EntityScope
SharedList Lista de palabras clave negativas o lista de exclusión de sitios web.

Si SharedEntityScope está vacío o está establecido en Cuenta, y si SharedList es negativeKeywordList, los elementos de lista devueltos serán objetos de palabra clave negativa (NegativeKeyword).

Si SharedEntityScope se establece en Customer y SharedList es PlacementExclusionList, los elementos de lista devueltos serán objetos de sitio negativos (NegativeSite).

Debe incluir el identificador de SharedList al realizar la solicitud de servicio.		 SharedList

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 GetListItemsBySharedListResponse 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
ListItems Lista de palabras clave negativas o sitios negativos.

Si no existe ningún elemento de lista en la lista compartida, se devuelve una matriz vacía.		 Matriz SharedListItem

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">GetListItemsBySharedList</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>
    <GetListItemsBySharedListRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <SharedList i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
        <ItemCount i:nil="false">ValueHere</ItemCount>
        <!--No additional fields are applicable if the derived type attribute is set to NegativeKeywordList-->
        <!--No additional fields are applicable if the derived type attribute is set to PlacementExclusionList-->
        <!--No additional fields are applicable if the derived type attribute is set to AccountNegativeKeywordList-->
        <!--No additional fields are applicable if the derived type attribute is set to BrandList-->
      </SharedList>
      <SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
    </GetListItemsBySharedListRequest>
  </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>
    <GetListItemsBySharedListResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ListItems d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <SharedListItem d4p1:type="-- derived type specified here with the appropriate prefix --">
          <ForwardCompatibilityMap xmlns:e335="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e335:KeyValuePairOfstringstring>
              <e335:key d4p1:nil="false">ValueHere</e335:key>
              <e335:value d4p1:nil="false">ValueHere</e335:value>
            </e335:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to NegativeKeyword-->
          <Id d4p1:nil="false">ValueHere</Id>
          <MatchType d4p1:nil="false">ValueHere</MatchType>
          <Text d4p1:nil="false">ValueHere</Text>
          <!--These fields are applicable if the derived type attribute is set to NegativeSite-->
          <Id d4p1:nil="false">ValueHere</Id>
          <Url d4p1:nil="false">ValueHere</Url>
          <!--This field is applicable if the derived type attribute is set to BrandItem-->
          <BrandId>ValueHere</BrandId>
        </SharedListItem>
      </ListItems>
    </GetListItemsBySharedListResponse>
  </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<GetListItemsBySharedListResponse> GetListItemsBySharedListAsync(
	SharedList sharedList,
	EntityScope? sharedEntityScope)
{
	var request = new GetListItemsBySharedListRequest
	{
		SharedList = sharedList,
		SharedEntityScope = sharedEntityScope
	};

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

static GetListItemsBySharedListResponse getListItemsBySharedList(
	SharedList sharedList,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	GetListItemsBySharedListRequest request = new GetListItemsBySharedListRequest();

	request.setSharedList(sharedList);
	request.setSharedEntityScope(sharedEntityScope);

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

static function GetListItemsBySharedList(
	$sharedList,
	$sharedEntityScope)
{

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

	$request = new GetListItemsBySharedListRequest();

	$request->SharedList = $sharedList;
	$request->SharedEntityScope = $sharedEntityScope;

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

response=campaignmanagement_service.GetListItemsBySharedList(
	SharedList=SharedList,
	SharedEntityScope=SharedEntityScope)

Requisitos

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

Dirección URL de solicitud

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/ListItems/QueryBySharedList

Elementos Request

El objeto GetListItemsBySharedListRequest 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
SharedEntityScope Indica si la entidad compartida está disponible en el nivel de cuenta de anuncio (cuenta) o de administrador (cliente).

Este elemento es opcional y el valor predeterminado es Ámbito de cuenta . El ámbito de la cuenta de anuncios solo es aplicable a las listas de palabras clave negativas.

Establezca este elemento en Customer para obtener los sitios negativos de una lista de exclusión de sitios web en la biblioteca compartida de la cuenta de administrador (cliente).		 EntityScope
SharedList Lista de palabras clave negativas o lista de exclusión de sitios web.

Si SharedEntityScope está vacío o está establecido en Cuenta, y si SharedList es negativeKeywordList, los elementos de lista devueltos serán objetos de palabra clave negativa (NegativeKeyword).

Si SharedEntityScope se establece en Customer y SharedList es PlacementExclusionList, los elementos de lista devueltos serán objetos de sitio negativos (NegativeSite).

Debe incluir el identificador de SharedList al realizar la solicitud de servicio.		 SharedList

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

El objeto GetListItemsBySharedListResponse 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 el JSON de respuesta.

Elementos del cuerpo de la respuesta

Elemento Descripción Tipo de datos
ListItems Lista de palabras clave negativas o sitios negativos.

Si no existe ningún elemento de lista en la lista compartida, se devuelve una matriz vacía.		 Matriz SharedListItem

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.

{
  "SharedList": {
    "ItemCount": IntValueHere
  },
  "SharedEntityScope": "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 SharedListItem es BrandItem.

{
  "ListItems": [
    {
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Type": "BrandItem",
      "BrandId": "LongValueHere"
    }
  ]
}

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<GetListItemsBySharedListResponse> GetListItemsBySharedListAsync(
	SharedList sharedList,
	EntityScope? sharedEntityScope)
{
	var request = new GetListItemsBySharedListRequest
	{
		SharedList = sharedList,
		SharedEntityScope = sharedEntityScope
	};

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

static GetListItemsBySharedListResponse getListItemsBySharedList(
	SharedList sharedList,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	GetListItemsBySharedListRequest request = new GetListItemsBySharedListRequest();

	request.setSharedList(sharedList);
	request.setSharedEntityScope(sharedEntityScope);

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

static function GetListItemsBySharedList(
	$sharedList,
	$sharedEntityScope)
{

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

	$request = new GetListItemsBySharedListRequest();

	$request->SharedList = $sharedList;
	$request->SharedEntityScope = $sharedEntityScope;

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

response=campaignmanagement_service.GetListItemsBySharedList(
	SharedList=SharedList,
	SharedEntityScope=SharedEntityScope)