Marketplace API に移行する

API を有効にする

他の認定バイヤー API と同様に、使用する前に Marketplace API を有効にする必要があります。Marketplace API を有効にするには、次の手順を行います。

  1. Google API Console の [有効な API] ページに移動します。Ad Exchange Buyer II や Real-time Bidding API など、他の認定バイヤー API へのアクセスに使用するプロジェクトを選択します。
  2. [+ API とサービスの有効化] リンクをクリックします。
  3. 検索ボックスに「Authorized Buyers Marketplace API」と入力して、Enter キーを押します。
  4. 検索結果で [認定バイヤーのマーケットプレイス 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

API にアクセスするには、サービス アカウント OAuth 2.0 フローを使用することをおすすめします。サポートされているすべての OAuth 2.0 フローでは、Marketplace API にアクセスできるトークンを Google からリクエストするために、新しい API スコープを指定する必要があります。

Ad Exchange Buyer II API リソースと Marketplace API のマッピング

クライアント

Ad Exchange Buyer II API の accounts.clients リソースを使用している場合は、Marketplace API の buyers.clients リソースに移行できます。

リソース メソッド

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 パラメータによる部分更新がサポートされるようになりました。

リソース フィールド

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

招待状とユーザー

Marketplace API は、Ad Exchange Buyer II API の accounts.clients.invitations リソースと accounts.clients.users リソースの機能を 1 つの buyers.clients.users リソースに統合しています。

リソース メソッド

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

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 Buyer 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 Buyer II API の accounts.publisherProfiles リソースを使用している場合は、Marketplace API の buyers.publisherProfiles リソースに移行できます。

リソース メソッド

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

このメソッドでリストフィルタがサポートされるようになりました。

リソース フィールド

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

提案と確定済みプロポーザル

Ad Exchange Buyer II API の accounts.proposals リソースを使用している場合は、Marketplace API の buyers.proposals リソースに移行できます。取引は、プロポーザルから buyers.proposals.deals サブリソースに分割されました。確定済みの提案は API に表示されなくなりました。これにより、buyers.finalizedDeals リソースで確定済みの取引をより細かく制御できるようになりました。

リソース メソッド

Ad Exchange Buyer 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 Buyer 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 は繰り返しフィールドですが、1 つのエントリを超えて入力されたことはありません。その結果、Marketplace API の preferredDealTerms.fixedPrice は同等です。
Proposal.deals.dealTerms.NonGuaranteedAuctionTerms

Deal.privateAuctionTerms

nonGuaranteedAuctionTerms.reservePricesPerBuyer は繰り返しフィールドですが、1 つのエントリを超えて入力されたことはありません。そのため、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 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

使用されるフィールドは、交渉中の購入者のアカウントの種類によって異なります。これらは、それぞれ 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