Operación del servicio GetEditorialReasonsByIds: Administración de campañas
Obtiene los motivos por los que las entidades especificadas no pudieron revisar editorialmente y si el problema es atractivo.
Elementos Request
El objeto GetEditorialReasonsByIdsRequest 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 |
|---|---|---|
| AccountId | Identificador de la cuenta que contiene las entidades especificadas. | largo |
| EntityIdToParentIdAssociations | Lista de objetos EntityIdToParentIdAssociation que contienen el identificador único del sistema de una entidad, como el anuncio o la palabra clave, y el identificador de su elemento primario. Un grupo de anuncios es el elemento primario de un anuncio o palabra clave. La lista debe incluir todos los anuncios o todas las palabras clave que no se pudieron revisar editorialmente. La lista no puede incluir una combinación de anuncios y palabras clave. La lista puede contener un máximo de 1000 identificadores. |
Matriz EntityIdToParentIdAssociation |
| EntityType | Tipo de entidades que contiene la lista de entidades. Los valores de tipo de entidad admitidos son Ad y Keyword. |
EntityType |
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 GetEditorialReasonsByIdsResponse 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 |
|---|---|---|
| EditorialReasons | Matriz de objetos EditorialReasonCollection que corresponde directamente a los objetos EntityIdToParentIdAssociation especificados en la solicitud. Cada objeto identifica el motivo del error y si es atractivo. Los elementos de la lista se pueden devolver como null. Para cada índice de lista en el que no se recuperó EditorialReasonCollection , el elemento correspondiente será null. Si la entidad no ha producido un error en la revisión editorial, el elemento correspondiente de esta colección es NULL. Además, el elemento será NULL si el identificador de anuncio o palabra clave especificado no es válido. |
Matriz EditorialReasonCollection |
| 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">GetEditorialReasonsByIds</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>
<GetEditorialReasonsByIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<AccountId>ValueHere</AccountId>
<EntityIdToParentIdAssociations i:nil="false">
<EntityIdToParentIdAssociation>
<EntityId>ValueHere</EntityId>
<ParentId>ValueHere</ParentId>
</EntityIdToParentIdAssociation>
</EntityIdToParentIdAssociations>
<EntityType>ValueHere</EntityType>
</GetEditorialReasonsByIdsRequest>
</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>
<GetEditorialReasonsByIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<EditorialReasons d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<EditorialReasonCollection>
<AdGroupId>ValueHere</AdGroupId>
<AdOrKeywordId>ValueHere</AdOrKeywordId>
<AppealStatus>ValueHere</AppealStatus>
<Reasons d4p1:nil="false">
<EditorialReason>
<Location d4p1:nil="false">ValueHere</Location>
<PublisherCountries d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:string>ValueHere</a1:string>
</PublisherCountries>
<ReasonCode>ValueHere</ReasonCode>
<Term d4p1:nil="false">ValueHere</Term>
</EditorialReason>
</Reasons>
</EditorialReasonCollection>
</EditorialReasons>
<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:e305="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e305:KeyValuePairOfstringstring>
<e305:key d4p1:nil="false">ValueHere</e305:key>
<e305:value d4p1:nil="false">ValueHere</e305:value>
</e305: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>
</GetEditorialReasonsByIdsResponse>
</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<GetEditorialReasonsByIdsResponse> GetEditorialReasonsByIdsAsync(
long accountId,
IList<EntityIdToParentIdAssociation> entityIdToParentIdAssociations,
EntityType entityType)
{
var request = new GetEditorialReasonsByIdsRequest
{
AccountId = accountId,
EntityIdToParentIdAssociations = entityIdToParentIdAssociations,
EntityType = entityType
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetEditorialReasonsByIdsAsync(r), request));
}
static GetEditorialReasonsByIdsResponse getEditorialReasonsByIds(
java.lang.Long accountId,
ArrayOfEntityIdToParentIdAssociation entityIdToParentIdAssociations,
EntityType entityType) throws RemoteException, Exception
{
GetEditorialReasonsByIdsRequest request = new GetEditorialReasonsByIdsRequest();
request.setAccountId(accountId);
request.setEntityIdToParentIdAssociations(entityIdToParentIdAssociations);
request.setEntityType(entityType);
return CampaignManagementService.getService().getEditorialReasonsByIds(request);
}
static function GetEditorialReasonsByIds(
$accountId,
$entityIdToParentIdAssociations,
$entityType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetEditorialReasonsByIdsRequest();
$request->AccountId = $accountId;
$request->EntityIdToParentIdAssociations = $entityIdToParentIdAssociations;
$request->EntityType = $entityType;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetEditorialReasonsByIds($request);
}
response=campaignmanagement_service.GetEditorialReasonsByIds(
AccountId=AccountId,
EntityIdToParentIdAssociations=EntityIdToParentIdAssociations,
EntityType=EntityType)
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/EditorialReasons/QueryByIds
Elementos Request
El objeto GetEditorialReasonsByIdsRequest 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 |
|---|---|---|
| AccountId | Identificador de la cuenta que contiene las entidades especificadas. | largo |
| EntityIdToParentIdAssociations | Lista de objetos EntityIdToParentIdAssociation que contienen el identificador único del sistema de una entidad, como el anuncio o la palabra clave, y el identificador de su elemento primario. Un grupo de anuncios es el elemento primario de un anuncio o palabra clave. La lista debe incluir todos los anuncios o todas las palabras clave que no se pudieron revisar editorialmente. La lista no puede incluir una combinación de anuncios y palabras clave. La lista puede contener un máximo de 1000 identificadores. |
Matriz EntityIdToParentIdAssociation |
| EntityType | Tipo de entidades que contiene la lista de entidades. Los valores de tipo de entidad admitidos son Ad y Keyword. |
EntityType |
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 GetEditorialReasonsByIdsResponse 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 |
|---|---|---|
| EditorialReasons | Matriz de objetos EditorialReasonCollection que corresponde directamente a los objetos EntityIdToParentIdAssociation especificados en la solicitud. Cada objeto identifica el motivo del error y si es atractivo. Los elementos de la lista se pueden devolver como null. Para cada índice de lista en el que no se recuperó EditorialReasonCollection , el elemento correspondiente será null. Si la entidad no ha producido un error en la revisión editorial, el elemento correspondiente de esta colección es NULL. Además, el elemento será NULL si el identificador de anuncio o palabra clave especificado no es válido. |
Matriz EditorialReasonCollection |
| 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.
{
"AccountId": "LongValueHere",
"EntityIdToParentIdAssociations": [
{
"EntityId": "LongValueHere",
"ParentId": "LongValueHere"
}
],
"EntityType": "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.
{
"EditorialReasons": [
{
"AdGroupId": "LongValueHere",
"AdOrKeywordId": "LongValueHere",
"AppealStatus": "ValueHere",
"Reasons": [
{
"Location": "ValueHere",
"PublisherCountries": [
"ValueHere"
],
"ReasonCode": IntValueHere,
"Term": "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<GetEditorialReasonsByIdsResponse> GetEditorialReasonsByIdsAsync(
long accountId,
IList<EntityIdToParentIdAssociation> entityIdToParentIdAssociations,
EntityType entityType)
{
var request = new GetEditorialReasonsByIdsRequest
{
AccountId = accountId,
EntityIdToParentIdAssociations = entityIdToParentIdAssociations,
EntityType = entityType
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetEditorialReasonsByIdsAsync(r), request));
}
static GetEditorialReasonsByIdsResponse getEditorialReasonsByIds(
java.lang.Long accountId,
ArrayOfEntityIdToParentIdAssociation entityIdToParentIdAssociations,
EntityType entityType) throws RemoteException, Exception
{
GetEditorialReasonsByIdsRequest request = new GetEditorialReasonsByIdsRequest();
request.setAccountId(accountId);
request.setEntityIdToParentIdAssociations(entityIdToParentIdAssociations);
request.setEntityType(entityType);
return CampaignManagementService.getService().getEditorialReasonsByIds(request);
}
static function GetEditorialReasonsByIds(
$accountId,
$entityIdToParentIdAssociations,
$entityType)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetEditorialReasonsByIdsRequest();
$request->AccountId = $accountId;
$request->EntityIdToParentIdAssociations = $entityIdToParentIdAssociations;
$request->EntityType = $entityType;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetEditorialReasonsByIds($request);
}
response=campaignmanagement_service.GetEditorialReasonsByIds(
AccountId=AccountId,
EntityIdToParentIdAssociations=EntityIdToParentIdAssociations,
EntityType=EntityType)