Toss Ads

https://toss-ads.gitbook.io/guide
Admin
Toss Ads is an advertising platform that enables businesses to run display and reward ad campaigns...
Tokens:93,773
Snippets:773
Trust Score:9.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Querying Documentation via HTTP GET

Source: https://toss-ads.gitbook.io/guide/a-d/creative-guidelines.md

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve specific information.

```http
GET https://toss-ads.gitbook.io/guide/a-d/creative-guidelines.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://toss-ads.gitbook.io/guide/a-d/app-install/banner-guide.md

GitBook 문서에서 정보를 동적으로 조회하기 위해 사용하는 HTTP GET 요청 예시입니다.

```http
GET https://toss-ads.gitbook.io/guide/a-d/app-install/banner-guide.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /guide/intro.md

Source: https://toss-ads.gitbook.io/guide/intro

Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /guide/intro.md

### Description
Retrieves information from the documentation by providing a natural language question and an optional end goal.

### Method
GET

### Endpoint
https://toss-ads.gitbook.io/guide/intro.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

--------------------------------

### GET /guide/account.md

Source: https://toss-ads.gitbook.io/guide/account

Queries the documentation for specific information using a natural language question and an optional goal context.

```APIDOC
## GET /guide/account.md

### Description
Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored answer with relevant excerpts.

### Method
GET

### Endpoint
https://toss-ads.gitbook.io/guide/account.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /guide/review.md

Source: https://toss-ads.gitbook.io/guide/review

Queries the documentation for specific information using a natural language question and an optional goal.

```APIDOC
## GET /guide/review.md

### Description
Queries the documentation dynamically to retrieve answers, relevant excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://toss-ads.gitbook.io/guide/review.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /guide/billing.md

Source: https://toss-ads.gitbook.io/guide/billing

Queries the documentation for specific information using natural language questions.

```APIDOC
## GET /guide/billing.md

### Description
Queries the documentation dynamically by providing a natural language question. This is useful for retrieving information not explicitly detailed on the current page.

### Method
GET

### Endpoint
https://toss-ads.gitbook.io/guide/billing.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /guide/targeting/list.md

Source: https://toss-ads.gitbook.io/guide/llms.txt

Performs a natural language query against the documentation index to retrieve an answer and relevant sources.

```APIDOC
## GET /guide/targeting/list.md

### Description
Perform an HTTP GET request on the documentation index to ask a specific question and optionally provide an end goal for context.

### Method
GET

### Endpoint
https://toss-ads.gitbook.io/guide/targeting/list.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /guide/reports.md

Source: https://toss-ads.gitbook.io/guide/reports

Performs a dynamic query against the documentation page to retrieve answers and relevant excerpts based on a user question.

```APIDOC
## GET /guide/reports.md

### Description
Queries the documentation dynamically to get answers to specific questions, optionally providing a goal to tailor the response.

### Method
GET

### Endpoint
https://toss-ads.gitbook.io/guide/reports.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### TossPixel.signUp()

Source: https://toss-ads.gitbook.io/guide/tracking/tosspixel/preservationguide-1.md

Tracks a user sign-up event.

```APIDOC
## TossPixel.signUp()

### Description
Tracks when a user completes the sign-up process.

### Method
JavaScript SDK Method

### Parameters
- **custom_param1/2** (string) - Optional - Custom tracking parameters.
```

--------------------------------

### 토스 픽셀 이벤트 메서드

Source: https://toss-ads.gitbook.io/guide/tracking/tosspixel.md

토스 픽셀 SDK에서 제공하는 이벤트 추적 메서드 목록입니다. 각 메서드는 웹사이트 내 특정 사용자 행동을 기록합니다.

```APIDOC
## 토스 픽셀 이벤트 메서드

### 설명
웹사이트 내 사용자 행동을 추적하기 위해 호출하는 SDK 메서드입니다.

### 메서드 목록
- **purchase()** - 결제 및 주문 완료(매출 발생)
- **signUp()** - 회원가입 완료
- **lead()** - 상담 신청, 양식 제출
- **productView()** - 상품/콘텐츠 상세 페이지 조회
- **addToCart()** - 장바구니 상품 추가
- **initiateCheckout()** - 결제/주문 페이지 진입
- **install()** - 앱 설치 완료
- **appOpen()** - 앱 실행
- **search()** - 서비스 내 검색 결과 조회
- **signIn()** - 로그인 완료
- **pageView()** - 페이지 방문
- **viewHome()** - 홈 화면 방문
- **firstPurchase()** - 첫 구매 완료
- **getOffer()** - 쿠폰 다운로드 / 혜택 수령
- **addToWishlist()** - 상품 위시리스트 추가
- **subscribe()** - 알림 신청 / 구독 시작
- **appDeeplinkOpen()** - 딥링크를 통한 앱 실행
- **preRegister()** - 사전 예약 / 런칭 전 등록
- **viewLimit()** - 대출/보험료 한도 조회
- **applyScreening()** - 가심사 조회 / 적격 확인
- **adImpression()** - 광고 노출 (매출 발생)
- **custom()** - 자유롭게 정의 가능한 커스텀 이벤트
```

--------------------------------

### Track Subscribe Events

Source: https://toss-ads.gitbook.io/guide/tracking/tosspixel/preservationguide-1.md

Call this function when a user starts a subscription or requests notifications.

```html
<script>
  TossPixel('전환 코드').subscribe({
    lead_type: "Newsletter",
    custom_param1: "push_opt_in",
    custom_param2: "app"
  });
</script>
```

--------------------------------

### GET /targeting.md

Source: https://toss-ads.gitbook.io/guide/targeting

Queries the documentation for specific information regarding targeting configurations using natural language.

```APIDOC
## GET /targeting.md

### Description
Queries the documentation dynamically by asking a question to retrieve information or context about targeting settings.

### Method
GET

### Endpoint
https://toss-ads.gitbook.io/guide/targeting.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question written in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

--------------------------------

### TossPixel.initiateCheckout()

Source: https://toss-ads.gitbook.io/guide/tracking/tosspixel/preservationguide-1.md

Tracks when a user enters the checkout or order page.

```APIDOC
## TossPixel.initiateCheckout()

### Description
Tracks the initiation of the checkout process.

### Method
JavaScript SDK Method

### Parameters
- **order_id** (string) - Required - Order identifier.
- **revenue** (number) - Required - Total order value.
- **products** (array) - Required - List of products in checkout.
```

--------------------------------

### TossPixel.signIn()

Source: https://toss-ads.gitbook.io/guide/tracking/tosspixel/preservationguide-1.md

Tracks user login events.

```APIDOC
## TossPixel.signIn()

### Description
Tracks when a user successfully logs in.

### Method
JavaScript SDK Method
```

--------------------------------

### GET /guide/catalog.md

Source: https://toss-ads.gitbook.io/guide/catalog

현재 문서 페이지를 대상으로 질문을 던져 관련 정보와 소스를 동적으로 조회합니다.

```APIDOC
## GET /guide/catalog.md

### Description
현재 문서 페이지를 대상으로 질문을 던져 관련 정보와 소스를 동적으로 조회합니다.

### Method
GET

### Endpoint
https://toss-ads.gitbook.io/guide/catalog.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - 질문 내용
- **goal** (string) - Optional - 최종 목표
```

--------------------------------

### TossPixel.firstPurchase()

Source: https://toss-ads.gitbook.io/guide/tracking/tosspixel/preservationguide-1.md

Tracks the first purchase event.

```APIDOC
## TossPixel.firstPurchase()

### Description
Tracks the first successful purchase by a user.
```

--------------------------------

### TossPixel.getOffer()

Source: https://toss-ads.gitbook.io/guide/tracking/tosspixel/preservationguide-1.md

Tracks coupon downloads or benefit claims.

```APIDOC
## TossPixel.getOffer()

### Description
Tracks when a user downloads a coupon or claims an offer.
```

--------------------------------

### Test Landing URL Example

Source: https://toss-ads.gitbook.io/guide/tracking/tosspixel/preservationguide.md

Use this URL format to verify that the tcid parameter is correctly passed to the landing page.

```http
https://www.example.com/?tcid=t2_test_6def583292221593d7951f7f9d454bc6e2e624d1dd
```

--------------------------------

### 카탈로그 문서 질의 API 호출

Source: https://toss-ads.gitbook.io/guide/catalog/spec.md

GitBook 문서 내에서 특정 정보를 검색하기 위해 HTTP GET 요청을 수행합니다.

```http
GET https://toss-ads.gitbook.io/guide/catalog/spec.md?ask=<question>&goal=<endgoal>
```
Tokens:
Raw