문제 해결

오류는 잘못된 환경 설정, 소프트웨어의 버그 또는 사용자의 잘못된 입력으로 인해 발생할 수 있습니다. 소스와 관계없이 문제를 해결하고 코드를 수정하거나 사용자 오류를 처리하는 로직을 추가해야 합니다. 이 가이드에서는 Google Ads API의 오류 문제 해결 시 권장되는 몇 가지 방법을 설명합니다.

연결 확인

  1. Google Ads API에 액세스할 수 있고 올바르게 설정되어 있는지 확인합니다. 응답에서 HTTP 오류가 반환되면 신중하게 처리하고 코드에서 사용하려는 서비스에 도달하는지 확인합니다.

  2. 서비스에서 사용자를 인증할 수 있도록 사용자 인증 정보가 요청에 삽입됩니다. 특히 클라이언트 라이브러리를 사용하지 않고 호출을 처리하려는 경우 Google Ads API 요청 및 응답의 구조를 숙지하세요. 각 클라이언트 라이브러리에는 구성 파일에 사용자 인증 정보를 포함하는 방법에 관한 구체적인 안내가 포함되어 있습니다 (클라이언트 라이브러리의 README 참조).

  3. 올바른 사용자 인증 정보를 사용하고 있는지 확인합니다. 빠른 시작 가이드에서는 필요한 올바른 집합을 가져오는 과정을 안내합니다. 예를 들어 다음 응답 실패는 사용자가 잘못된 사용자 인증 정보를 전송했음을 보여줍니다.

    {
      "error": {
        "code": 401,
        "message": "Request had invalid authentication credentials. Expected OAuth 2 access token, login cookie or other valid authentication credential. Visit https://developers.google.com/identity/sign-in/web/devconsole-project.",
        "status": "UNAUTHENTICATED",
        "details": [
          {
            "@type": "type.googleapis.com/google.rpc.DebugInfo",
            "detail": "Authentication error: 2"
          }
        ]
      }
    }
    

이 단계를 따랐는데도 문제가 계속되면 Google Ads API 오류 문제 해결을 시작해야 합니다.

문제 파악하기

Google Ads API는 일반적으로 응답에 오류 목록이 포함된 JSON 실패 객체로 오류를 보고합니다. 이러한 객체는 오류 코드와 함께 오류가 발생한 이유를 설명하는 메시지를 제공합니다. 이러한 신호는 문제가 무엇인지에 대한 첫 번째 단서입니다.

{
  "errors": [
    {
      "errorCode": { "fieldMaskError": "FIELD_NOT_FOUND" },
      "message": "The field mask contained an invalid field: 'keyword.match_type'.",
      "location": {
        "fieldPathElements": [
          { "fieldName": "operations", "index": 1 }
        ]
      }
    }
  ]
}

모든 클라이언트 라이브러리는 응답의 오류를 캡슐화하는 예외를 발생시킵니다. 이러한 예외를 포착하고 로그 또는 문제 해결 화면에 메시지를 출력하는 것이 좋은 시작 방법입니다. 이 정보를 애플리케이션의 다른 로깅된 이벤트와 통합하면 문제를 일으키는 원인을 파악하는 데 도움이 됩니다. 로그에서 오류를 식별한 후에는 그 의미를 파악해야 합니다.

오류 조사

  1. 가장 자주 발생하는 오류를 다루는 일반적인 오류 문서를 참고하세요. 오류 메시지, 관련 API 참조, 오류를 방지하거나 처리하는 방법을 설명합니다.

  2. 일반적인 오류 문서에 오류가 구체적으로 언급되지 않은 경우 참고 문서를 참조하여 오류 문자열을 찾습니다.

  3. 지원 채널을 검색하여 API 사용 경험을 공유하는 다른 개발자에게 액세스할 수 있습니다. 다른 사용자가 이미 이 문제를 겪고 해결했을 수 있습니다.

  4. 유효성 검사 또는 계정 한도 문제 해결에 도움이 필요하면 Google Ads 고객센터로 이동하세요. Google Ads API는 핵심 Google Ads 제품의 규칙과 제한사항을 상속합니다.

  5. 블로그 게시물은 애플리케이션 문제를 해결할 때 유용한 참고 자료가 될 수 있습니다.

  6. 문서화되지 않은 오류가 발생하면 지원팀에 문의하세요.

오류를 조사한 후에는 근본 원인을 파악해야 합니다.

원인 찾기

예외 메시지를 확인하여 오류의 원인을 파악합니다. 응답을 확인한 후 요청에서 가능한 원인을 확인합니다. 일부 Google Ads API 오류 메시지에는 GoogleAdsError의 location 필드에 fieldPathElements가 포함되어 요청에서 오류가 발생한 위치를 나타냅니다. 예를 들면 다음과 같습니다.

{
  "errors": [
    {
      "errorCode": {"criterionError": "CANNOT_ADD_CRITERIA_TYPE"},
      "message": "Criteria type can not be targeted.",
      "trigger": { "stringValue": "" },
      "location": {
        "fieldPathElements": [
          { "fieldName": "operations", "index": 0 },
          { "fieldName": "create" },
          { "fieldName": "keyword" }
        ]
      }
    }
  ]
}

문제를 해결할 때 애플리케이션이 API에 잘못된 정보를 제공하고 있음을 발견할 수 있습니다. 통합 개발 환경 (IDE) 디버거를 사용하여 중단점을 설정하고, 코드를 한 줄씩 단계별로 실행하고, 구성된 요청 페이로드를 전송하기 전에 검사하는 것이 좋습니다.

요청이 애플리케이션 입력과 일치하는지 다시 한번 확인합니다 (예: 캠페인 이름이 요청에 포함되지 않을 수 있음). 원하는 업데이트와 일치하는 필드 마스크를 전송해야 합니다. Google Ads API는 희소 업데이트를 지원합니다. mutate 요청의 필드 마스크에서 필드를 생략하면 API가 해당 필드를 그대로 두어야 함을 나타냅니다. 애플리케이션이 객체를 검색하고 변경한 후 다시 전송하는 경우 업데이트를 지원하지 않는 필드에 쓸 수 있습니다. 참고 문서에서 필드 설명을 확인하여 필드를 업데이트할 수 있는 시기 또는 여부에 제한이 있는지 확인합니다.

지원을 받는 방법

문제를 직접 파악하고 해결하는 것이 항상 가능한 것은 아닙니다. 도움이 필요하면 지원팀에 문의하세요.

쿼리에 최대한 많은 정보를 포함하세요. 추천 항목은 다음과 같습니다.

  • 정제된 JSON 요청 및 응답입니다. OAuth 액세스 토큰, 갱신 토큰, 고객 ID와 같은 민감한 정보는 삭제해야 합니다.
  • 코드 스니펫 언어별 문제가 있거나 API 사용에 도움이 필요한 경우 코드 스니펫을 포함하여 수행 중인 작업을 설명하세요.
  • request-id. 이렇게 하면 Google 개발자 관계팀 구성원이 프로덕션 환경에 대한 요청을 찾을 수 있습니다. 응답 헤더에 포함된 request-id 또는 응답 오류를 캡슐화하는 예외와 request-id만 있는 경우보다 더 많은 컨텍스트를 로깅하는 것이 좋습니다.
  • 런타임 또는 인터프리터 버전 및 플랫폼과 같은 추가 정보도 문제를 해결할 때 유용할 수 있습니다.

문제 해결

이제 문제를 파악하고 해결책을 마련했으므로 변경사항을 적용하고 테스트 계정 (권장) 또는 프로덕션 (버그가 특정 프로덕션 계정의 데이터에만 적용되는 경우)에서 수정사항을 테스트해야 합니다.

다음 단계

이제 이 문제를 해결했으니, 애초에 이 문제를 방지하기 위해 코드를 개선할 방법을 찾으셨나요?

단위 테스트를 적절하게 만들면 코드 품질과 안정성을 크게 개선할 수 있습니다. 또한 새로운 변경사항을 테스트하는 프로세스를 가속화하여 이전 기능이 중단되지 않도록 합니다. 또한 우수한 오류 처리 전략은 문제 해결에 필요한 모든 데이터를 표시하는 데 핵심적인 역할을 합니다.