Bermigrasi ke Marketplace API

Mengaktifkan API

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

  1. Buka halaman API yang Diaktifkan Konsol API Google. Pilih project yang Anda gunakan untuk mengakses Authorized Buyers API lainnya, seperti Ad Exchange Buyer II atau Real-time Bidding API.
  2. Klik link + ENABLE APIS AND SERVICES.
  3. Di kotak penelusuran, ketik "Authorized Buyers Marketplace API", lalu tekan Enter.
  4. Di hasil penelusuran, pilih Authorized Buyers Marketplace API.
  5. Klik tombol ENABLE untuk mengaktifkan Marketplace API.
  6. Sekarang Anda seharusnya dapat mengakses Marketplace API dengan kredensial yang dibuat dalam project ini.

Memperbarui kredensial OAuth 2.0

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

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

Sebaiknya gunakan alur OAuth 2.0 Akun Layanan 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

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

Metode ini kini mendukung filter daftar.

accounts.clients.update buyers.clients.patch

Metode ini kini mendukung update sebagian dengan parameter updateMask.

Kolom resource

Ad Exchange Buyer II API Marketplace API
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 menjadi satu resource buyers.clients.users.

Metode resource

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

Hanya pengguna dengan state yang ditetapkan ke INVITED yang akan setara dengan 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 lagi dapat membuat patch pengguna klien dengan API. Sebaiknya gunakan buyers.clients.users.delete untuk menghapus pengguna klien dan membuatnya ulang dengan perubahan yang diinginkan.

Kolom resource

Ad Exchange Buyer II API API Marketplace
ClientUserInvitation.invitationId

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

Kolom ini tidak ada lagi untuk pengguna klien. Sebagai gantinya, lihat 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, lihat 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

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

Metode ini kini mendukung filter daftar.

Kolom resource

Ad Exchange Buyer II API 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 & FinalizedProposals

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

Metode resource

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

Hanya panggil buyers.proposals.accept jika 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

Perlu diketahui 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 transaksi. Jika Anda menggunakan pemfilteran daftar, perhatikan 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 telah diselesaikan di tingkat bidder dengan bidders.finalizedDeals.list.
accounts.finalizedProposals.pause

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

Gunakan buyers.finalizedDeals.resume untuk melanjutkan transaksi individual yang telah diselesaikan untuk akun pembeli tertentu.

Kolom resource

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

Ad Exchange Buyer II API Marketplace API
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; sekarang 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. Oleh karena itu, 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. Akibatnya, 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. Oleh karena itu, 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

Anda tidak dapat lagi mengonfigurasi penargetan menggunakan kunci untuk menentukan kategori penargetan; namun, kategori yang dapat ditargetkan dapat ditemukan di Deal.targeting. Misalnya, kunci GOOG_CREATIVE_SIZE dari Pembeli Ad Exchange II merujuk ke 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 menambahkan transaksi.
Proposal.deals.isSetupComplete FinalizedDeal.readyToServe

Sekarang Anda hanya dapat memberikan sinyal bahwa kesepakatan siap ditayangkan jika telah diselesaikan. Gunakan metode buyers.finalizedDeals.setReadyToServe untuk menunjukkan bahwa transaksi Dijamin Terprogram yang telah selesai 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 melakukan negosiasi. Ini adalah nama resource dari resource buyers Real-time Bidding API, atau resource buyers.clients Marketplace.
Proposal.billedBuyer.accountId Proposal.billedBuyer

Ini sekarang 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