Operação de Serviço GetSharedEntityAssociationsByEntityIds – Gestão de Campanhas
Obtém a lista de palavras-chave negativa para associações de campanha por IDs de campanha ou lista de exclusão de sites para associações de contas de anúncios por IDs de conta de anúncios.
Sugestão
Para obter uma descrição geral, veja os guias técnicos Palavras-chave Negativas e Sites Negativos .
Importante
Apenas os utilizadores da conta de gestor (cliente) que detém uma lista de exclusão de sites (PlacementExclusionList) podem atualizar ou eliminar a lista, adicionar ou eliminar itens de lista e associar a lista a contas de anúncios. Se a sua conta de anúncio estiver associada a uma lista de exclusão de sites da qual não é proprietário, pode desassociar a lista da sua conta, mas os itens de lista e lista são só de leitura. O proprietário da lista é determinado pelo elemento SharedEntityCustomerId da associação.
Se tiver acesso a várias contas de gestor numa hierarquia de contas, os resultados da operação podem variar consoante o elemento de cabeçalho do pedido CustomerId que definiu.
Elementos do Pedido
O objeto GetSharedEntityAssociationsByEntityIdsRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.
Nota
Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.
Elementos do Corpo do Pedido
Elemento | Descrição | Tipo de Dados |
---|---|---|
EntityIds | A lista de identificadores de contas de campanha ou de anúncios. Esta matriz pode conter um máximo de 100 elementos. |
matriz longa |
EntityType | O tipo de entidade correspondente ao elemento EntityIds especificado. Defina este elemento como "Campanha" para obter uma lista de palavras-chave negativa para associações de campanha na biblioteca partilhada da sua conta de anúncio. Defina este elemento como "Conta" para obter a lista de exclusão de sites para associações de contas de anúncios na biblioteca partilhada da sua conta de gestor (cliente). |
cadeia |
SharedEntityScope | Indica se a entidade partilhada está disponível ao nível da conta de anúncio (Conta) ou da conta de gestor (Cliente). Este elemento é opcional e é predefinido como Âmbito da conta . O âmbito da conta de anúncio só é aplicável à lista de palavras-chave negativas às associações de campanha. Defina este elemento como Cliente para obter a lista de exclusão de sites para associações de contas de anúncios na biblioteca partilhada da sua conta de gestor (cliente). |
EntityScope |
SharedEntityType | O tipo de entidade partilhada para obter associações. Defina este elemento como "NegativeKeywordList" para obter uma lista de palavras-chave negativas para associações de campanha na biblioteca partilhada da sua conta de anúncios. Defina este elemento como "PlacementExclusionList" para obter a lista de exclusão de sites para associações de contas de anúncios na biblioteca partilhada da sua conta de gestor (cliente). |
cadeia |
Elementos do Cabeçalho do Pedido
Elemento | Descrição | Tipo de Dados |
---|---|---|
AuthenticationToken | O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth). |
cadeia |
CustomerAccountId | O identificador da conta de anúncio que detém ou está associada às entidades no pedido. Este elemento de cabeçalho tem de ter o mesmo valor que o elemento do corpo AccountId quando ambos são necessários. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente. |
cadeia |
CustomerId | O identificador da conta de gestor (cliente) a partir da qual o utilizador está a aceder ou a operar. Um utilizador pode ter acesso a várias contas de gestor. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente. |
cadeia |
DeveloperToken | O token de programador utilizado para aceder à API de Anúncios do Bing. Para obter mais informações, veja Obter um Token de Programador. |
cadeia |
Palavra-passe | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
Nome de Utilizador | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
Elementos de Resposta
O objeto GetSharedEntityAssociationsByEntityIdsResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.
Elementos do Corpo da Resposta
Elemento | Descrição | Tipo de Dados |
---|---|---|
Associações | Uma matriz de objetos SharedEntityAssociation que corresponde diretamente aos identificadores de entidade que especificou no pedido. Os itens da lista podem ser devolvidos como nulos. Para cada índice de lista em que uma associação não foi obtida, o elemento correspondente será nulo. | Matriz SharedEntityAssociation |
PartialErrors | Uma matriz de objetos BatchError que contêm detalhes para quaisquer itens de pedido que não tenham sido bem-sucedidos. A lista de erros não corresponde diretamente à lista de itens no pedido. A lista pode estar vazia se não existirem erros ou pode incluir um ou mais objetos de erro correspondentes a cada item de lista sem êxito no pedido. |
Matriz BatchError |
Elementos do Cabeçalho de Resposta
Elemento | Descrição | Tipo de Dados |
---|---|---|
TrackingId | O identificador da entrada de registo que contém os detalhes da chamada à API. | cadeia |
Pedir SOAP
Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.
<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 Resposta
Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta 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:e501="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e501:KeyValuePairOfstringstring>
<e501:key d4p1:nil="false">ValueHere</e501:key>
<e501:value d4p1:nil="false">ValueHere</e501:value>
</e501: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>
Sintaxe de Código
A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.
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
Serviço: CampaignManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/CampaignManagement/v13
URL do Pedido
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/SharedEntityAssociations/QueryByEntityIds
Elementos do Pedido
O objeto GetSharedEntityAssociationsByEntityIdsRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço.
Nota
Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.
Elementos do Corpo do Pedido
Elemento | Descrição | Tipo de Dados |
---|---|---|
EntityIds | A lista de identificadores de contas de campanha ou de anúncios. Esta matriz pode conter um máximo de 100 elementos. |
matriz longa |
EntityType | O tipo de entidade correspondente ao elemento EntityIds especificado. Defina este elemento como "Campanha" para obter uma lista de palavras-chave negativa para associações de campanha na biblioteca partilhada da sua conta de anúncio. Defina este elemento como "Conta" para obter a lista de exclusão de sites para associações de contas de anúncios na biblioteca partilhada da sua conta de gestor (cliente). |
cadeia |
SharedEntityScope | Indica se a entidade partilhada está disponível ao nível da conta de anúncio (Conta) ou da conta de gestor (Cliente). Este elemento é opcional e é predefinido como Âmbito da conta . O âmbito da conta de anúncio só é aplicável à lista de palavras-chave negativas às associações de campanha. Defina este elemento como Cliente para obter a lista de exclusão de sites para associações de contas de anúncios na biblioteca partilhada da sua conta de gestor (cliente). |
EntityScope |
SharedEntityType | O tipo de entidade partilhada para obter associações. Defina este elemento como "NegativeKeywordList" para obter uma lista de palavras-chave negativas para associações de campanha na biblioteca partilhada da sua conta de anúncios. Defina este elemento como "PlacementExclusionList" para obter a lista de exclusão de sites para associações de contas de anúncios na biblioteca partilhada da sua conta de gestor (cliente). |
cadeia |
Elementos do Cabeçalho do Pedido
Elemento | Descrição | Tipo de Dados |
---|---|---|
Autorização | O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Certifique-se de que o token tem o prefixo "Portador", que é necessário para uma autenticação adequada. Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth). |
cadeia |
CustomerAccountId | O identificador da conta de anúncio que detém ou está associada às entidades no pedido. Este elemento de cabeçalho tem de ter o mesmo valor que o elemento do corpo AccountId quando ambos são necessários. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente. |
cadeia |
CustomerId | O identificador da conta de gestor (cliente) a partir da qual o utilizador está a aceder ou a operar. Um utilizador pode ter acesso a várias contas de gestor. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente. |
cadeia |
DeveloperToken | O token de programador utilizado para aceder à API de Anúncios do Bing. Para obter mais informações, veja Obter um Token de Programador. |
cadeia |
Palavra-passe | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
Nome de Utilizador | Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. | cadeia |
Elementos de Resposta
O objeto GetSharedEntityAssociationsByEntityIdsResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no JSON de Resposta.
Elementos do Corpo da Resposta
Elemento | Descrição | Tipo de Dados |
---|---|---|
Associações | Uma matriz de objetos SharedEntityAssociation que corresponde diretamente aos identificadores de entidade que especificou no pedido. Os itens da lista podem ser devolvidos como nulos. Para cada índice de lista em que uma associação não foi obtida, o elemento correspondente será nulo. | Matriz SharedEntityAssociation |
PartialErrors | Uma matriz de objetos BatchError que contêm detalhes para quaisquer itens de pedido que não tenham sido bem-sucedidos. A lista de erros não corresponde diretamente à lista de itens no pedido. A lista pode estar vazia se não existirem erros ou pode incluir um ou mais objetos de erro correspondentes a cada item de lista sem êxito no pedido. |
Matriz BatchError |
Elementos do Cabeçalho de Resposta
Elemento | Descrição | Tipo de Dados |
---|---|---|
TrackingId | O identificador da entrada de registo que contém os detalhes da chamada à API. | cadeia |
Pedir JSON
Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho do pedido JSON. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.
{
"EntityIds": [
"LongValueHere"
],
"EntityType": "ValueHere",
"SharedEntityType": "ValueHere",
"SharedEntityScope": "ValueHere"
}
JSON de Resposta
Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho da resposta JSON.
Segue-se um exemplo aplicável se o tipo de BatchError for 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
}
]
}
Sintaxe de Código
Para chamar a API REST através de SDKs, tem de atualizar o SDK para uma determinada versão e configurar os parâmetros do sistema. A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.
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)