Переход на API торговой площадки

Включить API

Как и в случае с API других авторизованных покупателей, вам необходимо включить API Marketplace , прежде чем вы сможете его использовать. Вы можете включить Marketplace API, выполнив следующие действия:

  1. Перейдите на страницу API с поддержкой консоли Google API . Выберите проект, который вы используете для доступа к другим API авторизованных покупателей, например Ad Exchange Buyer II или API назначения ставок в реальном времени .
  2. Нажмите ссылку + ВКЛЮЧИТЬ APIS И СЕРВИСЫ .
  3. В поле поиска введите « API торговой площадки авторизованных покупателей » и нажмите Enter .
  4. В результатах поиска выберите API торговой площадки авторизованных покупателей .
  5. Нажмите кнопку ВКЛЮЧИТЬ , чтобы включить API Marketplace.
  6. Теперь вы сможете получить доступ к API Marketplace с учетными данными, созданными в рамках этого проекта.

Обновите свои учетные данные OAuth 2.0.

Существующие рабочие процессы OAuth 2.0 с областью API Ad Exchange Buyer II необходимо изменить, чтобы использовать область API Marketplace:

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 торговой площадки

Клиенты

Если вы используете accounts.clients API Ad Exchange Buyer II, вы можете перейти на ресурс buyers.clients API Marketplace.

Ресурсные методы

API Ad Exchange для покупателей II 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 .

Поля ресурсов

API Ad Exchange для покупателей II 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 .

Ресурсные методы

API Ad Exchange для покупателей II 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 , чтобы удалить пользователя клиента и воссоздать его с предпочтительными изменениями.

Поля ресурсов

API Ad Exchange для покупателей II 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.

Профили издателей

Если вы используете accounts.publisherProfiles API Ad Exchange Buyer II, вы можете перейти на ресурс buyers.publisherProfiles API Marketplace.

Ресурсные методы

API Ad Exchange для покупателей II API торговой площадки
accounts.publisherProfiles.get buyers.publisherProfiles.get
accounts.publisherProfiles.list buyers.publisherProfiles.list

Этот метод теперь поддерживает фильтры списков .

Поля ресурсов

API Ad Exchange для покупателей II 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 .

Ресурсные методы

API Ad Exchange для покупателей II 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 и имеют схожие этапы миграции.

API Ad Exchange для покупателей II 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 Marketplace API эквивалентен.

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 Marketplace 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 для ставок в реальном времени, либо ресурса buyers.clients API торговой площадки соответственно.

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