Naver¶

Naver SearchAd(검색광고) API 호출을 위한 모듈로 현재는 SearchAd API 중 Bizmoney와 RelKwdStat만 제공한다.

http://naver.github.io/searchad-apidoc

class Bizmoney(api_key, secret_key, customer_id)[소스]¶

Naver SearchAd API Bizmoney

Naver SearchAd에서 API키를 발급받은 api_key, secret_key, customer_id를 사용하여 Bizmoney 클래스 객체를 생성한다. 생성한 Bizmoney 객체로 Bizmoney의 잔액, 사용금액, 충전내역, 잠금상태에 대한 정보를 얻을 수 있다.

http://naver.github.io/searchad-apidoc/#/tags/Bizmoney

사용 예시) 2021-11-18 에 사용한 금액을 받아온다.

>>> from soomgogather.naver import Bizmoney

>>> bizmoney = Bizmoney(api_key='_', secret_key='_', customer_id='_')

>>> r = bizmoney.exhaust(params={
...    'search_start_dt': '20211118',
...    'search_end_dt': '20211118',
... })

>>> if r.status_code == 200:
...     print(r.json())

charge(params={})[소스]¶

파라미터로 전달한 기간의 Bizmoney 충전 내역을 반환한다.

매개변수: params (dict) – 충전 내역 데이터를 받아오기 위한 매개변수, search_start_dt, search_end_dt 모두 필수

params:

search_start_dt (str) : 조회 시작일, YYYYMMDD (KST)
search_end_dt (str) : 조회 종료일, YYYYMMDD (KST)

cost(params={})[소스]¶

파라미터로 전달한 기간의 Bizmoney 사용된 금액을 반환한다.

매개변수: params (dict) – 사용금액 데이터를 받아오기 위한 매개변수, search_start_dt, search_end_dt 모두 필수

params:

search_start_dt (str) : 조회 시작일, YYYYMMDD (KST)
search_end_dt (str) : 조회 종료일, YYYYMMDD (KST)

exhaust(params={})[소스]¶

파라미터로 전달한 기간의 Bizmoney 공제된 내역을 반환한다.

매개변수: params (dict) – 공제 내역 데이터를 받아오기 위한 매개변수, search_start_dt, search_end_dt 모두 필수

params:

search_start_dt (str) : 조회 시작일, YYYYMMDD (KST)
search_end_dt (str) : 조회 종료일, YYYYMMDD (KST)

period(params={})[소스]¶

파라미터로 전달한 기간의 일자별 BizMoney 상태값을 반환한다.

매개변수: params (dict) – 요청한 기간동안의 데이터를 받아오기 위한 매개변수, search_start_dt, search_end_dt 모두 필수

params:

search_start_dt (str) : 조회 시작일, YYYYMMDD (KST)
search_end_dt (str) : 조회 종료일, YYYYMMDD (KST)

status()[소스]¶: Bizmoney 잔액과 환불/예산의 잠금상태를 반환한다.

class RelKwdStat(api_key, secret_key, customer_id)[소스]¶

Naver SearchAd API RelKwdstat

Naver SearchAd에서 API키를 발급받은 api_key, secret_key, customer_id를 사용하여 RelKwdStat 클래스 객체를 생성한다. 생성한 RelKwdStat 객체를 사용하여 연관 검색어의 통계정보(Query count, Click count, CTR, 경쟁력 지표)에 대한 정보를 얻을 수 있다.

http://naver.github.io/searchad-apidoc/#/tags/RelKwdStat

사용 예시) 숨고와 숨고의 연관검색어에 대한 통계정보를 받아온다.

>>> from soomgogather.naver import RelKwdStat

>>> rel_keyword_stat = Relkwdstat(api_key='_', secret_key='_', customer_id='_')

>>> r = rel_keyword_stat.list(params={
...    'hint_keywords' : '숨고,soomgo',
... })

>>> if r.status_code == 200:
...     print(r.json())

list(params={})[소스]¶

파라미터의 조건에 맞는 키워드의 지표를 반환한다.

매개변수: params (dict) – 연관 검색어 데이터를 받아오기 위한 매개변수, show_detail 을 제외한 5개의 파라미터 중 1개 이상 지정되어야 결과값이 나옴

params:

site_id (str) : 채널타입이 SITE인 비즈니스 채널 ID(nccBusinessChannelId)
biztp_id (int) :: 비즈니스 타입 ID
hint_keywords (str)검색어 - comma(,)로 구분하여 5개까지 가능, 공백 허용 안됨
ex) `soomgo, 숨고` (X) `soomgo,숨 고` (X) `soomgo,숨고` (O)
event (int)시즌테마
- https://gist.github.com/naver-searchad/235202ffb08f9433b6f7cb10e45875f7#file-seasonal_event_code-md
month (int) : 월
show_detail (int)상세정보 조회 여부
- 0: 상세정보 조회안함(기본값)
- 1: 상세정보 조회

class MasterReport(api_key, secret_key, customer_id)[소스]¶

Naver SearchAd API MasterReport

Naver SearchAd API에서 발급받은 api_key, secret_key, customer_id를 사용하여 MasterReport 클래스 객체를 생성한다. 생성한 MasterReport 객체로 마스터 기능을 이용하여 종류별 광고 정보 일괄 다운로드(마스터 데이터)하고 각 광고 정보를 확인할 수 있다.

광고 정보 일괄 다운로드는 특정 시점을 기준으로 광고 계정에 등록된 모든 광고 정보를 다운로드하는 기능으로 상시로 변경되는 정보는 제공되지 않으며 사용자가 등록한 광고 정보만 제공된다. 다운로드된 광고 정보는 각각 종류별 정보만 담고있다.

광고 정보 일괄 다운로드(마스터 기능 이용하기)의 최대 제공 기간은 〈최근 2년(730일)〉이다.
데이터가 존재하지 않는 경우 다운로드 링크는 제공되지 않는다.
일부 항목은 변경 분 데이터를 제공하지 않는다.
릴리즈 노트 참고 - (http://naver.github.io/searchad-apidoc/#/release-notes)

https://naver.github.io/searchad-apidoc/#/tags/MasterReport

사용 예시) 특정 시점을 기준으로 광고 계정에 광고 정보에 대한 마스터리포트를 생성하고, 등록된 모든 광고 정보를 다운로드 할 수 있다.

>>> from soomgogather.naver import MasterReport

>>> master_report = MasterReport(api_key='_', secret_key='_', customer_id='_')

>>> r = master_report.create(params={
...     'item': 'Media',
... })

>>> if r.status_code == 204:
...     print("Media 광고 정보가 생성되었습니다.")

>>> r = master_report.list()

>>> if r.status_code == 200:
...     print(r.json())

create(params)[소스]¶

필요한 항목을 선택하여 마스터 리포트를 요청하고, 해당 항목에 대한 광고 정보 리포트를 생성한다.

https://gist.github.com/naver-searchad/186ca42e1e8596b0e3dcf74e3a86c04f

매개변수: params (dict) – 쿼리 스트링을 구성하기 위한 매개변수, item은 필수

params:

item (str) : 제공되는 광고 정보 목록 (네이버에서 제공하는 항목 중에 선택)
from_time (str, optional) - 특정 시점 (ISO 8601 UTC, 2021-12-01T00:00:00Z)

delete(job_id)[소스]¶

해당 마스터 리포트를 job id로 삭제한다.

매개변수: job_id (str) – 유효한 마스터 리포트 Job id

delete_all()[소스]¶: 모든 마스터 리포트 작업을 삭제한다.

get(job_id)[소스]¶

특정 job_id를 사용해서 해당 마스터 리포트의 작업 상세 정보를 가져온다.

매개변수: job_id (str) – 유효한 마스터 리포트 Job id

list()[소스]¶: 요청을 통해 생성된 광고 정보에 대한 작업 목록(최대 100개)을 가져온다.

class StatReport(api_key, secret_key, customer_id)[소스]¶

Naver SearchAd API StatReport

Naver SearchAd API에서 발급받은 api_key, secret_key, customer_id를 사용하여 StatReport 클래스 객체를 생성한다. 생성한 StatReport 객체로 대용량 보고서 기능을 이용하여 특정일에 발생한 대용량 보고서 다운로드(Stat 데이터)하고 광고 효과 보고서를 확인할 수 있다.

대용량 보고서 다운로드는 계정 단위로 특정일에 발생한 광고 효과 보고서를 다운로드하는 기능으로 일 단위로만 신청 가능하며, 기간별 조회 기능은 제공되지 않는다. 다운로드 항목에서 필요한 보고서 종류를 선택하고 생성 요청하여 사용할 수 있다.

대용량 보고서의 최대 제공 기간은 최근 1년이다. 유형에 따라 기간이 상이하다.

https://naver.github.io/searchad-apidoc/#/tags/StatReport

사용 예시) 계정단위로 특정일에 발생한 광고 효과 보고서(Stat 리포트)를 생성하고, 등록된 모든 광고 효과 보고서를 다운로드 할 수 있다.

>>> from soomgogather.naver import StatReport

>>> stat_report = StatReport(api_key='_', secret_key='_', customer_id='_')

>>> r = stat_report.create(params={
...     'report_type': 'AD_CONVERSION',
...     'report_date': '20211201',
... })

>>> if r.status_code == 204:
...     print("AD_CONVERSION 광고 효과 보고서가 생성되었습니다.")

>>> r = stat_report.list()

>>> if r.status_code == 200:
...     print(r.json())

create(params)[소스]¶

필요한 항목을 선택하여 대용량 보고서(Stat Report)를 요청하고, 특정일에 발생한 광고 효과 보고서를 생성한다.

https://naver.github.io/searchad-apidoc/#/operations/POST/~2Fstat-reports

매개변수: params (dict) – 쿼리 스트링을 구성하기 위한 매개변수

params:

reportTp (str) : 제공되는 광고 성과 목록 (네이버에서 제공하는 항목 중에 선택)
statDt (str) - 특정일 (ISO 8601(UTC): 2021-12-01T00:00:00Z, YYYYMMDD(KST): 20211201)

Naver¶

Soomgo-gather

탐색

Related Topics