Bermigrasi ke Marketplace API

Mengaktifkan API

Serupa dengan API Authorized Buyers lainnya, Anda harus mengaktifkan Marketplace API sebelum dapat menggunakannya. Anda dapat mengaktifkan Marketplace API dengan langkah-langkah berikut:

  1. Buka halaman Google API Console Enabled APIs. Pilih project yang Anda gunakan untuk mengakses Authorized Buyers API lainnya, seperti Ad Exchange Buyer II atau Bidding Real-time API.
  2. Klik link + AKTIFKAN API DAN LAYANAN.
  3. Di kotak penelusuran, ketik "Authorized Buyers Marketplace API", dan tekan Enter.
  4. Di hasil penelusuran, pilih Authorized Buyers Marketplace API.
  5. Klik tombol AKTIFKAN untuk mengaktifkan Marketplace API.
  6. Sekarang Anda dapat mengakses Marketplace API dengan kredensial yang dibuat di project ini.

Memperbarui kredensial OAuth 2.0 Anda

Alur kerja OAuth 2.0 yang ada dengan cakupan Ad Exchange Buyer II API perlu diubah agar dapat menggunakan cakupan Marketplace API:

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

Sebaiknya gunakan alur OAuth Akun Layanan 2.0 untuk mengakses API. Semua alur OAuth 2.0 yang didukung harus menentukan cakupan API baru untuk meminta token dari Google yang dapat mengakses Marketplace API.

Memetakan resource Ad Exchange Buyer II API ke Marketplace API

Klien

Jika menggunakan resource accounts.clients Ad Exchange Buyer II API, Anda dapat bermigrasi ke resource buyers.clients Marketplace API.

Metode resource

API Pembeli Ad Exchange II API Marketplace
accounts.clients.create buyers.clients.create
accounts.clients.get buyers.clients.get
accounts.clients.list buyers.clients.list

Metode ini sekarang mendukung filter daftar.

accounts.clients.update buyers.clients.patch

Metode ini sekarang mendukung update parsial dengan parameter updateMask.

Kolom resource

API Pembeli Ad Exchange II API Marketplace
Client.clientAccountId Client.name

clientAccountId adalah ID resource klien.
Client.role Client.role
Client.status Client.state
Client.clientName Client.displayName
Client.visibleToSeller Client.sellerVisible
Client.entityType

Kolom ini telah dihentikan.
Client.entityId

Kolom ini telah dihentikan.
Client.entityName

Kolom ini telah dihentikan.
Client.partnerClientId Client.partnerClientId

Undangan & Pengguna

Marketplace API menggabungkan fungsi resource accounts.clients.invitations dan accounts.clients.users Ad Exchange Buyer II API ke dalam satu resource buyers.clients.users.

Metode resource

API Pembeli Ad Exchange II API 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

Hanya pengguna yang state-nya ditetapkan ke INVITED yang akan setara dengan pengguna yang ditampilkan oleh accounts.clients.invitations.list.

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

Anda tidak dapat lagi melakukan patch pada pengguna klien dengan API. Sebaiknya gunakan buyers.clients.users.delete untuk menghapus pengguna klien dan membuatnya ulang dengan perubahan yang diinginkan.

Kolom resource

API Pembeli Ad Exchange II API Marketplace
ClientUserInvitation.invitationId

Kolom ini telah dihentikan.
ClientUserInvitation.email ClientUser.email
ClientUserInvitation.clientAccountId

Kolom ini tidak ada lagi untuk pengguna klien. Sebagai gantinya, tampilkan clientAccountId dalam nama klien induk.
ClientUser.userId ClientUser.name

userId adalah ID resource pengguna.
ClientUser.clientAccountId

Kolom ini tidak ada lagi untuk pengguna klien. Sebagai gantinya, tampilkan clientAccountId dalam nama klien induk.
ClientUser.status ClientUser.state
ClientUser.email ClientUser.email

Produk

Resource ini dan fungsinya tidak tersedia di Marketplace API.

PublisherProfiles

Jika menggunakan resource accounts.publisherProfiles Ad Exchange Buyer II API, Anda dapat bermigrasi ke resource buyers.publisherProfiles Marketplace API.

Metode resource

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

Metode ini sekarang mendukung filter daftar.

Kolom resource

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

publisherProfileId adalah ID resource profil penayang.
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

Kolom ini telah dihentikan.
PublisherProfile.googlePlusUrl

Kolom ini telah dihentikan.
PublisherProfile.overview PublisherProfile.overview
PublisherProfile.buyerPitchStatement PublisherProfile.pitchStatement
PublisherProfile.topHeadlines PublisherProfile.topHeadlines
PublisherProfile.audienceDescription PublisherProfile.audienceDescription
PublisherProfile.isParent PublisherProfile.isParent

Proposal & Proposal Final

Jika menggunakan resource accounts.proposals Ad Exchange Buyer II API, Anda dapat bermigrasi ke resource buyers.proposals Marketplace API. Transaksi telah dipisahkan dari proposal ke dalam sub-resource buyers.proposals.deals. Proposal yang diselesaikan tidak lagi direpresentasikan di API, sehingga Anda memiliki kontrol yang lebih terperinci atas transaksi yang diselesaikan dengan resource buyers.finalizedDeals.

Metode resource

API Pembeli Ad Exchange II API Marketplace
accounts.proposals.accept buyers.proposals.accept

Hanya panggil buyers.proposals.accept saat status proposal adalah 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

Perhatikan bahwa proposal tidak akan lagi berisi informasi tentang transaksi.

accounts.proposals.list buyers.proposals.list

Perhatikan bahwa proposal yang ditampilkan tidak akan lagi berisi informasi tentang transaksi. Jika Anda menggunakan pemfilteran daftar, perlu diperhatikan bahwa Marketplace API hanya mendukung sintaksis filter daftar.
accounts.proposals.pause buyers.finalizedDeals.pause
accounts.proposals.resume buyers.finalizedDeals.resume
accounts.proposals.update buyers.proposals.patch

Metode ini sekarang mendukung update parsial dengan parameter updateMask.
accounts.finalizedProposals.list

Gunakan buyers.finalizedDeals.list untuk melihat transaksi akhir untuk akun pembeli tertentu. Sekarang Anda dapat mengambil transaksi yang diselesaikan pada tingkat bidder dengan bidders.finalizedDeals.list.
accounts.finalizedProposals.pause

Gunakan buyers.finalizedDeals.pause untuk menjeda masing-masing transaksi yang diselesaikan untuk akun pembeli tertentu.
accounts.finalizedProposals.resume

Gunakan buyers.finalizedDeals.resume untuk melanjutkan transaksi akhir individual untuk akun pembeli tertentu.

Kolom resource

Resource proposals dan finalizedProposals memiliki representasi Proposal yang sama dan memiliki langkah migrasi yang serupa.

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

proposalId adalah ID resource proposal.
Proposal.updateTime Proposal.updateTime
Proposal.proposalRevision

Proposal.proposalRevision dan Deal.proposalRevision
Proposal.deals.dealId Deal.name

dealId adalah ID resource transaksi.
Proposal.deals.proposalId Deal.name

proposalId adalah ID resource proposal induk.
Proposal.deals.createTime Deal.createTime
Proposal.deals.updateTime Deal.updateTime
Proposal.deals.createProductId

Kolom ini telah dihentikan.
Proposal.deals.createProductRevision

Kolom ini telah dihentikan.
Proposal.deals.displayName Deal.displayName
Proposal.deals.buyerPrivateData.referenceId

Kolom ini telah dihentikan; kini hanya ditampilkan di tingkat proposal.
Proposal.deals.dealTerms.description Deal.description
Proposal.deals.dealTerms.brandingType

Kolom ini telah dihentikan.
Proposal.deals.dealTerms.estimatedGrossSpend Deal.estimatedGrossSpend
Proposal.deals.dealTerms.estimatedImpressionsPerDay

Kolom ini telah dihentikan.
Proposal.deals.dealTerms.sellerTimeZone Deal.sellerTimeZone
Proposal.deals.dealTerms.guaranteedFixedPriceTerms

Deal.programmaticGuaranteedTerms

Perhatikan bahwa meskipun guaranteedFixedPriceTerms.fixedPrices adalah kolom berulang, kolom ini tidak pernah diisi dengan lebih dari satu entri. Dengan demikian, programmaticGuaranteedTerms.fixedPrice Marketplace API setara.
Proposal.deals.dealTerms.nonGuaranteedFixedPriceTerms

Deal.preferredDealTerms

Perhatikan bahwa meskipun nonGuaranteedFixedPriceTerms.fixedPrices adalah kolom berulang, kolom ini tidak pernah diisi dengan lebih dari satu entri. Dengan demikian, preferredDealTerms.fixedPrice Marketplace API setara.
Proposal.deals.dealTerms.NonGuaranteedAuctionTerms

Deal.privateAuctionTerms

Perhatikan bahwa meskipun nonGuaranteedAuctionTerms.reservePricesPerBuyer adalah kolom berulang, kolom ini tidak pernah diisi dengan lebih dari satu entri. Dengan demikian, privateAuctionTerms.floorPrice Marketplace API setara.
Proposal.deals.webPropertyCode

Kolom ini telah dihentikan.
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

Penargetan tidak dapat dikonfigurasi lagi menggunakan kunci untuk menentukan kategori penargetan, tetapi kategori yang dapat ditargetkan dapat ditemukan di Deal.targeting. Misalnya, kunci GOOG_CREATIVE_SIZE dari Pembeli Ad Exchange II merujuk pada Deal.targeting.inventorySizeTargeting Marketplace API.
Proposal.deals.targeting Deal.targeting

Kategori kriteria penargetan tambahan telah ditambahkan.
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

Kolom ini telah dihentikan.
Proposal.deals.syndicationProduct

Kolom ini telah dihentikan.
Proposal.deals.creativePreApprovalPolicy Deal.creativeRequirements.creativePreApprovalPolicy
Proposal.deals.creativeSafeFrameCompatibility Deal.creativeRequirements.creativeSafeFrameCompatibility
Proposal.deals.dealServingMetadata

Informasi serupa dapat ditemukan di kolom FinalizedDeal.dealPausingInfo.
Proposal.deals.programmaticCreativeSource Deal.creativeRequirements.programmaticCreativeSource
Proposal.deals.deliveryControl Deal.deliveryControl

Detail tambahan tentang cara transaksi akan ditambahkan.
Proposal.deals.isSetupComplete FinalizedDeal.readyToServe

Sekarang Anda hanya dapat memberikan sinyal bahwa transaksi siap ditayangkan jika sudah diselesaikan. Gunakan metode buyers.finalizedDeals.setReadyToServe untuk menunjukkan bahwa transaksi Dijamin Terprogram akhir siap ditayangkan.
Proposal.originatorRole Proposal.originatorRole
Proposal.seller.accountId Proposal.publisherProfile

Gunakan nama profil penayang untuk mengidentifikasi penjual. Anda dapat melihat profil penayang dengan resource buyers.publisherProfiles.
Proposal.seller.subAccountId Proposal.publisherProfile

Gunakan nama profil penayang untuk mengidentifikasi penjual. Anda dapat melihat profil penayang dengan resource buyers.publisherProfiles.
Proposal.buyer.accountId

Proposal.buyer atau Proposal.client.

Kolom yang digunakan akan bergantung pada jenis akun pembeli yang bernegosiasi. Ini adalah nama resource dari resource buyers Real-time Bidding API atau resource buyers.clients Marketplace API.
Proposal.billedBuyer.accountId Proposal.billedBuyer

Sekarang, ini menjadi nama resource yang merujuk ke akun pembeli seperti yang direpresentasikan dalam resource 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

Kolom ini telah dihentikan.
Proposal.isSetupComplete FinalizedDeal.readyToServe

Sekarang diakses secara lebih terperinci dengan buyers.finalizedDeals.

Proposal.lastUpdaterOrCommentorRole Proposal.lastUpdaterOrCommentorRole
Proposal.notes.proposalRevision

Kolom ini telah dihentikan.
Proposal.notes.noteId

Kolom ini telah dihentikan.
Proposal.notes.createTime Proposal.notes.createTime
Proposal.notes.creatorRole Proposal.notes.creatorRole
Proposal.notes.note Proposal.notes.note
Proposal.termsAndConditions Proposal.termsAndConditions