מעבר ל-Marketplace API

הפעלת ה-API

דומים לאלה של Authorized Buyers אחרים ממשקי API, עליכם להפעיל את Marketplace API לפני אפשר להשתמש בו. כדי להפעיל את Marketplace API:

  1. מעבר אל ממשקי ה-API המופעלים של מסוף Google API . בוחרים את שבו אתם משתמשים כדי לגשת לממשקי API אחרים של Authorized Buyers, כמו 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 שיכול לגשת לממשק API של Marketplace.

מיפוי משאבי API של Ad Exchange Buyer II לממשק ה-API של Marketplace

לקוחות

אם אתם משתמשים ב-Ad Exchange Buyer II API accounts.clients אפשר לעבור ל-Marketplace API buyers.clients משאב.

שיטות משאבים

ממשק API של Ad Exchange Buyer II API של Marketplace
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 Buyer 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 משלב את הפונקציונליות של ממשק ה-API של Ad Exchange Buyer II accounts.clients.invitations ו-accounts.clients.users את המשאבים בחשבון אחד buyers.clients.users משאב.

שיטות משאבים

ממשק API של Ad Exchange Buyer II 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 Buyer 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

אם אתם משתמשים ב-Ad Exchange Buyer II API accounts.publisherProfiles אפשר לעבור ל-Marketplace API buyers.publisherProfiles משאב.

שיטות משאבים

ממשק API של Ad Exchange Buyer II API של Marketplace
accounts.publisherProfiles.get buyers.publisherProfiles.get
accounts.publisherProfiles.list buyers.publisherProfiles.list

השיטה הזו תומכת עכשיו לרשימת מסנני הרשימה.

שדות המשאבים

ממשק API של Ad Exchange Buyer II API של Marketplace
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 Buyer II API accounts.proposals אפשר לעבור ל-Marketplace API buyers.proposals משאב. עסקאות הופרדו מההצעות buyers.proposals.deals במשאב משנה. ההצעות הסופיות כבר לא מיוצגות ב-API, שליטה מפורטת יותר בעסקאות סופיות buyers.finalizedDeals משאב.

שיטות משאבים

ממשק API של Ad Exchange Buyer II 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 כדי לחדש את המינוי האישי עסקאות סופיות לחשבון קונה נתון.

שדות המשאבים

יש הבדל בין Proposal למשאבים proposals ו-finalizedProposals יש שלבי העברה דומים.

ממשק API של Ad Exchange Buyer II API של Marketplace
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 הוא בשדה חוזר, הוא אף פעם לא מאוכלס ביותר מרשומה אחת. בתור כתוצאה מכך, ממשקי ה-API של Marketplace הערך programmaticGuaranteedTerms.fixedPrice הוא שווה ערך.

Proposal.deals.dealTerms.nonGuaranteedFixedPriceTerms

Deal.preferredDealTerms

חשוב לשים לב שבזמן nonGuaranteedFixedPriceTerms.fixedPrices שדה חוזר, הוא אף פעם לא מאוכלס ביותר מרשומה אחת. כתוצאה מכך, ממשקי ה-API של Marketplace הערך preferredDealTerms.fixedPrice הוא שווה ערך.

Proposal.deals.dealTerms.NonGuaranteedAuctionTerms

Deal.privateAuctionTerms

שימו לב שבזמן nonGuaranteedAuctionTerms.reservePricesPerBuyer הוא בשדה חוזר, הוא אף פעם לא מאוכלס ביותר מרשומה אחת. בתור כתוצאה מכך, ממשקי ה-API של Marketplace הערך 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. לדוגמה, המפתח GOOG_CREATIVE_SIZE מ-Ad Exchange Buyer II מתייחס אל ממשקי API של Marketplace 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