ย้ายข้อมูลไปยัง Marketplace API

เปิดใช้ API

คุณต้องเปิดใช้ Marketplace API ก่อนจึงจะใช้งานได้เช่นเดียวกับ API ของ Authorized Buyers อื่นๆ คุณเปิดใช้ Marketplace API ได้โดยทำตามขั้นตอนต่อไปนี้

  1. ไปที่หน้า API ที่เปิดใช้คอนโซล Google API เลือกโครงการที่คุณใช้เข้าถึง Authorized Buyers API อื่นๆ เช่น Ad Exchange Buyer II หรือ Real-time Bidding API
  2. คลิกลิงก์ + เปิดใช้ API และบริการ
  3. ในช่องค้นหา ให้พิมพ์ "Authorized Buyers Marketplace API" แล้วกด Enter
  4. ในผลการค้นหา ให้เลือก Authorized Buyers Marketplace API
  5. คลิกปุ่มเปิดใช้เพื่อเปิดใช้ Marketplace API
  6. ตอนนี้คุณควรมีสิทธิ์เข้าถึง Marketplace API ด้วยข้อมูลเข้าสู่ระบบที่สร้างขึ้นในโปรเจ็กต์นี้แล้ว

อัปเดตข้อมูลเข้าสู่ระบบ OAuth 2.0

เวิร์กโฟลว์ OAuth 2.0 ที่มีอยู่ซึ่งมีขอบเขต Ad Exchange Buyer II API ต้องเปลี่ยนไปใช้ขอบเขต Marketplace API โดยทำดังนี้

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

เราขอแนะนำให้ใช้โฟลว์ OAuth 2.0 ของบัญชีบริการเพื่อเข้าถึง API ขั้นตอน OAuth 2.0 ที่รองรับทั้งหมดต้องระบุขอบเขต API ใหม่เพื่อขอโทเค็นจาก Google ที่เข้าถึง Marketplace API ได้

การแมปทรัพยากร Ad Exchange Buyer II API กับ Marketplace API

ในนามของลูกค้า

หากใช้ทรัพยากร accounts.clients ของ Ad Exchange Buyer II API คุณสามารถย้ายข้อมูลไปยังทรัพยากร buyers.clients ของ Marketplace API ได้

วิธีการของทรัพยากร

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

ตอนนี้วิธีการนี้รองรับตัวกรองรายการแล้ว

accounts.clients.update buyers.clients.patch

ตอนนี้วิธีการนี้รองรับการอัปเดตบางส่วนด้วยพารามิเตอร์ updateMask แล้ว

ช่องทรัพยากร

API ผู้ซื้อ Ad Exchange II API สำหรับ 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 API รวมฟังก์ชันการทำงานของแหล่งข้อมูล accounts.clients.invitations และ accounts.clients.users ของ Ad Exchange Buyer II API เข้าเป็นแหล่งข้อมูล buyers.clients.users แหล่งเดียว

วิธีการของทรัพยากร

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

เฉพาะผู้ใช้ที่มีการตั้งค่า 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

คุณไม่สามารถแพตช์ผู้ใช้ไคลเอ็นต์ด้วย API ได้อีกต่อไป เราขอแนะนำให้คุณใช้ buyers.clients.users.delete เพื่อลบผู้ใช้ไคลเอ็นต์และสร้างผู้ใช้ใหม่โดยทำการเปลี่ยนแปลงที่ต้องการ

ช่องทรัพยากร

API ผู้ซื้อ Ad Exchange II API สำหรับ 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

หากใช้ทรัพยากร accounts.publisherProfiles Buyer II API ของ Ad Exchange คุณสามารถย้ายข้อมูลไปยังทรัพยากร buyers.publisherProfiles ของ Marketplace API ได้

วิธีการของทรัพยากร

Ad Exchange Buyer II API API สำหรับ Marketplace
accounts.publisherProfiles.get buyers.publisherProfiles.get
accounts.publisherProfiles.list buyers.publisherProfiles.list

ตอนนี้วิธีการนี้รองรับตัวกรองรายการแล้ว

ช่องทรัพยากร

API ผู้ซื้อ Ad Exchange II API สำหรับ 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

Proposals และ FinalizedProposals

หากใช้ทรัพยากร accounts.proposals ของ Ad Exchange Buyer II API คุณสามารถย้ายข้อมูลไปยังทรัพยากร buyers.proposals ของ Marketplace API ได้ ดีลแยกออกจากข้อเสนอแล้วไปอยู่ในแหล่งข้อมูลย่อย buyers.proposals.deals ระบบจะไม่แสดงข้อเสนอที่สรุปแล้วใน API อีกต่อไป ซึ่งจะช่วยให้คุณควบคุมดีลที่สรุปแล้วได้อย่างละเอียดยิ่งขึ้นด้วยแหล่งข้อมูล buyers.finalizedDeals

วิธีการของทรัพยากร

Ad Exchange Buyer II API API สำหรับ 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 แบบเดียวกันและมีขั้นตอนการย้ายข้อมูลคล้ายกัน

API ผู้ซื้อ Ad Exchange II 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 จะเป็นช่องที่ซ้ำกัน แต่ไม่เคยมีการป้อนข้อมูลมากกว่า 1 รายการ ด้วยเหตุนี้ programmaticGuaranteedTerms.fixedPrice ของ Marketplace API จึงเทียบเท่า

Proposal.deals.dealTerms.nonGuaranteedFixedPriceTerms

Deal.preferredDealTerms

โปรดทราบว่าแม้ nonGuaranteedFixedPriceTerms.fixedPrices จะเป็นช่องที่ซ้ำ แต่ไม่ได้ป้อนข้อมูลมากกว่า 1 รายการ ด้วยเหตุนี้ preferredDealTerms.fixedPrice ของ Marketplace API จึงเทียบเท่า

Proposal.deals.dealTerms.NonGuaranteedAuctionTerms

Deal.privateAuctionTerms

โปรดทราบว่าแม้ว่า nonGuaranteedAuctionTerms.reservePricesPerBuyer จะเป็นช่องที่ซ้ำกัน แต่ไม่เคยมีการป้อนข้อมูลมากกว่า 1 รายการ ด้วยเหตุนี้ 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 Real-time Bidding API หรือ buyers.clients Marketplace API ตามลำดับ

Proposal.billedBuyer.accountId Proposal.billedBuyer

ตอนนี้เป็นชื่อทรัพยากรที่อ้างอิงบัญชีผู้ซื้อตามที่แสดงใน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

ช่องนี้เลิกใช้งานแล้ว

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