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

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

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

  1. 'Google API कंसोल से चालू किए गए एपीआई' पेज पर जाएं. वह प्रोजेक्ट चुनें जिसका इस्तेमाल दूसरे Authorized Buyers API को ऐक्सेस करने के लिए किया जाता है. जैसे, 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 एपीआई संसाधनों को Marketplace एपीआई में मैप करना

क्लाइंट

अगर Ad Exchange Buyer II API के accounts.clients संसाधन का इस्तेमाल किया जाता है, तो Marketplace API के buyers.clients संसाधन पर माइग्रेट किया जा सकता है.

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

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

न्योते और उपयोगकर्ता

मार्केटप्लेस एपीआई, Ad Exchange Buyer II API के accounts.clients.invitations और accounts.clients.users संसाधनों को एक buyers.clients.users संसाधन में जोड़ता है.

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

Ad Exchange Buyer II एपीआई मार्केटप्लेस एपीआई
accounts.clients.invitations.create buyers.clients.users.create
accounts.clients.invitations.get buyers.clients.users.get
accounts.clients.invitations.list buyers.clients.users.list

सिर्फ़ उन उपयोगकर्ताओं को accounts.clients.invitations.list के ज़रिए लौटाए गए उपयोगकर्ताओं के बराबर किया जाएगा जिनके state को INVITED पर सेट किया गया है.

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 एपीआई मार्केटप्लेस एपीआई
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 एपीआई मार्केटप्लेस एपीआई
accounts.publisherProfiles.get buyers.publisherProfiles.get
accounts.publisherProfiles.list buyers.publisherProfiles.list

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

संसाधन फ़ील्ड

Ad Exchange Buyer 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

प्रपोज़ल और फ़ाइनल हो चुके प्रस्ताव

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

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

Ad Exchange Buyer II एपीआई मार्केटप्लेस एपीआई
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 एपीआई मार्केटप्लेस एपीआई
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 एपीआई का programmaticGuaranteedTerms.fixedPrice भी एक जैसा है.

Proposal.deals.dealTerms.nonGuaranteedFixedPriceTerms

Deal.preferredDealTerms

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

Proposal.deals.dealTerms.NonGuaranteedAuctionTerms

Deal.privateAuctionTerms

ध्यान दें कि nonGuaranteedAuctionTerms.reservePricesPerBuyer, दोहराया गया फ़ील्ड है. हालांकि, इसमें कभी भी एक से ज़्यादा एंट्री नहीं डाली गई. इस वजह से, Marketplace एपीआई का 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