Operação de Serviço GetSharedEntities – Gestão de Campanhas
Obtém listas de palavras-chave negativas ou listas de exclusão de sites.
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 GetSharedEntitiesRequest 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 |
|---|---|---|
| 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 a listas de palavras-chave negativas. Defina este elemento como Cliente para obter listas de exclusão de sites na biblioteca partilhada da sua conta de gestor (cliente). |
EntityScope |
| SharedEntityType | O tipo de entidade partilhada a obter a partir da biblioteca da conta de anúncio ou da conta de gestor (cliente). Defina este elemento como NegativeKeywordList para obter listas de palavras-chave negativas (NegativeKeywordList) na biblioteca partilhada da sua conta de anúncios. Defina este elemento como PlacementExclusionList para obter listas de exclusão de sites (PlacementExclusionList) 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 GetSharedEntitiesResponse 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 |
|---|---|---|
| Entidades Partilhadas | As listas de palavras-chave negativas ou listas de exclusão de sites. | Matriz SharedEntity |
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">GetSharedEntities</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>
<GetSharedEntitiesRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<SharedEntityType i:nil="false">ValueHere</SharedEntityType>
<SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
</GetSharedEntitiesRequest>
</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>
<GetSharedEntitiesResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<SharedEntities d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<SharedEntity d4p1:type="-- derived type specified here with the appropriate prefix --">
<AssociationCount d4p1:nil="false">ValueHere</AssociationCount>
<ForwardCompatibilityMap xmlns:e166="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e166:KeyValuePairOfstringstring>
<e166:key d4p1:nil="false">ValueHere</e166:key>
<e166:value d4p1:nil="false">ValueHere</e166:value>
</e166:KeyValuePairOfstringstring>
</ForwardCompatibilityMap>
<Id d4p1:nil="false">ValueHere</Id>
<Name d4p1:nil="false">ValueHere</Name>
<Type d4p1:nil="false">ValueHere</Type>
<!--This field is applicable if the derived type attribute is set to SharedList-->
<ItemCount d4p1:nil="false">ValueHere</ItemCount>
</SharedEntity>
</SharedEntities>
</GetSharedEntitiesResponse>
</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<GetSharedEntitiesResponse> GetSharedEntitiesAsync(
string sharedEntityType,
EntityScope? sharedEntityScope)
{
var request = new GetSharedEntitiesRequest
{
SharedEntityType = sharedEntityType,
SharedEntityScope = sharedEntityScope
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetSharedEntitiesAsync(r), request));
}
static GetSharedEntitiesResponse getSharedEntities(
java.lang.String sharedEntityType,
EntityScope sharedEntityScope) throws RemoteException, Exception
{
GetSharedEntitiesRequest request = new GetSharedEntitiesRequest();
request.setSharedEntityType(sharedEntityType);
request.setSharedEntityScope(sharedEntityScope);
return CampaignManagementService.getService().getSharedEntities(request);
}
static function GetSharedEntities(
$sharedEntityType,
$sharedEntityScope)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetSharedEntitiesRequest();
$request->SharedEntityType = $sharedEntityType;
$request->SharedEntityScope = $sharedEntityScope;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetSharedEntities($request);
}
response=campaignmanagement_service.GetSharedEntities(
SharedEntityType=SharedEntityType,
SharedEntityScope=SharedEntityScope)
Requisitos
Serviço: CampaignManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/CampaignManagement/v13