迁移到 Marketplace API

启用 API

类似于其他 Authorized Buyers 买方的您需要启用 Marketplace API 早于 就可以使用了您可以按照以下步骤启用 Marketplace API：

  1. 转到 Google API 控制台中已启用的 API 页面。选择 用于访问其他 Authorized Buyers API 的项目，例如 Ad Exchange 买方 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 凭据

使用 Ad Exchange 买方 II API 范围的现有 OAuth 2.0 工作流程需要 更改为使用 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 的对应关系

客户端

如果您使用 Ad Exchange 买方 II API accounts.clients 您可以迁移到 Marketplace API buyers.clients 资源。

资源方法

Ad Exchange 买方 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 参数。

资源字段

Ad Exchange 买方 II API Marketplace API
Client.clientAccountId Client.name

clientAccountId 是客户端资源 ID。
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

邀请和用户

市场 API 结合了 Ad Exchange 买方 II API 的功能 accounts.clients.invitations 和accounts.clients.users 集中在 buyers.clients.users 资源。

资源方法

Ad Exchange 买方 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

您无法再使用该 API 为客户端用户打补丁。我们建议 您使用的 buyers.clients.users.delete，用于删除 然后使用所需更改重新创建该用户。

资源字段

Ad Exchange 买方 II API Marketplace API
ClientUserInvitation.invitationId

此字段已停用。
ClientUserInvitation.email ClientUser.email
ClientUserInvitation.clientAccountId

对于客户用户，此字段已不存在。请改为查看 clientAccountId 添加到父级客户端的名称中。
ClientUser.userId ClientUser.name

userId 是用户资源 ID。
ClientUser.clientAccountId

对于客户用户，此字段已不存在。请改为查看 clientAccountId 添加到父级客户端的名称中。
ClientUser.status ClientUser.state
ClientUser.email ClientUser.email

产品

Marketplace API 中不提供此资源及其功能。

PublisherProfiles

如果您使用 Ad Exchange 买方 II API accounts.publisherProfiles 您可以迁移到 Marketplace API buyers.publisherProfiles 资源。

资源方法

Ad Exchange 买方 II API Marketplace API
accounts.publisherProfiles.get buyers.publisherProfiles.get
accounts.publisherProfiles.list buyers.publisherProfiles.list

此方法现在支持 列表过滤条件。

资源字段

Ad Exchange 买方 II API Marketplace API
PublisherProfile.publisherProfileId PublisherProfile.name

publisherProfileId 是发布商资料资源 ID。
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

提案和FinalizedProposals

如果您使用 Ad Exchange 买方 II API accounts.proposals 您可以迁移到 Marketplace API buyers.proposals 资源。交易已从提案中分离出来 buyers.proposals.deals 子资源。已敲定的提案将不再显示在 API 中 让您能够更精细地控制最终交易 buyers.finalizedDeals 资源。

资源方法

Ad Exchange 买方 II API Marketplace API
accounts.proposals.accept buyers.proposals.accept

仅当提案的状态为 BUYER_ACCEPTANCE_REQUESTED 时，才调用 buyers.proposals.accept。
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 买方 II API Marketplace API
Proposal.proposalId Proposal.name

proposalId 是提案资源 ID。
Proposal.updateTime Proposal.updateTime
Proposal.proposalRevision

Proposal.proposalRevision和 Deal.proposalRevision
Proposal.deals.dealId Deal.name

dealId 是交易资源 ID。
Proposal.deals.proposalId Deal.name

proposalId 是父级提案资源 ID。
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 买方 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。

所使用的字段取决于协商交易的账号类型 买方。这些是 Real-time Bidding API 或 buyers 资源或 Marketplace API buyers.clients 资源。
Proposal.billedBuyer.accountId Proposal.billedBuyer

该资源现在是一个资源名称，用于指代买方账号 在 Real-time Bidding API 的 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