Operación del servicio GetGeoLocationsFileUrl: Administración de campañas

Artículo
12/21/2023

Obtiene una dirección URL temporal que puede usar para descargar un archivo que contiene identificadores para las ubicaciones geográficas a las que puede dirigirse o excluir.

Para obtener más información sobre el contenido del archivo, consulte Códigos de ubicación geográfica.

Elementos Request

El objeto GetGeoLocationsFileUrlRequest define los elementos body y header de la solicitud de operación de servicio. Los elementos deben estar en el mismo orden que se muestra en la solicitud SOAP.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento	Descripción	Tipo de datos
CompressionType	Define los posibles tipos de compresión para que el archivo se descargue. Actualmente, el único formato de compresión compatible es GZip. Este elemento request es opcional. Si no se pasa ningún valor, la API seguirá devolviendo archivos sin comprimir.	CompressionType
LanguageLocale	Idioma y configuración regional de los nombres para mostrar de la ubicación geográfica. Los valores de configuración regional del idioma admitidos son zh-Hant (chino tradicional), en (inglés), fr (francés), de (alemán), it (italiano), ja-JP (japonés), pt-BR (portugués brasileño) y es (español).	string
Versión	Versión del archivo de ubicación que desea descargar. Actualmente, la única versión admitida es la 2.0.	string

Elementos de encabezado de solicitud

Elemento	Descripción	Tipo de datos
AuthenticationToken	Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Para obtener más información, consulte Autenticación con OAuth.	string
CustomerAccountId	Identificador de la cuenta de anuncio que posee o está asociada a las entidades de la solicitud. Este elemento de encabezado debe tener el mismo valor que el elemento de cuerpo AccountId cuando ambos son necesarios. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.	string
Customerid	Identificador de la cuenta de administrador (cliente) desde la que el usuario accede o funciona. Un usuario puede tener acceso a varias cuentas de administrador. Este elemento es necesario para la mayoría de las operaciones de servicio y, como procedimiento recomendado, siempre debe establecerlo. Para obtener más información, consulte Obtención de su cuenta e identificadores de cliente.	string
DeveloperToken	Token de desarrollador que se usa para acceder a Bing Ads API. Para obtener más información, consulte Obtención de un token de desarrollador.	string
Password	Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario.	string
UserName	Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario.	string

Elementos de respuesta

El objeto GetGeoLocationsFileUrlResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en soap de respuesta.

Elementos del cuerpo de la respuesta

Elemento	Descripción	Tipo de datos
FileUrl	Dirección URL del archivo que puede usar para descargar los datos de ubicación geográfica de la versión, el idioma y la configuración regional que solicitó. Antes de descargar el archivo, compruebe si la fecha y hora del elemento LastModifiedTimeUtc es posterior a la fecha y hora de la descarga anterior. Solo debe descargar el archivo si es necesario.	string
FileUrlExpiryTimeUtc	Fecha y hora en que expirará la dirección URL del archivo proporcionada. Si no descarga el archivo antes de la hora de expiración, puede volver a llamar a la operación para solicitar una nueva dirección URL de archivo. Puede observar que la dirección URL está establecida para expirar 15 minutos a partir del momento en que se complete esta operación; sin embargo, no debe depender de una duración fija. Las llamadas futuras a esta operación pueden dar lugar a un tiempo de expiración más corto o más largo. El valor se encuentra en la hora UTC (hora universal coordinada). El valor de fecha y hora refleja la fecha y hora en el servidor, no en el cliente. Para obtener información sobre el formato de la fecha y hora, vea la entrada dateTime en Tipos de datos XML primitivos.	dateTime
LastModifiedTimeUtc	Fecha y hora en que se actualizaron por última vez los datos de ubicación geográfica para la versión, el idioma y la configuración regional especificados. Como procedimiento recomendado, debe almacenar esta fecha y hora y, en adelante, descargar solo el archivo si este valor se actualiza a una fecha y hora posteriores. El valor se encuentra en la hora UTC (hora universal coordinada). El valor de fecha y hora refleja la fecha y hora en el servidor, no en el cliente. Para obtener información sobre el formato de la fecha y hora, vea la entrada dateTime en Tipos de datos XML primitivos.	dateTime

Elementos de encabezado de respuesta

Elemento	Descripción	Tipo de datos
Seguimiento del Id.	Identificador de la entrada de registro que contiene los detalles de la llamada API.	string

Solicitud de SOAP

Esta plantilla se generó mediante una herramienta para mostrar el orden del cuerpo y los elementos de encabezado de la solicitud SOAP. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

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

Esta plantilla se generó mediante una herramienta para mostrar el orden de los elementos body y header para la respuesta 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>

Sintaxis de código

La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

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

Servicio: CampaignManagementService.svc v13
Nombres: https://bingads.microsoft.com/CampaignManagement/v13

Compartir a través de