Data Destinations (ETL) Availability API

フォローする
Avatar
Dora Kishinevsky
Updated

Data Destinations Availability API を使用して、データデスティネーション内のデータが最新の状態であるかを確認します。この API は、お客様側 (S3 など) の昨日のデータが Singular データベース内の最新データと一致しているかを確認します。

構成された各データデスティネーションについて、API は is_all_data_updated (true または false) を返します。また、データデスティネーションのエクスポートに含まれる各データコネクタについて is_updated も返します。

比較されるデータは常に昨日のデータであることに注意してください。

Data Destinations Availability エンドポイント

メソッド エンドポイント
GET https://api.singular.net/api/v2.0/data_destinations_availability_status

サンプルクエリ (Python) 

import requests
url = "https://api.singular.net/api/v2.0/data_destinations_availability_status"
queryparams = {"api_key":"<API_KEY>"}
response = requests.get(url=url, params=queryparams)

クエリパラメータ

パラメータ 形式 説明
api_key String Singular API キー (Singular ウェブアプリの Developer Tools > Reporting API Key から取得できます)。

出力サンプル

次のサンプルは、2 つのデータコネクタを含む 1 つのデータデスティネーションの結果を示しています。このサンプルでは、すべてのデータコネクタについて "is_updated" が true であるため、"is_all_data_updated" も true になります。 

{
    'status': 0,
    'substatus': 0,
    'value': [
        {
            'data_destination_info': {
            'data_destination_id': 'dhjeghdj11',
            'data_destination_source_name': 'Postgres Destination',
            'data_destination_schema': 'Campaign and creative data',
            'is_all_data_updated': True,
            'status': 'Active',
            'data_connectors': [
                {
                    'data_connector_id': 'dhe836dh',
                    'display_name':  'AdWords',
                    'data_connector_username': 'myUserName',
                    'is_updated': True,
                    'is_data_delay': False,
                    'is_loading_progress': False
                },{
                    'data_connector_id':  '75encfrr',
                    'display_name':  'Vungle',
                    'data_connector_username': 'myUserName',
                    'is_updated': True,
                    'is_data_delay': False,
                    'is_loading_progress': False
                }

                ...

出力パラメータ

パラメータ 形式 説明
'data_destination_info' オブジェクト内のパラメータ
data_destination_id String データデスティネーションの一意の識別子。
data_destination_source_name String Singular ウェブアプリに表示されるデータデスティネーション名。
data_destination_schema String Singular ウェブアプリに表示されるデータデスティネーションスキーマ。同じデータデスティネーションに構成された 2 つのエクスポートを区別するのに役立ちます。
is_all_data_updated Boolean 関連するすべてのデータコネクタからのデータがデータデスティネーションで更新されている場合、True になります。
データコネクタごとのパラメータ
data_connector_id String データコネクタの一意の識別子。
display_name String Singular ウェブアプリに表示されるデータコネクタの名前。
data_connector_username String Singular ウェブアプリで構成されたデータコネクタのユーザー名。同じ広告ネットワークに対して異なる認証情報で別のデータを取得する複数のコネクタがある場合、正しいデータコネクタを識別するのに役立ちます。
is_updated Boolean このデータコネクタのデータがデータデスティネーション (BI プラットフォーム、S3 バケットなど) で更新されている場合、True になります。
is_loading_progress Boolean このデータコネクタのデータがまだデータデスティネーションにロード中の場合、True になります。is_loading_progress が true の場合、is_updated が false である理由を示します。再度確認する前に、ロードが完了するまでお待ちください。
is_data_delay Boolean Singular がソース (例: 広告ネットワーク) からのデータ取得に遅延が発生している場合、True になります。is_data_delay が true の場合、is_updated が false である理由を示します。後ほど再確認するか、Singular ウェブアプリの Data Connectors ページで遅延のステータスに関する詳細を確認してください。