به API Marketplace مهاجرت کنید

API را فعال کنید

مشابه سایر API های مجاز خریداران، قبل از اینکه بتوانید از آن استفاده کنید، باید API بازار را فعال کنید. می توانید API بازار را با مراحل زیر فعال کنید:

  1. به صفحه Google API Console Enabled APIs بروید. پروژه‌ای را که برای دسترسی به سایر APIهای مجاز خریداران استفاده می‌کنید، مانند Ad Exchange Buyer II یا Real-time Bidding API انتخاب کنید.
  2. روی پیوند + ENABLE APIS AND SERVICES کلیک کنید.
  3. در کادر جستجو، « Autorized Buyers Marketplace API » را تایپ کرده و Enter را فشار دهید.
  4. در نتایج جستجو، Authorized Buyers Marketplace API را انتخاب کنید.
  5. برای فعال کردن API بازار، روی دکمه ENABLE کلیک کنید.
  6. اکنون باید بتوانید با اعتبارنامه های ایجاد شده در این پروژه به API Marketplace دسترسی داشته باشید.

اعتبارنامه OAuth 2.0 خود را به روز کنید

گردش‌های کاری موجود OAuth 2.0 با دامنه API Ad Exchange Buyer II برای استفاده از محدوده API Marketplace باید تغییر کند:

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

توصیه می کنیم برای دسترسی به API از جریان OAuth 2.0 Service Account استفاده کنید. همه جریان‌های پشتیبانی شده OAuth 2.0 باید محدوده API جدید را برای درخواست رمزی از Google برای دسترسی به API Marketplace مشخص کنند.

نگاشت منابع API Buyer II Ad Exchange به API Marketplace

مشتریان

اگر از منبع accounts.clients API Ad Exchange Buyer II استفاده می‌کنید، می‌توانید به منبع buyers.clients API Marketplace مهاجرت کنید.

روش های منابع

Ad Exchange Buyer II API 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 API بازار
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 API Ad Exchange Buyer II را در یک منبع buyers.clients.users ترکیب می کند.

روش های منابع

Ad Exchange Buyer II API 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 API بازار
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 API Ad Exchange Buyer II استفاده می‌کنید، می‌توانید به منبع buyers.publisherProfiles API Marketplace مهاجرت کنید.

روش های منابع

Ad Exchange Buyer II API API بازار
accounts.publisherProfiles.get buyers.publisherProfiles.get
accounts.publisherProfiles.list buyers.publisherProfiles.list

این روش اکنون از فیلترهای لیست پشتیبانی می کند.

زمینه های منابع

Ad Exchange Buyer II API API بازار
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

پیشنهادات و پیشنهادات نهایی

اگر از منبع accounts.proposals API Ad Exchange Buyer II استفاده می کنید، می توانید به منبع buyers.proposals API Marketplace مهاجرت کنید. معاملات از پیشنهادات به منبع فرعی buyers.proposals.deals جدا شده است. پیشنهادات نهایی شده دیگر در API نمایش داده نمی شوند، و به شما کنترل دقیق تری بر معاملات نهایی شده با منبع buyers.finalizedDeals می دهد.

روش های منابع

Ad Exchange Buyer II API API بازار
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

توجه داشته باشید که پیشنهادات برگشتی دیگر حاوی اطلاعاتی در مورد معاملات نخواهند بود. اگر از فیلتر لیست استفاده می کنید، توجه داشته باشید که API Marketplace فقط از نحو فیلتر لیست پشتیبانی می کند.

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 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 یک فیلد تکراری است، هرگز با بیش از یک ورودی پر نشده است. در نتیجه، programmaticGuaranteedTerms.fixedPrice Marketplace API معادل است.

Proposal.deals.dealTerms.nonGuaranteedFixedPriceTerms

Deal.preferredDealTerms

توجه داشته باشید که اگرچه nonGuaranteedFixedPriceTerms.fixedPrices یک فیلد تکراری است، هرگز با بیش از یک ورودی پر نشده است. در نتیجه، preferredDealTerms.fixedPrice API Marketplace معادل است.

Proposal.deals.dealTerms.NonGuaranteedAuctionTerms

Deal.privateAuctionTerms

توجه داشته باشید که اگرچه nonGuaranteedAuctionTerms.reservePricesPerBuyer یک فیلد تکراری است، هرگز با بیش از یک ورودی پر نشده است. در نتیجه، 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 در 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 API Bidding در زمان واقعی یا منابع buyers.clients API Marketplace هستند.

Proposal.billedBuyer.accountId Proposal.billedBuyer

اکنون این نام منبعی است که به حساب خریدار که در منبع buyers 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