Marketplace API पर माइग्रेट करें

इस एपीआई को चालू करें

Authorized Buyers के अन्य एपीआई की तरह ही, इसका इस्तेमाल करने से पहले आपको Marketplace API को चालू करना होगा. Marketplace API को चालू करने के लिए, यह तरीका अपनाएं:

  1. Google API Console की सुविधा वाले एपीआई पेज पर जाएं. वह प्रोजेक्ट चुनें जिसका इस्तेमाल, Authorized Buyers के अन्य एपीआई को ऐक्सेस करने के लिए किया जाता है. जैसे, Ad Exchange Buyer II या रीयल-टाइम बिडिंग एपीआई.
  2. + एपीआई और सेवाएं चालू करें लिंक पर क्लिक करें.
  3. खोज बॉक्स में, "Authorized Buyers Marketplace API" टाइप करें और Enter दबाएं.
  4. खोज के नतीजों में, Authorized Buyers Marketplace API चुनें.
  5. Marketplace API को चालू करने के लिए, चालू करें बटन पर क्लिक करें.
  6. अब इस प्रोजेक्ट में बनाए गए क्रेडेंशियल से Marketplace API को ऐक्सेस किया जा सकता है.

अपने OAuth 2.0 क्रेडेंशियल अपडेट करना

Ad Exchange Buyer II API के दायरे वाले मौजूदा OAuth 2.0 वर्कफ़्लो को, 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 संसाधन का इस्तेमाल किया जाता है, तो Marketplace API के buyers.clients संसाधन पर माइग्रेट किया जा सकता है.

संसाधन के तरीके

Ad Exchange Buyer II 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 खरीदार II एपीआई Marketplace API
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 Buyer II API 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 खरीदार II एपीआई 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 संसाधन का इस्तेमाल किया जाता है, तो Marketplace API के buyers.publisherProfiles संसाधन पर माइग्रेट किया जा सकता है.

संसाधन के तरीके

Ad Exchange Buyer II API Marketplace API
accounts.publisherProfiles.get buyers.publisherProfiles.get
accounts.publisherProfiles.list buyers.publisherProfiles.list

इस तरीके में अब सूची के लिए फ़िल्टर का इस्तेमाल किया जा सकता है.

रिसॉर्स फ़ील्ड

Ad Exchange खरीदार II एपीआई मार्केटप्लेस एपीआई
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

Ad Exchange Buyer II API के accounts.proposals संसाधन का इस्तेमाल करने पर, Marketplace API के buyers.proposals संसाधन पर माइग्रेट किया जा सकता है. डील को प्रस्तावों से अलग करके, buyers.proposals.deals सब-रिसॉर्स में रखा गया है. स्वीकार किए गए प्रस्ताव अब एपीआई में नहीं दिखाए जाते. इससे आपको buyers.finalizedDeals संसाधन की मदद से, स्वीकार किए गए ऑफ़र को ज़्यादा बेहतर तरीके से कंट्रोल करने में मदद मिलती है.

संसाधन के तरीके

Ad Exchange Buyer II API 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 एक बार-बार इस्तेमाल होने वाला फ़ील्ड है, लेकिन इसे कभी भी एक से ज़्यादा एंट्री से नहीं भरा गया था. इसलिए, Marketplace API का programmaticGuaranteedTerms.fixedPrice एक जैसा है.

Proposal.deals.dealTerms.nonGuaranteedFixedPriceTerms

Deal.preferredDealTerms

ध्यान दें कि nonGuaranteedFixedPriceTerms.fixedPrices एक बार में कई बार दिखने वाला फ़ील्ड है. हालांकि, इसमें एक से ज़्यादा एंट्री कभी नहीं भरी गईं. इसलिए, Marketplace API का preferredDealTerms.fixedPrice एक जैसा है.

Proposal.deals.dealTerms.NonGuaranteedAuctionTerms

Deal.privateAuctionTerms

ध्यान दें कि nonGuaranteedAuctionTerms.reservePricesPerBuyer एक दोहराया गया फ़ील्ड है, लेकिन इसे कभी भी एक से ज़्यादा एंट्री से नहीं भरा गया था. इसलिए, Marketplace API का privateAuctionTerms.floorPrice एक जैसा है.

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 में देखी जा सकती हैं. उदाहरण के लिए, Ad Exchange Buyer II की GOOG_CREATIVE_SIZE कुंजी, Marketplace API के Deal.targeting.inventorySizeTargeting को दिखाती है.

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 रिसॉर्स या Marketplace API buyers.clients रिसॉर्स के नाम हैं.

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