GetGeoLocationsFileUrl 服務作業 - 活動管理
取得暫時 URL,可用來下載包含可作為目標或排除之地理位置標識碼的檔案。
如需檔案內容的詳細資訊,請參閱 地理位置代碼。
要求專案
GetGeoLocationsFileUrlRequest 物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 描述 | 資料類型 |
---|---|---|
CompressionType | 定義要下載之檔案的可能壓縮類型。 目前唯一支援的壓縮格式是 GZip。 此要求項目是選擇性的。 如果未傳遞任何值,API 會繼續傳回未壓縮的檔案。 |
CompressionType |
LanguageLocale | 地理位置的語言和地區設定會顯示名稱。 支援的語言地區設定值為 zh-Hant (繁體中文) 、 en (英文) 、 fr (法) 、 de (德文) 、 ( 義大利文) 、 ja-JP (日文) 、 pt-BR (巴西葡萄牙文) ,以及 es (西班牙文) 。 | string |
版本 | 您要下載的位置檔案版本。 目前唯一支援的版本是 2.0。 |
string |
要求標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
AuthenticationToken | OAuth 存取令牌,代表有權Microsoft Advertising 帳戶之用戶的認證。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
CustomerAccountId | 擁有或與要求中實體相關聯之廣告帳戶的標識碼。 當兩者都需要時,此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶標識符。 |
string |
CustomerId | (使用者存取或操作之使用者) 客戶的管理員帳戶標識碼。 用戶可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶標識符。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ,請參閱取得開發人員令牌。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
Response 元素
GetGeoLocationsFileUrlResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。
回應本文專案
元素 | 描述 | 資料類型 |
---|---|---|
FileUrl | 檔案 URL,可用來下載您所要求之版本、語言和地區設定的地理位置數據。 下載檔案之前,請檢查 LastModifiedTimeUtc 元素的日期和時間是否晚於您先前下載的日期和時間。 您應該只在必要時下載檔。 |
string |
FileUrlExpiryTimeUtc | 提供的檔案 URL 到期的日期和時間。 如果您未在到期時間之前下載檔案,則可以再次呼叫作業來要求新的檔案 URL。 您可能會發現 URL 設定為自此作業完成後 15 分鐘到期;不過,您不應該相依於固定的持續時間。 未來呼叫此作業可能會導致較短或更長的到期時間。 值為國際標準時間 (UTC)。 日期和時間值會反映伺服器上的日期和時間,而不是用戶端。 如需日期和時間格式的相關信息,請參閱 基本 XML 數據類型中的 dateTime 專案。 |
dateTime |
LastModifiedTimeUtc | 上次更新指定版本、語言和地區設定的地理位置數據的日期和時間。 最佳做法是儲存此日期和時間,而且只有在此值更新為稍後的日期和時間時,才下載檔。 值為國際標準時間 (UTC)。 日期和時間值會反映伺服器上的日期和時間,而不是用戶端。 如需日期和時間格式的相關信息,請參閱 基本 XML 數據類型中的 dateTime 專案。 |
dateTime |
回應標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
TrackingId | 包含 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>
程序代碼語法
範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例,請參閱 Bing 廣告 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
https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/GeoLocationsFileUrl/Query
要求專案
GetGeoLocationsFileUrlRequest 物件會定義服務作業要求的主體和標頭元素。
注意事項
除非下面另有說明,否則所有要求專案都是必要的。
要求本文專案
元素 | 描述 | 資料類型 |
---|---|---|
CompressionType | 定義要下載之檔案的可能壓縮類型。 目前唯一支援的壓縮格式是 GZip。 此要求項目是選擇性的。 如果未傳遞任何值,API 會繼續傳回未壓縮的檔案。 |
CompressionType |
LanguageLocale | 地理位置的語言和地區設定會顯示名稱。 支援的語言地區設定值為 zh-Hant (繁體中文) 、 en (英文) 、 fr (法) 、 de (德文) 、 ( 義大利文) 、 ja-JP (日文) 、 pt-BR (巴西葡萄牙文) ,以及 es (西班牙文) 。 | string |
版本 | 您要下載的位置檔案版本。 目前唯一支援的版本是 2.0。 |
string |
要求標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
授權 | OAuth 存取令牌,代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ,這是正確驗證的必要專案。 如需詳細資訊,請 參閱使用 OAuth 進行驗證。 |
string |
CustomerAccountId | 擁有或與要求中實體相關聯之廣告帳戶的標識碼。 當兩者都需要時,此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶標識符。 |
string |
CustomerId | (使用者存取或操作之使用者) 客戶的管理員帳戶標識碼。 用戶可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案,最佳做法是一律加以設定。 如需詳細資訊, 請參閱取得您的帳戶和客戶標識符。 |
string |
DeveloperToken | 用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ,請參閱取得開發人員令牌。 |
string |
密碼 | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
UserName | 此元素會保留供內部使用,並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 | string |
Response 元素
GetGeoLocationsFileUrlResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。
回應本文專案
元素 | 描述 | 資料類型 |
---|---|---|
FileUrl | 檔案 URL,可用來下載您所要求之版本、語言和地區設定的地理位置數據。 下載檔案之前,請檢查 LastModifiedTimeUtc 元素的日期和時間是否晚於您先前下載的日期和時間。 您應該只在必要時下載檔。 |
string |
FileUrlExpiryTimeUtc | 提供的檔案 URL 到期的日期和時間。 如果您未在到期時間之前下載檔案,則可以再次呼叫作業來要求新的檔案 URL。 您可能會發現 URL 設定為自此作業完成後 15 分鐘到期;不過,您不應該相依於固定的持續時間。 未來呼叫此作業可能會導致較短或更長的到期時間。 值為國際標準時間 (UTC)。 日期和時間值會反映伺服器上的日期和時間,而不是用戶端。 如需日期和時間格式的相關信息,請參閱 基本 XML 數據類型中的 dateTime 專案。 |
dateTime |
LastModifiedTimeUtc | 上次更新指定版本、語言和地區設定的地理位置數據的日期和時間。 最佳做法是儲存此日期和時間,而且只有在此值更新為稍後的日期和時間時,才下載檔。 值為國際標準時間 (UTC)。 日期和時間值會反映伺服器上的日期和時間,而不是用戶端。 如需日期和時間格式的相關信息,請參閱 基本 XML 數據類型中的 dateTime 專案。 |
dateTime |
回應標頭元素
元素 | 描述 | 資料類型 |
---|---|---|
TrackingId | 包含 API 呼叫詳細數據的記錄項目識別碼。 | string |
要求 JSON
此範本是由工具所產生,用來顯示 JSON 要求的 主體 和 標頭 元素。 如需可搭配此服務作業使用的支援類型,請參閱上述 的要求本文項目 參考。
{
"Version": "ValueHere",
"LanguageLocale": "ValueHere",
"CompressionType": "ValueHere"
}
回應 JSON
此範本是由工具所產生,用來顯示 JSON 回應的 主體 和 標頭 元素。
{
"FileUrl": "ValueHere",
"FileUrlExpiryTimeUtc": "ValueHere",
"LastModifiedTimeUtc": "ValueHere"
}
程序代碼語法
若要透過 SDK 呼叫 REST API,您必須將 SDK 升級至特定版本並設定系統參數。範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例,請參閱 Bing 廣告 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)