> 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/integration/ja/data-api/api-overview.md).

# APIの概要

## どのように Epsilon Retail Media はどのように機能しますか？

このAPIはRESTを中心に構成されています。予測可能なリソース指向のURLを備え、APIエラーを示すためにHTTP応答コードを使用します。HTTP認証やHTTP動詞など、市販のHTTPクライアントが理解できる組み込みのHTTP機能を活用しています。

APIへの認証は、APIキーの使用によって管理されます。APIキーは、お客様のバックエンドと APIとの間の通信で使用されます。

Integration APIは、広告の生成に使用される商品、カタログ、顧客、および注文データのアップロードをサポートします。Integration APIを使用して、広告をリクエストしたり、それらの広告とのインタラクションについてレポートしたりできます。

## 統合エンドポイント

Epsilon Retail Media 各種エンドポイントを使用してデータを同期し、広告を生成します。以下に簡単な概要を示します。

| エンドポイント            | 用途                                                                                                                                                                                                                              | 説明                                                                     |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `catalogs`         | [API経由でのカタログ同期](/retail-media-interface/integration/ja/data-api/catalog-products-2/syncing-catalog-via-api.md)                                                                                                                  | API経由でカタログを作成するために使用されます。単一のカタログネームスペースの場合、テクニカルアカウントマネージャーがこれを配備できます。 |
| `catalog-products` | [API経由での商品同期](/retail-media-interface/integration/ja/data-api/catalog-products-2/syncing-products-via-api.md)                                                                                                                   | カタログ内の商品データを作成および更新するために使用されます。                                        |
| `customers`        | [API経由での顧客データ同期](/retail-media-interface/integration/ja/data-api/customer-data/syncing-customer-data-via-api-1.md)                                                                                                              | カタログ内の顧客データを作成および更新するために使用されます。                                        |
| `orders`           | [API経由での注文データ同期](/retail-media-interface/integration/ja/data-api/order-data-1/syncing-order-data-via-api.md)                                                                                                                    | 注文データを送信するために使用されます。                                                   |
| `/resource/`       | [インプレッションとクリックのレポート](/retail-media-interface/integration/ja/data-api/api-overview/reporting-impressions-clicks.md) [API経由での注文データ同期](/retail-media-interface/integration/ja/data-api/order-data-1/syncing-order-data-via-api.md) | クリック数やインプレッション数、フロントエンド経由でレポートする場合は注文数をレポートするために使用されます。                |
| `/ads/generate`    | 広告の生成                                                                                                                                                                                                                           | プロダクト広告やバナー広告を生成するために使用されます。                                           |
| `/ads/bannerx`     | 広告の生成                                                                                                                                                                                                                           | バナー x 広告の生成に使用されます。                                                    |

{% hint style="info" %}
カタログ、商品、顧客、および注文の同期にエンドポイントを使用する必要はありません。 Epsilon Retail Media ファイル経由でのデータ同期をサポートしており、お客様の要件に適している場合があります。
{% endhint %}

## コンテンツタイプとペイロード

データペイロードは JSON 形式です。 `Content-Type` のこれらのエンドポイント向けは `application/json`であり、次のようにリクエストのヘッダーとして渡す必要があります。

```
-H "Content-Type: application/json" \
```

## リクエストの認証

### 基本認証

すべての連携リソースは基本認証を使用します。これは次のように API キーと一緒にヘッダーとして渡す必要があります。

```
-H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \
```

API キーは、リテールチームの「連携設定」セクションでアクセスできます。必要なのはシークレット API キーのみです。

### OAuth2.0 認証

Epsilon Retail Mediaの広告生成エンドポイントは、OAuth2.0 とも互換性があります。詳細については [OAuth 2.0認証](/retail-media-interface/integration/ja/data-api/api-overview/oauth-20-authentication.md) をご確認ください。

## ベース URL

Epsilon Retail Media は、ステージング環境と本番環境で異なるベース URL を使用します。

{% hint style="info" %}
ステージングのベース URL を受け取るには、 Epsilon Retail Mediaまでご連絡ください。連携が進み次第、本番環境のベース URL を提供いたします。
{% endhint %}


---

# 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/integration/ja/data-api/api-overview.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.