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

業界またはジョブ関数プロファイル データのダウンロードに使用できる一時的な URL を取得します。

ダウンロードした CSV ファイルには、 ProfileCriterion で使用できるプロファイル識別子が含まれています。

注:

SearchCompanies 操作を使用して、会社名でプロファイル データを検索できます。

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
LanguageLocale	プロファイルの表示名の言語とロケール。 サポートされている言語ロケールの値は 、zh-Hant (繁体字中国語)、 en (英語)、 fr (フランス語)、 de (ドイツ語)、 it (イタリア語)、 pt-BR (ブラジルポルトガル語)、 および es (スペイン語) です。 LinkedIn でローカライズされたプロファイル名が指定されていない場合は、既定でユニバーサル名 (通常は英語で定義されます) に注意してください。	string
ProfileType	業界またはジョブ機能のプロファイル データのどちらを必要とするかを決定します。 このサービス操作では 、CompanyName プロファイルの種類はサポートされていません。 SearchCompanies 操作を使用して、会社名でプロファイル データを検索できます。	ProfileType

要求ヘッダー要素

要素	説明	データ型
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 要素

GetProfileDataFileUrlResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。 要素は、 応答 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">GetProfileDataFileUrl</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>
    <GetProfileDataFileUrlRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <LanguageLocale i:nil="false">ValueHere</LanguageLocale>
      <ProfileType>ValueHere</ProfileType>
    </GetProfileDataFileUrlRequest>
  </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>
    <GetProfileDataFileUrlResponse 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>
    </GetProfileDataFileUrlResponse>
  </s:Body>
</s:Envelope>

コード構文

構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。

public async Task<GetProfileDataFileUrlResponse> GetProfileDataFileUrlAsync(
	string languageLocale,
	ProfileType profileType)
{
	var request = new GetProfileDataFileUrlRequest
	{
		LanguageLocale = languageLocale,
		ProfileType = profileType
	};

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

static GetProfileDataFileUrlResponse getProfileDataFileUrl(
	java.lang.String languageLocale,
	ArrayList<ProfileType> profileType) throws RemoteException, Exception
{
	GetProfileDataFileUrlRequest request = new GetProfileDataFileUrlRequest();

	request.setLanguageLocale(languageLocale);
	request.setProfileType(profileType);

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

static function GetProfileDataFileUrl(
	$languageLocale,
	$profileType)
{

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

	$request = new GetProfileDataFileUrlRequest();

	$request->LanguageLocale = $languageLocale;
	$request->ProfileType = $profileType;

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

response=campaignmanagement_service.GetProfileDataFileUrl(
	LanguageLocale=LanguageLocale,
	ProfileType=ProfileType)

要件

サービス: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

要求 URL

運用 URL

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

サンドボックス URL

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

Request 要素

GetProfileDataFileUrlRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。

注:

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

要求本文要素

要素	説明	データ型
LanguageLocale	プロファイルの表示名の言語とロケール。 サポートされている言語ロケールの値は 、zh-Hant (繁体字中国語)、 en (英語)、 fr (フランス語)、 de (ドイツ語)、 it (イタリア語)、 pt-BR (ブラジルポルトガル語)、 および es (スペイン語) です。 LinkedIn でローカライズされたプロファイル名が指定されていない場合は、既定でユニバーサル名 (通常は英語で定義されます) に注意してください。	string
ProfileType	業界またはジョブ機能のプロファイル データのどちらを必要とするかを決定します。 このサービス操作では 、CompanyName プロファイルの種類はサポートされていません。 SearchCompanies 操作を使用して、会社名でプロファイル データを検索できます。	ProfileType

要求ヘッダー要素

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

Response 要素

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

応答本文の要素

要素	説明	データ型
FileUrl	要求したプロファイルの種類、言語、ロケールのプロファイル データをダウンロードするために使用できるファイル URL。 ファイルをダウンロードする前に、LastModifiedTimeUtc 要素の日時が以前のダウンロードの日付と時刻より後であるかどうかをチェックします。 必要な場合にのみファイルをダウンロードする必要があります。	string
FileUrlExpiryTimeUtc	指定されたファイル URL の有効期限が切れる日付と時刻。 有効期限の前にファイルをダウンロードしない場合は、もう一度操作を呼び出して新しいファイル URL を要求できます。 この操作が完了した時点から 15 分後に URL が期限切れに設定されている場合があります。ただし、一定の期間に依存しないでください。 この操作を今後呼び出すと、有効期限が短くなるか長くなる可能性があります。 値は、世界協定時刻 (UTC) です。 日付と時刻の値は、クライアントではなく、サーバーでの日付と時刻を反映します。 日付と時刻の形式については、「 プリミティブ XML データ型」の dateTime エントリを参照してください。	dateTime
LastModifiedTimeUtc	プロファイルの種類、言語、ロケールのプロファイル データが最後に更新された日時。 ベスト プラクティスとして、この日付と時刻を保存し、この値が後の日付と時刻に更新される場合にのみファイルをダウンロードする必要があります。 値は、世界協定時刻 (UTC) です。 日付と時刻の値は、クライアントではなく、サーバーでの日付と時刻を反映します。 日付と時刻の形式については、「 プリミティブ XML データ型」の dateTime エントリを参照してください。	dateTime

応答ヘッダー要素

要素	説明	データ型
TrackingId	API 呼び出しの詳細を含むログ エントリの識別子。	string

JSON を要求する

このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。

{
  "LanguageLocale": "ValueHere",
  "ProfileType": "ValueHere"
}

応答 JSON

このテンプレートは、JSON 応答の 本文 と ヘッダー 要素を表示するツールによって生成されました。

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

コード構文

SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。

public async Task<GetProfileDataFileUrlResponse> GetProfileDataFileUrlAsync(
	string languageLocale,
	ProfileType profileType)
{
	var request = new GetProfileDataFileUrlRequest
	{
		LanguageLocale = languageLocale,
		ProfileType = profileType
	};

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

static GetProfileDataFileUrlResponse getProfileDataFileUrl(
	java.lang.String languageLocale,
	ArrayList<ProfileType> profileType) throws RemoteException, Exception
{
	GetProfileDataFileUrlRequest request = new GetProfileDataFileUrlRequest();

	request.setLanguageLocale(languageLocale);
	request.setProfileType(profileType);

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

static function GetProfileDataFileUrl(
	$languageLocale,
	$profileType)
{

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

	$request = new GetProfileDataFileUrlRequest();

	$request->LanguageLocale = $languageLocale;
	$request->ProfileType = $profileType;

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

response=campaignmanagement_service.GetProfileDataFileUrl(
	LanguageLocale=LanguageLocale,
	ProfileType=ProfileType)