> 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/campaign-field-definitions.md). # キャンペーン項目の定義 ## 共通のキャンペーンフィールド このセクションでは、プロダクト広告、バナー、バナー X など、さまざまなタイプに共通するキャンペーンフィールドを理解するのに役立つ簡単な説明と例を提供します。各エントリには、フィールドの目的とプラットフォームの代表的な実装例が含まれています。 | フィールド | 目的と例 | | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | キャンペーンを簡単に識別できるように、「Cadbury Chocolate June Clearance」などのプロモーション対象商品、期間、戦略などの詳細を含めることをお勧めします。名前は最大 255 文字まで入力できます。 | | `namespaceId` |

ベース URL にある名前空間の一意の識別子。たとえば、 exampleretailer.citrusad.com内では、 namespaceId is exampleretailer.

入力した名前空間の ID に対するリソースが存在することを確認してください。

| | `approval.state` |

キャンペーンの承認状態には、指定された enum 値のみを使用できます。サポートされている状態は次のとおりです： APPROVAL\_STATE\_APPROVED, APPROVAL\_STATE\_REJECTED, APPROVAL\_STATE\_PENDING.

注意点：APPROVAL\_STATE\_UNSPECIFIED は使用できません。

| | `approval.rejectionReason` | キャンペーンが拒否された理由。status が以下の場合は必須フィールドです： `APPROVAL_STATE_REJECTED`. | | `campaignState` |

キャンペーンのアクティブ状態は、アクティブ、一時停止、下書き、アーカイブのいずれであるかを示します。たとえば、 CAMPAIGN\_STATE\_ACTIVE, CAMPAIGN\_STATE\_DRAFT, CAMPAIGN\_STATE\_UNSPECIFIED.

注意点： CAMPAIGN\_STATE\_UNSPECIFIED は使用できません。

| | `teamId` |

は、 teamId キャンペーンのチームの一意の識別子です。

リソースが指定されたチームIDに対して存在し、アーカイブ済みフラグが設定されていないことを確認してください。さらに、テンプレートチームIDはキャンペーンチームIDと一致する必要があります。

| | `startTime` |

キャンペーンの開始時間。正確なISO-8601タイムスタンプを使用します。例： 2024-09-01T12:00:00Z.

以下の場合はこの値を省略してください： always on キャンペーン。

| | `endTime` |

キャンペーンの終了時間。正確なISO-8601タイムスタンプを使用し、以下の場合には設定する必要があります： startTime が指定されています。例： 2024-09-30T23:59:59Z。終了時間は開始時間より後である必要があります。

以下の場合はこの値を省略してください：always on キャンペーン。

| | `walletId` |

キャンペーンの請求先となるウォレットの一意の識別子。例： wallet\_123456789.

- If campaignType が「Wildcard」でない場合、IDに対応するオブジェクトが存在する必要があります。
- ウォレットチームIDはキャンペーンチームIDと一致する必要があります。
- ウォレットの通貨コードはキャンペーンカタログの通貨コードと一致する必要があります。不明な場合は、カスタマーインテグレーションエンジニア（CIE）にご確認ください。

| | `placementId` |

キャンペーンの掲載面の一意の識別子。例： placement\_987654321.

リソースが指定された掲載面IDに対して存在し、適切なキャンペーンに対応していることを確認してください。

| | `catalogIds` |

リテール業者カタログの一意の識別子。例： \["329f1e08-d3ee-4e04-90c4-068b3ce6b856","6c29a96a-f55a-497f-b03a-2fed85dd7198" ].

リソースが指定されたカタログIDに対して存在し、適切なキャンペーンに対応していることを確認してください。

| | `advertisedProducts.
productsByKey` |

キャンペーンで掲載されている商品コードとカタログIDの組み合わせ。キャンペーンが2つのカタログに表示される場合は、2つのカタログと商品のペアを指定します。

たとえば、 \[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}].

| | `targeting.searchTerms` | キャンペーンがターゲットとする検索語句とその一致タイプ。この情報は検索プレースメントの場合にのみ含めてください。たとえば、 `{"matchType": "MATCH_TYPE_EXACT_MATCH","phrase": "string"}`}. | | `targeting.excludeFilters` |

ターゲティング段階で除外するフィルター。これらは、お客様の環境に対応した場所またはカテゴリーのフィルターのみである必要があります filterClassId。ほとんどの連携ではこれらの値を省略できます。2つのフィルタークラスを使用する場合は、フィルタークラスごとに1つのオブジェクトを指定します。

{"excludeFilters": \[ \
{ \
"catalogId": "76df36b4-45a2-46a5-9308-3dd14861d76e", \
"filter": "category:chocolate" \
}, \
{ \
"catalogId": "76df36b4-45a2-46a5-9308-3dd14861d76e", \
"filter": "location:florida" \
} \
] \
}

| | `targeting.includeFilters` |

キャンペーンによってターゲティングされる明示的なフィルター。標準的な連携ではこれを省略します。指示された場合、または固定掲載キャンペーンを作成する場合にのみ、このフィールドに入力してください。

{"includeFilters": \[ \
{ \
"catalogId": "76df36b4-45a2-46a5-9308-3dd14861d76e", \
"filter": "category:flavoured-milk" \
} \
] \
}

| | `targeting.negativeSearchTerms` | 除外キーワードは、特定の単語やフレーズをキャンペーンから除外し、無関係な検索に広告が表示されるのを防ぎます。この戦略により、オーディエンスが絞り込まれ、コストが削減され、キャンペーンの効率が向上します。たとえば、追加することで `used` 新車の広告の除外タームとして設定すると、中古車を探しているユーザーへの表示を回避できます。 | | `targeting.crossSell` | クロスセルプレースメントのターゲティングを指定します。 | | `targeting.crossSell.
targetProductsByKey` |

ターゲティングする明示的なカタログ商品のペアを指定します。

\[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}]

- ターゲット商品カタログは、キャンペーンカタログと一致する必要があります。
- 商品とカタログのペアごとに商品が存在する必要があります。
- ターゲット商品を掲載対象商品にすることはできません。
- ターゲット商品と掲載対象商品は一致するカテゴリーを共有している必要があります。

| | `targeting.upSell.
targetProductsByKey` |

ターゲティングする明示的なカタログ商品のペアを指定します。

\[{"catalogId": "14edbbc5-a7be-4c54-9f35-767b4ee29fd3","productCode": "ABC123"}]

| | `strategy.auction.maxBid` |

キャンペーンの最大クリック単価（CPC）入札価格。たとえば、2.99。

- 有効な BigDecimal である必要があります。
- 最低入札価格以上である必要があります。

},
"strategy": {
"auction": {
"maxBid": "string",
"spendLimit": {
"daily": "string",
"total": "string"
}
},

| | `strategy.auction.spendLimit` |

キャンペーンの1日あたりまたは合計の最大消化金額を指定します。

これを省略すると always on キャンペーンは、キャンペーンのウォレットに資金がある限り消化を継続します。例: "daily": "1000"。消化制限が 0 より大きい BigDecimal 値であることを確認してください。

},
"strategy": {
"auction": {
"maxBid": "string",
"spendLimit": {
"daily": "string",
"total": "string"
}
},

| | `strategy.fixedTenancy.cost` |

キャンペーンの総費用を表します。レポート作成のみに使用され、ウォレットから控除されません。リテールメディア事業者がパッケージ全体または挿入注文（IO）全体で最適化を行う場合、この値を更新できます。例: 1000.99。

"fixedTenancy": {
"cost": "1000.99",
"positions": \[
0
],
"catalogCosts": \[
{
"catalogId": "string",
"catalogCostPercentage": 0
}
]
}

| | `strategy.fixedTenancy.
catalogCostPercentage` |

各カタログに割り当てられる費用の割合を示す0から1の間の値。複数のカタログを使用する場合は、割合（例：0.5）を割り当てます。単一のカタログの場合は、値1を使用します。

"fixedTenancy": {
"cost": "string",
"positions": \[
0
],
"catalogCosts": \[
{
"catalogId": "string",
"catalogCostPercentage": 0.5
}
]
}

| | `strategy.fixedTenancy.
fixedCosts` |

キャンペーンに関連する外部データ、クリエイティブ作業、またはその他のサービスに関する追加費用を指定します。これらの費用はキャンペーンが承認されたときに適用され、変更することはできません。広告主に追加費用が適用されない場合は、これを省略してください。

{
"dataCost": "150",
"creativeCost": "200",
"otherCost": "400"
}

| | `fixedCosts.dataCost` | キャンペーンのデータに関連する費用。例: $100.00。 | | `fixedCosts.creativeCost` | キャンペーンのクリエイティブ制作に関連する費用。例: $200.00。 | | `fixedCosts.otherCost` | キャンペーンのその他の経費に関連する費用。例: $50.00。 | | `customFields.customFieldId` |

設定する一意の customFieldId を指定します。カスタムフィールドは標準インテグレーションでは必須ではなく、Customer Integration Engineer (CIE) から指示がない限り、このフィールドを使用しない可能性が高いです。

{
"customFieldId": "3e31d3e4-bf15-411b-a18e-5553f08a6122",
"content": "PO-12345"
}

| | `customFields.content` |

キャンペーンのカスタムフィールドの内容。

{
"customFieldId": "3e31d3e4-bf15-411b-a18e-5553f08a6122",
"content": "PO-12345"
}

| | `customQuestions.customQuestionId` |

設定する一意のカスタムターゲット質問を指定します。カスタム質問は標準インテグレーションでは必須ではなく、Customer Integration Engineer (CIE) から指示がない限り、このフィールドを使用しない可能性が高いです。

{
"answers": \[
"preference:delivery",
"preference:online"
],"customQuestionId": "593a9860-5ce4-4dcc-b6c4-15cf6fb08426"
}

| | `customQuestions.answers` |

顧客ターゲット用に広告主によって選択された回答を指定します。顧客の targetingData 値に一致する必要があります。

{
"answers": \[
"preference:delivery",
"preference:online"
],"customQuestionId": "593a9860-5ce4-4dcc-b6c4-15cf6fb08426"
}

| ## Banner X キャンペーン項目 | フィールド | 目的と例 | | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentStandardId` |

コンテンツ規格の一意の識別子。コンテンツ規格とは、ウェブサイトまたはデジタルプラットフォーム上の指定された領域内にバナー広告をどのように表示するかを指示するガイドラインおよび技術パラメータです。

この識別子は、作成されたバナー X アセットが小売業者のコンテンツ規格に準拠していることを確認するために必要です。

| | `slotId` | 'homepage\_banner\_slot\_1' など、設定内の枠の一意の識別子。この識別子は、シングルタイル、ダブルタイル、バナーなど、小売業者によって定義された正しい枠をバナーが使用するようにします。 | | `slotType` | 画像が配置されるコンテンツ規格内の一意の枠。画像があらかじめ定義された枠の要件と検証に準拠していることを保証します。例としては、left\_ribbon、top\_banner、side\_panel などがあります。 | | `headingText` | バナーの見出しテキスト。 | | `bannerText` | バナーテキストは、バナー広告に表示されるテキストです。 | | `bannerTextColourHex` | 16進数形式のバナーテキストの色。 | | `ctaFlag` | バナーで有効なコールトゥアクション（CTA）があるかどうかを示すフラグ。 | | `ctaText` | バナー上のコールトゥアクションテキスト。コールトゥアクション（CTA）は、購入の実行や別のページへの移動など、ユーザーに対策を促すクリック可能なテキストまたはボタンです。例: "今すぐショッピング"。 | | `ctaTextAccessibility` | アクセシビリティ目的のコールトゥアクションテキスト。 | | `ctaLink` | コールトゥアクションリンクのURL。 | | `backgroundColourHex` | 16進数形式のバナー X プライマリ背景画像の色。 | | `backgroundImageId` | これはプライマリ背景画像の一意の識別子です。 | | `backgroundImagePosition` | コンテナ内でのプライマリ背景画像の配置または位置。 | | `secondaryBackgroundImageId` | セカンダリ背景画像の一意の識別子。 | | `secondaryBackgroundImagePosition` | コンテナ内でのセカンダリ背景画像の配置または位置。 | | `heroImageId` | ヒーロー画像の一意の識別子。ヒーロー画像は主要なプロモーション画像であり、通常は製品やロゴを表示するために使用されます。 | | `heroImageAltText` | アクセシビリティを支援する、ヒーロー画像の代替テキスト。 | | `heroMode` | ヒーローセクションの表示モードまたはスタイル。 | | `secondaryHeroImageId` | セカンダリヒーロー画像の一意の識別子。 | | `secondaryHeroImageAltText` | アクセシビリティを支援する、セカンダリヒーロー画像の代替テキスト。 | | `secondaryHeroMode` | セカンダリヒーローセクションの表示モードまたはスタイル。 | | `trackingTags` | バナー X キャンペーンのパフォーマンスを監視および分析するためのトラッキングプロバイダーとそれに関連付けられたタグを指定するために使用されるオブジェクトの必須配列。 | | `additionalFields` | バナー X の追加設定オプションを提供するオブジェクトの必須配列。 | ## バナーキャンペーン項目 | フィールド | 目的と例 | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentStandardId` |

コンテンツ規格の一意の識別子。コンテンツ規格とは、ウェブサイトまたはデジタルプラットフォーム上の指定された領域内にバナー広告をどのように表示するかを指示するガイドラインおよび技術パラメータです。

この識別子は、作成されたバナーアセットが小売業者のコンテンツ規格に準拠していることを確認するために必要です。

| | `slotId` | 'homepage\_banner\_slot\_1' など、設定内の枠の一意の識別子。この識別子は、シングルタイル、ダブルタイル、バナーなど、小売業者によって定義された正しい枠をバナーが使用するようにします。 | | `artworkImageId` | バナー用にアップロードされたアートワーク画像の一意の識別子。この ID (fileId) は「クリエイティブアセットのアップロード」API によって返されます。 | | `link` | これはバナー枠にリンクされている URL で、ユーザーが広告をクリックしたときにターゲットページに誘導します。例: | | `altText` | アクセシビリティ目的でアートワーク画像を説明する代替テキスト。例: 'サマーセールのプロモーションバナー'。 | | `text` | バナーの表示テキスト。枠の表示テキストで、追加情報やメッセージを提供します。例: '初回購入が20%オフ！' | | `trackingTags` | 枠とのインタラクションを監視するために使用される、プロバイダーからのトラッキングタグのリスト。例: \[ { provider: 'Google Analytics', tag: 'promo\_click' }, { provider: 'Adobe Analytics', tag: 'banner\_view' } ]。これらのタグは、サードパーティ検証のために広告に含まれます。 | --- # 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/campaign-field-definitions.md?ask=&goal= ``` `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.