문제 해결

동영상: 2019년 워크숍의 오류 처리 강연 확인하기

오류는 잘못된 환경 설정, 소프트웨어의 버그 또는 사용자의 잘못된 입력으로 인해 발생할 수 있습니다. 출처와 관계없이 문제를 해결하고 코드를 수정하거나 사용자 오류를 처리하는 로직을 추가해야 합니다. 이 가이드에서는 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/matchtype'.",
      "location": { "operationIndex": "1" }
    }
  ]
}

모든 클라이언트 라이브러리는 응답에서 오류를 캡슐화하는 예외를 발생시킵니다. 이러한 예외를 캡처하고 로그 또는 문제 해결 화면에 메시지를 출력하는 것이 좋습니다. 이 정보를 애플리케이션에서 기록된 다른 이벤트와 통합하면 문제를 일으키는 원인을 간략하게 파악할 수 있습니다. 로그에서 오류를 확인한 후에는 그 의미를 파악해야 합니다.

오류 조사

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

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

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

  4. 문서에 설명되지 않은 오류가 발생하면 포럼에서 알려주세요.

  5. 유효성 검사 또는 계정 한도 문제 해결에 관한 도움말은 Google Ads 고객센터를 참고하세요. Google Ads API는 핵심 Google Ads 제품의 규칙과 제한사항을 상속합니다.

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

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

원인 찾기

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

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

문제를 해결할 때 애플리케이션이 API에 잘못된 정보를 제공하고 있을 수 있습니다. 디버깅을 돕기 위해 Eclipse (주로 Java 개발에 사용되지만 다른 언어용 플러그인이 있는 무료 오픈소스 IDE)와 같은 대화형 개발 환경 (IDE)을 사용하는 것이 좋습니다. 이를 통해 중단점을 설정하고 코드를 한 줄씩 단계별로 실행할 수 있습니다.

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

지원을 받는 방법

문제를 직접 식별하고 해결할 수 없는 경우도 있습니다. 포럼에 질문하면 동일한 문제를 처리해야 했던 수천 명의 개발자에게 질문이 노출됩니다.

검색어에 최대한 많은 정보를 포함해 보세요. 다음의 항목을 포함할 것을 권장합니다.

  • 정리된 JSON 요청 및 응답 개발자 토큰 또는 AuthToken과 같은 민감한 정보는 삭제해야 합니다.
  • 코드 스니펫 언어 관련 문제가 있거나 API 사용과 관련하여 도움을 요청하는 경우 수행 중인 작업을 설명하는 데 도움이 되는 코드 스니펫을 포함하세요.
  • RequestId. 이렇게 하면 Google 개발자 관계팀 구성원이 프로덕션 환경에 대해 요청한 경우 요청을 찾을 수 있습니다. 응답 오류를 캡슐화하는 예외에 속성으로 포함된 requestId와 requestId 이외의 더 많은 컨텍스트를 로그에 등록하는 것이 좋습니다.
  • 런타임/인터프리터 버전, 플랫폼과 같은 추가 정보도 문제 해결 시 유용합니다.

문제 해결

이제 문제를 파악하고 해결 방법을 찾았으므로 변경사항을 적용하고 테스트 계정 (권장) 또는 프로덕션 (버그가 특정 프로덕션 계정의 데이터에만 적용되는 경우)에서 수정사항을 테스트할 시간입니다.

공유 고려

이전에 포럼에 표시되지 않았던 오류에 관한 질문을 게시한 후 해결 방법을 찾은 경우 대화목록에 추가하는 것이 좋습니다. 다음에 개발자가 동일한 문제를 겪을 때 바로 해결할 수 있습니다.

다음 단계

이제 이 문제를 해결했으므로 이러한 문제가 처음부터 발생하지 않도록 코드를 개선할 방법을 발견하셨나요?

유닛 테스트 집합을 잘 만들면 코드 품질과 신뢰성을 크게 개선할 수 있습니다. 또한 새 변경사항이 이전 기능을 중단하지 않았는지 확인하는 테스트 프로세스의 속도를 높입니다. 좋은 오류 처리 전략은 문제 해결에 필요한 모든 데이터를 표시하는 데도 중요합니다.