Bid Manager API v1.1'den v2'ye geçiş

Mart 2022'de Bid Manager API'nin 2. sürümünü yayınladık. Bu yeni sürümün yayınlanmasıyla birlikte, v1.1 için yakında kullanımdan kaldırma tarihi duyurmayı planlıyoruz. 1.1 sürümünden 2 sürümüne geçiş işleminize en kısa sürede başlamanızı öneririz.

Uygulamanızı taşıma

v1.1'den v2'ye geçiş için uç nokta URL'lerinizi v2'yi çağıracak şekilde güncellemeniz ve uygulamanızı, önemli değişiklikleri hesaba katacak şekilde güncellemeniz gerekir.

API çağrılarınızı v1.1'den v2'ye güncelleme

v1.1 yerine v2'yi kullanmak için isteklerinizi yeni v2 uç noktalarını kullanacak şekilde güncellemeniz gerekir.

Eşdeğer yöntemleri belirleme

API çağrılarınızı v1.1'den v2'ye güncellemek için öncelikle v2'deki eşdeğer v1.1 yöntemlerini belirlemeniz gerekir.

Tüm hizmetlerin ve yöntemlerin aşağıdaki adları, v1.1 ile v2 arasında biraz değişti:

• v1.1'deki Queries ve Reports hizmetleri, v2'de queries ve queries.reports olarak bilinir.
• Yöntemler, v2'de aşağıdaki şekilde yeniden adlandırıldı:

  v1.1 yöntem adı	Eşdeğer v2 yöntemi
  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

Yeni uç noktalara güncelleme

Eşdeğer yöntemleri belirledikten sonra isteklerinizi güncellemeniz gerekir. Örneğin, queries.getquery yöntemini v1.1 ile çağırmak için aşağıdaki URL'yi kullanırsınız:

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

v2'de queries.get olarak bilinen eşdeğer yöntemi çağırmak için URL'yi aşağıdaki şekilde güncelleyin:

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

API'ye istek göndermek için bir istemci kitaplığı kullanıyorsanız istemci kitaplığının en son sürümünü kullanın ve yapılandırmanızı v2'yi kullanacak şekilde güncelleyin.

Gerekli değişiklikleri yapın

v2'de bir dizi zarar veren değişiklik yapıyoruz. Aşağıdaki talimatları inceleyin ve Bid Manager API'nin mevcut kullanımınızla ilgili gerekli değişiklikleri yapın.

queries hizmetine yapılan çağrıları güncelleme

• Query kaynağındaki aşağıdaki alanlar, başlangıçta genel iç içe yerleştirilmiş nesnelerle temsil edilirken aşağıdaki nesne türlerini kullanacak şekilde değiştirildi:

  v1.1 alanı	Eşdeğer v2 nesne türü
  metadata	QueryMetadata
  params	Parameters
  params.options	Options
  params.options.pathQueryOptions	Kaldırıldı
  params.options.pathQueryOptions.channelGrouping	Kaldırıldı
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter	Kaldırıldı
  params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter	Kaldırıldı
  schedule	QuerySchedule

• Başlangıçta genel liste nesneleriyle temsil edilen Query kaynağındaki aşağıdaki alanlar, aşağıdaki yeni nesne türlerinin listeleri olacak şekilde değiştirildi:

  v1.1 liste alanı	v2 nesne türü
  params.filters[]	FilterPair
  params.options.pathQueryOptions.channelGrouping.rules[]	Kaldırıldı
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[]	Kaldırıldı
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[]	Kaldırıldı
  params.options.pathQueryOptions.pathFilters[]	Kaldırıldı
  params.options.pathQueryOptions.pathFilters[].eventFilters[]	Kaldırıldı

• Başlangıçta dizelerle temsil edilen Query kaynağındaki aşağıdaki alanlar, v2'de enum türleriyle temsil edilir ve aşağıdaki değişiklikleri içerir:
  • metadata.dataRange öğesinin v2 karşılığı artık Range enum'ını kullanıyor. Bu enum'a dönüştürülürken PREVIOUS_HALF_MONTH değeri kaldırıldı ve TYPE_NOT_SUPPORTED değeri RANGE_UNSPECIFIED olarak değiştirildi.
  • metadata.format artık Format enum'ını kullanıyor. Bu numaralandırmaya dönüştürülürken EXCEL_CSV değeri kaldırıldı ve FORMAT_UNSPECIFIED değeri eklendi.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match ve params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match artık Match enum'ını kullanıyor.
  • params.options.pathQueryOptions.pathFilters[].pathMatchPosition artık PathMatchPosition sıralamasını kullanıyor. Bu enum'a dönüştürülürken PATH_MATCH_POSITION_UNSPECIFIED değeri eklendi.
  • schedule.frequency artık Frequency enum'ını kullanıyor. Bu numaralandırmaya dönüştürülürken FREQUENCY_UNSPECIFIED değeri eklendi.
  • params.type artık ReportType enum'ını kullanıyor. Bu enum'a dönüştürülürken aşağıdaki değişiklikler yapıldı:
  • Aşağıdaki değerler kullanımdan kaldırıldı:
    • 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
  • Kalan tüm değerler, kullanıcı arayüzündeki eşdeğer değerlerini daha iyi yansıtacak şekilde güncellendi:

    v1.1 değerleri	Eşdeğer ReportType değeri
    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 ve reportDataEndTimeMs alanları range, customStartDate ve customEndDate alanlarıyla değiştirildi. Yeni tarih alanlarında, Unix Epoch'tan bu yana geçen milisaniye yerine Date nesneleri kullanılır. Bu değiştirme alanları, QueryMetadata nesnesindeki dataRange alanına atanmış DataRange nesnesine taşındı.
• schedule.startTimeMs ve schedule.endTimeMs alanlarının yerini QuerySchedule nesnesindeki startDate ve endDate alanları aldı. Yeni tarih alanlarında, Unix Epoch'tan bu yana geçen milisaniye yerine Date nesneleri kullanılır.
• metadata.running, metadata.reportCount, metadata.googleCloudStoragePathForLatestReport, metadata.googleDrivePathForLatestReport ve metadata.latestReportRunTimeMs alanları kaldırıldı. Bir sorgunun en son oluşturulan raporlarıyla ilgili bilgiler, isteğin en son raporları ilk olarak listelemesini sağlamak için "key.reportId desc" orderBy sorgu parametresiyle birlikte queries.reports.list yöntemi kullanılarak alınmalıdır.
• kind, timezoneCode, metadata.locale, params.includeInviteData ve schedule.nextRunMinuteOfDay alanları kaldırıldı.
• queries.create artık oluşturulduktan sonra sorguları otomatik olarak çalıştırmıyor ve asynchronous sorgu parametresi kaldırıldı. Yeni sorgular için rapor oluşturmak üzere queries.create işleminden sonra Call queries.run işlevini kullanın.
• queries.run yöntemi aşağıdaki şekillerde güncellendi:
  • asynchronous sorgu parametresi, synchronous sorgu parametresiyle değiştirildi. Yeni sorgu parametresi ters mantıkla çalışır ve belirtilmediği takdirde yanlış kabul edilir. Bu nedenle, queries.run, v1.1'de varsayılan olarak kullanılan senkron rapor oluşturma yerine v2'de varsayılan olarak eşzamansız rapor oluşturur.
  • İstek gövdesi, timezoneCode alanını kaldırmak ve dataRange, reportDataStartTimeMs, reportDataEndTimeMs alanlarını dataRange alanına atanmış bir DataRange nesnesiyle değiştirmek için güncellendi.
  • Yöntem, boş bir yanıt gövdesi yerine sonuçtaki Report nesnesini döndürür.
• queries.list yanıt gövdesindeki kind alanı kaldırıldı.

reports hizmetine yapılan çağrıları güncelleme

• Başlangıçta genel iç içe yerleştirilmiş nesnelerle temsil edilen Report kaynağındaki aşağıdaki alanlar, aşağıdaki nesne türlerini kullanacak şekilde değiştirildi:

  v1.1 alanı	Eşdeğer v2 nesne türü
  key	ReportKey
  metadata	ReportMetadata
  metadata.status	ReportStatus
  params	Parameters
  params.options	Options
  params.options.pathQueryOptions	Kaldırıldı
  params.options.pathQueryOptions.channelGrouping	Kaldırıldı
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter	Kaldırıldı
  params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter	Kaldırıldı

• Başlangıçta Report kaynağı genel liste nesneleriyle temsil edilen aşağıdaki alanlar, aşağıdaki yeni nesne türlerinin listeleri olacak şekilde değiştirildi:

  v1.1 liste alanı	v2 nesne türü
  params.filters[]	FilterPair
  params.options.pathQueryOptions.channelGrouping.rules[]	Kaldırıldı
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[]	Kaldırıldı
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[]	Kaldırıldı
  params.options.pathQueryOptions.pathFilters[]	Kaldırıldı
  params.options.pathQueryOptions.pathFilters[].eventFilters[]	Kaldırıldı

• Report kaynağında başlangıçta dizelerle temsil edilen aşağıdaki alanlar değişti. Bu nedenle, v2'deki eşdeğer alanlar yeni enum türleriyle temsil ediliyor ve kabul edilebilir değerlerde değişiklikler içeriyor:
  • metadata.status.format artık Format enum'ını kullanıyor. Bu numaralandırılmış türe dönüştürülürken EXCEL_CSV değeri kaldırıldı ve FORMAT_UNSPECIFIED değeri eklendi.
  • metadata.status.state artık State enum'ını kullanıyor. Bu numaralandırmaya dönüştürülürken QUEUED ve STATE_UNSPECIFIED değerleri eklenmiştir.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match ve params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match artık Match enum'ını kullanıyor.
  • params.options.pathQueryOptions.pathFilters[].pathMatchPosition artık PathMatchPosition enum'ını kullanıyor. Bu enum'a dönüştürülürken PATH_MATCH_POSITION_UNSPECIFIED değeri eklendi.
  • params.type artık ReportType enum'ını kullanıyor. Bu enum'a dönüştürme işleminde çok sayıda değişiklik yapıldı. Bu değişiklikler, sorgu hizmeti çağrılarını güncelleme ile ilgili önceki bölümde ayrıntılı olarak listelenmiştir.
• metadata.reportDataStartTimeMs ve metadata.reportDataEndTimeMs alanlarının yerini ReportMetadata nesnesinde reportDataStartDate ve reportDataEndDate alanları aldı. Yeni alanlarda, Unix Epoch'tan bu yana geçen milisaniye yerine Date nesneleri kullanılır.
• metadata.status.finishTimeMs, ReportStatus nesnesindeki finishTime alanı ile değiştirildi. Bu yeni zaman alanı, tarihi ve saati Unix Epoch'tan itibaren milisaniye cinsinden değil, RFC3339 UTC "Zulu" biçiminde zaman damgası olarak gösterir.
• metadata.status.failure ve params.includeInviteData alanları kaldırıldı.
• reports.list yanıt gövdesindeki kind alanı kaldırıldı.

Hata işleme mantığını güncelleme

API genelindeki hata mesajları v2'de güncellendi. Bu yeni hata mesajları daha spesifiktir ve bazı durumlarda, API isteğindeki hangi değerlerin hataya neden olduğuna dair bilgi verir. Mevcut hata işleme mantığınız belirli hata mesajı metnine dayanıyorsa v2'ye geçmeden önce hata işleme mantığınızı genelleştirin.