GetGeoLocationsFileUrl 服务操作 - 市场活动管理

获取一个临时 URL，可用于下载包含可定位或排除的地理位置的标识符的文件。

有关文件内容的详细信息，请参阅 地理位置代码。

请求元素

GetGeoLocationsFileUrlRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

元素	说明	数据类型
CompressionType	定义要下载的文件的可能压缩类型。 目前唯一支持的压缩格式是 GZip。 此请求元素是可选的。 如果未传递任何值，API 将继续返回未压缩的文件。	CompressionType
LanguageLocale	地理位置显示名称的语言和区域设置。 支持的语言区域设置值为 zh-Hant (繁体中文) 、 en (English) 、 fr (法语) 、 de (德语 ) 、意大利语 () 、 ja-JP (日语) 、 pt-BR (巴西葡萄牙语) 和 es (西班牙语) 。	string
版本	要下载的位置文件的版本。 目前唯一受支持的版本是 2.0。	string

请求标头元素

元素	说明	数据类型
AuthenticationToken	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
CustomerAccountId	拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
CustomerId	用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

GetGeoLocationsFileUrlResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。

响应正文元素

元素	说明	数据类型
FileUrl	可用于下载所请求的版本、语言和区域设置的地理位置数据的文件 URL。 在下载文件之前，检查 LastModifiedTimeUtc 元素的日期和时间是否晚于上次下载的日期和时间。 仅在必要时才应下载文件。	string
FileUrlExpiryTimeUtc	提供的文件 URL 将过期的日期和时间。 如果未在过期时间之前下载文件，则可以再次调用操作以请求新的文件 URL。 你可能会发现 URL 设置为自此操作完成 15 分钟起过期;但是，不应依赖于固定持续时间。 将来对此操作的调用可能会导致过期时间较短或更长。 该值以协调世界时 (UTC) 表示。 日期和时间值反映服务器的日期和时间，而不是客户端。 有关日期和时间格式的信息，请参阅 基元 XML 数据类型中的 dateTime 条目。	dateTime
LastModifiedTimeUtc	指定版本、语言和区域设置的地理位置数据的上次更新日期和时间。 作为最佳做法，应存储此日期和时间，并且仅当此值更新到以后的日期和时间时，才下载文件。 该值以协调世界时 (UTC) 表示。 日期和时间值反映服务器的日期和时间，而不是客户端。 有关日期和时间格式的信息，请参阅 基元 XML 数据类型中的 dateTime 条目。	dateTime

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 API 调用详细信息的日志条目的标识符。	string

请求 SOAP

此模板由一个工具生成，用于显示 SOAP 请求的正文和标头元素的顺序。 有关可用于此服务操作的支持类型，请参阅上面的 请求正文元素 参考。

<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

此模板由一个工具生成，用于显示 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>

代码语法

示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。

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)

要求

服务： CampaignManagementService.svc v13
命名空间： https://bingads.microsoft.com/CampaignManagement/v13

请求 URL

生产 URL

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

沙盒 URL

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

请求元素

GetGeoLocationsFileUrlRequest 对象定义服务操作请求的正文和标头元素。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

元素	说明	数据类型
CompressionType	定义要下载的文件的可能压缩类型。 目前唯一支持的压缩格式是 GZip。 此请求元素是可选的。 如果未传递任何值，API 将继续返回未压缩的文件。	CompressionType
LanguageLocale	地理位置显示名称的语言和区域设置。 支持的语言区域设置值为 zh-Hant (繁体中文) 、 en (English) 、 fr (法语) 、 de (德语 ) 、意大利语 () 、 ja-JP (日语) 、 pt-BR (巴西葡萄牙语) 和 es (西班牙语) 。	string
版本	要下载的位置文件的版本。 目前唯一受支持的版本是 2.0。	string

请求标头元素

元素	说明	数据类型
Authorization	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
CustomerAccountId	拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
CustomerId	用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

GetGeoLocationsFileUrlResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。

响应正文元素

元素	说明	数据类型
FileUrl	可用于下载所请求的版本、语言和区域设置的地理位置数据的文件 URL。 在下载文件之前，检查 LastModifiedTimeUtc 元素的日期和时间是否晚于上次下载的日期和时间。 仅在必要时才应下载文件。	string
FileUrlExpiryTimeUtc	提供的文件 URL 将过期的日期和时间。 如果未在过期时间之前下载文件，则可以再次调用操作以请求新的文件 URL。 你可能会发现 URL 设置为自此操作完成 15 分钟起过期;但是，不应依赖于固定持续时间。 将来对此操作的调用可能会导致过期时间较短或更长。 该值以协调世界时 (UTC) 表示。 日期和时间值反映服务器的日期和时间，而不是客户端。 有关日期和时间格式的信息，请参阅 基元 XML 数据类型中的 dateTime 条目。	dateTime
LastModifiedTimeUtc	指定版本、语言和区域设置的地理位置数据的上次更新日期和时间。 作为最佳做法，应存储此日期和时间，并且仅当此值更新到以后的日期和时间时，才下载文件。 该值以协调世界时 (UTC) 表示。 日期和时间值反映服务器的日期和时间，而不是客户端。 有关日期和时间格式的信息，请参阅 基元 XML 数据类型中的 dateTime 条目。	dateTime

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 API 调用详细信息的日志条目的标识符。	string

请求 JSON

此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型，请参阅上面的 请求正文元素 参考。

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

响应 JSON

此模板由一个工具生成，用于显示 JSON 响应的 正文 和 标头 元素。

{
  "FileUrl": "ValueHere",
  "FileUrlExpiryTimeUtc": "ValueHere",
  "LastModifiedTimeUtc": "ValueHere"
}

代码语法

若要通过 SDK 调用 REST API，需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。

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)