نقل البيانات من Bid Manager API v1.1 إلى v2

في آذار (مارس) 2022، أطلقنا الإصدار 2 من Bid Manager API. بناءً على من هذا الإصدار الجديد، فإننا نخطط للإعلان عن تاريخ الإيقاف النهائي للإصدار 1.1 قريبًا. أر ننصحك ببدء عملية نقل البيانات من الإصدار 1.1 إلى الإصدار 2 في أقرب وقت ممكن.

نقل بيانات تطبيقك

يتطلّب نقل البيانات من الإصدار 1.1 إلى الإصدار 2 تعديل عناوين URL لنقاط النهاية من أجل استخدام الإصدار 2. تحديث تطبيقك لمراعاة التغييرات التي قد تؤدي إلى أعطال.

تحديث "طلبات البيانات من واجهة برمجة التطبيقات" من الإصدار 1.1 إلى الإصدار 2

لاستخدام الإصدار 2 بدلاً من الإصدار 1.1، يجب تعديل طلباتك لاستخدام الإصدار 2 الجديد. والنقاط النهائية.

تحديد الطرق المكافئة

لتعديل طلبات البيانات من واجهة برمجة التطبيقات من استخدام الإصدار 1.1 إلى الإصدار 2، عليك أولاً تحديد الطرق المكافئة لإصدار v1.1 في الإصدار 2.

تم تغيير الأسماء التالية لجميع الخدمات والطرق قليلاً بين الإصداران 1.1 و2:

• الخدمتان Queries وReports في الإصدار 1.1 معروفة. مثل queries وqueries.reports في الإصدار 2.
• تمت إعادة تسمية الطرق على النحو التالي في الإصدار 2:

  اسم طريقة الإصدار 1.1	طريقة الإصدار 2 المكافئة
  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

التحديث إلى نقاط نهاية جديدة

بعد تحديد الطرق المكافئة، عليك تعديل طلباتك. بالنسبة على سبيل المثال، لاستدعاء طريقة queries.getquery مع الإصدار 1.1، يمكنك استخدام عنوان URL التالي:

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

لطلب الطريقة المكافئة في الإصدار 2، والمعروفة باسم queries.get، عليك تعديل إلى ما يلي:

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

إذا كنت تستخدم مكتبة برامج لتقديم طلبات إلى واجهة برمجة التطبيقات، فاستخدم إصدار حديث من مكتبة البرامج وتعديل الإعدادات لاستخدام الإصدار 2.

إجراء التغييرات المطلوبة

سنجري عددًا من التغييرات التي قد تؤدي إلى أعطال في الإصدار 2. راجِع ما يلي: من التعليمات وإجراء التغييرات المطلوبة ذات الصلة باستخدامك الحالي واجهة برمجة تطبيقات إدارة عرض السعر.

تعديل المكالمات إلى خدمة "queries"

• الحقول التالية في مورد Query ممثلة في الأصل بشكل عام تم تغيير الكائنات المتداخلة لاستخدام أنواع الكائنات التالية:

  حقل الإصدار 1.1	نوع العنصر المكافئ للإصدار 2
  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 ممثلة في الأصل بشكل عام تم تغيير كائنات القائمة إلى قوائم لأنواع الكائنات الجديدة التالية:

  حقل قائمة الإصدار 1.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"، والتي يتم تمثيلها في الأصل بواسطة يتم تمثيل السلاسل بأنواع التعداد في الإصدار 2، وتتضمن ما يلي التغييرات:
  • يستخدم الإصدار الثاني المكافئ لـ metadata.dataRange الآن Range تعداد. عند التحويل إلى هذا التعداد، تمّ تحويل القيمة PREVIOUS_HALF_MONTH تمت إزالته وتم تغيير القيمة TYPE_NOT_SUPPORTED إلى RANGE_UNSPECIFIED
  • يستخدم metadata.format الآن التعداد Format. في إحالة ناجحة إلى هذا التعداد، تمت إزالة القيمة EXCEL_CSV تمت إضافة FORMAT_UNSPECIFIED.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match أو params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match سنستخدم الآن تعداد Match.
  • يتم استخدام بطاقة params.options.pathQueryOptions.pathFilters[].pathMatchPosition الآن تعداد PathMatchPosition. في التحويل إلى هذا التعداد، تمت إضافة القيمة PATH_MATCH_POSITION_UNSPECIFIED.
  • يستخدم schedule.frequency الآن التعداد Frequency. ضِمن التحويل إلى هذا التعداد، تمت إضافة القيمة FREQUENCY_UNSPECIFIED.
  • يستخدم params.type الآن التعداد ReportType. ضِمن بالتحويل إلى هذا التعداد، تم إجراء التغييرات التالية:
  • تم إيقاف القيم التالية نهائيًا:
    • 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
  • تم تحديث كل القيم المتبقية لتعكس بشكل أفضل القيم المكافئة في واجهة المستخدم:

    قيم الإصدار 1.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 مَعلمة طلب البحث orderBy من "key.reportId desc" إلى أن الطلب يسرد أحدث التقارير أولاً.
• الحقول kind، timezoneCode، metadata.locale, params.includeInviteData، تمت إزالة schedule.nextRunMinuteOfDay.
• لن تشغِّل queries.create طلبات البحث تلقائيًا بعد إنشائها. وتمت إزالة معلَمة طلب البحث asynchronous. اتصل queries.run بعد queries.create لإنشاء تقارير عن طلبات بحث جديدة.
• تم تعديل طريقة queries.run بالطرق التالية:
  • تم استبدال معلَمة طلب البحث asynchronous مَعلمة طلب البحث synchronous. معلَمة طلب البحث الجديدة يعمل بمنطق معكوس ويعتبر false إذا لم يتم تحديده. المقدَّمة هذا، ينشئ queries.run التقارير بشكل غير متزامن تلقائيًا في وليس بشكل متزامن، وهو الخيار التلقائي في الإصدار 1.1.
  • تم تعديل نص الطلب لإزالة timezoneCode واستبدال dataRange، reportDataStartTimeMs، حقول reportDataEndTimeMs تحتوي على تم تعيين الكائن DataRange إلى dataRange.
  • تُرجع الطريقة كائن Report الناتج بدلاً من نص الاستجابة فارغ.
• الحقل kind في نص الاستجابة queries.list تمت إزالة.

تعديل المكالمات إلى خدمة "reports"

• الحقول التالية في مورد "Report" التي تم تمثيلها في الأصل تم تغيير الكائنات المدمجة العامة لاستخدام أنواع الكائنات التالية:

  حقل الإصدار 1.1	نوع العنصر المكافئ للإصدار 2
  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" التي تم تمثيلها في الأصل تم تغيير كائنات القائمة العامة إلى قوائم بالكائنات الجديدة التالية الأنواع:

  حقل قائمة الإصدار 1.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" التي تم تمثيلها في الأصل تغيرت السلاسل بحيث يتم تمثيل الحقول المكافئة لها في الإصدار 2 أنواع التعداد وتضمين التغييرات في القيم المقبولة:
  • يستخدم metadata.status.format الآن التعداد Format. ضِمن بالتحويل إلى هذا التعداد، تمت إزالة القيمة EXCEL_CSV تمت إضافة FORMAT_UNSPECIFIED.
  • يستخدم metadata.status.state الآن التعداد State. ضِمن بالتحويل إلى هذا التعداد، تشتمل القيمتان QUEUED وSTATE_UNSPECIFIED على تمت إضافتها.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match أو params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match سنستخدم الآن تعداد Match.
  • يتم استخدام بطاقة params.options.pathQueryOptions.pathFilters[].pathMatchPosition الآن تعداد PathMatchPosition. في التحويل إلى هذا التعداد، تمت إضافة القيمة PATH_MATCH_POSITION_UNSPECIFIED.
  • يستخدم params.type الآن التعداد ReportType. ضِمن بالتحويل إلى هذا التعداد، تم إجراء العديد من التغييرات وإدراجها في التفاصيل في القسم السابق بخصوص تحديث طلبات البحث المتعلقة بخدمة الاستعلامات.
• الحقلان metadata.reportDataStartTimeMs و تم استبدال metadata.reportDataEndTimeMs بـ الحقول reportDataStartDate reportDataEndDate في الكائن ReportMetadata. تستخدم الحقول الجديدة Date كائنات بدلاً من المللي ثانية منذ Unix Epoch
• تم استبدال metadata.status.finishTimeMs بـ الحقل finishTime في قسم الكائن ReportStatus. يمثل حقل الوقت الجديد هذا التاريخ والوقت كطابع زمني في RFC3339 UTC "زولو" التنسيق بدلاً من بالمللي ثانية منذ Unix Epoch
• metadata.status.failure و تمت إزالة حقول params.includeInviteData.
• يحتوي الحقل kind في نص الاستجابة reports.list على تمت إزالته.

تعديل منطق معالجة الأخطاء

تم تحديث رسائل الخطأ عبر واجهة برمجة التطبيقات في الإصدار 2. رسائل الخطأ الجديدة هذه أكثر تحديدًا، وفي بعض الحالات، تقدم معلومات عن القيم في طلب واجهة برمجة التطبيقات الذي يتسبّب في عرض الخطأ. إذا كان الخطأ الحالي فإن التعامل مع المنطق يعتمد على نص رسالة خطأ محددة، مع تعميم الخطأ المعالجة قبل الانتقال إلى الإصدار 2.