adjust-icon

フィルターデータのエンドポイント

フィルターデータのエンドポイントにより、フィルターオプションのリストを取得できます。これらのオプションを使用して、レポートサービスAPIスイートでその他のエンドポイントへのコールをフィルターすることができます。

指標の全リストは、 Datascape指標用語集をご覧ください。

事前準備

このエンドポイントを使用するには、Adjust APIトークンが必要です。トークンを取得するには、認証ガイドの手順に従ってください。

エンドポイント

GET https://automate.adjust.com/reports-service/filters_data

GETリクエスト

フィルター項目のリストを返します。その他のAPIコールをフィルターするには、返されたオブジェクトのidフィールドを使用してください。

パラメーター

パラメーターデータタイプ入力する値説明
required_filters*Stringクエリフィルターのコンマ区切りリスト。値のリストについては、下の「必須のフィルター」の表を参照してください。
[required_filters]__containsStringクエリ検索語を入力して、オブジェクトのidフィールドとnameフィールドで完全一致または部分一致を検索します。

必須のフィルター

フィルター (Filter)説明
ad_revenue_sources広告収益ソースのリストを返します。
ad_spend_mode広告費用モードのリストを返します。例：attribution、network、mixed。
appsアプリのリストを返します。
apps_networkアプリとそれらに関連するストアIDのリストを返します。
attributesアトリビュートのリストを返します。
attribution_typesアトリビューションタイプのリストを返します。例：クリック（click）、インプレッション（impression）、エンゲージされた広告（engaged_ad）。
attribution_sourceアトリビューションソースのリストを返します。
attribution_statusアトリビューションのステータスのリストを返します。
channelsチャネルのリストを返します。
cohort_maturityコホート成熟度オプションのリストを返します。例：immature
countries国のリストを返します。
currencies通貨のリストを返します。
dimensionsディメンションのリストを返します。
full_cohort_periodsコホートに関連する期間のリストを返します。
iap_revenue_mode広告収益モードのリストを返します。
monetization_partners広告収益の収益化パートナーのリストを返します。
networksネットワークのリストを返します。
os_namesオペレーティングシステム名のリストを返します。
partnersパートナーのリストを返します。
platformプラットフォームのリストを返します。例：mobile_app
period_over_periodデータの比較に使用される期間のリストを返します。
sdk_signature_versionSDKシグネチャーバージョンのリストを返します。
skad_time_adjustment有効なSKAdNetworkアクティビティウィンドウのリストを返します。
store_typeApp Storeのリストを返します。
subscription_revenue_mode広告収益モードのリストを返します。
utc_offsetUTC（協定世界時）との差。デフォルトは0（UTC)。

レスポンス

このエンドポイントは、以下のレスポンスを返します：

レスポンスメッセージ注意
200Successレポート情報を返す
204No contentレスポンスオブジェクトが空の場合に返される
400Bad requestリクエストに不正があるか、サポートされていないパラメーターが含まれている場合に返される
401Unauthorized認証情報が正しくないか欠けている場合に返される
403Forbidden閲覧許可がない情報にアクセスしようとした場合に返される
429Too many requestsレート制限を超える場合に返される
503Service unavailableサーバーにリーチできなかった場合に返される
504Gateway timeoutクエリが応答を返すのに時間がかかりすぎた場合に返される

成功レスポンス

{
   "required_filters_1": [
      {
         "id": "string",
         "name": "string",
         "short_name": "string",
         "section": "string",
         "formatting": "string",
         "description": "string"
      }
   ],
   "required_filters_2": [
      {
         "id": "string",
         "name": "string",
         "short_name": "string",
         "section": "string",
         "formatting": "string",
         "description": "string"
      },
      {
         "id": "string",
         "name": "string",
         "short_name": "string",
         "section": "string",
         "formatting": "string",
         "description": "string"
      }
   ]
}

パラメーター

パラメーターデータタイプ説明
idStringフィルター項目のID。これを使用して、APIコールをフィルターします。
nameStringフィルター項目の読み取り可能な名前。
short_nameStringフィルター項目の短縮された名前。
sectionStringフィルター項目が関連付けられているセクション。
formattingStringフィルター項目のデータ形式。例：money、decimal、string。
descriptionStringフィルター項目の説明。

例

リクエスト - cURL
curl --location --request GET 'https://automate.adjust.com/reports-service/filters_data?required_filters=dimension,ad_spend_modes&dimensions__contains=source' \
--header 'Authorization: Bearer {API_TOKEN}'
レスポンス
{
   "ad_spend_mode": [
      {
         "id": "adjust",
         "name": "Attribution",
         "short_name": "",
         "section": "",
         "formatting": null,
         "description": ""
      },
      {
         "id": "mixed",
         "name": "Mixed",
         "short_name": "",
         "section": "",
         "formatting": null,
         "description": ""
      },
      {
         "id": "network",
         "name": "Network",
         "short_name": "",
         "section": "",
         "formatting": null,
         "description": ""
      }
   ],
   "dimensions": [
      {
         "id": "source_id_network",
         "name": "Source ID",
         "short_name": "",
         "section": "",
         "formatting": null,
         "description": "The ID of the app where the ad was placed."
      },
      {
         "id": "source_network",
         "name": "Source name",
         "short_name": "",
         "section": "",
         "formatting": null,
         "description": "The name of the app where the ad was placed."
      }
   ]
}