> ## Documentation Index
> Fetch the complete documentation index at: https://dev-docs.trychainshift.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 구글 자동완성

> 기준 키워드를 포함하는 세부(롱테일) 구글 키워드를 검색량 내림차순으로 조회합니다. 기준 키워드는 목록에서 제외되며, 그 지표는 응답의 metrics 필드로 제공됩니다. 기준 키워드에 검색 데이터가 없으면 metrics가 null입니다.



## OpenAPI

````yaml GET /v1beta/platform/keywords/google/suggestions
openapi: 3.1.0
info:
  description: >-
    외부 파트너용 플랫폼 API. 조직 API 키 기반 인증을 사용합니다.

    ### 공통 요청 제한

    - 요청 body 크기는 최대 2MiB이며, 초과 시 413과 함께 `COMMON_REQUEST_BODY_TOO_LARGE` 코드를
    반환합니다.

    - 배열 파라미터와 문자열 필드에는 엔드포인트별 개수·길이 상한이 있습니다. 상한은 각 필드/파라미터 설명에 명시되어 있으며, 위반 시
    400과 함께 `COMMON_VALIDATION` 코드를 반환합니다.

    - 검증 실패 시 `details` 배열에 위반 필드와 사유가 담깁니다. 예:
    `{"code":"COMMON_VALIDATION","message":"데이터 검증에
    실패했습니다","details":["keywords: 최대 100개까지 입력할 수 있습니다"]}`

    - `message`와 `details`는 Accept-Language 헤더에 따라 한국어(ko) 또는 영어(en)로 제공됩니다.
  title: Platform API
  version: '1.0'
servers:
  - url: https://dev-platform-api.trychainshift.ai/api
security: []
tags:
  - description: API 키가 귀속되는 최상위 계정 단위입니다. 조직의 기본 정보를 조회합니다.
    name: Organization
  - description: AI 서비스에서 노출을 모니터링하는 대상 브랜드입니다. 브랜드 등록·조회·수정·삭제를 제공합니다.
    name: Brand
  - description: >-
      브랜드와 시장을 분석하기 위한 키워드 인텔리전스입니다. 구글·네이버 검색 지표, 연관·자동완성 키워드 조회와 사이트 URL 기반
      키워드 분석을 제공합니다.
    name: Keyword
  - description: 프롬프트를 목적별로 묶는 그룹입니다. 프롬프트 세트 생성·조회·수정·삭제를 제공합니다.
    name: PromptSet
  - description: AI 서비스에 질의하는 문장 단위입니다. 프롬프트 생성·조회·수정·삭제와 대량 생성을 제공합니다.
    name: Prompt
  - description: 실행(Run)에 사용하는 AI 서비스 모델입니다. 지원 모델 목록을 조회합니다.
    name: Model
  - description: Run 제출에 사용하는 실행 지역입니다. 지원 리전 목록을 조회합니다.
    name: Region
  - description: 프롬프트를 AI 서비스에 실제로 실행하는 작업 단위입니다. Run 제출과 진행 상태·목록 조회를 제공합니다.
    name: Run
  - description: 실행으로 수집된 AI 서비스의 응답입니다. 인용 출처·검색 쿼리를 포함한 답변을 조회합니다.
    name: Answer
  - description: 답변에 인용된 출처를 도메인·URL 단위로 집계한 지표입니다. 인용 요약, 도메인별·URL별 인용 집계를 조회합니다.
    name: SourceStatistics
  - description: 답변 본문의 토큰(Kiwi 명사)을 집계한 지표입니다. 많이 나온 토큰 랭킹과 특정 단어의 근접 토큰을 조회합니다.
    name: AnswerStatistics
  - description: AI가 답변 생성 시 실제로 던진 검색 쿼리(팬아웃)를 집계한 지표입니다. 검색 쿼리별 등장 횟수 랭킹을 조회합니다.
    name: FanoutStatistics
  - description: 텍스트에서 고유명사를 식별하는 부가 기능입니다. 고유명사 추출을 제공합니다.
    name: ProperNoun
  - description: 조직 크레딧 잔액 및 플랫폼 API 과금 정보입니다. 현재 크레딧 잔액을 조회합니다.
    name: Credit
externalDocs:
  description: ''
  url: ''
paths:
  /v1beta/platform/keywords/google/suggestions:
    get:
      tags:
        - Keyword
      summary: 구글 키워드 제안(자동완성) 조회
      description: >-
        기준 키워드를 포함하는 세부(롱테일) 구글 키워드를 검색량 내림차순으로 조회합니다. 기준 키워드는 목록에서 제외되며, 그 지표는
        응답의 metrics 필드로 제공됩니다. 기준 키워드에 검색 데이터가 없으면 metrics가 null입니다.
      operationId: listGoogleKeywordSuggestions
      parameters:
        - description: 세부 키워드를 조회할 기준 키워드 (80자 이내)
          in: query
          name: keyword
          required: true
          schema:
            type: string
        - description: 언어 코드 (ISO 639-1, 기본 ko)
          in: query
          name: languageCode
          schema:
            type: string
        - description: 국가 코드 (ISO 3166-1 alpha-2, 기본 KR)
          in: query
          name: countryCode
          schema:
            type: string
        - description: 최대 반환 개수 (기본 30, 최대 100)
          in: query
          name: limit
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/domain.ListGoogleKeywordSuggestionsResponse
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.Error'
          description: >-
            잘못된 요청: 검증 실패, 지원하지 않는 국가 코드(KEYWORD_COUNTRY_NOT_SUPPORTED), 공급자
            거부(KEYWORD_METRICS_PROVIDER_REJECTED)
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.Error'
          description: '인증 실패: API 키가 유효하지 않습니다'
        '402':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.Error'
          description: 크레딧 부족 (INSUFFICIENT_CREDITS)
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.Error'
          description: 요청 한도 초과 (PLATFORM_RATE_LIMIT_EXCEEDED, Retry-After 헤더 참조)
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.Error'
          description: 서버 내부 오류
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.Error'
          description: 지표 공급자 호출 실패 (KEYWORD_METRICS_PROVIDER_UNAVAILABLE)
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain.Error'
          description: 키워드 지표 기능 비활성 (KEYWORD_METRICS_NOT_CONFIGURED)
      security:
        - OrgAPIKeyAuth: []
components:
  schemas:
    domain.ListGoogleKeywordSuggestionsResponse:
      properties:
        countryCode:
          description: 적용된 국가 코드 (기본값 반영)
          type: string
        keyword:
          description: 조회 기준 키워드 (에코)
          type: string
        languageCode:
          description: 적용된 언어 코드 (기본값 반영)
          type: string
        metrics:
          $ref: '#/components/schemas/domain.GoogleKeywordMetricsDTO'
        suggestedKeywords:
          description: 제안 키워드 (검색량 내림차순, 기준 키워드 제외)
          items:
            $ref: '#/components/schemas/domain.GoogleKeywordMetricsItemDTO'
          type: array
          uniqueItems: false
      required:
        - countryCode
        - keyword
        - languageCode
        - suggestedKeywords
      type: object
    domain.Error:
      properties:
        code:
          type: string
        details: {}
      type: object
    domain.GoogleKeywordMetricsDTO:
      description: 검색 지표 (null = 데이터 없음)
      properties:
        cpc:
          description: 평균 클릭당 비용 (USD)
          type: number
        keywordDifficulty:
          description: SEO 난이도 (0~100)
          type: integer
        monthlySearches:
          description: 최근 12개월 월별 검색량
          items:
            $ref: '#/components/schemas/domain.GoogleMonthlySearchDTO'
          type: array
          uniqueItems: false
        searchIntent:
          description: 검색 의도 (informational | navigational | commercial | transactional)
          type: string
        searchVolume:
          description: 월평균 검색량. null = Google Ads 제한 카테고리(의료·금융 등)로 검색량 비공개
          type: integer
        searchVolumeTrend:
          $ref: '#/components/schemas/domain.GoogleSearchVolumeTrendDTO'
      type: object
    domain.GoogleKeywordMetricsItemDTO:
      properties:
        keyword:
          description: 키워드 (요청 원문 그대로)
          type: string
        metrics:
          $ref: '#/components/schemas/domain.GoogleKeywordMetricsDTO'
      required:
        - keyword
      type: object
    domain.GoogleMonthlySearchDTO:
      properties:
        month:
          description: 월 (1~12)
          type: integer
        searchVolume:
          description: 해당 월 검색량
          type: integer
        year:
          description: 연도
          type: integer
      required:
        - month
        - year
      type: object
    domain.GoogleSearchVolumeTrendDTO:
      description: 기간별 검색량 증감률 (%)
      properties:
        monthly:
          description: 전월 대비 (%)
          type: number
        quarterly:
          description: 전분기 대비 (%)
          type: number
        yearly:
          description: 전년 대비 (%)
          type: number
      type: object
  securitySchemes:
    OrgAPIKeyAuth:
      description: '"조직 API 키를 입력하세요. 예: ''cs_live_xxxx'' 또는 ''cs_test_xxxx''"'
      in: header
      name: API-Key
      type: apiKey

````