Operación de servicio GetLabelAssociationsByEntityIds: Administración de campañas
Obtiene las asociaciones de etiquetas por identificadores de entidad.
El objeto GetLabelAssociationsByEntityIdsRequest 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.
Elemento | Descripción | Tipo de datos |
---|---|---|
EntityIds | Lista de identificadores de entidad que se usan para solicitar asociaciones de etiquetas. El tamaño máximo de la lista es de 100 elementos por solicitud de servicio. |
matriz larga |
EntityType | Filtra las asociaciones devueltas por tipo de entidad. Los valores de tipo de entidad admitidos son Campaign, AdGroup, Ad y Keyword. |
EntityType |
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 |
El objeto GetLabelAssociationsByEntityIdsResponse 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.
Elemento | Descripción | Tipo de datos |
---|---|---|
EtiquetaSociaciones | Matriz de asociaciones de etiquetas. Para cada identificador de entidad especificado en la solicitud, se devuelven cero o más objetos LabelAssociation . Mientras que el orden de los objetos LabelAssociation devueltos está garantizado en el orden de los identificadores de entidad solicitados, tenga en cuenta que se pueden devolver varios objetos LabelAssociation para el mismo identificador de entidad. |
Matriz LabelAssociation |
PartialErrors | Matriz de objetos BatchError que contienen detalles de las asociaciones que no se recuperaron correctamente. La lista de errores corresponde directamente a la lista de asociaciones de la solicitud. Los elementos de la lista se pueden devolver como null. Para cada índice de lista en el que se recuperó correctamente una asociación, el elemento de error correspondiente será null. Idealmente, todas las asociaciones se recuperan correctamente y todos los elementos de esta lista son null. |
Matriz BatchError |
Elemento | Descripción | Tipo de datos |
---|---|---|
Seguimiento del Id. | Identificador de la entrada de registro que contiene los detalles de la llamada API. | string |
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">GetLabelAssociationsByEntityIds</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>
<GetLabelAssociationsByEntityIdsRequest 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>ValueHere</EntityType>
</GetLabelAssociationsByEntityIdsRequest>
</s:Body>
</s:Envelope>
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>
<GetLabelAssociationsByEntityIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<LabelAssociations d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<LabelAssociation>
<EntityId>ValueHere</EntityId>
<LabelId>ValueHere</LabelId>
</LabelAssociation>
</LabelAssociations>
<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:e329="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e329:KeyValuePairOfstringstring>
<e329:key d4p1:nil="false">ValueHere</e329:key>
<e329:value d4p1:nil="false">ValueHere</e329:value>
</e329: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>
</GetLabelAssociationsByEntityIdsResponse>
</s:Body>
</s:Envelope>
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<GetLabelAssociationsByEntityIdsResponse> GetLabelAssociationsByEntityIdsAsync(
IList<long> entityIds,
EntityType entityType)
{
var request = new GetLabelAssociationsByEntityIdsRequest
{
EntityIds = entityIds,
EntityType = entityType
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetLabelAssociationsByEntityIdsAsync(r), request));
}
static GetLabelAssociationsByEntityIdsResponse getLabelAssociationsByEntityIds(
ArrayOflong entityIds,
EntityType entityType) throws RemoteException, Exception
{
GetLabelAssociationsByEntityIdsRequest request = new GetLabelAssociationsByEntityIdsRequest();
request.setEntityIds(entityIds);
request.setEntityType(entityType);
return CampaignManagementService.getService().getLabelAssociationsByEntityIds(request);
}
static function GetLabelAssociationsByEntityIds(
$entityIds,
$entityType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetLabelAssociationsByEntityIdsRequest();
$request->EntityIds = $entityIds;
$request->EntityType = $entityType;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetLabelAssociationsByEntityIds($request);
}
response=campaignmanagement_service.GetLabelAssociationsByEntityIds(
EntityIds=EntityIds,
EntityType=EntityType)
Servicio: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/LabelAssociations/QueryByEntityIds
El objeto GetLabelAssociationsByEntityIdsRequest 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.
Elemento | Descripción | Tipo de datos |
---|---|---|
EntityIds | Lista de identificadores de entidad que se usan para solicitar asociaciones de etiquetas. El tamaño máximo de la lista es de 100 elementos por solicitud de servicio. |
matriz larga |
EntityType | Filtra las asociaciones devueltas por tipo de entidad. Los valores de tipo de entidad admitidos son Campaign, AdGroup, Ad y Keyword. |
EntityType |
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 |
El objeto GetLabelAssociationsByEntityIdsResponse 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.
Elemento | Descripción | Tipo de datos |
---|---|---|
EtiquetaSociaciones | Matriz de asociaciones de etiquetas. Para cada identificador de entidad especificado en la solicitud, se devuelven cero o más objetos LabelAssociation . Mientras que el orden de los objetos LabelAssociation devueltos está garantizado en el orden de los identificadores de entidad solicitados, tenga en cuenta que se pueden devolver varios objetos LabelAssociation para el mismo identificador de entidad. |
Matriz LabelAssociation |
PartialErrors | Matriz de objetos BatchError que contienen detalles de las asociaciones que no se recuperaron correctamente. La lista de errores corresponde directamente a la lista de asociaciones de la solicitud. Los elementos de la lista se pueden devolver como null. Para cada índice de lista en el que se recuperó correctamente una asociación, el elemento de error correspondiente será null. Idealmente, todas las asociaciones se recuperan correctamente y todos los elementos de esta lista son null. |
Matriz BatchError |
Elemento | Descripción | Tipo de datos |
---|---|---|
Seguimiento del Id. | Identificador de la entrada de registro que contiene los detalles de la llamada API. | string |
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"
}
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.
{
"LabelAssociations": [
{
"EntityId": "LongValueHere",
"LabelId": "LongValueHere"
}
],
"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
}
]
}
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<GetLabelAssociationsByEntityIdsResponse> GetLabelAssociationsByEntityIdsAsync(
IList<long> entityIds,
EntityType entityType)
{
var request = new GetLabelAssociationsByEntityIdsRequest
{
EntityIds = entityIds,
EntityType = entityType
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetLabelAssociationsByEntityIdsAsync(r), request));
}
static GetLabelAssociationsByEntityIdsResponse getLabelAssociationsByEntityIds(
ArrayOflong entityIds,
EntityType entityType) throws RemoteException, Exception
{
GetLabelAssociationsByEntityIdsRequest request = new GetLabelAssociationsByEntityIdsRequest();
request.setEntityIds(entityIds);
request.setEntityType(entityType);
return CampaignManagementService.getService().getLabelAssociationsByEntityIds(request);
}
static function GetLabelAssociationsByEntityIds(
$entityIds,
$entityType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetLabelAssociationsByEntityIdsRequest();
$request->EntityIds = $entityIds;
$request->EntityType = $entityType;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetLabelAssociationsByEntityIds($request);
}
response=campaignmanagement_service.GetLabelAssociationsByEntityIds(
EntityIds=EntityIds,
EntityType=EntityType)