Google Ad Manager API

  • The Ad Manager API allows management of inventory and reporting.

  • The API utilizes REST resources like networks, ad units, reports, and more for various functionalities.

  • Multiple resources offer methods to retrieve lists of objects using a GET request to a parent endpoint.

  • Several resources also provide methods for creating, updating, activating, deactivating, archiving, and submitting objects for approval.

  • Reports can be created, retrieved, updated, and run asynchronously, with results available for fetching.

Manage your Ad Manager inventory, run reports and more.

Service: admanager.googleapis.com

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://admanager.googleapis.com

REST Resource: v1.networks

Methods
get GET /v1/{name}
API to retrieve a Network object.
list GET /v1/networks
API to retrieve all the networks the current user has access to.

REST Resource: v1.networks.adRules

Methods
batchActivate POST /v1/{parent}/adRules:batchActivate
Activates a list of AdRule objects.
batchCreate POST /v1/{parent}/adRules:batchCreate
Batch creates AdRule objects.
batchDeactivate POST /v1/{parent}/adRules:batchDeactivate
Deactivates a list of AdRule objects.
batchDelete POST /v1/{parent}/adRules:batchDelete
Deletes a list of AdRule objects.
batchUpdate POST /v1/{parent}/adRules:batchUpdate
Batch updates AdRule objects.
create POST /v1/{parent}/adRules
Creates a AdRule object.
get GET /v1/{name}
Retrieves an AdRule object.
list GET /v1/{parent}/adRules
Lists AdRule objects.
patch PATCH /v1/{adRule.name}
Updates a AdRule object.

REST Resource: v1.networks.adSpots

Methods
batchCreate POST /v1/{parent}/adSpots:batchCreate
Batch creates AdSpot objects.
batchUpdate POST /v1/{parent}/adSpots:batchUpdate
Batch updates AdSpot objects.
create POST /v1/{parent}/adSpots
Creates an AdSpot object.
get GET /v1/{name}
Retrieves an AdSpot object.
list GET /v1/{parent}/adSpots
Lists AdSpot objects.
patch PATCH /v1/{adSpot.name}
Updates an AdSpot object.

REST Resource: v1.networks.adUnitSizes

Methods
list GET /v1/{parent}/adUnitSizes
Lists AdUnitSize objects.

REST Resource: v1.networks.adUnits

Methods
batchActivate POST /v1/{parent}/adUnits:batchActivate
Batch activates AdUnit objects.
batchArchive POST /v1/{parent}/adUnits:batchArchive
Archives a list of AdUnit objects.
batchCreate POST /v1/{parent}/adUnits:batchCreate
Creates AdUnit objects.
batchDeactivate POST /v1/{parent}/adUnits:batchDeactivate
Deactivates a list of AdUnit objects.
batchUpdate POST /v1/{parent}/adUnits:batchUpdate
Batch updates AdUnit objects.
create POST /v1/{parent}/adUnits
Creates an AdUnit object.
get GET /v1/{name}
Retrieves an AdUnit object.
list GET /v1/{parent}/adUnits
Lists AdUnit objects.
patch PATCH /v1/{adUnit.name}
Updates an AdUnit object.

REST Resource: v1.networks.applications

Methods
batchArchive POST /v1/{parent}/applications:batchArchive
Batch archives Application objects.
batchCreate POST /v1/{parent}/applications:batchCreate
Creates Application objects.
batchUnarchive POST /v1/{parent}/applications:batchUnarchive
Batch unarchives Application objects.
batchUpdate POST /v1/{parent}/applications:batchUpdate
Batch updates Application objects.
create POST /v1/{parent}/applications
Creates a Application object.
get GET /v1/{name}
Retrieves a Application object.
list GET /v1/{parent}/applications
Lists Application objects.
patch PATCH /v1/{application.name}
Updates a Application object.

REST Resource: v1.networks.audienceSegments

Methods
get GET /v1/{name}
API to retrieve an AudienceSegment object.
list GET /v1/{parent}/audienceSegments
API to retrieve a list of AudienceSegment objects.

REST Resource: v1.networks.bandwidthGroups

Methods
get GET /v1/{name}
Retrieves a BandwidthGroup object.
list GET /v1/{parent}/bandwidthGroups
Lists BandwidthGroup objects.

REST Resource: v1.networks.browserLanguages

Methods
get GET /v1/{name}
Retrieves a BrowserLanguage object.
list GET /v1/{parent}/browserLanguages
Lists BrowserLanguage objects.

REST Resource: v1.networks.browsers

Methods
get GET /v1/{name}
Retrieves a Browser object.
list GET /v1/{parent}/browsers
Lists Browser objects.

REST Resource: v1.networks.cdnConfigs

Methods
batchActivate POST /v1/{parent}/cdnConfigs:batchActivate
Batch activates CdnConfig objects.
batchArchive POST /v1/{parent}/cdnConfigs:batchArchive
Batch archives CdnConfig objects.
batchCreate POST /v1/{parent}/cdnConfigs:batchCreate
Batch creates CdnConfig objects.
batchUpdate POST /v1/{parent}/cdnConfigs:batchUpdate
Batch updates CdnConfig objects.
create POST /v1/{parent}/cdnConfigs
Creates a CdnConfig object.
get GET /v1/{name}
Retrieves a CdnConfig object.
list GET /v1/{parent}/cdnConfigs
Lists CdnConfig objects.
patch PATCH /v1/{cdnConfig.name}
Updates a CdnConfig object.

REST Resource: v1.networks.cmsMetadataKeys

Methods
batchActivate POST /v1/{parent}/cmsMetadataKeys:batchActivate
Activates a list of CmsMetadataKey objects.
batchDeactivate POST /v1/{parent}/cmsMetadataKeys:batchDeactivate
Deactivates a list of CmsMetadataKey objects.
get GET /v1/{name}
Retrieves a CmsMetadataKey object.
list GET /v1/{parent}/cmsMetadataKeys
Lists CmsMetadataKey objects.

REST Resource: v1.networks.cmsMetadataValues

Methods
batchActivate POST /v1/{parent}/cmsMetadataValues:batchActivate
Activates a list of CmsMetadataValue objects.
batchDeactivate POST /v1/{parent}/cmsMetadataValues:batchDeactivate
Deactivates a list of CmsMetadataValue objects.
get GET /v1/{name}
Retrieves a CmsMetadataValue object.
list GET /v1/{parent}/cmsMetadataValues
Lists CmsMetadataValue objects.

REST Resource: v1.networks.companies

Methods
get GET /v1/{name}
API to retrieve a Company object.
list GET /v1/{parent}/companies
API to retrieve a list of Company objects.

REST Resource: v1.networks.contacts

Methods
batchCreate POST /v1/{parent}/contacts:batchCreate
API to batch create Contact objects.
batchUpdate POST /v1/{parent}/contacts:batchUpdate
API to batch update Contact objects.
create POST /v1/{parent}/contacts
API to create a Contact object.
get GET /v1/{name}
API to retrieve a Contact object.
list GET /v1/{parent}/contacts
API to retrieve a list of Contact objects.
patch PATCH /v1/{contact.name}
API to update a Contact object.

REST Resource: v1.networks.content

Methods
get GET /v1/{name}
Retrieves a Content object.
list GET /v1/{parent}/content
Lists Content objects.

REST Resource: v1.networks.contentBundles

Methods
get GET /v1/{name}
Retrieves a ContentBundle object.
list GET /v1/{parent}/contentBundles
Lists ContentBundle objects.

REST Resource: v1.networks.contentLabels

Methods
get GET /v1/{name}
Retrieves a ContentLabel object.
list GET /v1/{parent}/contentLabels
Lists ContentLabel objects.

REST Resource: v1.networks.creativeTemplates

Methods
get GET /v1/{name}
Retrieves a CreativeTemplate object.
list GET /v1/{parent}/creativeTemplates
Lists CreativeTemplate objects.

REST Resource: v1.networks.customFields

Methods
batchActivate POST /v1/{parent}/customFields:batchActivate
Activates a list of CustomField objects.
batchCreate POST /v1/{parent}/customFields:batchCreate
Creates CustomField objects.
batchDeactivate POST /v1/{parent}/customFields:batchDeactivate
Deactivates a list of CustomField objects.
batchUpdate POST /v1/{parent}/customFields:batchUpdate
Batch updates CustomField objects.
create POST /v1/{parent}/customFields
Creates a CustomField object.
get GET /v1/{name}
Retrieves a CustomField object.
list GET /v1/{parent}/customFields
Lists CustomField objects.
patch PATCH /v1/{customField.name}
Updates a CustomField object.

REST Resource: v1.networks.customTargetingKeys

Methods
batchActivate POST /v1/{parent}/customTargetingKeys:batchActivate
Batch activates CustomTargetingKey objects.
batchCreate POST /v1/{parent}/customTargetingKeys:batchCreate
Creates CustomTargetingKey objects.
batchDeactivate POST /v1/{parent}/customTargetingKeys:batchDeactivate
Deactivates a list of CustomTargetingKey objects.
batchUpdate POST /v1/{parent}/customTargetingKeys:batchUpdate
Batch updates CustomTargetingKey objects.
create POST /v1/{parent}/customTargetingKeys
Creates a CustomTargetingKey object.
get GET /v1/{name}
Retrieves a CustomTargetingKey object.
list GET /v1/{parent}/customTargetingKeys
Lists CustomTargetingKey objects.
patch PATCH /v1/{customTargetingKey.name}
Updates a CustomTargetingKey object.

REST Resource: v1.networks.customTargetingKeys.customTargetingValues

Methods
get GET /v1/{name}
Retrieves a CustomTargetingValue object.
list GET /v1/{parent}/customTargetingValues
Lists CustomTargetingValue objects.

REST Resource: v1.networks.customTargetingValues

Methods
batchActivate POST /v1/{parent}/customTargetingValues:batchActivate
Batch activates CustomTargetingValue objects.
batchCreate POST /v1/{parent}/customTargetingValues:batchCreate
Creates CustomTargetingValue objects.
batchDeactivate POST /v1/{parent}/customTargetingValues:batchDeactivate
Deactivates a list of CustomTargetingValue objects.
batchUpdate POST /v1/{parent}/customTargetingValues:batchUpdate
Batch updates CustomTargetingValue objects.
create POST /v1/{parent}/customTargetingValues
Creates a CustomTargetingValue object.
get GET /v1/{name}
Retrieves a CustomTargetingValue object.
list GET /v1/{parent}/customTargetingValues
Lists CustomTargetingValue objects.
patch PATCH /v1/{customTargetingValue.name}
Updates a CustomTargetingValue object.

REST Resource: v1.networks.deviceCapabilities

Methods
get GET /v1/{name}
Retrieves a DeviceCapability object.
list GET /v1/{parent}/deviceCapabilities
Lists DeviceCapability objects.

REST Resource: v1.networks.deviceCategories

Methods
get GET /v1/{name}
Retrieves a DeviceCategory object.
list GET /v1/{parent}/deviceCategories
Lists DeviceCategory objects.

REST Resource: v1.networks.deviceManufacturers

Methods
get GET /v1/{name}
Retrieves a DeviceManufacturer object.
list GET /v1/{parent}/deviceManufacturers
Lists DeviceManufacturer objects.

REST Resource: v1.networks.entitySignalsMappings

Methods
batchCreate POST /v1/{parent}/entitySignalsMappings:batchCreate
API to batch create EntitySignalsMapping objects.
batchUpdate POST /v1/{parent}/entitySignalsMappings:batchUpdate
API to batch update EntitySignalsMapping objects.
create POST /v1/{parent}/entitySignalsMappings
API to create an EntitySignalsMapping object.
get GET /v1/{name}
API to retrieve a EntitySignalsMapping object.
list GET /v1/{parent}/entitySignalsMappings
API to retrieve a list of EntitySignalsMapping objects.
patch PATCH /v1/{entitySignalsMapping.name}
API to update an EntitySignalsMapping object.

REST Resource: v1.networks.geoTargets

Methods
get GET /v1/{name}
Retrieves a GeoTarget object.
list GET /v1/{parent}/geoTargets
Lists GeoTarget objects.

REST Resource: v1.networks.labels

Methods
batchActivate POST /v1/{parent}/labels:batchActivate
Activates Label objects.
batchCreate POST /v1/{parent}/labels:batchCreate
Creates Label objects.
batchDeactivate POST /v1/{parent}/labels:batchDeactivate
Deactivates Label objects.
batchUpdate POST /v1/{parent}/labels:batchUpdate
Batch updates Label objects.
create POST /v1/{parent}/labels
Creates a Label object.
get GET /v1/{name}
Retrieves a Label object.
list GET /v1/{parent}/labels
Lists Label objects.
patch PATCH /v1/{label.name}
Updates a Label object.

REST Resource: v1.networks.lineItems

Methods
get GET /v1/{name}
Retrieves a LineItem object.
list GET /v1/{parent}/lineItems
Lists LineItem objects.

REST Resource: v1.networks.linkedDevices

Methods
get GET /v1/{name}
Gets a LinkedDevice.
list GET /v1/{parent}/linkedDevices
Lists LinkedDevice objects.

REST Resource: v1.networks.liveStreamEvents.adBreaks

Methods
create POST /v1/{parent}/adBreaks
Creates an AdBreak object.
get GET /v1/{name}
Retrieves an AdBreak object.
list GET /v1/{parent}/adBreaks
Lists AdBreak objects.

REST Resource: v1.networks.liveStreamEventsByAssetKey.adBreaks

Methods
create POST /v1/{parent}/adBreaks
Creates an AdBreak object.
delete DELETE /v1/{name}
Deletes an AdBreak object.
get GET /v1/{name}
Retrieves an AdBreak object.
list GET /v1/{parent}/adBreaks
Lists AdBreak objects.
patch PATCH /v1/{adBreak.name}
Updates an AdBreak object.

REST Resource: v1.networks.liveStreamEventsByCustomAssetKey.adBreaks

Methods
create POST /v1/{parent}/adBreaks
Creates an AdBreak object.
get GET /v1/{name}
Retrieves an AdBreak object.
list GET /v1/{parent}/adBreaks
Lists AdBreak objects.

REST Resource: v1.networks.liveStreams

Methods
batchActivate POST /v1/{parent}/liveStreams:batchActivate
Batch activates LiveStream objects.
batchArchive POST /v1/{parent}/liveStreams:batchArchive
Batch archives LiveStream objects.
batchCreate POST /v1/{parent}/liveStreams:batchCreate
Batch creates LiveStream objects.
batchPause POST /v1/{parent}/liveStreams:batchPause
Batch pauses LiveStream objects.
batchPauseAds POST /v1/{parent}/liveStreams:batchPauseAds
Batch pauses ads on LiveStream objects.
batchRefreshMasterPlaylists POST /v1/{parent}/liveStreams:batchRefreshMasterPlaylists
Batch refreshes master playlists on LiveStream objects.
batchUpdate POST /v1/{parent}/liveStreams:batchUpdate
Batch updates LiveStream objects.
create POST /v1/{parent}/liveStreams
Creates a LiveStream object.
get GET /v1/{name}
Retrieves a LiveStream object.
list GET /v1/{parent}/liveStreams
Lists LiveStream objects.
patch PATCH /v1/{liveStream.name}
Updates a LiveStream object.

REST Resource: v1.networks.mcmEarnings

Methods
fetch GET /v1/{parent}/mcmEarnings:fetch
API to retrieve a list of McmEarnings objects.

REST Resource: v1.networks.mobileCarriers

Methods
get GET /v1/{name}
Retrieves a MobileCarrier object.
list GET /v1/{parent}/mobileCarriers
Lists MobileCarrier objects.

REST Resource: v1.networks.mobileDeviceSubmodels

Methods
get GET /v1/{name}
Retrieves a MobileDeviceSubmodel object.
list GET /v1/{parent}/mobileDeviceSubmodels
Lists MobileDeviceSubmodel objects.

REST Resource: v1.networks.mobileDevices

Methods
get GET /v1/{name}
Retrieves a MobileDevice object.
list GET /v1/{parent}/mobileDevices
Lists MobileDevice objects.

REST Resource: v1.networks.operatingSystemVersions

Methods
get GET /v1/{name}
Retrieves a OperatingSystemVersion object.
list GET /v1/{parent}/operatingSystemVersions
Lists OperatingSystemVersion objects.

REST Resource: v1.networks.operatingSystems

Methods
get GET /v1/{name}
Retrieves a OperatingSystem object.
list GET /v1/{parent}/operatingSystems
Lists OperatingSystem objects.

REST Resource: v1.networks.operations.reports.runs

Methods
cancel POST /v1/{name}:cancel
Starts asynchronous cancellation on a long-running operation.
get GET /v1/{name}
Gets the latest state of a long-running operation.

REST Resource: v1.networks.orders

Methods
get GET /v1/{name}
Retrieves an Order object.
list GET /v1/{parent}/orders
Lists Order objects.

REST Resource: v1.networks.placements

Methods
batchActivate POST /v1/{parent}/placements:batchActivate
Activates a list of Placement objects.
batchArchive POST /v1/{parent}/placements:batchArchive
Archives a list of Placement objects.
batchCreate POST /v1/{parent}/placements:batchCreate
Creates Placement objects.
batchDeactivate POST /v1/{parent}/placements:batchDeactivate
Deactivates a list of Placement objects.
batchUpdate POST /v1/{parent}/placements:batchUpdate
Batch updates Placement objects.
create POST /v1/{parent}/placements
Creates an Placement object.
get GET /v1/{name}
Retrieves a Placement object.
list GET /v1/{parent}/placements
Lists Placement objects.
patch PATCH /v1/{placement.name}
Updates an Placement object.

REST Resource: v1.networks.privateAuctionDeals

Methods
create POST /v1/{parent}/privateAuctionDeals
Creates a PrivateAuctionDeal object.
get GET /v1/{name}
Retrieves a PrivateAuctionDeal object.
list GET /v1/{parent}/privateAuctionDeals
Lists PrivateAuctionDeal objects.
patch PATCH /v1/{privateAuctionDeal.name}
Updates a PrivateAuctionDeal object.

REST Resource: v1.networks.privateAuctions

Methods
create POST /v1/{parent}/privateAuctions
Creates a PrivateAuction object.
get GET /v1/{name}
Retrieves a PrivateAuction object.
list GET /v1/{parent}/privateAuctions
Lists PrivateAuction objects.
patch PATCH /v1/{privateAuction.name}
Updates a PrivateAuction object.

REST Resource: v1.networks.programmaticBuyers

Methods
get GET /v1/{name}
Retrieves a ProgrammaticBuyer object.
list GET /v1/{parent}/programmaticBuyers
Lists ProgrammaticBuyer objects.

REST Resource: v1.networks.reports

Methods
create POST /v1/{parent}/reports
API to create a Report object.
get GET /v1/{name}
API to retrieve a Report object.
list GET /v1/{parent}/reports
API to retrieve a list of Report objects.
patch PATCH /v1/{report.name}
API to update a Report object.
run POST /v1/{name}:run
Initiates the execution of an existing report asynchronously.

REST Resource: v1.networks.reports.results

Methods
fetchRows GET /v1/{name}:fetchRows
Returns the result rows from a completed report.

REST Resource: v1.networks.richMediaAdsCompanies

Methods
get GET /v1/{name}
Retrieves a RichMediaAdsCompany object.
list GET /v1/{parent}/richMediaAdsCompanies
Lists RichMediaAdsCompany objects.

REST Resource: v1.networks.roles

Methods
get GET /v1/{name}
API to retrieve a Role object.
list GET /v1/{parent}/roles
API to retrieve a list of Role objects.

REST Resource: v1.networks.sites

Methods
batchCreate POST /v1/{parent}/sites:batchCreate
API to batch create Site objects.
batchDeactivate POST /v1/{parent}/sites:batchDeactivate
Deactivates a list of Site objects.
batchSubmitForApproval POST /v1/{parent}/sites:batchSubmitForApproval
Submits a list of Site objects for approval.
batchUpdate POST /v1/{parent}/sites:batchUpdate
API to batch update Site objects.
create POST /v1/{parent}/sites
API to create a Site object.
get GET /v1/{name}
API to retrieve a Site object.
list GET /v1/{parent}/sites
API to retrieve a list of Site objects.
patch PATCH /v1/{site.name}
API to update a Site object.

REST Resource: v1.networks.suggestedAdUnit

Methods
batchApprove POST /v1/{parent}/suggestedAdUnit:batchApprove
Bulk approve SuggestedAdUnit objects.

REST Resource: v1.networks.suggestedAdUnits

Methods
get GET /v1/{name}
Get a SuggestedAdUnit object.
list GET /v1/{parent}/suggestedAdUnits
Retrieve a list of SuggestedAdUnit objects.

REST Resource: v1.networks.targetingPreset

Methods
batchDeactivate POST /v1/{parent}/targetingPreset:batchDeactivate
Batch deactivates TargetingPreset objects.

REST Resource: v1.networks.targetingPresets

Methods
batchCreate POST /v1/{parent}/targetingPresets:batchCreate
Creates TargetingPreset objects.
create POST /v1/{parent}/targetingPresets
Creates a TargetingPreset object.
get GET /v1/{name}
Retrieves a TargetingPreset object.
list GET /v1/{parent}/targetingPresets
Lists TargetingPreset objects.

REST Resource: v1.networks.taxonomyCategories

Methods
get GET /v1/{name}
API to retrieve a TaxonomyCategory object.
list GET /v1/{parent}/taxonomyCategories
API to retrieve a list of TaxonomyCategory objects.

REST Resource: v1.networks.teams

Methods
batchActivate POST /v1/{parent}/teams:batchActivate
API to batch activate Team objects.
batchCreate POST /v1/{parent}/teams:batchCreate
API to batch create Team objects.
batchDeactivate POST /v1/{parent}/teams:batchDeactivate
API to batch deactivate Team objects.
batchUpdate POST /v1/{parent}/teams:batchUpdate
API to batch update Team objects.
create POST /v1/{parent}/teams
API to create a Team object.
get GET /v1/{name}
API to retrieve a Team object.
list GET /v1/{parent}/teams
API to retrieve a list of Team objects.
patch PATCH /v1/{team.name}
API to update a Team object.

REST Resource: v1.networks.thirdPartyCompanies

Methods
get GET /v1/{name}
API to retrieve a ThirdPartyCompany object.
list GET /v1/{parent}/thirdPartyCompanies
API to retrieve a list of ThirdPartyCompany objects.

REST Resource: v1.networks.users

Methods
get GET /v1/{name}
API to retrieve a User object.

REST Resource: v1.networks.webProperties.adReviewCenterAds

Methods
batchAllow POST /v1/{parent}/adReviewCenterAds:batchAllow
Batch allows AdReviewCenterAds.
batchBlock POST /v1/{parent}/adReviewCenterAds:batchBlock
Batch blocks AdReviewCenterAds.
search GET /v1/{parent}/adReviewCenterAds:search
Searches for AdReviewCenterAds.

REST Resource: v1.operations

Methods
delete DELETE /v1/{name}
Deletes a long-running operation.
list GET /v1/{name}
Lists operations that match the specified filter in the request.