아래에서는 표준 요청에서 가능한 속성과 광고를 수신하는 경우의 응답을 간략하게 설명합니다.
요청된 항목
| 문자열 | 설명 | 필수/선택 |
|---|---|---|
catalogId | 웹사이트의 제품 카탈로그 식별자입니다. | 필수 입력 항목입니다 |
customerId | 고객에게 제공되는 광고의 고유한 식별자입니다. | 선택 사항 |
filterMode | 요청 구조를 정의하는 선택적 방법입니다. 자세한 정보는 광고 생성 필터링 을 참조하십시오. | 선택 및 선호 사항 |
maxNumberOfAds | 최대 10개까지 반환할 수 있는 최대 광고 수입니다. | 필수 입력 항목입니다 |
options | 요청 구조를 정의하는 선택적 방법입니다. 더 자세한 사항은 광고 생성 필터링을 참조하세요. 이것은 또한 유럽 디지털 서비스법과 같은 국가별 광고 법률을 준수하기 위해 광고주 정보를 요청할 수 있는 객체입니다. | 선택 및 선호 사항 |
placement | 사용자가 요청하는 광고의 고유한 게재위치입니다. | 필수 입력 항목입니다 |
productFilters | 요청과 관련된 제품 필터입니다. 카테고리, 위치 또는 크기가 있습니다. | 필수 입력 항목입니다 |
sessionId | 고객 세션의 고유 식별자입니다. 표준 통합의 속성에 사용됩니다. 자세한 정보는 통합 워크플로 옵션 을 검토하십시오. | 표준 통합 필수 항목 |
memoryToken | 페이지 매김에 사용됩니다. 이전 광고 요청에서 제공된 토큰을 사용하여 CitrusAd가 고객에게 새 광고만 실행하도록 하십시오. 이 항목이 제공되면 CitrusAd는 광고 응답에서 이전에 실행된 광고를 제외합니다. 더 자세히 사항은 페이지 매김을 참조하십시오. | 선택 사항 |
dtmCookieId | 웹사이트에서 생성 및 저장하는 쿠키로 동일한 도메인에서 사용자 행동을 추적하는 데 사용됩니다. | 선택 사항 |
반환된 항목
| 문자열 | 설명 | 예시 값 |
|---|---|---|
customPayload | 카탈로그 파일에서 광고 생성으로 스레드되어야 하는 사용자 정의 페이로드입니다. 필드에는 바이트 배열로 직렬화된 유효한 JSON 오브젝트와 인코딩된 Base64가 포함되어야 합니다. JSON 오브젝트는 스키마를 준수해야 합니다. | 통합별 사용자 정의 |
sellerId | 판매자의 고유한 Id입니다. sellerId가 팀에 설정된 경우에만 표시됩니다. sellerIds는 일반적으로 마켓플레이스 판매자를 온보딩하는 경우에 사용됩니다. | 73nns-32sxr-32ss 통합별 사용자 정의 |
id | 광고의 고유한 ID입니다. 이는 CitrusAd에 대한 각 요청에 대해 고유하며 캐싱할 수 없습니다. | display_yCaCIy_kKaJnRnzrenBkVSytwr8yNTgxMzM4 |
gtin | 광고의 제품 코드입니다. 이는 제품 카탈로그에서 동기화되는 제품 코드입니다. | 25813383 |
discount | 무시할 수 있는 레거시입니다. | { "amount": 0, "minPrice": 0, "maxPerCustomer": 0 } |
position | CitrusAd 응답에 있는 광고의 위치입니다. 고정된 테넌시 캠페인이 활용되는 경우 이 위치를 준수해야 합니다. | 1 |
memoryToken | 페이지 매김 및 광고 요청 연결에 사용됩니다. 동일한 컨텍스트에 대한 다음 광고 요청에 이 항목이 제공되면, CitrusAd는 광고 응답에서 이전에 실행된 광고를 제외합니다. 더 자세한 사항은 페이지 매김을 참조하십시오. | |
metadata | 광고주가 유럽의 디지털 서비스법과 같은 국가별 광고법을 준수하는 데 필요한 광고주 정보를 포함한 객체입니다.advertiser 공급업체 팀의 회사 이름에서 가져온 것입니다.onBehalfOf 공급업체 팀의 광고 재정 담당자로부터 전달됩니다. | "metadata": { "advertiserInfo": { "advertiser": "Bob's advertising agency", "onBehalfOf": "Brand company inc" } ... |