Operação do Serviço SearchCompanies - Gestão de Campanhas

Artigo
12/21/2023

Procure dados de perfil por nome da empresa.

Cada Empresa devolvida inclui um identificador de perfil que pode utilizar com ProfileCriterion.

Nota

Pode utilizar a operação GetProfileDataFileUrl para obter dados do perfil da função da indústria e da tarefa.

Elementos do Pedido

O objeto SearchCompaniesRequest 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
CompanyNameFilter	A cadeia de filtro do nome da empresa. Pode procurar com o nome parcial ou completo da empresa. O comprimento mínimo da cadeia é 3. O serviço procura a cadeia em todas as regiões de idiomas. O nome da empresa será devolvido na LanguageLocale pedida, se disponível.	cadeia
LanguageLocale	O idioma e a região dos nomes a apresentar do perfil. Os valores de região de idioma suportados são zh-Hant (chinês tradicional), en (inglês), fr (francês), de (alemão), it (italiano), pt-BR (português brasileiro) e es (espanhol). Tenha em atenção que se o LinkedIn não fornecer o nome do perfil localizado, será predefinido para o nome universal (normalmente definido em inglês).	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 SearchCompaniesResponse 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
Empresas	A lista de empresas que correspondem ao filtro de nome da empresa pedido.	Matriz da empresa

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">SearchCompanies</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>
    <SearchCompaniesRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <CompanyNameFilter i:nil="false">ValueHere</CompanyNameFilter>
      <LanguageLocale i:nil="false">ValueHere</LanguageLocale>
    </SearchCompaniesRequest>
  </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>
    <SearchCompaniesResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Companies d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <Company>
          <LogoUrl d4p1:nil="false">ValueHere</LogoUrl>
          <Name d4p1:nil="false">ValueHere</Name>
          <ProfileId>ValueHere</ProfileId>
          <Status d4p1:nil="false">ValueHere</Status>
        </Company>
      </Companies>
    </SearchCompaniesResponse>
  </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<SearchCompaniesResponse> SearchCompaniesAsync(
	string companyNameFilter,
	string languageLocale)
{
	var request = new SearchCompaniesRequest
	{
		CompanyNameFilter = companyNameFilter,
		LanguageLocale = languageLocale
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.SearchCompaniesAsync(r), request));
}

static SearchCompaniesResponse searchCompanies(
	java.lang.String companyNameFilter,
	java.lang.String languageLocale) throws RemoteException, Exception
{
	SearchCompaniesRequest request = new SearchCompaniesRequest();

	request.setCompanyNameFilter(companyNameFilter);
	request.setLanguageLocale(languageLocale);

	return CampaignManagementService.getService().searchCompanies(request);
}

static function SearchCompanies(
	$companyNameFilter,
	$languageLocale)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new SearchCompaniesRequest();

	$request->CompanyNameFilter = $companyNameFilter;
	$request->LanguageLocale = $languageLocale;

	return $GLOBALS['CampaignManagementProxy']->GetService()->SearchCompanies($request);
}

response=campaignmanagement_service.SearchCompanies(
	CompanyNameFilter=CompanyNameFilter,
	LanguageLocale=LanguageLocale)

Requisitos

Serviço: CampaignManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/CampaignManagement/v13

Partilhar via