النقل إلى Marketplace API

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

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

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

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

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

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

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

ربط موارد واجهة برمجة التطبيقات Ad Exchange Buyer II بواجهة برمجة تطبيقات Marketplace

العملاء

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

طرق الموارد

واجهة برمجة التطبيقات للمشتري II في Ad Exchange واجهة برمجة تطبيقات Marketplace
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.

حقول الموارد

واجهة برمجة التطبيقات للمشتري II في Ad Exchange واجهة برمجة تطبيقات 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 بين وظائف موارد Ad Exchange Buyer II API من accounts.clients.invitations وaccounts.clients.users في مورد واحد buyers.clients.users.

طرق الموارد

واجهة برمجة التطبيقات للمشتري II في Ad Exchange واجهة برمجة تطبيقات Marketplace
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 لحذف حساب العميل وإعادة إنشائه بالتغييرات المفضّلة.

حقول الموارد

واجهة برمجة التطبيقات للمشتري II في Ad Exchange واجهة برمجة تطبيقات Marketplace
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.

طرق الموارد

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

تتوافق هذه الطريقة الآن مع فلاتر القوائم.

حقول الموارد

واجهة برمجة التطبيقات للمشتري II في Ad Exchange واجهة برمجة تطبيقات Marketplace
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

الاقتراحات والمقترحات النهائية

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

طرق الموارد

واجهة برمجة التطبيقات للمشتري II في Ad Exchange واجهة برمجة تطبيقات Marketplace
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 نفسه، ولهما خطوات نقل بيانات مشابهة.

واجهة برمجة التطبيقات للمشتري II في Ad Exchange واجهة برمجة تطبيقات Marketplace
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 هو حقل متكرّر، إلا أنّه لم تتم تعبئته بأكثر من إدخال واحد. ونتيجة لذلك، يعادل 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 لواجهة برمجة تطبيقات عروض الأسعار في الوقت الفعلي أو مورد buyers.clients لواجهة برمجة تطبيقات Marketplace على التوالي.

Proposal.billedBuyer.accountId Proposal.billedBuyer

أصبح هذا الآن اسم مورد يشير إلى حساب المشتري كما هو موضح في مورد buyers لواجهة برمجة تطبيقات عروض الأسعار في الوقت الفعلي.

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