GetGeoLocationsFileUrl サービス操作 - キャンペーン管理

[アーティクル]
10/04/2023

ターゲットまたは除外できる地理的な場所の識別子を含むファイルをダウンロードするために使用できる一時的な URL を取得します。

ファイルの内容の詳細については、「地理的な場所コード」を参照してください。

Request 要素

GetGeoLocationsFileUrlRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。要素は、要求 SOAP に示されている順序と同じ順序である必要があります。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素	説明	データ型
CompressionType	ダウンロードするファイルの圧縮の種類を定義します。現在、サポートされている圧縮形式は GZip のみです。この要求要素は省略可能です。値が渡されない場合、API は圧縮されていないファイルを引き続き返します。	CompressionType
LanguageLocale	地理的な場所の表示名の言語とロケール。サポートされている言語ロケールの値は、zh-Hant (繁体字中国語)、 en (英語)、 fr (フランス語)、 de (ドイツ語)、 it (イタリア語)、 ja-JP (日本語)、 pt-BR (ブラジルポルトガル語)、および es (スペイン語) です。	string
バージョン	ダウンロードする場所ファイルのバージョン。現在、サポートされている唯一のバージョンは 2.0 です。	string

要求ヘッダー要素

要素	説明	データ型
AuthenticationToken	Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセストークン。詳細については、「 OAuth による認証」を参照してください。	string
CustomerAccountId	要求のエンティティを所有または関連付けられている広告アカウントの識別子。両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。この要素は、ほとんどのサービス操作に必要であり、ベストプラクティスとして常に設定する必要があります。詳細については、「アカウントと顧客 ID を取得する」を参照してください。	string
Customerid	ユーザーがアクセスまたは操作しているマネージャーアカウント (顧客) の識別子。ユーザーは複数のマネージャーアカウントにアクセスできます。この要素は、ほとんどのサービス操作に必要であり、ベストプラクティスとして常に設定する必要があります。詳細については、「アカウントと顧客 ID を取得する」を参照してください。	string
DeveloperToken	Bing Ads API へのアクセスに使用される開発者トークン。詳細については、「開発者トークンを取得する」を参照してください。	string
Password	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string
UserName	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string

Response 要素

GetGeoLocationsFileUrlResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。要素は、応答 SOAP に示されている順序と同じ順序で返されます。

応答本文の要素

要素	説明	データ型
FileUrl	要求したバージョン、言語、ロケールの地理的な場所データをダウンロードするために使用できるファイル URL。ファイルをダウンロードする前に、 LastModifiedTimeUtc 要素の日付と時刻が以前のダウンロードの日付と時刻より後かどうかを確認します。必要な場合にのみファイルをダウンロードする必要があります。	string
FileUrlExpiryTimeUtc	指定されたファイル URL の有効期限が切れる日付と時刻。有効期限の前にファイルをダウンロードしない場合は、もう一度操作を呼び出して新しいファイル URL を要求できます。この操作が完了した時点から 15 分後に URL が期限切れに設定されている場合があります。ただし、一定の期間に依存しないでください。この操作を今後呼び出すと、有効期限が短くなるか長くなる可能性があります。値は、世界協定時刻 (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

次の方法で共有