파트너 API

배너 x 참조

아래에서는 귀하의 요청과 귀하가 광고를 수신하는 경우 응답에 대한 광고 요청 에 기술된 대로 표준 요청에서 사용 가능한 속성을 간략히 설명합니다.

요청된 항목

문자열설명필수/선택
BannerSlotIds요청되는 배너 slotIds의 json 배열입니다.필수 입력 항목입니다
catalogId웹사이트의 제품 카탈로그 식별자입니다.필수 입력 항목입니다
contentStandardId웹사이트의 배너 사양 식별자입니다.필수 입력 항목입니다
customerId고객에게 제공되는 광고의 고유한 식별자입니다.선택 사항
filterMode요청 구조를 정의하는 선택적 방법입니다. 자세한 정보는 광고 생성 필터링 을 참조하십시오.선택 및 선호 사항
maxNumberOfAds반환하려는 각 배너 슬롯의 최대 수입니다.필수 입력 항목입니다
options요청 구조를 정의하는 선택적 방법입니다. 자세한 정보는 광고 생성 필터링 을 참조하십시오.선택 및 선호 사항
placement사용자가 요청하는 광고의 고유한 게재위치입니다.필수 입력 항목입니다
productFilters요청과 관련된 제품 필터입니다. 카테고리, 위치 또는 크기 필터가 있습니다.카테고리 게재위치에 필요합니다.
searchTerm고객이 웹 사이트에 입력한 검색어입니다.검색 게재위치에 필요합니다.
sessionId고객 세션의 고유 식별자입니다. 표준 통합의 속성에 사용됩니다. 자세한 정보는 통합 워크플로 옵션 을 검토하십시오.표준 통합 필수 항목
slotId여기에는 컨텍스트에서 요청된 모든 SlotId가 포함됩니다. 하나 또는 여러 개가 있을 수 있습니다.필수 입력 항목입니다

반환된 항목

문자열설명예시 값
backgroundColour배너의 배경 색상입니다. HEX 값만 적용됩니다.6e6c6c
backgroundImage배너 배경 이미지의 이미지 링크입니다.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
backgroundImagePosition배경 이미지의 위치 유형을 정의합니다. 값이 없는 경우 기본 값을 다음으로 설정해야 합니다: leftaligned .leftaligned
rightaligned
fill
repeating
bannerText배너에 표시되는 텍스트입니다. HTML 태그를 포함할 수 있습니다.<strong>Double Fudge Ice Cream</strong>
bannerTextColour배너 텍스트 색상 - HEX 값만 가능합니다. Citrus는 다음을 전송하지 않습니다: #.1dc711
citrusAdId광고의 고유한 ID입니다.
이는 CitrusAd에 대한 각 요청에 대해 고유하며 캐싱할 수 없습니다.		shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3
citrusCampaignName광고의 캠페인 이름입니다.CitrusAd-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6
citrusContentStandardId슬롯과 관련된 배너 사양 ID입니다.8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c
citrusExpiry광고의 만료일입니다. 클릭 수가 CitrusAd에 보고될 수 있는 가장 최근의 지점입니다.2021-06-01T23:48:16.573967987Z
citrusSlotId요청한 배너에 대한 특정 슬롯의 ID입니다.Category_Top
contentStandardId슬롯과 관련된 배너 사양 ID입니다. 다음의 중복입니다. citrusContentStandardId8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c
ctaFlagCTA의 표시 여부를 정의합니다.true
false
ctaLinkCTA에서 전달한 URL(배너의 linkUrl과 비슷한 역할). ctaFlag가 다음에 해당하는 경우에만: true<https://www.retailer.com/groceries/en-GB/search?query=double-fudge>
ctaTextCTA 내의 텍스트입니다.Shop now
ctaTextAccessibility스크린 리더 사용자를 위한 CTA의 내게 필요한 옵션 텍스트입니다.for Double Fudge Ice Cream
gtins캠페인의 광고 제품에서 선택한 제품 코드 최대 20개의 배열입니다.

소매업체는 이 목록을 사용하여 배너 클릭 시 리스터 페이지를 자동화하거나 특정 렌더링 기능(라운델, 가격 책정, 2차 재고 수준 점검)을 자동화할 수 있습니다.		[ "7714107", "7163379", "7733636", "7733657", "7733628" ],
headingText스크린 리더 사용자를 위한 제목 텍스트입니다.Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button
heroImageAltText간혹 히어로 이미지가 표시되지 않을 때를 위한 대체 텍스트입니다.Image of double fudge iced cream
heroImage배너의 히어로 이미지의 이미지 링크입니다.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
positionCitrusAd 응답에 있는 배너의 위치입니다. 고정된 테넌시 캠페인이 활용되는 경우 이 위치를 준수해야 합니다.1
secondaryBackgroundImage추가 배경 이미지의 이미지 링크입니다.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
secondaryBackgroundImagePosition추가 배경 이미지의 위치 유형을 정의합니다.leftaligned
rightaligned
secondaryHeroImageAltText간혹 추가 히어로 이미지가 표시되지 않을 때를 위한 대체 텍스트입니다.Image of [brand] logo
secondaryHeroImage추가 히어로 이미지의 이미지 링크입니다.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
secondaryHeroMode추가 히어로 이미지의 표시 모드를 정의합니다. 값이 없는 경우 기본 값을 다음으로 설정해야 합니다: block .block
landscape
slotId요청한 배너의 슬롯 ID입니다. 여러 배너를 요청할 때 요청된 ID를 참조하는 데 사용할 수 있습니다.Category_Top
tags이 필드는 캠페인에서 광고주가 입력한 모든 타사 태그를 반환합니다. API 응답이 포맷되어 있지만 현재 배너 x에 의해 지원되는 대상이 아닙니다.{}
sellerId판매자의 고유한 Id입니다. sellerId가 팀에 설정된 경우에만 표시됩니다. sellerIds는 일반적으로 마켓플레이스 판매자를 온보딩하는 경우에 사용됩니다.73nns-32sxr-32ss 통합별 사용자 정의

📘

광고 캠페인의 일부로 구성되지 않은 필드가 있는 경우 해당 필드가 제공되지 않습니다. 즉, 광고주가 heroImage를 구성하지 않은 경우에는 CitrusAd는 heroImage 속성을 실행하지 않습니다.