API を有効にする
他の認定バイヤーの API と同様に、この API を使用するには Marketplace API を有効にする必要があります。Marketplace API は次の手順で有効にできます。
- Google API Console の [有効な API] ページに移動します。他の 認定バイヤー API(Ad Exchange Buyer II や Real-time Bidding API など)へのアクセスに使用しているプロジェクトを選択します。
- [+ API とサービスの有効化] リンクをクリックします。
- 検索ボックスに「認定バイヤー Marketplace API」と入力して、Enter キーを押します。
- 検索結果で、[認定バイヤー Marketplace API] を選択します。
- [有効にする] ボタンをクリックして Marketplace API を有効にします。
- これで、このプロジェクトで作成された認証情報を使用して 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 フローを使用することをおすすめします。Marketplace API にアクセスできるトークンを Google にリクエストするには、サポートされているすべての OAuth 2.0 フローで新しい 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
このメソッドは、 |
リソース フィールド
Ad Exchange Buyer II API | Marketplace API |
---|---|
Client.clientAccountId |
Client.name
|
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
|
accounts.clients.users.get |
buyers.clients.users.get |
accounts.clients.users.list |
buyers.clients.users.list
|
accounts.clients.users.update |
API を使用してクライアント ユーザーにパッチを適用することはできなくなりました。
|
リソース フィールド
Ad Exchange Buyer II API | Marketplace API |
---|---|
ClientUserInvitation.invitationId |
このフィールドは廃止されました。 |
ClientUserInvitation.email |
ClientUser.email |
ClientUserInvitation.clientAccountId |
クライアント ユーザーのこのフィールドはもう存在しません。代わりに、親クライアントの名前で |
ClientUser.userId |
ClientUser.name
|
ClientUser.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
|
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 と FinalizedProposal
Ad Exchange Buyer II API の accounts.proposals
リソースを使用する場合は、Marketplace API の buyers.proposals
リソースに移行できます。取引はプロポーザルから buyers.proposals.deals
サブリソースに分割されています。確定済みの提案は API には表示されず、buyers.finalizedDeals
リソースを使って確定済みの取引をより細かく管理できます。
リソース メソッド
リソース フィールド
proposals
リソースと finalizedProposals
リソースは同じ Proposal
表現を共有し、移行手順も似ています。
Ad Exchange Buyer II API | Marketplace API |
---|---|
Proposal.proposalId |
Proposal.name
|
Proposal.updateTime |
Proposal.updateTime |
Proposal.proposalRevision |
|
Proposal.deals.dealId |
Deal.name
|
Proposal.deals.proposalId |
Deal.name
|
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 |
|
Proposal.deals.dealTerms.nonGuaranteedFixedPriceTerms |
|
Proposal.deals.dealTerms.NonGuaranteedAuctionTerms |
|
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
キーを使用してターゲティング カテゴリを決定する際にターゲティングを設定することはできなくなりましたが、ターゲットに設定できるカテゴリは |
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 |
同様の情報は |
Proposal.deals.programmaticCreativeSource |
Deal.creativeRequirements.programmaticCreativeSource |
Proposal.deals.deliveryControl |
Deal.deliveryControl
セールの実施方法に関する詳細情報を追加しました。 |
Proposal.deals.isSetupComplete |
FinalizedDeal.readyToServe
取引が確定した場合にのみ、配信可能な状態であることを通知できるようになりました。 |
Proposal.originatorRole |
Proposal.originatorRole |
Proposal.seller.accountId |
Proposal.publisherProfile
パブリッシャー プロフィール名を使用して販売者を特定します。パブリッシャーのプロフィールは、 |
Proposal.seller.subAccountId |
Proposal.publisherProfile
パブリッシャー プロフィール名を使用して販売者を特定します。パブリッシャーのプロフィールは、 |
Proposal.buyer.accountId |
使用されるフィールドは、交渉している購入者のアカウント タイプによって異なります。それぞれ、Realtime Bidding API |
Proposal.billedBuyer.accountId |
Proposal.billedBuyer
これは、Realtime 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
|
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 |