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

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.

Elementos do Corpo do Pedido

Elementos do Cabeçalho do Pedido

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

Elementos do Cabeçalho de Resposta

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

URL do Pedido

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/Companies/Search

https://campaign.api.sandbox.bingads.microsoft.com/CampaignManagement/v13/Companies/Search

Elementos do Pedido

O objeto SearchCompaniesRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço.

Elementos do Corpo do Pedido

Elementos do Cabeçalho do Pedido

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 JSON de Resposta.

Elementos do Corpo da Resposta

Elementos do Cabeçalho de Resposta

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.

{
  "CompanyNameFilter": "ValueHere",
  "LanguageLocale": "ValueHere"
}

JSON de Resposta

Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho da resposta JSON.

{
  "Companies": [
    {
      "LogoUrl": "ValueHere",
      "Name": "ValueHere",
      "ProfileId": "LongValueHere",
      "Status": "ValueHere"
    }
  ]
}

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<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)