النقل إلى Marketplace API

تفعيل واجهة برمجة التطبيقات

على غرار واجهات برمجة التطبيقات الأخرى الخاصة بالشراة المعتمَدين، يجب تفعيل Marketplace API قبل أن تتمكّن من استخدامها. يمكنك تفعيل Marketplace API باتّباع الخطوات التالية:

  1. انتقِل إلى صفحة "واجهات برمجة التطبيقات المفعّلة" في "وحدة تحكّم واجهة Google API". اختَر المشروع الذي تستخدمه للوصول إلى واجهات برمجة تطبيقات أخرى للشراة المعتمَدين، مثل Ad Exchange Buyer II أو Real-time Bidding API.
  2. انقر على الرابط + ENABLE APIS AND SERVICES (+ تفعيل واجهات برمجة التطبيقات والخدمات).
  3. في مربّع البحث، اكتب Authorized Buyers Marketplace API، ثم اضغط على Enter.
  4. في نتائج البحث، اختَر Authorized Buyers Marketplace API.
  5. انقر على الزر تفعيل لتفعيل Marketplace API.
  6. من المفترض أن تتمكّن الآن من الوصول إلى Marketplace API باستخدام بيانات الاعتماد التي تم إنشاؤها ضمن هذا المشروع.

تعديل بيانات اعتماد OAuth 2.0

يجب تغيير سير العمل الحالية في OAuth 2.0 التي تستخدم نطاق Ad Exchange Buyer II API لاستخدام نطاق Marketplace API:

https://www.googleapis.com/auth/authorized-buyers-marketplace

ننصح باستخدام عملية OAuth 2.0 لحساب الخدمة للوصول إلى واجهة برمجة التطبيقات. يجب أن تحدِّد جميع عمليات OAuth 2.0 المتوافقة نطاق واجهة برمجة التطبيقات الجديد لطلب رمز مميز من Google يمكنه الوصول إلى Marketplace API.

ربط موارد Ad Exchange Buyer II API بـ Marketplace API

العملاء

إذا كنت تستخدِم واجهة برمجة التطبيقات Ad Exchange Buyer II API التي توفّر المَعلمة accounts.clients ، يمكنك نقل البيانات إلى المَعلمة buyers.clients التي توفّرها واجهة برمجة التطبيقات Marketplace API.

طرق الموارد

واجهة برمجة التطبيقات للمشتري عبر Ad Exchange II Marketplace API
accounts.clients.create buyers.clients.create
accounts.clients.get buyers.clients.get
accounts.clients.list buyers.clients.list

تتيح هذه الطريقة الآن استخدام فلاتر القوائم.

accounts.clients.update buyers.clients.patch

تتيح هذه الطريقة الآن إجراء تعديلات جزئية باستخدام معلَمة updateMask.

حقول الموارد

Ad Exchange Buyer II API واجهة برمجة تطبيقات Marketplace
Client.clientAccountId Client.name

clientAccountId هو رقم تعريف مورد العميل.
Client.role Client.role
Client.status Client.state
Client.clientName Client.displayName
Client.visibleToSeller Client.sellerVisible
Client.entityType

تم إيقاف هذا الحقل نهائيًا.
Client.entityId

تم إيقاف هذا الحقل نهائيًا.
Client.entityName

تم إيقاف هذا الحقل نهائيًا.
Client.partnerClientId Client.partnerClientId

الدعوات والمستخدمون

تجمع Marketplace API بين وظائف موارد Ad Exchange Buyer II API accounts.clients.invitations وaccounts.clients.users في مورد واحد buyers.clients.users.

طرق الموارد

واجهة برمجة التطبيقات للمشتري عبر Ad Exchange II Marketplace API
accounts.clients.invitations.create buyers.clients.users.create
accounts.clients.invitations.get buyers.clients.users.get
accounts.clients.invitations.list buyers.clients.users.list

لن يكون سوى المستخدِمين الذين تم ضبط state لديهم على INVITED معادلاً للمستخدِمين الذين تم عرضهم من قِبل accounts.clients.invitations.list.

accounts.clients.users.get buyers.clients.users.get
accounts.clients.users.list buyers.clients.users.list
accounts.clients.users.update

لم يعُد بإمكانك تصحيح أخطاء مستخدمي العميل باستخدام واجهة برمجة التطبيقات. وننصح باستخدام buyers.clients.users.delete لحذف مستخدم البرنامج وإعادة إنشائه مع التغييرات المفضّلة.

حقول الموارد

Ad Exchange Buyer II API Marketplace API
ClientUserInvitation.invitationId

تم إيقاف هذا الحقل نهائيًا.
ClientUserInvitation.email ClientUser.email
ClientUserInvitation.clientAccountId

لم يعد هذا الحقل متوفرًا للمستخدمين العميلين. بدلاً من ذلك، يمكنك عرض clientAccountId باسم البرنامج الرئيسي.
ClientUser.userId ClientUser.name

userId هو رقم التعريف لمورد المستخدم.
ClientUser.clientAccountId

لم يعد هذا الحقل متوفرًا للمستخدمين العميلين. بدلاً من ذلك، اطّلِع على clientAccountId في اسم العميل الرئيسي.
ClientUser.status ClientUser.state
ClientUser.email ClientUser.email

المنتجات

لا يتوفّر هذا المورد ووظائفه في Marketplace API.

PublisherProfiles

إذا كنت تستخدِم واجهة برمجة التطبيقات Ad Exchange Buyer II API التي توفّر المَعلمة accounts.publisherProfiles ، يمكنك نقل البيانات إلى المَعلمة buyers.publisherProfiles التي توفّرها واجهة برمجة التطبيقات Marketplace API.

طرق الموارد

واجهة برمجة التطبيقات للمشتري عبر Ad Exchange II Marketplace API
accounts.publisherProfiles.get buyers.publisherProfiles.get
accounts.publisherProfiles.list buyers.publisherProfiles.list

تتيح هذه الطريقة الآن استخدام فلاتر القوائم.

حقول الموارد

Ad Exchange Buyer II API Marketplace API
PublisherProfile.publisherProfileId PublisherProfile.name

‫publisherProfileId هو رقم تعريف موارد ملف الناشر

PublisherProfile.seller.accountId PublisherProfile.seller.accountId
PublisherProfile.seller.subAccountId PublisherProfile.seller.subAccountId
PublisherProfile.displayName PublisherProfile.displayName
PublisherProfile.domains PublisherProfile.domains
PublisherProfile.mobileApps PublisherProfile.mobileApps
PublisherProfile.logoUrl PublisherProfile.logoUrl
PublisherProfile.directDealsContact PublisherProfile.directDealsContact
PublisherProfile.programmaticDealsContact PublisherProfile.programmaticDealsContact
PublisherProfile.mediaKitUrl PublisherProfile.mediaKitUrl
PublisherProfile.samplePageUrl PublisherProfile.samplePageUrl
PublisherProfile.rateCardUrl

تم إيقاف هذا الحقل نهائيًا.
PublisherProfile.googlePlusUrl

تم إيقاف هذا الحقل.
PublisherProfile.overview PublisherProfile.overview
PublisherProfile.buyerPitchStatement PublisherProfile.pitchStatement
PublisherProfile.topHeadlines PublisherProfile.topHeadlines
PublisherProfile.audienceDescription PublisherProfile.audienceDescription
PublisherProfile.isParent PublisherProfile.isParent

Proposals وFinalizedProposals

إذا كنت تستخدِم مورد accounts.proposals في Ad Exchange Buyer II API، يمكنك نقل البيانات إلى مورد buyers.proposals في Marketplace API. تم فصل الصفقات عن العروض في المورد الفرعي buyers.proposals.deals. لم تعُد العروض النهائية معروضة في واجهة برمجة التطبيقات، ما يمنحك إمكانية التحكّم بشكل أدق في الصفقات النهائية باستخدام موارد buyers.finalizedDeals.

طرق الموارد

واجهة برمجة التطبيقات للمشتري عبر Ad Exchange II Marketplace API
accounts.proposals.accept buyers.proposals.accept

لا تتصل بـ buyers.proposals.accept إلا عندما تكون حالة الاقتراح هي BUYER_ACCEPTANCE_REQUESTED.
accounts.proposals.addNote buyers.proposals.addNote
accounts.proposals.cancelNegotiation buyers.proposals.cancelNegotiation
accounts.proposals.completeSetup buyers.finalizedDeals.setReadyToServe
accounts.proposals.create buyers.proposals.sendRfp
accounts.proposals.get buyers.proposals.get

يُرجى العلم أنّ الاقتراح لن يحتوي بعد ذلك على معلومات عن الصفقات.

accounts.proposals.list buyers.proposals.list

يُرجى العلم أنّ العروض المُعاد عرضها لن تحتوي بعد ذلك على معلومات عن الصفقات. في حال استخدام فلترة القوائم، يُرجى العِلم أنّ واجهة Marketplace API تتوافق فقط مع بنية فلاتر القوائم.
accounts.proposals.pause buyers.finalizedDeals.pause
accounts.proposals.resume buyers.finalizedDeals.resume
accounts.proposals.update buyers.proposals.patch

تتيح هذه الطريقة الآن إجراء تعديلات جزئية باستخدام المَعلمة updateMask.
accounts.finalizedProposals.list

استخدِم buyers.finalizedDeals.list للاطّلاع على الصفقات النهائية لحساب مشتري معيّن. أصبح من الممكن الآن استرداد الصفقات النهائية على مستوى مقدّم العرض باستخدام bidders.finalizedDeals.list.
accounts.finalizedProposals.pause

استخدِم الرمز buyers.finalizedDeals.pause لإيقاف مؤقت لصفقة محددة تم إتمامها لحساب مشتري معيّن.
accounts.finalizedProposals.resume

استخدِم buyers.finalizedDeals.resume لاستئناف الصفقات الفردية التي تمّت الموافقة عليها لحساب مشتري معيّن.

حقول الموارد

تشترك المَعلمتَان proposals وfinalizedProposals في تمثيل Proposal نفسها وتتضمّنان خطوات نقل بيانات مشابهة.

Ad Exchange Buyer II API Marketplace API
Proposal.proposalId Proposal.name

proposalId هو رقم تعريف مصدر الاقتراح.
Proposal.updateTime Proposal.updateTime
Proposal.proposalRevision

Proposal.proposalRevision و Deal.proposalRevision
Proposal.deals.dealId Deal.name

dealId هو رقم تعريف مصدر الصفقة.
Proposal.deals.proposalId Deal.name

proposalId هو رقم تعريف مورد الاقتراح الرئيسي.
Proposal.deals.createTime Deal.createTime
Proposal.deals.updateTime Deal.updateTime
Proposal.deals.createProductId

تم إيقاف هذا الحقل نهائيًا.
Proposal.deals.createProductRevision

تم إيقاف هذا الحقل نهائيًا.
Proposal.deals.displayName Deal.displayName
Proposal.deals.buyerPrivateData.referenceId

تم إيقاف هذا الحقل نهائيًا، ولا يظهر الآن إلا على مستوى المقترح.
Proposal.deals.dealTerms.description Deal.description
Proposal.deals.dealTerms.brandingType

تم إيقاف هذا الحقل نهائيًا.
Proposal.deals.dealTerms.estimatedGrossSpend Deal.estimatedGrossSpend
Proposal.deals.dealTerms.estimatedImpressionsPerDay

تم إيقاف هذا الحقل نهائيًا.
Proposal.deals.dealTerms.sellerTimeZone Deal.sellerTimeZone
Proposal.deals.dealTerms.guaranteedFixedPriceTerms

Deal.programmaticGuaranteedTerms

يُرجى العلم أنّه على الرغم من أنّ guaranteedFixedPriceTerms.fixedPrices هو حقل repeated ، لم تتم تعبئته مطلقًا بأكثر من إدخال واحد. نتيجةً لذلك، يكون programmaticGuaranteedTerms.fixedPrice في Marketplace API مساويًا.
Proposal.deals.dealTerms.nonGuaranteedFixedPriceTerms

Deal.preferredDealTerms

يُرجى العلم أنّه على الرغم من أنّ nonGuaranteedFixedPriceTerms.fixedPrices هو حقل متكرّر، لم تتم تعبئته أبدًا بأكثر من إدخال واحد. ونتيجةً لذلك، فإنّ preferredDealTerms.fixedPrice في Marketplace API هو مكافئ.
Proposal.deals.dealTerms.NonGuaranteedAuctionTerms

Deal.privateAuctionTerms

يُرجى العلم أنّه على الرغم من أنّ nonGuaranteedAuctionTerms.reservePricesPerBuyer هو حقل متكرّر، لم تتم تعبئته أبدًا بأكثر من إدخال واحد. نتيجةً لذلك، يكون privateAuctionTerms.floorPrice في Marketplace API مساويًا.
Proposal.deals.webPropertyCode

تم إيقاف هذا الحقل نهائيًا.
Proposal.deals.sellerContacts Proposal.sellerContacts
Proposal.deals.availableStartTime Proposal.flightStartTime
Proposal.deals.availableEndTime Proposal.flightEndTime
Proposal.deals.description Proposal.description
Proposal.deals.targetingCriterion Deal.targeting

لم يعُد من الممكن ضبط الاستهداف باستخدام مفتاح لتحديد فئة الاستهداف، ولكن يمكن العثور على الفئات التي يمكن استهدافها في Deal.targeting. على سبيل المثال، يشير مفتاح GOOG_CREATIVE_SIZE من Ad Exchange Buyer II إلى Deal.targeting.inventorySizeTargeting في Marketplace API.
Proposal.deals.targeting Deal.targeting

تمت إضافة فئات معايير استهداف إضافية.
Proposal.deals.creativeRestrictions.creativeFormat Deal.creativeRequirements.creativeFormat
Proposal.deals.creativeRestrictions.skippableAdType Deal.creativeRequirements.skippableAdType
Proposal.deals.creativeRestrictions.creativeSpecifications.creativeSize Deal.targeting.inventorySizeTargeting
Proposal.deals.externalDealId

تم إيقاف هذا الحقل نهائيًا.
Proposal.deals.syndicationProduct

تم إيقاف هذا الحقل نهائيًا.
Proposal.deals.creativePreApprovalPolicy Deal.creativeRequirements.creativePreApprovalPolicy
Proposal.deals.creativeSafeFrameCompatibility Deal.creativeRequirements.creativeSafeFrameCompatibility
Proposal.deals.dealServingMetadata

يمكن العثور على معلومات مشابهة في الحقل FinalizedDeal.dealPausingInfo.
Proposal.deals.programmaticCreativeSource Deal.creativeRequirements.programmaticCreativeSource
Proposal.deals.deliveryControl Deal.deliveryControl

تمت إضافة تفاصيل إضافية حول كيفية إجراء الصفقات.
Proposal.deals.isSetupComplete FinalizedDeal.readyToServe

يمكنك الآن الإشارة إلى أنّ الصفقة جاهزة للعرض فقط إذا كانت قد اكتملت. استخدِم طريقة buyers.finalizedDeals.setReadyToServe للإشارة إلى أنّ الصفقة النهائية المضمونة آليًا جاهزة للعرض.
Proposal.originatorRole Proposal.originatorRole
Proposal.seller.accountId Proposal.publisherProfile

استخدِم اسم الملف الشخصي للناشر لتحديد هوية البائع. يمكنك الاطّلاع على الملفات الشخصية للناشرين باستخدام المرجع buyers.publisherProfiles.
Proposal.seller.subAccountId Proposal.publisherProfile

استخدِم اسم الملف الشخصي للناشر لتحديد البائع. يمكنك الاطّلاع على الملفات الشخصية للناشرين باستخدام المرجع buyers.publisherProfiles.
Proposal.buyer.accountId

Proposal.buyer أو Proposal.client

سيعتمد الحقل المستخدَم على نوع حساب المشتري الذي يتفاوض. هذه هي أسماء الموارد لواجهة برمجة التطبيقات لعروض الأسعار في الوقت الفعلي buyers أو واجهة برمجة التطبيقات لسوق Google AdSense buyers.clients على التوالي.
Proposal.billedBuyer.accountId Proposal.billedBuyer

أصبح هذا الآن اسم مورد يشير إلى حساب مشتري كما هو معروض في مورد buyers ضمن واجهة برمجة التطبيقات Real-time Bidding API.
Proposal.displayName Proposal.displayName
Proposal.proposalState Proposal.state
Proposal.isRenegotiating Proposal.isRenegotiating
Proposal.buyerPrivateData Proposal.buyerPrivateData
Proposal.sellerContacts Proposal.sellerContacts
Proposal.buyerContacts Proposal.buyerContacts
Proposal.privateAuctionId

تم إيقاف هذا الحقل نهائيًا.
Proposal.isSetupComplete FinalizedDeal.readyToServe

يمكن الآن الوصول إلى هذه البيانات بدقة أكبر باستخدام buyers.finalizedDeals.

Proposal.lastUpdaterOrCommentorRole Proposal.lastUpdaterOrCommentorRole
Proposal.notes.proposalRevision

تم إيقاف هذا الحقل نهائيًا.
Proposal.notes.noteId

تم إيقاف هذا الحقل نهائيًا.
Proposal.notes.createTime Proposal.notes.createTime
Proposal.notes.creatorRole Proposal.notes.creatorRole
Proposal.notes.note Proposal.notes.note
Proposal.termsAndConditions Proposal.termsAndConditions