GetSharedEntityAssociationsByEntityIds Service Operation - Campaign Management
Obtiene la lista de palabras clave negativas a las asociaciones de campaña por identificadores de campaña o lista de exclusión del sitio web a las asociaciones de cuentas publicitarias por identificadores de cuenta de anuncios.
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 GetSharedEntityAssociationsByEntityIdsRequest 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 |
|---|---|---|
| EntityIds | Lista de identificadores de campañas o cuentas publicitarias. Esta matriz puede contener un máximo de 100 elementos. |
matriz larga |
| EntityType | Tipo de entidad correspondiente al elemento EntityIds especificado. Establezca este elemento en "Campaign" para obtener una lista de palabras clave negativas en las asociaciones de campaña de la biblioteca compartida de la cuenta de anuncios. Establezca este elemento en "Cuenta" para obtener la lista de exclusión del sitio web en asociaciones de cuentas publicitarias en la biblioteca compartida de la cuenta de administrador (cliente). |
string |
| 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 publicitaria solo se aplica para la lista de palabras clave negativas a las asociaciones de campaña. Establezca este elemento en Cliente para obtener la lista de exclusión del sitio web en asociaciones de cuentas publicitarias en la biblioteca compartida de la cuenta de administrador (cliente). |
EntityScope |
| SharedEntityType | Tipo de entidad compartida para obtener asociaciones. Establezca este elemento en "NegativeKeywordList" para obtener una lista de palabras clave negativas en las asociaciones de campaña de la biblioteca compartida de la cuenta de anuncios. Establezca este elemento en "PlacementExclusionList" para obtener la lista de exclusión del sitio web en asociaciones de cuentas publicitarias en la biblioteca compartida de la cuenta de administrador (cliente). |
string |
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 GetSharedEntityAssociationsByEntityIdsResponse 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 |
|---|---|---|
| Asociaciones | Matriz de objetos SharedEntityAssociation que corresponde directamente a los identificadores de entidad especificados en la solicitud. Los elementos de la lista se pueden devolver como null. Para cada índice de lista en el que no se recuperó una asociación, el elemento correspondiente será null. | Matriz SharedEntityAssociation |
| 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">GetSharedEntityAssociationsByEntityIds</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>
<GetSharedEntityAssociationsByEntityIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<EntityIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</EntityIds>
<EntityType i:nil="false">ValueHere</EntityType>
<SharedEntityType i:nil="false">ValueHere</SharedEntityType>
<SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
</GetSharedEntityAssociationsByEntityIdsRequest>
</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>
<GetSharedEntityAssociationsByEntityIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Associations d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<SharedEntityAssociation>
<EntityId>ValueHere</EntityId>
<EntityType d4p1:nil="false">ValueHere</EntityType>
<SharedEntityCustomerId d4p1:nil="false">ValueHere</SharedEntityCustomerId>
<SharedEntityId>ValueHere</SharedEntityId>
<SharedEntityType d4p1:nil="false">ValueHere</SharedEntityType>
</SharedEntityAssociation>
</Associations>
<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:e355="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e355:KeyValuePairOfstringstring>
<e355:key d4p1:nil="false">ValueHere</e355:key>
<e355:value d4p1:nil="false">ValueHere</e355:value>
</e355: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>
</GetSharedEntityAssociationsByEntityIdsResponse>
</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<GetSharedEntityAssociationsByEntityIdsResponse> GetSharedEntityAssociationsByEntityIdsAsync(
IList<long> entityIds,
string entityType,
string sharedEntityType,
EntityScope? sharedEntityScope)
{
var request = new GetSharedEntityAssociationsByEntityIdsRequest
{
EntityIds = entityIds,
EntityType = entityType,
SharedEntityType = sharedEntityType,
SharedEntityScope = sharedEntityScope
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetSharedEntityAssociationsByEntityIdsAsync(r), request));
}
static GetSharedEntityAssociationsByEntityIdsResponse getSharedEntityAssociationsByEntityIds(
ArrayOflong entityIds,
java.lang.String entityType,
java.lang.String sharedEntityType,
EntityScope sharedEntityScope) throws RemoteException, Exception
{
GetSharedEntityAssociationsByEntityIdsRequest request = new GetSharedEntityAssociationsByEntityIdsRequest();
request.setEntityIds(entityIds);
request.setEntityType(entityType);
request.setSharedEntityType(sharedEntityType);
request.setSharedEntityScope(sharedEntityScope);
return CampaignManagementService.getService().getSharedEntityAssociationsByEntityIds(request);
}
static function GetSharedEntityAssociationsByEntityIds(
$entityIds,
$entityType,
$sharedEntityType,
$sharedEntityScope)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetSharedEntityAssociationsByEntityIdsRequest();
$request->EntityIds = $entityIds;
$request->EntityType = $entityType;
$request->SharedEntityType = $sharedEntityType;
$request->SharedEntityScope = $sharedEntityScope;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetSharedEntityAssociationsByEntityIds($request);
}
response=campaignmanagement_service.GetSharedEntityAssociationsByEntityIds(
EntityIds=EntityIds,
EntityType=EntityType,
SharedEntityType=SharedEntityType,
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/SharedEntityAssociations/QueryByEntityIds
Elementos Request
El objeto GetSharedEntityAssociationsByEntityIdsRequest 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 |
|---|---|---|
| EntityIds | Lista de identificadores de campañas o cuentas publicitarias. Esta matriz puede contener un máximo de 100 elementos. |
matriz larga |
| EntityType | Tipo de entidad correspondiente al elemento EntityIds especificado. Establezca este elemento en "Campaign" para obtener una lista de palabras clave negativas en las asociaciones de campaña de la biblioteca compartida de la cuenta de anuncios. Establezca este elemento en "Cuenta" para obtener la lista de exclusión del sitio web en asociaciones de cuentas publicitarias en la biblioteca compartida de la cuenta de administrador (cliente). |
string |
| 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 publicitaria solo se aplica para la lista de palabras clave negativas a las asociaciones de campaña. Establezca este elemento en Cliente para obtener la lista de exclusión del sitio web en asociaciones de cuentas publicitarias en la biblioteca compartida de la cuenta de administrador (cliente). |
EntityScope |
| SharedEntityType | Tipo de entidad compartida para obtener asociaciones. Establezca este elemento en "NegativeKeywordList" para obtener una lista de palabras clave negativas en las asociaciones de campaña de la biblioteca compartida de la cuenta de anuncios. Establezca este elemento en "PlacementExclusionList" para obtener la lista de exclusión del sitio web en asociaciones de cuentas publicitarias en la biblioteca compartida de la cuenta de administrador (cliente). |
string |
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 GetSharedEntityAssociationsByEntityIdsResponse 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 |
|---|---|---|
| Asociaciones | Matriz de objetos SharedEntityAssociation que corresponde directamente a los identificadores de entidad especificados en la solicitud. Los elementos de la lista se pueden devolver como null. Para cada índice de lista en el que no se recuperó una asociación, el elemento correspondiente será null. | Matriz SharedEntityAssociation |
| 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.
{
"EntityIds": [
"LongValueHere"
],
"EntityType": "ValueHere",
"SharedEntityType": "ValueHere",
"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 BatchError es EditorialError.
{
"Associations": [
{
"EntityId": "LongValueHere",
"EntityType": "ValueHere",
"SharedEntityCustomerId": "LongValueHere",
"SharedEntityId": "LongValueHere",
"SharedEntityType": "ValueHere"
}
],
"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<GetSharedEntityAssociationsByEntityIdsResponse> GetSharedEntityAssociationsByEntityIdsAsync(
IList<long> entityIds,
string entityType,
string sharedEntityType,
EntityScope? sharedEntityScope)
{
var request = new GetSharedEntityAssociationsByEntityIdsRequest
{
EntityIds = entityIds,
EntityType = entityType,
SharedEntityType = sharedEntityType,
SharedEntityScope = sharedEntityScope
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetSharedEntityAssociationsByEntityIdsAsync(r), request));
}
static GetSharedEntityAssociationsByEntityIdsResponse getSharedEntityAssociationsByEntityIds(
ArrayOflong entityIds,
java.lang.String entityType,
java.lang.String sharedEntityType,
EntityScope sharedEntityScope) throws RemoteException, Exception
{
GetSharedEntityAssociationsByEntityIdsRequest request = new GetSharedEntityAssociationsByEntityIdsRequest();
request.setEntityIds(entityIds);
request.setEntityType(entityType);
request.setSharedEntityType(sharedEntityType);
request.setSharedEntityScope(sharedEntityScope);
return CampaignManagementService.getService().getSharedEntityAssociationsByEntityIds(request);
}
static function GetSharedEntityAssociationsByEntityIds(
$entityIds,
$entityType,
$sharedEntityType,
$sharedEntityScope)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetSharedEntityAssociationsByEntityIdsRequest();
$request->EntityIds = $entityIds;
$request->EntityType = $entityType;
$request->SharedEntityType = $sharedEntityType;
$request->SharedEntityScope = $sharedEntityScope;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetSharedEntityAssociationsByEntityIds($request);
}
response=campaignmanagement_service.GetSharedEntityAssociationsByEntityIds(
EntityIds=EntityIds,
EntityType=EntityType,
SharedEntityType=SharedEntityType,
SharedEntityScope=SharedEntityScope)