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

Mart 2022'de Bid Manager API'sinin 2. sürümünü kullanıma sunduk. Raporda yakında 1.1 sürümünün kullanımdan kaldırılacağı tarihi duyurmayı planlıyoruz. Biz 1.1'den v2'ye en kısa sürede taşımanızı öneririz.

Uygulamanızı taşıma

v1.1'den v2'ye geçiş yapmak için uç nokta URL'lerinizin v2'yi çağıracak şekilde güncellenmesi gerekir ve uygulamanızı güncelleyerek zarar veren değişiklikleri hesaba katabilirsiniz.

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

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

Eşdeğer yöntemleri tanımlama

API çağrılarınızı v1.1'den v2'ye güncellemek için öncelikle 2. sürümdeki eşdeğer v1.1 yöntemleri.

Tüm hizmet ve yöntemlerin aşağıda belirtilen adları sürüm 1.1 ve sürüm 2:

• 1.1 sürümündeki Queries ve Reports hizmetleri biliniyor queries ve queries.reports olarak kullanılıyor.
• Yöntemler v2'de aşağıdaki gibi 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ç noktalarda güncelleme

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

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

v2'de queries.get olarak bilinen eşdeğer yöntemi çağırmak için Bu URL:

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

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

Gerekli değişiklikleri yapın

2. sürümde, zarar veren bazı değişiklikler yapıyoruz. Aşağıdakileri inceleyin geçerli talimatları ve mevcut Bid Manager API'si.

queries hizmetine yapılan aramaları güncelle

• Query kaynağında başlangıçta genel olarak gösterilen aşağıdaki alanlar iç içe yerleştirilmiş nesneler, 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	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 kaynağında başlangıçta genel olarak gösterilen aşağıdaki alanlar liste nesneleri, 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[]	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 kaynağında bulunan ve başlangıçta dizeler, v2'deki enum türleriyle temsil edilir ve aşağıdakileri içerir: değişiklikler:
  • metadata.dataRange ürününün v2 eşdeğeri artık Range kullanıyor enum. Bu sıralamaya dönüştürülürken PREVIOUS_HALF_MONTH değeri kaldırıldı ve TYPE_NOT_SUPPORTED değeri şu şekilde değiştirildi: RANGE_UNSPECIFIED.
  • metadata.format artık Format sıralaması kullanıyor. Dönüşümde bu sıralamaya EXCEL_CSV değeri kaldırılmış ve FORMAT_UNSPECIFIED eklendi.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match ve params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match artık Match enum'unu kullanabilirsiniz.
  • params.options.pathQueryOptions.pathFilters[].pathMatchPosition artık kullanıyor PathMatchPosition sıralaması. Şuna dönüştürülüyor: bu sıralamada PATH_MATCH_POSITION_UNSPECIFIED değeri eklenmiştir.
  • schedule.frequency artık Frequency sıralaması kullanıyor. İçinde bu sıralamaya dönüştürüldüğünde FREQUENCY_UNSPECIFIED değeri eklenmiştir.
  • params.type artık ReportType sıralaması kullanıyor. İçinde bu sıralamaya dönüştürüldüğünde aşağıdaki değişiklikler yapıldı:
  • Aşağıdaki değerlerin desteği sonlandı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 değerlerin tümü, sıklık değerlerini daha iyi yansıtacak şekilde güncellenmiştir eşdeğer değerlere sahip olur:

    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 alanları, reportDataStartTimeMs ve reportDataEndTimeMs alanlarla değiştirildi range, customStartDate ve customEndDate. Yeni tarih alanları, Date değerini kullanır milisaniye yerine 180.000 civarı gözlemledim. Değiştirilen bu alanlar DataRange dataRange alanı QueryMetadata nesnesini tanımlayın.
• schedule.startTimeMs ve schedule.endTimeMs alanlarla değiştirildi startDate ve endDate QuerySchedule nesnesini tanımlayın. Yeni tarih alanları, Date değerini kullanır milisaniye yerine 180.000 civarı gözlemledim.
• metadata.running alanları, metadata.reportCount, metadata.googleCloudStoragePathForLatestReport, metadata.googleDrivePathForLatestReport ve metadata.latestReportRunTimeMs kaldırıldı. Bir sorgunun en son oluşturulan raporlarıyla ilgili bilgiler, bunun yerinequeries.reports.list "key.reportId desc" değerinin orderBy sorgu parametresini istekte en son raporların ilk sırada listelendiğini garanti edersiniz.
• Alanlar kind, timezoneCode, metadata.locale, params.includeInviteData ve schedule.nextRunMinuteOfDay kaldırıldı.
• queries.create, oluşturulduktan sonra artık sorguları otomatik olarak çalıştırmaz ve asynchronous sorgu parametresi kaldırıldı. Telefonla arama Şu hesapla ilgili raporlar oluşturmak üzere queries.create tarihinden sonra queries.run: anlamına gelir.
• queries.run yöntemi aşağıdaki şekillerde güncellenmiştir:
  • asynchronous sorgu parametresi synchronous sorgu parametresi. Yeni sorgu parametresi ters mantıkla çalışır ve belirtilmezse yanlış kabul edilir. Verilen queries.run, raporları varsayılan olarak v1.1'de varsayılan ayar olan v2'dir.
  • İsteğin gövdesi, timezoneCode alanına dokunup değiştirin ve dataRange, reportDataStartTimeMs, reportDataEndTimeMs alanlarında bir DataRange nesne dataRange alanına girin.
  • Yöntem, bir Report yerine boş yanıt gövdesi.
• queries.list yanıt gövdesindeki kind alanı kaldırıldı.

reports hizmetine yapılan aramaları güncelle

• Report kaynağında başlangıçta temsil edilen aşağıdaki alanlar iç içe yerleştirilmiş genel nesneler, 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	PathQueryOptions
  params.options.pathQueryOptions.channelGrouping	ChannelGrouping
  params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter	PathQueryOptionsFilter
  params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter	PathQueryOptionsFilter

• Report kaynağında başlangıçta temsil edilen aşağıdaki alanlar genel liste nesneleri, aşağıdaki yeni nesnenin listeleri olacak şekilde değiştirildi türler:

  v1.1 liste alanı	v2 nesne türü
  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 kaynağında başlangıçta temsil edilen aşağıdaki alanlar dizeler değişmiştir ve dolayısıyla v2'deki eşdeğer alanları, yeni ve kabul edilebilir değerlerdeki değişiklikleri dahil edin:
  • metadata.status.format artık Format sıralaması kullanıyor. İçinde bu sıralamaya dönüştürüldüğünde EXCEL_CSV değeri kaldırılmış ve FORMAT_UNSPECIFIED eklendi.
  • metadata.status.state artık State sıralaması kullanıyor. İçinde bu sıralamaya dönüştürüldüğünde, QUEUED ve STATE_UNSPECIFIED değerleri eklendi.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match ve params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match artık Match enum'unu kullanabilirsiniz.
  • params.options.pathQueryOptions.pathFilters[].pathMatchPosition artık kullanıyor PathMatchPosition sıralaması. Şuna dönüştürülüyor: bu sıralamada PATH_MATCH_POSITION_UNSPECIFIED değeri eklenmiştir.
  • params.type artık ReportType sıralaması kullanıyor. İçinde bu sıralamaya dönüştürüldüğünde, birçok değişiklik yapılmıştır ve bunlar (sorgular hizmet çağrılarını güncellemeyle ilgili olarak) önceki bölümde yer alan ayrıntılara değineceğiz.
• metadata.reportDataStartTimeMs ve metadata.reportDataEndTimeMs, şununla değiştirildi: alanları reportDataStartDate ve reportDataEndDate - ReportMetadata nesnesini ifade eder. Yeni alanlar, Unix Epoch'tan beri milisaniye yerine Date nesne.
• metadata.status.finishTimeMs, şununla değiştirildi: finishTime alanını ReportStatus nesnesini tanımlayın. Bu yeni zaman alanı, RFC3339 UTC "Zulu" özelliğinde zaman damgası olarak tarih ve saat biçiminde değil, Unix Epoch'tan beri geçen milisaniye.
• metadata.status.failure ve params.includeInviteData alanları kaldırıldı.
• reports.list yanıt gövdesindeki kind alanında kaldırıldı.

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

API genelindeki hata mesajları v2'de güncellendi. Bu yeni hata mesajları daha belirlidir ve bazı durumlarda, Hatanın döndürülmesine neden olan API istekleri. Mevcut hata belirli bir hata mesajı metnine bağlı olduğundan hatanızı genel hatlarıyla belirtin. ele alacağız.