Mart 2022'de Bid Manager API'nin sürüm 2'sini kullanıma sunduk. Bu yeni sürümün yayınlanmasıyla birlikte, 1.1 sürümünün kullanımdan kaldırılacağını yakında duyurmayı planlıyoruz. En kısa sürede v1.1'den v2'ye taşıma işlemine başlamanızı öneririz.
Uygulamanızı taşıyın
v1.1'den v2'ye geçiş yapmak için uç nokta URL'lerinizin v2'yi çağıracak şekilde güncellenmesi ve uygulamanızın zarar veren değişiklikleri hesaba katacak şekilde güncellenmesi gerekir.
API çağrılarınızı v1.1'den v2'ye güncelleyin
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 sürümünden v2'ye güncellemek için önce v2'de eşdeğer v1.1 yöntemlerini belirlemeniz gerekir.
Tüm hizmet ve yöntemlerin aşağıdaki adları, v1.1 ve v2 arasında biraz değişmiştir:
- 1.1 sürümündeki
Queries
veReports
hizmetleri, 2. sürümdequeries
, 2. sürümde isequeries.reports
olarak bilinir. - Yöntemler v2'de aşağıdaki gibi yeniden adlandırıldı:
Yeni uç noktalara güncelle
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 yeni 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 bazı zarar veren değişiklikler yapıyoruz. Aşağıdaki talimatları inceleyin ve Bid Manager API'sinin mevcut kullanımıyla ilgili gerekli değişiklikleri yapın.
queries
hizmetine yapılan çağrıları güncelle
- Başlangıçta genel olarak iç içe yerleştirilmiş nesneler tarafından temsil edilen
Query
kaynağında bulunan şu alanlar, şu nesne türlerini kullanacak şekilde değiştirildi: - Başlangıçta genel liste nesneleri tarafından temsil edilen
Query
kaynağında bulunan şu alanlar, aşağıdaki yeni nesne türlerinin listesi olacak şekilde değiştirildi: Query
kaynağında bulunan ve başlangıçta dizelerle temsil edilen aşağıdaki alanlar, v2'deki enum türleriyle temsil edilir ve aşağıdaki değişiklikleri içerir:metadata.dataRange
öğesinin v2 eşdeğeri artıkRange
enum'u kullanıyor. Bu sıralamaya dönüştürülürkenPREVIOUS_HALF_MONTH
değeri kaldırıldı veTYPE_NOT_SUPPORTED
değeriRANGE_UNSPECIFIED
olarak değiştirildi.metadata.format
artıkFormat
sıralamasını kullanıyor. Bu sıralamaya dönüştürülürkenEXCEL_CSV
değeri kaldırıldı veFORMAT_UNSPECIFIED
değeri eklendi.params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match
veparams.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match
şimdiMatch
sıralamasını kullanın.params.options.pathQueryOptions.pathFilters[].pathMatchPosition
artıkPathMatchPosition
sıralamasını kullanıyor. Bu sıralamaya dönüştürülürkenPATH_MATCH_POSITION_UNSPECIFIED
değeri eklenmiştir.schedule.frequency
artıkFrequency
sıralamasını kullanıyor. Bu sıralamaya dönüşüm yapılırkenFREQUENCY_UNSPECIFIED
değeri eklenmiştir.params.type
artıkReportType
sıralamasını kullanıyor. Bu sıralamaya dönüştürülürken aşağıdaki değişiklikler yapıldı:- Aşağıdaki değerler kullanımdan kaldırılmıştır:
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 değerlerin tümü, eşdeğer değerlerini kullanıcı arayüzünde daha iyi yansıtacak şekilde güncellendi:
v1.1 değerleri Eşdeğer ReportType
değeriTYPE_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
vereportDataEndTimeMs
alanları,range
,customStartDate
vecustomEndDate
alanları ile değiştirildi. Yeni tarih alanları, Unix Epoch'tan beri milisaniyeler yerineDate
nesneleri kullanır. Bu değiştirme alanları,QueryMetadata
nesnesindekidataRange
alanına atanmışDataRange
nesnesine taşındı.schedule.startTimeMs
veschedule.endTimeMs
alanları,QuerySchedule
nesnesindekistartDate
veendDate
alanları ile değiştirildi. Yeni tarih alanları, Unix Epoch'tan beri milisaniyeler yerineDate
nesneleri kullanır.metadata.running
,metadata.reportCount
,metadata.googleCloudStoragePathForLatestReport
,metadata.googleDrivePathForLatestReport
vemetadata.latestReportRunTimeMs
alanları kaldırıldı. Bunun yerine, bir sorgunun en son oluşturulan raporlarıyla ilgili bilgiler, isteğin ilk olarak en son raporları listelediğini garanti etmek içinqueries.reports.list
yöntemi ile "key.reportId desc"orderBy
sorgu parametresi kullanılarak alınmalıdır.kind
,timezoneCode
,metadata.locale
,params.includeInviteData
veschedule.nextRunMinuteOfDay
alanları kaldırıldı.queries.create
, oluşturulduktan sonra artık sorguları otomatik olarak çalıştırmamaktadır veasynchronous
sorgu parametresi kaldırılır. Yeni sorgularla ilgili rapor oluşturmak içinqueries.create
tarihinden sonraqueries.run
numaralı telefonu çağırın.queries.run
yöntemi, aşağıdaki şekillerde güncellenmiştir:asynchronous
sorgu parametresi,synchronous
sorgu parametresiyle değiştirildi. Yeni sorgu parametresi, ters mantıkla çalışır ve belirtilmezse yanlış olarak kabul edilir. Bu nedenlequeries.run
, raporları v1.1'de varsayılan ayar olan eşzamanlı olarak değil, v2'de eşzamansız olarak oluşturur.- İstek gövdesi,
timezoneCode
alanını kaldırıpdataRange
,reportDataStartTimeMs
vereportDataEndTimeMs
alanlarınıdataRange
alanına atanmış birDataRange
nesneyle değiştirecek şekilde güncellendi. - Yöntem, boş bir yanıt gövdesi yerine sonuçta elde edilen
Report
nesnesini döndürür.
queries.list
yanıt gövdesindekikind
alanı kaldırıldı.
reports
hizmetine yapılan çağrıları güncelle
- Başlangıçta genel iç içe yerleştirilmiş nesneler tarafından temsil edilen
Report
kaynağında bulunan şu alanlar, aşağıdaki nesne türlerini kullanacak şekilde değiştirildi: - Başlangıçta genel liste nesneleri tarafından temsil edilen
Report
kaynağında bulunan şu alanlar, aşağıdaki yeni nesne türlerinin listesi olacak şekilde değiştirildi: Report
kaynağında, başlangıçta dizelerle temsil edilen aşağıdaki alanlar, v2'deki eşdeğer alanları yeni enum türleriyle temsil edilecek ve kabul edilebilir değerlerde yapılan değişiklikleri içerecek şekilde değişmiştir:metadata.status.format
artıkFormat
sıralamasını kullanıyor. Bu sıralamaya dönüşüm yapılırkenEXCEL_CSV
değeri kaldırıldı veFORMAT_UNSPECIFIED
eklendi.metadata.status.state
artıkState
sıralamasını kullanıyor. Bu sıralamaya dönüşüm yapılırkenQUEUED
veSTATE_UNSPECIFIED
değerleri eklenmiştir.params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match
veparams.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match
şimdiMatch
sıralamasını kullanın.params.options.pathQueryOptions.pathFilters[].pathMatchPosition
artıkPathMatchPosition
sıralamasını kullanıyor. Bu sıralamaya dönüştürülürkenPATH_MATCH_POSITION_UNSPECIFIED
değeri eklenmiştir.params.type
artıkReportType
sıralamasını kullanıyor. Bu sıralamaya dönüşüm yapılırken çok sayıda değişiklik yapılmıştır ve sorgu hizmet çağrılarını güncelleme ile ilgili önceki bölümde ayrıntılı olarak listelenmiştir.
metadata.reportDataStartTimeMs
vemetadata.reportDataEndTimeMs
alanları,ReportMetadata
nesnesindekireportDataStartDate
vereportDataEndDate
alanlarıyla değiştirildi. Yeni alanlar, Unix Epoch'tan beri milisaniyeler yerineDate
nesnelerini kullanır.metadata.status.finishTimeMs
öğesinin yerineReportStatus
nesnesindekifinishTime
alanı kullanılmaktadır. Bu yeni zaman alanı, tarih ve saati, Unix Epoch'tan bu yana milisaniye cinsinden değil, RFC3339 UTC "Zulu" biçiminde bir zaman damgası olarak gösterir.metadata.status.failure
veparams.includeInviteData
alanları kaldırıldı.reports.list
yanıt gövdesindekikind
alanı kaldırıldı.
Hata işleme mantığını güncelleyin
API genelindeki hata mesajları v2'de güncellendi. Bu yeni hata mesajları daha spesifiktir ve bazı durumlarda API isteği içinde hatanın döndürülmesine neden olan değerler hakkında bilgi verir. Mevcut hata işleme mantığınız belirli bir hata mesajı metnine dayanıyorsa v2'ye geçmeden önce hata işlemenizi genelleştirin.