Bid Manager API v1.1에서 v2로 이전

2022년 3월에 Bid Manager API 버전 2가 출시되었습니다. 주어진 v1.1의 지원 종료 날짜를 곧 발표할 예정입니다. 가능한 한 빨리 v1.1에서 v2로 이전을 시작하는 것이 좋습니다.

애플리케이션 마이그레이션

v1.1에서 v2로 이전하려면 v2를 호출하도록 엔드포인트 URL을 업데이트해야 합니다. 브레이킹 체인지를 고려하여 애플리케이션을 업데이트하면 됩니다.

API 호출을 v1.1에서 v2로 업데이트

v1.1 대신 v2를 사용하려면 새로운 v2를 사용하도록 요청을 업데이트해야 합니다. 엔드포인트가 있습니다

등가의 메서드

API 호출을 v1.1에서 v2로 업데이트하려면 먼저 v1.1 메서드를 지원합니다.

모든 서비스 및 메서드의 다음 이름은 v1.1 및 v2:

• v1.1의 서비스 Queries 및 Reports는 알려져 있습니다. (v2의 경우 queries 및 queries.reports)
• v2에서는 메서드의 이름이 다음과 같이 변경되었습니다.

  v1.1 메서드 이름	상응하는 v2 메서드
  Queries.createquery	queries.create
  Queries.deletequery	queries.delete
  Queries.getquery	queries.get
  Queries.listqueries	queries.list
  Queries.runquery	queries.run
  Reports.listreports	queries.reports.list

새 엔드포인트로 업데이트

동일한 메서드를 식별한 후에는 요청을 업데이트해야 합니다. 대상 예를 들어 v1.1로 queries.getquery 메서드를 호출하려면 다음을 사용합니다. 다음 URL을 사용하세요.

https://www.googleapis.com/doubleclickbidmanager/v1.1/query/queryId

v2에서 동등한 메서드(queries.get라고 함)를 호출하려면 다음을 업데이트합니다. 다음으로 연결되는 URL:

GET https://doubleclickbidmanager.googleapis.com/v2/queries/queryId

클라이언트 라이브러리를 사용하여 API에 요청하는 경우 최신 버전의 클라이언트 라이브러리를 다운로드하고 v2를 사용하도록 구성을 업데이트하세요.

필수 변경사항 적용

v2에 여러 가지 브레이킹 체인지가 도입됩니다. 다음을 검토하세요. 안내에 따라 필요한 변경사항을 Bid Manager API

queries 서비스 호출 업데이트

• 원래 일반으로 표현된 Query 리소스의 다음 필드 중첩된 객체가 다음 객체 유형을 사용하도록 변경되었습니다.

  v1.1 필드	상응하는 v2 객체 유형
  metadata	QueryMetadata
  params	Parameters
  params.options	Options
  params.options.pathQueryOptions	PathQueryOptions
  params.options.pathQueryOptions.channelGrouping	ChannelGrouping
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter	PathQueryOptionsFilter
  params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter	PathQueryOptionsFilter
  schedule	QuerySchedule

• 원래 일반으로 표현된 Query 리소스의 다음 필드 list 객체가 다음과 같은 새로운 객체 유형 목록으로 변경되었습니다.

  v1.1 목록 필드	v2 객체 유형
  params.filters[]	FilterPair
  params.options.pathQueryOptions.channelGrouping.rules[]	Rule
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[]	DisjunctiveMatchStatement
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[]	EventFilter
  params.options.pathQueryOptions.pathFilters[]	PathFilter
  params.options.pathQueryOptions.pathFilters[].eventFilters[]	EventFilter

• Query 리소스의 다음 필드(원래 다음으로 표시됨) 문자열은 v2에서 enum 유형으로 표현되며 변경사항:
  • metadata.dataRange에 상응하는 v2 함수는 이제 Range를 사용합니다. enum입니다. 이 enum으로 변환할 때 PREVIOUS_HALF_MONTH 값은 다음과 같습니다. 삭제되어 TYPE_NOT_SUPPORTED 값이 RANGE_UNSPECIFIED입니다.
  • 이제 metadata.format가 Format enum을 사용합니다. 전환 중 EXCEL_CSV 값이 삭제되고 FORMAT_UNSPECIFIED이(가) 추가되었습니다.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match 및 params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match 이제 Match enum을 사용합니다.
  • 이제 params.options.pathQueryOptions.pathFilters[].pathMatchPosition에서 다음을 사용합니다. PathMatchPosition enum 로 변환 시 이 enum에 값 PATH_MATCH_POSITION_UNSPECIFIED가 추가되었습니다.
  • 이제 schedule.frequency가 Frequency enum을 사용합니다. 포함 이 enum으로 변환하면 FREQUENCY_UNSPECIFIED 값이 추가되었습니다.
  • 이제 params.type가 ReportType enum을 사용합니다. 포함 이 enum으로 변환하면 다음과 같이 변경되었습니다.
  • 다음 값은 지원 중단되었습니다. <ph type="x-smartling-placeholder">
    </ph>
    • TYPE_ACTIVE_GRP
    • TYPE_AUDIENCE_PERFORMANCE
    • TYPE_CLIENT_SAFE
    • TYPE_COMSCORE_VCE
    • TYPE_CROSS_FEE
    • TYPE_CROSS_PARTNER
    • TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER
    • TYPE_ESTIMATED_CONVERSION
    • TYPE_FEE
    • TYPE_KEYWORD
    • TYPE_LINEAR_TV_SEARCH_LIFT
    • TYPE_NIELSEN_AUDIENCE_PROFILE
    • TYPE_NIELSEN_DAILY_REACH_BUILD
    • TYPE_NIELSEN_ONLINE_GLOBAL_MARKET
    • TYPE_PAGE_CATEGORY
    • TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD
    • TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET
    • TYPE_PIXEL_LOAD
    • TYPE_THIRD_PARTY_DATA_PROVIDER
    • TYPE_TRUEVIEW_IAR
    • TYPE_VERIFICATION
    • TYPE_YOUTUBE_VERTICAL
  • 나머지 값은 UI에서 상응하는 값을 찾습니다.

    v1.1 값	상응하는 ReportType 값
    TYPE_NOT_SUPPORTED	REPORT_TYPE_UNSPECIFIED
    TYPE_GENERAL	STANDARD
    TYPE_INVENTORY_AVAILABILITY	INVENTORY_AVAILABILITY
    TYPE_AUDIENCE_COMPOSITION	AUDIENCE_COMPOSITION
    TYPE_ORDER_ID	FLOODLIGHT
    TYPE_TRUEVIEW	YOUTUBE
    TYPE_NIELSEN_SITE	GRP
    TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE	YOUTUBE_PROGRAMMATIC_GUARANTEED
    TYPE_REACH_AND_FREQUENCY	REACH
    TYPE_REACH_AUDIENCE	UNIQUE_REACH_AUDIENCE
    TYPE_PATH	FULL_PATH
    TYPE_PATH_ATTRIBUTION	PATH_ATTRIBUTION

• 필드 metadata.dataRange, reportDataStartTimeMs 및 reportDataEndTimeMs를 필드로 대체했습니다. range, customStartDate, customEndDate 새 날짜 필드에는 Date가 사용됩니다. 객체를 밀리초 대신 사용합니다. 이러한 대체 필드 상위 항목에 할당된 DataRange 객체로 dataRange 필드 QueryMetadata 객체를 반환합니다.
• schedule.startTimeMs 및 schedule.endTimeMs가 필드로 대체되었습니다. startDate 및 endDate QuerySchedule 객체를 반환합니다. 새 날짜 필드에는 Date가 사용됩니다. 객체를 밀리초 대신 사용합니다.
• 필드 metadata.running, metadata.reportCount, metadata.googleCloudStoragePathForLatestReport, metadata.googleDrivePathForLatestReport 및 metadata.latestReportRunTimeMs가 삭제되었습니다. 검색어에 대해 가장 최근에 생성된 보고서에 관한 정보는 queries.reports.list 메서드를 사용하여 검색 결과를 가져올 수 있습니다. 'key.reportId desc'의 orderBy 쿼리 매개변수를 요청에서 최신 보고서가 먼저 나열되도록 보장합니다.
• 필드 kind, timezoneCode, metadata.locale, params.includeInviteData 및 schedule.nextRunMinuteOfDay가 삭제되었습니다.
• queries.create에서 생성 후 더 이상 쿼리를 자동으로 실행하지 않습니다. asynchronous 쿼리 매개변수는 삭제되었습니다. 전화걸기 queries.create 이후 queries.run에 대한 보고서 생성 새 쿼리를 생성할 수 있습니다
• queries.run 메서드가 다음과 같이 업데이트되었습니다. <ph type="x-smartling-placeholder">
  </ph>
  • asynchronous 쿼리 매개변수가 synchronous 쿼리 매개변수. 새 쿼리 매개변수 역논리로 작동하며 지정하지 않으면 false로 간주됩니다. 주어진 queries.run는 기본적으로 동기식이 아닌 v2(v1.1의 기본값)입니다.
  • 요청 본문이 업데이트되어 timezoneCode 필드를 사용하고 dataRange, reportDataStartTimeMs, reportDataEndTimeMs 필드가 DataRange 객체가 dataRange 필드
  • 이 메서드는 결과 Report 객체를 응답 본문이 비어 있습니다.
• queries.list 응답 본문의 kind 필드 이(가) 삭제되었습니다.

reports 서비스 호출 업데이트

• Report 리소스의 다음 필드는 원래 일반 중첩 객체가 다음 객체 유형을 사용하도록 변경되었습니다.

  v1.1 필드	상응하는 v2 객체 유형
  key	ReportKey
  metadata	ReportMetadata
  metadata.status	ReportStatus
  params	Parameters
  params.options	Options
  params.options.pathQueryOptions	PathQueryOptions
  params.options.pathQueryOptions.channelGrouping	ChannelGrouping
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter	PathQueryOptionsFilter
  params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter	PathQueryOptionsFilter

• Report 리소스의 다음 필드는 원래 일반 목록 객체가 다음과 같은 새 객체 목록으로 변경되었습니다. 유형:

  v1.1 목록 필드	v2 객체 유형
  params.filters[]	FilterPair
  params.options.pathQueryOptions.channelGrouping.rules[]	Rule
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[]	DisjunctiveMatchStatement
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[]	EventFilter
  params.options.pathQueryOptions.pathFilters[]	PathFilter
  params.options.pathQueryOptions.pathFilters[].eventFilters[]	EventFilter

• Report 리소스의 다음 필드는 원래 문자열이 변경되어 v2에서 상응하는 필드가 새로운 enum 유형과 허용 가능한 값에 대한 변경사항을 포함합니다.
  • 이제 metadata.status.format가 Format enum을 사용합니다. 포함 이 enum으로 변환하면 EXCEL_CSV 값이 삭제되고 FORMAT_UNSPECIFIED이(가) 추가되었습니다.
  • 이제 metadata.status.state가 State enum을 사용합니다. 포함 이 enum으로 변환하면 QUEUED 및 STATE_UNSPECIFIED 값의 추가되었습니다.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match 및 params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match 이제 Match enum을 사용합니다.
  • 이제 params.options.pathQueryOptions.pathFilters[].pathMatchPosition에서 다음을 사용합니다. PathMatchPosition enum 로 변환 시 이 enum에 값 PATH_MATCH_POSITION_UNSPECIFIED가 추가되었습니다.
  • 이제 params.type가 ReportType enum을 사용합니다. 포함 많은 변경사항이 발생했으며 이 열거형으로 변환되는 쿼리 서비스 호출 업데이트에 대한 이전 섹션의 세부정보를 참조하세요.
• metadata.reportDataStartTimeMs 및 metadata.reportDataEndTimeMs을(를) 다음으로 대체했습니다. reportDataStartDate 필드 및 reportDataEndDate ReportMetadata 객체를 반환합니다. 새 필드에는 Unix 에포크 이후 밀리초가 아닌 Date 객체.
• metadata.status.finishTimeMs가 다음으로 대체되었습니다. 아래의 finishTime 필드 ReportStatus 객체를 반환합니다. 이 새로운 시간 필드는 RFC3339 UTC 'Zulu'의 타임스탬프인 datetime 를 사용해야 합니다. 밀리초 단위입니다.
• metadata.status.failure 및 params.includeInviteData 입력란이 삭제되었습니다.
• reports.list 응답 본문의 kind 필드에는 다음이 포함됩니다. 삭제되었습니다.

오류 처리 로직 업데이트

API 전반의 오류 메시지가 v2에서 업데이트되었습니다. 이러한 새로운 오류 메시지는 보다 구체적이며 경우에 따라 오류 반환의 원인이 되는 API 요청입니다. 기존 오류가 특정 오류 메시지 텍스트에 따라 로직을 처리하는 경우 오류를 일반화하세요. v2로 마이그레이션하기 전에 고려해야 합니다.