Operação de Serviço GetGeoLocationsFileUrl – Gestão de Campanhas

Obtém um URL temporário que pode utilizar para transferir um ficheiro que contém identificadores para as localizações geográficas que pode direcionar ou excluir.

Para obter detalhes sobre o conteúdo do ficheiro, veja Códigos de Localização Geográfica.

Elementos do Pedido

O objeto GetGeoLocationsFileUrlRequest 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
CompressionType	Define os possíveis tipos de compressão para o ficheiro transferir. Atualmente, o único formato de compressão suportado é GZip. Este elemento de pedido é opcional. Se não for transmitido nenhum valor, a API continuará a devolver ficheiros não comprimidos.	CompressionType
LanguageLocale	O idioma e a região da localização geográfica apresentam nomes. 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), ja-JP (japonês), pt-BR (português brasileiro) e es (espanhol).	cadeia
Versão	A versão do ficheiro de localização que pretende transferir. Atualmente, a única versão suportada é a 2.0.	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 GetGeoLocationsFileUrlResponse 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
FileUrl	O URL de ficheiro que pode utilizar para transferir os dados de localização geográfica para a versão, idioma e região que pediu. Antes de transferir o ficheiro, verifique se a data e hora do elemento LastModifiedTimeUtc é posterior à data e hora da transferência anterior. Só deve transferir o ficheiro se necessário.	cadeia
FileUrlExpiryTimeUtc	A data e hora em que o URL do ficheiro fornecido irá expirar. Se não transferir o ficheiro antes da hora de expiração, pode chamar a operação novamente para pedir um novo URL de ficheiro. Poderá observar que o URL está definido para expirar 15 minutos após a conclusão desta operação; no entanto, não deve depender de uma duração fixa. As chamadas futuras para esta operação podem resultar num tempo de expiração mais curto ou mais longo. O valor está em Hora Universal Coordenada (UTC). O valor de data e hora reflete a data e hora no servidor, não o cliente. Para obter informações sobre o formato da data e hora, veja a entrada dateTime em Tipos de Dados XML Primitivos.	dateTime
LastModifiedTimeUtc	A data e hora em que os dados de localização geográfica da versão, idioma e região especificados foram atualizados pela última vez. Como melhor prática, deve armazenar esta data e hora e, daqui para a frente, transferir apenas o ficheiro se este valor for atualizado para uma data e hora posteriores. O valor está em Hora Universal Coordenada (UTC). O valor de data e hora reflete a data e hora no servidor, não o cliente. Para obter informações sobre o formato da data e hora, veja a entrada dateTime em Tipos de Dados XML Primitivos.	dateTime

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">GetGeoLocationsFileUrl</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>
    <GetGeoLocationsFileUrlRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Version i:nil="false">ValueHere</Version>
      <LanguageLocale i:nil="false">ValueHere</LanguageLocale>
      <CompressionType i:nil="false">ValueHere</CompressionType>
    </GetGeoLocationsFileUrlRequest>
  </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>
    <GetGeoLocationsFileUrlResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <FileUrl d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</FileUrl>
      <FileUrlExpiryTimeUtc d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</FileUrlExpiryTimeUtc>
      <LastModifiedTimeUtc>ValueHere</LastModifiedTimeUtc>
    </GetGeoLocationsFileUrlResponse>
  </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<GetGeoLocationsFileUrlResponse> GetGeoLocationsFileUrlAsync(
	string version,
	string languageLocale,
	CompressionType? compressionType)
{
	var request = new GetGeoLocationsFileUrlRequest
	{
		Version = version,
		LanguageLocale = languageLocale,
		CompressionType = compressionType
	};

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

static GetGeoLocationsFileUrlResponse getGeoLocationsFileUrl(
	java.lang.String version,
	java.lang.String languageLocale,
	CompressionType compressionType) throws RemoteException, Exception
{
	GetGeoLocationsFileUrlRequest request = new GetGeoLocationsFileUrlRequest();

	request.setVersion(version);
	request.setLanguageLocale(languageLocale);
	request.setCompressionType(compressionType);

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

static function GetGeoLocationsFileUrl(
	$version,
	$languageLocale,
	$compressionType)
{

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

	$request = new GetGeoLocationsFileUrlRequest();

	$request->Version = $version;
	$request->LanguageLocale = $languageLocale;
	$request->CompressionType = $compressionType;

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

response=campaignmanagement_service.GetGeoLocationsFileUrl(
	Version=Version,
	LanguageLocale=LanguageLocale,
	CompressionType=CompressionType)

Requisitos

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

URL do Pedido

URL de Produção

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/GeoLocationsFileUrl/Query

Sandbox URL

https://campaign.api.sandbox.bingads.microsoft.com/CampaignManagement/v13/GeoLocationsFileUrl/Query

Elementos do Pedido

O objeto GetGeoLocationsFileUrlRequest 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
CompressionType	Define os possíveis tipos de compressão para o ficheiro transferir. Atualmente, o único formato de compressão suportado é GZip. Este elemento de pedido é opcional. Se não for transmitido nenhum valor, a API continuará a devolver ficheiros não comprimidos.	CompressionType
LanguageLocale	O idioma e a região da localização geográfica apresentam nomes. 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), ja-JP (japonês), pt-BR (português brasileiro) e es (espanhol).	cadeia
Versão	A versão do ficheiro de localização que pretende transferir. Atualmente, a única versão suportada é a 2.0.	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 GetGeoLocationsFileUrlResponse 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
FileUrl	O URL de ficheiro que pode utilizar para transferir os dados de localização geográfica para a versão, idioma e região que pediu. Antes de transferir o ficheiro, verifique se a data e hora do elemento LastModifiedTimeUtc é posterior à data e hora da transferência anterior. Só deve transferir o ficheiro se necessário.	cadeia
FileUrlExpiryTimeUtc	A data e hora em que o URL do ficheiro fornecido irá expirar. Se não transferir o ficheiro antes da hora de expiração, pode chamar a operação novamente para pedir um novo URL de ficheiro. Poderá observar que o URL está definido para expirar 15 minutos após a conclusão desta operação; no entanto, não deve depender de uma duração fixa. As chamadas futuras para esta operação podem resultar num tempo de expiração mais curto ou mais longo. O valor está em Hora Universal Coordenada (UTC). O valor de data e hora reflete a data e hora no servidor, não o cliente. Para obter informações sobre o formato da data e hora, veja a entrada dateTime em Tipos de Dados XML Primitivos.	dateTime
LastModifiedTimeUtc	A data e hora em que os dados de localização geográfica da versão, idioma e região especificados foram atualizados pela última vez. Como melhor prática, deve armazenar esta data e hora e, daqui para a frente, transferir apenas o ficheiro se este valor for atualizado para uma data e hora posteriores. O valor está em Hora Universal Coordenada (UTC). O valor de data e hora reflete a data e hora no servidor, não o cliente. Para obter informações sobre o formato da data e hora, veja a entrada dateTime em Tipos de Dados XML Primitivos.	dateTime

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.

{
  "Version": "ValueHere",
  "LanguageLocale": "ValueHere",
  "CompressionType": "ValueHere"
}

JSON de Resposta

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

{
  "FileUrl": "ValueHere",
  "FileUrlExpiryTimeUtc": "ValueHere",
  "LastModifiedTimeUtc": "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<GetGeoLocationsFileUrlResponse> GetGeoLocationsFileUrlAsync(
	string version,
	string languageLocale,
	CompressionType? compressionType)
{
	var request = new GetGeoLocationsFileUrlRequest
	{
		Version = version,
		LanguageLocale = languageLocale,
		CompressionType = compressionType
	};

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

static GetGeoLocationsFileUrlResponse getGeoLocationsFileUrl(
	java.lang.String version,
	java.lang.String languageLocale,
	CompressionType compressionType) throws RemoteException, Exception
{
	GetGeoLocationsFileUrlRequest request = new GetGeoLocationsFileUrlRequest();

	request.setVersion(version);
	request.setLanguageLocale(languageLocale);
	request.setCompressionType(compressionType);

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

static function GetGeoLocationsFileUrl(
	$version,
	$languageLocale,
	$compressionType)
{

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

	$request = new GetGeoLocationsFileUrlRequest();

	$request->Version = $version;
	$request->LanguageLocale = $languageLocale;
	$request->CompressionType = $compressionType;

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

response=campaignmanagement_service.GetGeoLocationsFileUrl(
	Version=Version,
	LanguageLocale=LanguageLocale,
	CompressionType=CompressionType)