# Audience API の概要

> Tapjoy Offerwall Audience API を使用して、アプリがすでにインストールされているデバイスのリストを管理し、それらのユーザーがオファーを重複して受け取らないようにします。

Tapjoy の Audience API は、オーディエンスに関する情報を作成および取得するための REST API で、デバイスのリストに基づくアプリの抑制に使用できます。

## アプリの抑制##app-suppression

アプリの抑制とは、関連するアプリ ID がすでにインストールされていることを示すマークを、指定のデバイスに付ける必要があることを意味します。この情報は、デバイスに関する通常のネットワーク/SDK データの外部から取得されます。例えば、広告主がすでにアプリがインストールされていることを把握しているデバイスのリストをアップロードします。Tapjoy はアプリの提供を "抑制" し、このアプリのオファーをユーザーに表示しません。

## リクエストの作成##making-requests

API リクエストを行うには、まず OAuth API 経由でアクセストークンをリクエストする必要があります。これを行う方法の詳細については、[こちら](./api-authentication.md) を参照してください。

### 必須のパラメーターと期待される値##required-parameters-and-expected-values

| 必須パラメーター      | 期待される値                              | ノート                                                                 |
| ------------- | ----------------------------------- | ------------------------------------------------------------------- |
| `account_id`  | システムで広告主を認証するための広告主アカウント ID。        |                                                                     |
| `name`        | オーディエンスの名前。                         |                                                                     |
| `description` | オーディエンスの説明。                         |                                                                     |
| `devices`     | ヘッダーのないデバイス ID の CSV ファイル。          | IDFA と GAID は、大文字と小文字のどちらでも使用でき、ハイフンを入れることができます。これらはバックエンドで正規化されます。 |
| `offer_id`    | Tapjoy の `offer_id` (または AdSet ID)。 |                                                                     |
| `app_id`      | 広告主が抑制したいアプリの Tapjoy `app_id`。      |                                                                     |
| `list_type`   | リクエストがアプリの抑制用であることを示すリストのタイプ。       | 使用可能な値: `['app_suppression']`。期待される値は、使用可能なオプションの 1 つである必要があります。    |

> **Note:**
>
> API リクエストには、リストされているパラメーター (合計 7 個) が必要です。ただし、API から成功の応答を返すために、各パラメーターにすべての値をリストする必要はありません。
> また、各リクエストは同じ API エンドポイントに対して行われます。

### エンドポイント##endpoint

すべてのリクエストは以下のエンドポイントに対して行われます。

```text
https://api.tapjoy.com/v4/audiences
```

### リクエストの例##example-requests

以下の例は、認証された API リクエストに必要なヘッダーを示しています。

```curlrc
POST /v4/audiences 
Host: api.tapjoy.com 
Authorization: Bearer <token_string> 
Accept: application/json
```

#### アプリの抑制##app-suppression

以下の例は、アプリケーション抑制リクエストのパラメーター値を示しています。

```curlrc
account_id:'497670f6-a152-4bdd-a717-dbe7f7635dc7' 
name: ' ' 
description: ' ' 
devices: device_list_3.csv 
offer_id: ' ' (blank for suppression lists)
app_id:'6881899b-9c55-4d83-9afc-552f880289d4' 
list_type: 'app_suppression'
```

以下の例は、デバイス リスト ファイルのアップロードとクエリ パラメータを含む完全な curl コマンドと同じリクエストを示しています。

```curlrc
curl --header "Authorization:Bearer YOUR-TOKEN" --request POST --form devices=@/path/to/device_list.csv "https://api.tapjoy.com/v4/audiences?account_id=497670f6-a152-4bdd-a717-dbe7f7635dc7&app_id=6881899b-9c55-4d83-9afc-552f880289d4&description=LIST-DESCRIPTION&list_type=app_suppression&name=LIST-NAME&offer_id="
```

## FAQ##faq

**How often can a client upload an audience for app suppression?:**お好みの頻度を指定できます (1 時間など)。**What is the max list of devices I can upload?:**デバイス数には 100 万個のソフト上限があります。さらに処理する必要がある場合は、エンジニアリング部門にお問い合わせください。**If I upload two files (for example:, list\\\_one.csv, list\\\_two.csv) are they being replaced or merged?:**アプリの抑制 - csv 内のすべてのデバイスに、指定したアプリがインストールされていることがマークされます。2 つのリストを送信すると、それらがマージされます。**Can I delete a list?:**アプリの抑制 - いいえ。デバイスでアプリがインストールされているとマークされている場合、ユーザーがアプリをアンインストールしたことを Tapjoy に伝えることはできません。パートナーがデバイスを削除できるようにしたい場合は、拒否リストを使用する必要があります。**Which MMPs are integrated with the audience API automatically?:**[Appsflyer](../mmp-integrations/appsflyer)