> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/partner/ja/partner-api-overview/epsilon-retail-media-partner-apis-overview-1.md).

# Epsilon Retail Media パートナー API の概要

へようこそ Epsilon Retail Media パートナー APIへようこそ。このガイドは、当社の広告プラットフォームと連携して、キャンペーン、ウォレット、チーム、ユーザーをプログラムで管理するのに役立ちます。また、パフォーマンスを追跡し、ビジネスを効果的に成長させることができます。

## APIとは何ですか？

APIとはApplication Programming Interface（アプリケーション・プログラミング・インターフェース）の略です。APIは仲介者として機能し、一連の関数やプロシージャを使用して2つのソフトウェアコンポーネントが通信できるようにします。APIは一般的に、 データの取得や送信、他のアプリケーションの機能やサービスへのアクセスに使用されます。

## パートナー APIとは何ですか？

当社のパートナー APIを使用すると、 Epsilon オンサイトキャンペーン管理プラットフォームのユーザーインターフェースで実行できるほぼすべての操作にプログラムでアクセスできます。つまり、アプリを手動でクリックする代わりに、システムや開発者が当社のプラットフォームに直接接続し、その機能を独自のツールやワークフローに自動化、カスタマイズ、または統合できます。

パートナー APIは、Pacvue、Skai、Commerce IQなどのアグリゲーターを含む、多くの小売業者やパートナーによって利用されています。

## API overview

The Epsilon Retail Media パートナー APIは、リテールメディアのプログラムによる管理を可能にします [キャンペーン](/retail-media-interface/partner/ja/campaign-management-api/productcampaign-1/createproductcampaign.md), [チーム](/retail-media-interface/partner/ja/team-user-api/team.md) & [ユーザー](/retail-media-interface/partner/ja/team-user-api/user-1/createuserteaminvite.md)、および [ウォレット](/retail-media-interface/partner/ja/billing-api/wallet.md)。これを使用して、スポンサードプロダクト広告（SPA）、静的バナー、レスポンシブ Banner X 広告など、複数の広告フォーマットにわたってキャンペーンを作成および更新します。

当社のパートナー APIは、JSONペイロードを介して一般的なGET、POST、PATCH、およびDELETEプロトコルを使用するRESTベースのAPIです。

## 主なメリット

* REST APIエンドポイントを通じて、キャンペーン、チーム＆ユーザー、およびウォレットの操作を自動化します。
* 一括操作サポートにより、複数のキャンペーンやリソースを効率的に管理します。
* 既存のワークフローやシステムアーキテクチャに適合するようにAPI呼び出しを構築できます。
* スポンサードプロダクト広告、バナー、および Banner X フォーマットにわたるキャンペーンを作成および管理します。
* 安全なAPI相互作用のための有効期限付きトークンを使用したユーザーキーベースの認証。

## 前提条件

<figure><img src="/files/qTjIkojjazgawSl4N9Fd" alt="" width="100%"><figcaption></figcaption></figure>

パートナー APIを使用する前に、次の要件が満たされていることを確認してください。

### ネームスペースへのアクセス

データと設定のコンテナとして機能する、指定されたネームスペースへのアクセス権が必要です。小売業者に固有のネームスペース設定の詳細を取得するには、 Epsilon サポートチームにお問い合わせください。

### チームメンバーシップ

ネームスペース内で適切な権限を持つサプライヤーチームまたはプライマリ小売業者チームのいずれかに所属している必要があります。

### API利用リクエスト

広告アグリゲーター、代理店、およびブランドパートナーは、パートナー APIを使用する前にAPI利用リクエストを送信する必要があります。で参照されている公式の利用フォームを使用して、 [KB0040933](https://citrusad.service-now.com/now/nav/ui/classic/params/target/kb_view.do%3Fsysparm_article%3DKB0040933)新しいAPI接続を開始してください。

### レポーティングAPIへのアクセス

dim\_product、dim\_catalog、dim\_placementなどの関連テーブルをクエリするには、レポーティングAPI（BigQueryデータウェハウス）へのアクセス権が必要です。これにより、統合の準備状況が検証され、メタデータが確認できます。

### 必要なメタデータ

商品カタログ、プレースメント、およびチーム情報が作成され、ネームスペースで利用可能であることを確認してください。これは、適切なBigQueryテーブルをクエリすることで検証できます。

BigQueryへのアクセス権がない場合は、公式のAPIアクセスリクエストフォームを通じてリクエストしてください。ニーズに応じて、適切なナレッジベースの記事を参照してください：

* **レポーティング BigQuery API エンドポイントの変更/削除**: 既存のAPIエンドポイントを変更する必要がある場合 - [KB0040934](https://citrusad.service-now.com/now/nav/ui/classic/params/target/kb_view.do%3Fsysparm_article%3DKB0040934).
* 新規 パートナー API（レポーティング API）\*\* - [KB0040947](https://citrusad.service-now.com/now/nav/ui/classic/params/target/kb_view.do%3Fsysparm_article%3DKB0040947).

{% hint style="info" %}
アクセスに関する注意: このドキュメント内の一部のリンクは、内部リソースまたは制限されたリソースを指しています。コンテンツにアクセスするには、適切な資格情報でサインインしていることを確認してください。
{% endhint %}

## パートナー APIの始め方

<figure><img src="/files/6KPn9Uk420VSw0CrKibw" alt="" width="100%"><figcaption></figcaption></figure>

### 認証の要件

Partner APIでは、User Keyを必要とする認証プロセスを使用します。アクセストークンは、User Key Authentication APIを呼び出して取得します。

* 取得したUser Keyは、このリクエストのヘッダーで渡されます。
* 取得したアクセストークンは、その後のPartner APIへのメソッド呼び出しで使用されます。
* トークンは生成から24時間弱で失効します。

{% hint style="info" %}
前のトークンが失効した場合は、新しいトークンをリクエストする必要があります。クライアントは、APIへのリクエストごとに新しいトークンを生成するべきではありません。
{% endhint %}

### API資格情報の取得

使用を開始するには Epsilon Retail Media Partner APIを使用するには、以下の情報が必要です。詳細について不明な点がある場合は、サポートにお問い合わせいただくか、チケットを発行して支援を受けてください。

* 認証用のUser key。
* API呼び出しを行うためのベースURL。

### User keyを取得する

1. ログインしてください Epsilon Retail Media チームアカウント。
2. チームを選択します。
3. プロフィールのドロップダウンから **User settings** を選択します。
4. User key\*\* タブに移動します。
5. **Show** をクリックしてAPIキーを表示します。

このキーを使用してAPIリクエストを認証します。 Epsilon Retail Media はUser keyベースの認証を使用します。APIリクエストを認証するには、User keyを期間限定のアクセストークンと交換します。詳細については、以下を参照してください [認証リクエスト](/retail-media-interface/partner/ja/partner-api-authentication/authenticating-requests.md).

### ベースURLの取得

お使いの環境の正しいベースURLを取得するには、サポートにお問い合わせください。エンドポイントの例:

```
https://campaign.<env>.citrusad.com/v3/campaigns
```

User keyを取得したら、認証を行い、次へのAPI呼び出しを開始できます:

* 広告キャンペーンの表示と管理。
* 広告予算と支出の管理。
* チームとユーザーの詳細の管理。

## 環境のセットアップ

Epsilon Retail Media リテールメディアプラットフォームは、リテールパートナーごとにProductionとSandboxの2つの異なる環境を提供します。どちらの環境も、リテールパートナーがオンボーディングされるとデフォルトで作成されます。

### Sandbox環境

{% hint style="info" %}
Sandboxへのアクセス権は、通常、リテールパートナーおよびアグリゲーターにのみ提供されます。資格があるかどうかが不明な場合は、サポートにお問い合わせください。
{% endhint %}

本番運用前に連携をテストするには、この安全な環境を使用してください。リテールパートナーは本番運用前に、API呼び出しの検証、カタログアップロードのテスト、キャンペーン作成のシミュレーションを行い、エンドツーエンドの機能をテストするためにこの環境を使用する必要があります。すべての開発、テスト、QAアクティビティにはSandboxを使用してください。各リテールパートナーには、通常次の形式の固有のSandbox URLが割り当てられます:

```
https://<retailer>-sandbox.citrusad.com
```

Sandbox環境には以下が含まれます:

<figure><img src="/files/Ose5StzNO7hQ6pBi9f5e" alt="" width="100%"><figcaption></figcaption></figure>

### Production環境

Sandboxでの検証が成功した後にのみ、Productionに切り替えてください。Production環境は、実際のキャンペーンやリアルタイムの広告配信に使用されます。カタログの更新、注文の同期、広告パフォーマンスの追跡など、大規模な運用をサポートします。ProductionのURLは次の形式に従います:

```
https://<namespace>.citrusad.com
```

この環境を使用する前に、すべてのデータ（カタログ、商品、注文）が正確かつ完全であることを確認してください。

{% hint style="info" %}
特に認証情報やベースURLを使用する場合は、API呼び出しを行う前に常に正しい環境を確認してください。ベースURLは、リテール事業者の連携設定によっては、必ずしもネームスペースと一致しない場合があります。
{% endhint %}

## パートナーAPIエンドポイント

Epsilon Retail Media APIは、機能カテゴリごとにグループ化された一連のコア機能を提供し、それぞれが専用のエンドポイントによってサポートされています。以下の表は、主要なパートナー向けAPI、その目的、および使用されるHTTPメソッドの概要を示しています。

<figure><img src="/files/A2lo6NTmeTLmfT0bCniE" alt="" width="100%"><figcaption></figcaption></figure>

### キャンペーン管理

**スポンサープロダクト広告とは？** スポンサープロダクト広告（SPA）は、リテール事業者サイトのプロダクトグリッド内に配置される広告で、通常、検索ページやカテゴリーページ、PDP、ホームページなどにオーガニック表示と重ね合わせて配置されます。

**とは** Banner X Ad?\*\* Banner X 広告は完全なレスポンシブ広告ユニットであり、ユーザーのビューポートに合わせてサイズや配置が変化します。ヒーロー画像や背景画像、ヘッドラインテキスト、CTAボタンなど、数多くのクリエイティブ要素で構成されています。

**バナー広告とは？** 標準的なバナーは、裏にクリックURLが設定された静止画像です。

#### プロダクトキャンペーン

| エンドポイント                                                                                                                                 | 説明                                            | メソッド  |
| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | ----- |
| [プロダクトキャンペーンを作成する](/retail-media-interface/partner/ja/campaign-management-api/productcampaign-1/createproductcampaign.md)               | リクエストボディで提供された詳細情報を使用して、新しいプロダクトキャンペーンを作成します。 | POST  |
| [すべての商品キャンペーンの一覧を取得](/retail-media-interface/partner/ja/campaign-management-api/productcampaign-1/listproductcampaigns.md)              | 提供されたパラメーターに基づいて、すべてのプロダクトキャンペーンのリストを取得します。   | GET   |
| [商品キャンペーンを更新](/retail-media-interface/partner/ja/campaign-management-api/productcampaign-1/updateproductcampaign.md)                    | キャンペーンIDを使用して、既存のプロダクトキャンペーンを更新します            | PATCH |
| [IDによるプロダクトキャンペーンの取得](/retail-media-interface/partner/ja/campaign-management-api/productcampaign-1/getproductcampaign-1.md)             | 指定されたキャンペーンIDのプロダクトキャンペーンの詳細情報を取得します。         | GET   |
| [プロダクトキャンペーンの承認状態を変更する](/retail-media-interface/partner/ja/campaign-management-api/productcampaign-1/approveproductcampaign-1.md)       | 指定されたプロダクトキャンペーンの承認状態を更新します。                  | POST  |
| [固定掲載キャンペーンの予約実現可能性を確認する](/retail-media-interface/partner/ja/campaign-management-api/productcampaign-1/checkfixedtenancyavailable-1.md) | 固定掲載キャンペーンの予約が可能かどうかを確認します。                   | POST  |

#### Banner X キャンペーン

| エンドポイント                                                                                                                            | 説明                                                                         | メソッド  |
| ---------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ----- |
| [Banner Xキャンペーンを作成する](/retail-media-interface/partner/ja/campaign-management-api/bannerxcampaign-1/createbannerxcampaign-1.md)     | リクエストボディで提供された詳細情報を使用して、新しいバナーXキャンペーンを作成します。                               | POST  |
| [Banner Xキャンペーンの詳細を取得する](/retail-media-interface/partner/ja/campaign-management-api/bannerxcampaign-1/getbannerxcampaign-1.md)     | 指定されたキャンペーンIDのバナーXキャンペーンの詳細情報を取得します。                                       | GET   |
| [Banner Xキャンペーンを更新](/retail-media-interface/partner/ja/campaign-management-api/bannerxcampaign-1/updatebannerxcampaign.md)         | キャンペーンIDとリクエストボディで提供された更新後のキャンペーンデータを指定して、既存の Banner X キャンペーンを更新します。       | PATCH |
| [Banner Xキャンペーンの承認状態を更新](/retail-media-interface/partner/ja/campaign-management-api/bannerxcampaign-1/approvebannerxcampaign-1.md) | 指定されたバナーXキャンペーンの承認状態を更新します。                                                | POST  |
| [すべてのBanner Xキャンペーンの一覧を取得](/retail-media-interface/partner/ja/campaign-management-api/bannerxcampaign-1/listbannerxcampaigns.md)   | キャンペーン名、プレースメントID、チームID、承認状態など、指定されたフィルターとパラメーターに基づいてバナーXキャンペーンのリストを取得します。 | GET   |

#### バナーキャンペーン

| エンドポイント                                                                                                                 | 説明                                          | メソッド  |
| ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | ----- |
| [バナーキャンペーンを作成する](/retail-media-interface/partner/ja/campaign-management-api/bannercampaign/createbannercampaign-1.md)   | リクエストボディで提供された詳細情報を使用して、新しいバナーキャンペーンを作成します。 | POST  |
| [バナーキャンペーンの詳細を取得する](/retail-media-interface/partner/ja/campaign-management-api/bannercampaign/getbannercampaign-1.md)   | 指定されたキャンペーンIDのバナーキャンペーンの詳細情報を取得します。         | GET   |
| [バナーキャンペーンを更新](/retail-media-interface/partner/ja/campaign-management-api/bannercampaign/updatebannercampaign.md)       | キャンペーンIDを使用して、既存のバナーキャンペーンを更新します。           | PATCH |
| [バナーキャンペーンの承認状態を更新](/retail-media-interface/partner/ja/campaign-management-api/bannercampaign/approvebannercampaign.md) | 指定されたバナーキャンペーンの承認状態を更新します                   | POST  |

#### キャンペーンファイル

| エンドポイント                                                                                                              | 説明                                             | メソッド |
| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ---- |
| [キャンペーンファイルをアップロード](/retail-media-interface/partner/ja/campaign-management-api/creativeassets/uploadfile.md)         | さまざまな種類のキャンペーンファイルをアップロードします                   | POST |
| [キャンペーンファイルのURLを取得](/retail-media-interface/partner/ja/campaign-management-api/creativeassets/getcampaignfileurl.md) | 指定されたファイルIDとファイルタイプを使用して、キャンペーンファイルのURLを取得します。 | POST |

#### コンテンツスタンダード

| エンドポイント                                                                                                                                         | 説明                                                                               | メソッド |
| ----------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ---- |
| [Banner Xのコンテンツ標準の詳細を取得する](/retail-media-interface/partner/ja/campaign-management-api/bannerxcontentstandard/getbannerxcontentstandard-1.md)    | 取得します Banner X 指定されたコンテンツスタンダードIDのコンテンツスタンダードの詳細情報を取得します。                        | GET  |
| [Banner Xキャンペーンのコンテンツ基準の一覧を取得](/retail-media-interface/partner/ja/campaign-management-api/bannerxcontentstandard/listbannerxcontentstandard.md) | コンテンツスタンダードのリストを取得します Banner X ネームスペース、名前、コンテンツスタンダードIDなどの指定されたパラメーターに基づくキャンペーン。 | GET  |
| [バナーコンテンツ標準の詳細を取得する](/retail-media-interface/partner/ja/campaign-management-api/bannerxcontentstandard/getbannercontentstandard.md)             | 指定されたコンテンツスタンダードIDのバナーコンテンツスタンダードの詳細情報を取得します。                                    | GET  |
| [バナーキャンペーンのコンテンツ基準の一覧を取得](/retail-media-interface/partner/ja/campaign-management-api/bannerxcontentstandard/listbannercontentstandard.md)       | ネームスペース、名前、コンテンツスタンダードIDなどの指定されたパラメーターに基づいて、バナーキャンペーンのコンテンツスタンダードのリストを取得します。     | GET  |

#### キャンペーン

| エンドポイント                                                                                                             | 説明                                                                                    | メソッド |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ---- |
| [すべてのキャンペーンの一覧を取得](/retail-media-interface/partner/ja/campaign-management-api/campaign/listcampaigns-1.md)          | キャンペーン名、キャンペーンタイプ、プレースメントID、チームID、承認状態など、指定されたフィルターとパラメーターに基づいてキャンペーンのリストを取得します。      | POST |
| [キャンペーンの履歴を取得](/retail-media-interface/partner/ja/campaign-management-api/campaign/getcampaignhistory.md)           | キャンペーンIDを使用してキャンペーンの履歴を取得します。                                                         | GET  |
| [キーワードの最低入札価格の詳細を取得](/retail-media-interface/partner/ja/campaign-management-api/campaign/retrievekeywordsminbid.md) | 検索およびカテゴリー＆検索プレースメントタイプのキャンペーンにおいて、指定されたキーワードの配列に対する個別の最低入札額の詳細とキャンペーン全体の最低入札額を取得します。 | POST |
| [カテゴリーの最低入札価格の詳細を取得](/retail-media-interface/partner/ja/campaign-management-api/campaign/retrievecategoryminbid.md) | カテゴリープレースメントタイプのキャンペーンにおいて、個別の最低入札額の詳細とキャンペーン全体の最低入札額を取得します。                          | POST |

## クリエイティブアセット管理

### クリエイティブアセットとは？

クリエイティブアセットとは、バナーおよび Banner X キャンペーンで使用される画像です。適切な表示とパフォーマンスを確保するために、これらのアセットは特定の技術要件を満たす必要があります。

### アップロードガイドライン:

* ファイルサイズ < 4 MB
* ファイル形式: PNG、JPEG、JPG、GIF、SVG、PDF
* 一度に1ファイルのみ
* チームID、スロットID、コンテンツスタンダードIDは必須です
* ファイルへの完全な絶対パスを入力してください

{% hint style="info" %}
クリエイティブアセットのアップロードは、上記の「キャンペーン管理」セクションに記載されているキャンペーンファイルエンドポイントを通じて処理されます。
{% endhint %}

## コンテンツスタンダード管理

### コンテンツスタンダードとは？

コンテンツスタンダードとは、バナーまたは Banner X 広告をウェブサイトやデジタルプラットフォーム上の指定されたスペース内にどのように表示するかを規定するガイドラインおよび技術パラメーターです。スタンダードには、寸法とサイズ、ファイル形式とサイズ、解像度と品質、配置と配置調整、コンテンツ制限、インタラクティブ性などのパラメーターが含まれます。

### チーム＆ユーザー管理

#### チームとは？

チームはユーザーの集まりであり、サプライヤー（広告主）またはリテール事業者チームのいずれかに分類されます。通常、サプライヤーチームはキャンペーンを作成し、リテール事業者はキャンペーンのレビューや管理者タスクを実行します。システム内のユーザーは、複数のチームに所属することも、1つのチームだけに所属することもできます。通常、チームには関連付けられたユーザー、キャンペーン、ウォレットが存在します。

#### チーム

| エンドポイント                                                                                | 説明                                                          | メソッド  |
| -------------------------------------------------------------------------------------- | ----------------------------------------------------------- | ----- |
| [チームを作成する](/retail-media-interface/partner/ja/team-user-api/team/createteam-1.md)      | 新しいチームを作成します。                                               | POST  |
| チームを更新する                                                                               | team\_id で指定されたチームの詳細を更新します。                                | PATCH |
| すべてのチームを一覧表示する                                                                         | name、namespace\_id、seller\_id などのパラメーターを指定して、チームのリストを取得します。 | GET   |
| [指定されたIDのチームを取得する](/retail-media-interface/partner/ja/team-user-api/team/getteam-1.md) | メンバーを含む特定のチームに関する詳細情報を取得します。                                | GET   |
| 招待トークンを使用してチームに参加する                                                                    | 有効で期限切れになっていない招待トークンを使用して、ユーザーがチームに参加できるようにします。             | POST  |

#### ユーザー

| エンドポイント                                                                                          | 説明                                                      | メソッド   |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------- | ------ |
| [チームにユーザーを招待する](/retail-media-interface/partner/ja/team-user-api/user-1/createuserteaminvite.md) | 指定されたチームに参加するための招待をユーザーに送信します。                          | POST   |
| ユーザー ID を使用してユーザーの詳細を取得する                                                                        | 現在ログインしているユーザーの詳細を取得します： Epsilon Retail Media プラットフォーム。 | GET    |
| [ユーザーの詳細を取得](/retail-media-interface/partner/ja/team-user-api/user-1/getusersforteam.md)         | 提供されたチーム ID に基づいてユーザーの詳細を取得します。                         | GET    |
| [現在のユーザーの詳細を更新](/retail-media-interface/partner/ja/team-user-api/user-1/updateuserprofile.md)    | 現在ログインしているユーザーの詳細を修正します： Epsilon Retail Media プラットフォーム。 | PATCH  |
| [ユーザー権限を修正](/retail-media-interface/partner/ja/team-user-api/user-1/modifyuserpermission.md)     | ユーザー ID とチーム ID の両方を提供して、ユーザーの権限を更新します。                 | PATCH  |
| [ファイルをアップロード](/retail-media-interface/partner/ja/team-user-api/user-1/uploadfile-1.md)           | ユーザープロファイルおよびチーム用のロゴをアップロードします。                         | POST   |
| [ファイルのURLを取得](/retail-media-interface/partner/ja/team-user-api/user-1/getfileurl.md)             | 指定されたファイル ID を使用して、チームまたはユーザーのロゴの URL を取得します。           | POST   |
| ユーザーを削除する                                                                                        | チームからユーザーを削除します。                                        | DELETE |

### 請求およびウォレット管理

#### ウォレットとは何ですか？

ウォレットは、支払いを行う目的（例: 実績広告の支払いなど）で広告主の資金を保持します。

#### ウォレット

| エンドポイント                                                                                       | 説明                                                                      | メソッド  |
| --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----- |
| [ウォレットを作成する](/retail-media-interface/partner/ja/billing-api/wallet/createwallet.md)           | 指定されたネームスペース内にウォレットを作成し、チーム ID を使用してチームに関連付けます。                         | POST  |
| [ウォレットを更新](/retail-media-interface/partner/ja/billing-api/wallet/updatewallet-1.md)           | 指定されたネームスペースおよび teamId 内のウォレットを更新します。                                   | PATCH |
| [IDによるウォレットの取得](/retail-media-interface/partner/ja/billing-api/wallet/getwallet-1.md)         | 一意の識別子 {id} を使用して、特定のウォレットの詳細を取得します。                                    | GET   |
| [すべてのウォレットを一覧表示する](/retail-media-interface/partner/ja/billing-api/wallet/listwallets.md)      | チーム ID、ウォレット名、ウォレット ID、外部 ID などの指定されたフィルターとパラメーターに基づいて、ウォレットのリストを取得します。 | GET   |
| [特定のウォレットの残高を取得する](/retail-media-interface/partner/ja/billing-api/wallet/getwalletbalance.md) | 指定されたウォレットの現在の残高を取得します。                                                 | GET   |
| [特定のウォレットへの資金を管理する](/retail-media-interface/partner/ja/billing-api/wallet/managefunds.md)     | 特定のウォレットの資金操作を管理します。                                                    | POST  |

#### 消化額

| エンドポイント                                                                                      | 説明                                       | メソッド |
| -------------------------------------------------------------------------------------------- | ---------------------------------------- | ---- |
| [キャンペーンの支出詳細を取得する](/retail-media-interface/partner/ja/billing-api/spend/getcampaignspend.md) | 利用可能な残高と消化上限に基づいて、特定のキャンペーンの残りの予算を計算します。 | POST |

### 一括操作

#### キャンペーン

| エンドポイント                                                                                                                  | 説明                                           | メソッド  |
| ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------- | ----- |
| [キャンペーンを一括作成する](/retail-media-interface/partner/ja/bulk-operation-api/bulkcampaignoperations/bulkcreatecampaign.md)      | キャンペーンタイプに基づいて、複数のキャンペーン（最大1,000件）を同時に作成します。 | POST  |
| [キャンペーンを一括更新する](/retail-media-interface/partner/ja/bulk-operation-api/bulkcampaignoperations/bulkupdatecampaign-1.md)    | 指定されたネームスペース内のキャンペーンを更新します。                  | PATCH |
| [キャンペーンの承認状態を更新する](/retail-media-interface/partner/ja/bulk-operation-api/bulkcampaignoperations/bulkcampaignapproval.md) | 指定されたネームスペース内のキャンペーンを承認または拒否します。             | POST  |
| 一括操作のステータスを取得する                                                                                                          | 一括操作 ID を使用して、一括キャンペーン操作のステータスと詳細を取得します。     | GET   |

#### ウォレット

| エンドポイント                                                                                                               | 説明                                | メソッド  |
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------- | ----- |
| [ウォレットを一括作成する](/retail-media-interface/partner/ja/bulk-operation-api/bulkwalletoperations/bulkcreatewallet.md)        | 組織内で一度に複数のウォレットを作成します（最大1,000件）。  | POST  |
| [一括ウォレット操作ステータスを取得する](/retail-media-interface/partner/ja/bulk-operation-api/bulkwalletoperations/bulkwalletstatus.md) | 一括 ID を使用して一括ウォレット操作のステータスを取得します。 | GET   |
| [ウォレットを一括更新する](/retail-media-interface/partner/ja/bulk-operation-api/bulkwalletoperations/bulkupdatewallet.md)        | 複数のウォレットを同時に更新します。                | PATCH |

#### チーム

| エンドポイント                                                                                                             | 説明                              | メソッド  |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ----- |
| [チームを一括作成する](/retail-media-interface/partner/ja/bulk-operation-api/bulkwalletoperations-1/bulkcreateteam.md)        | 組織の一括チームを作成します。                 | POST  |
| [チームを一括更新する](/retail-media-interface/partner/ja/bulk-operation-api/bulkwalletoperations-1/bulkupdateteam.md)        | 複数のチームを同時に更新します。                | PATCH |
| [一括チーム操作ステータスを取得する](/retail-media-interface/partner/ja/bulk-operation-api/bulkwalletoperations-1/bulkteamstatus.md) | 一括 ID を使用して一括チーム操作のステータスを取得します。 | GET   |

### 推奨検索キーワード

#### 推奨検索キーワードとは何ですか？

推奨検索キーワードは、検索キーワードステップでキャンペーンを作成する際にユーザーに提示される、商品を特定のキーワードに関連付ける小売業者からファイル経由で提供されるキーワードのコレクションです。詳細については、推奨検索キーワードを参照してください。

| エンドポイント                                                                                                                          | 説明                                                            | メソッド |
| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ---- |
| [推奨検索語句をすべて一覧表示する](/retail-media-interface/partner/ja/suggested-search-term-api/suggestedsearchterm/listsuggestedsearchterms.md) | カタログ ID、商品コードなどの指定されたパラメーターに基づいて、カタログターゲティングの推奨検索キーワードを取得します。 | GET  |

## ベストプラクティス

スムーズで効率的かつ信頼性の高い統合を確実に行うために、以下のベストプラクティスに従ってください： Epsilon Retail Media パートナー API:

* 本番環境へのデプロイ前には、常にサンドボックスでテストしてください。
* 複数の操作には一括エンドポイントを使用してください。
* エラーレスポンスで特定的数据の問題がないか確認してください。
* より迅速なデータアップロードのために圧縮ファイルを使用してください。
* アクセストークンは期限切れになった場合にのみ更新してください。
* リクエストを送信する前に必須フィールドを検証してください。

## エラーハンドリング

当社のパートナー API は、堅牢な例外処理をサポートするために構造化された JSON エラーレスポンスを返します。

* **HTTP ステータスコード**: 標準エラーコード（400、401、403、500 など）
* **エラーコード**: 特定のエラー識別子。
* **メッセージ**: 人間が読めるエラーの説明。
* **フィールド違反**: データ入力の問題に対する特定のフィールド検証エラー。

詳細なエラーハンドリング情報については、以下を参照してください： [エラーハンドリング](/retail-media-interface/partner/ja/partner-api-overview/error-handling.md).

## サポートとリソース

| リソース                                                                                            | 説明                        |
| ----------------------------------------------------------------------------------------------- | ------------------------- |
| [よくある質問](/retail-media-interface/partner/ja/partner-api-overview/frequently-asked-questions.md) | APIの使用と統合に関連するよくある質問と回答。  |
| リリースノート                                                                                         | APIに関する最近のアップデートまたは変更の概要。 |
| [用語集](https://developers.citrusad.com/partner/docs/createupdate-campaign-fields-1)              | APIドキュメント全体で使用される主要用語の定義。 |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.citrusad.com/retail-media-interface/partner/ja/partner-api-overview/epsilon-retail-media-partner-apis-overview-1.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.