This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.
See Dimensions, Metrics, and Filters for a full list of available dimensions.
See Standard Query Parameters for query parameters that can be used with all methods and all resources.
Resource types
- AccountActiveAdSummaries
- AccountPermissionGroups
- AccountPermissions
- AccountUserProfiles
- Accounts
- Ads
- AdvertiserGroups
- AdvertiserLandingPages
- Advertisers
- Browsers
- CampaignCreativeAssociations
- Campaigns
- ChangeLogs
- Cities
- ConnectionTypes
- ContentCategories
- Conversions
- Countries
- CreativeAssets
- CreativeFieldValues
- CreativeFields
- CreativeGroups
- Creatives
- DimensionValues
- DirectorySites
- DynamicTargetingKeys
- EventTags
- Files
- FloodlightActivities
- FloodlightActivityGroups
- FloodlightConfigurations
- InventoryItems
- Languages
- Metros
- MobileApps
- MobileCarriers
- OperatingSystemVersions
- OperatingSystems
- OrderDocuments
- Orders
- PlacementGroups
- PlacementStrategies
- Placements
- PlatformTypes
- PostalCodes
- Projects
- Regions
- RemarketingListShares
- RemarketingLists
- Reports
- Reports.compatibleFields
- Reports.files
- Sites
- Sizes
- Subaccounts
- TargetableRemarketingLists
- TargetingTemplates
- UserProfiles
- UserRolePermissionGroups
- UserRolePermissions
- UserRoles
- VideoFormats
AccountActiveAdSummaries
For AccountActiveAdSummaries Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/accountActiveAdSummaries/summaryAccountId
|
Gets the account's active ad summary by account ID. |
AccountPermissionGroups
For AccountPermissionGroups Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/accountPermissionGroups/id
|
Gets one account permission group by ID. |
list |
GET /userprofiles/profileId/accountPermissionGroups
|
Retrieves the list of account permission groups. |
AccountPermissions
For AccountPermissions Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/accountPermissions/id
|
Gets one account permission by ID. |
list |
GET /userprofiles/profileId/accountPermissions
|
Retrieves the list of account permissions. |
AccountUserProfiles
For AccountUserProfiles Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/accountUserProfiles/id
|
Gets one account user profile by ID. |
insert |
POST /userprofiles/profileId/accountUserProfiles
|
Inserts a new account user profile. |
list |
GET /userprofiles/profileId/accountUserProfiles
|
Retrieves a list of account user profiles, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/accountUserProfiles
|
Updates an existing account user profile. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/accountUserProfiles
|
Updates an existing account user profile. |
Accounts
For Accounts Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/accounts/id
|
Gets one account by ID. |
list |
GET /userprofiles/profileId/accounts
|
Retrieves the list of accounts, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/accounts
|
Updates an existing account. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/accounts
|
Updates an existing account. |
Ads
For Ads Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/ads/id
|
Gets one ad by ID. |
insert |
POST /userprofiles/profileId/ads
|
Inserts a new ad. |
list |
GET /userprofiles/profileId/ads
|
Retrieves a list of ads, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/ads
|
Updates an existing ad. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/ads
|
Updates an existing ad. |
AdvertiserGroups
For AdvertiserGroups Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
delete |
DELETE /userprofiles/profileId/advertiserGroups/id
|
Deletes an existing advertiser group. |
get |
GET /userprofiles/profileId/advertiserGroups/id
|
Gets one advertiser group by ID. |
insert |
POST /userprofiles/profileId/advertiserGroups
|
Inserts a new advertiser group. |
list |
GET /userprofiles/profileId/advertiserGroups
|
Retrieves a list of advertiser groups, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/advertiserGroups
|
Updates an existing advertiser group. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/advertiserGroups
|
Updates an existing advertiser group. |
AdvertiserLandingPages
For AdvertiserLandingPages Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/advertiserLandingPages/id
|
Gets one landing page by ID. |
insert |
POST /userprofiles/profileId/advertiserLandingPages
|
Inserts a new landing page. |
list |
GET /userprofiles/profileId/advertiserLandingPages
|
Retrieves a list of landing pages. |
patch |
PATCH /userprofiles/profileId/advertiserLandingPages
|
Updates an existing landing page. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/advertiserLandingPages
|
Updates an existing landing page. |
Advertisers
For Advertisers Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/advertisers/id
|
Gets one advertiser by ID. |
insert |
POST /userprofiles/profileId/advertisers
|
Inserts a new advertiser. |
list |
GET /userprofiles/profileId/advertisers
|
Retrieves a list of advertisers, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/advertisers
|
Updates an existing advertiser. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/advertisers
|
Updates an existing advertiser. |
Browsers
For Browsers Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
list |
GET /userprofiles/profileId/browsers
|
Retrieves a list of browsers. |
CampaignCreativeAssociations
For CampaignCreativeAssociations Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
insert |
POST /userprofiles/profileId/campaigns/campaignId/campaignCreativeAssociations
|
Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already. |
list |
GET /userprofiles/profileId/campaigns/campaignId/campaignCreativeAssociations
|
Retrieves the list of creative IDs associated with the specified campaign. This method supports paging. |
Campaigns
For Campaigns Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/campaigns/id
|
Gets one campaign by ID. |
insert |
POST /userprofiles/profileId/campaigns
|
Inserts a new campaign. |
list |
GET /userprofiles/profileId/campaigns
|
Retrieves a list of campaigns, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/campaigns
|
Updates an existing campaign. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/campaigns
|
Updates an existing campaign. |
ChangeLogs
For ChangeLogs Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/changeLogs/id
|
Gets one change log by ID. |
list |
GET /userprofiles/profileId/changeLogs
|
Retrieves a list of change logs. This method supports paging. |
Cities
For Cities Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
list |
GET /userprofiles/profileId/cities
|
Retrieves a list of cities, possibly filtered. |
ConnectionTypes
For ConnectionTypes Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/connectionTypes/id
|
Gets one connection type by ID. |
list |
GET /userprofiles/profileId/connectionTypes
|
Retrieves a list of connection types. |
ContentCategories
For ContentCategories Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
delete |
DELETE /userprofiles/profileId/contentCategories/id
|
Deletes an existing content category. |
get |
GET /userprofiles/profileId/contentCategories/id
|
Gets one content category by ID. |
insert |
POST /userprofiles/profileId/contentCategories
|
Inserts a new content category. |
list |
GET /userprofiles/profileId/contentCategories
|
Retrieves a list of content categories, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/contentCategories
|
Updates an existing content category. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/contentCategories
|
Updates an existing content category. |
Conversions
For Conversions Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
batchinsert |
POST /userprofiles/profileId/conversions/batchinsert
|
Inserts conversions. |
batchupdate |
POST /userprofiles/profileId/conversions/batchupdate
|
Updates existing conversions. |
Countries
For Countries Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/countries/dartId
|
Gets one country by ID. |
list |
GET /userprofiles/profileId/countries
|
Retrieves a list of countries. |
CreativeAssets
For CreativeAssets Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
insert |
POST
and POST /userprofiles/profileId/creativeAssets/advertiserId/creativeAssets
|
Inserts a new creative asset. |
CreativeFieldValues
For CreativeFieldValues Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
delete |
DELETE /userprofiles/profileId/creativeFields/creativeFieldId/creativeFieldValues/id
|
Deletes an existing creative field value. |
get |
GET /userprofiles/profileId/creativeFields/creativeFieldId/creativeFieldValues/id
|
Gets one creative field value by ID. |
insert |
POST /userprofiles/profileId/creativeFields/creativeFieldId/creativeFieldValues
|
Inserts a new creative field value. |
list |
GET /userprofiles/profileId/creativeFields/creativeFieldId/creativeFieldValues
|
Retrieves a list of creative field values, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/creativeFields/creativeFieldId/creativeFieldValues
|
Updates an existing creative field value. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/creativeFields/creativeFieldId/creativeFieldValues
|
Updates an existing creative field value. |
CreativeFields
For CreativeFields Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
delete |
DELETE /userprofiles/profileId/creativeFields/id
|
Deletes an existing creative field. |
get |
GET /userprofiles/profileId/creativeFields/id
|
Gets one creative field by ID. |
insert |
POST /userprofiles/profileId/creativeFields
|
Inserts a new creative field. |
list |
GET /userprofiles/profileId/creativeFields
|
Retrieves a list of creative fields, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/creativeFields
|
Updates an existing creative field. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/creativeFields
|
Updates an existing creative field. |
CreativeGroups
For CreativeGroups Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/creativeGroups/id
|
Gets one creative group by ID. |
insert |
POST /userprofiles/profileId/creativeGroups
|
Inserts a new creative group. |
list |
GET /userprofiles/profileId/creativeGroups
|
Retrieves a list of creative groups, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/creativeGroups
|
Updates an existing creative group. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/creativeGroups
|
Updates an existing creative group. |
Creatives
For Creatives Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/creatives/id
|
Gets one creative by ID. |
insert |
POST /userprofiles/profileId/creatives
|
Inserts a new creative. |
list |
GET /userprofiles/profileId/creatives
|
Retrieves a list of creatives, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/creatives
|
Updates an existing creative. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/creatives
|
Updates an existing creative. |
DimensionValues
For DimensionValues Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
query |
POST /userprofiles/profileId/dimensionvalues/query
|
Retrieves a list of report dimension values for a list of filters. |
DirectorySites
For DirectorySites Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/directorySites/id
|
Gets one directory site by ID. |
insert |
POST /userprofiles/profileId/directorySites
|
Inserts a new directory site. |
list |
GET /userprofiles/profileId/directorySites
|
Retrieves a list of directory sites, possibly filtered. This method supports paging. |
DynamicTargetingKeys
For DynamicTargetingKeys Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
delete |
DELETE /userprofiles/profileId/dynamicTargetingKeys/objectId
|
Deletes an existing dynamic targeting key.
Required query parameters:
name , objectType |
insert |
POST /userprofiles/profileId/dynamicTargetingKeys
|
Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement. |
list |
GET /userprofiles/profileId/dynamicTargetingKeys
|
Retrieves a list of dynamic targeting keys. |
EventTags
For EventTags Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
delete |
DELETE /userprofiles/profileId/eventTags/id
|
Deletes an existing event tag. |
get |
GET /userprofiles/profileId/eventTags/id
|
Gets one event tag by ID. |
insert |
POST /userprofiles/profileId/eventTags
|
Inserts a new event tag. |
list |
GET /userprofiles/profileId/eventTags
|
Retrieves a list of event tags, possibly filtered. |
patch |
PATCH /userprofiles/profileId/eventTags
|
Updates an existing event tag. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/eventTags
|
Updates an existing event tag. |
Files
For Files Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /reports/reportId/files/fileId
|
Retrieves a report file by its report ID and file ID. This method supports media download. |
list |
GET /userprofiles/profileId/files
|
Lists files for a user profile. |
FloodlightActivities
For FloodlightActivities Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
delete |
DELETE /userprofiles/profileId/floodlightActivities/id
|
Deletes an existing floodlight activity. |
generatetag |
POST /userprofiles/profileId/floodlightActivities/generatetag
|
Generates a tag for a floodlight activity. |
get |
GET /userprofiles/profileId/floodlightActivities/id
|
Gets one floodlight activity by ID. |
insert |
POST /userprofiles/profileId/floodlightActivities
|
Inserts a new floodlight activity. |
list |
GET /userprofiles/profileId/floodlightActivities
|
Retrieves a list of floodlight activities, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/floodlightActivities
|
Updates an existing floodlight activity. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/floodlightActivities
|
Updates an existing floodlight activity. |
FloodlightActivityGroups
For FloodlightActivityGroups Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/floodlightActivityGroups/id
|
Gets one floodlight activity group by ID. |
insert |
POST /userprofiles/profileId/floodlightActivityGroups
|
Inserts a new floodlight activity group. |
list |
GET /userprofiles/profileId/floodlightActivityGroups
|
Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/floodlightActivityGroups
|
Updates an existing floodlight activity group. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/floodlightActivityGroups
|
Updates an existing floodlight activity group. |
FloodlightConfigurations
For FloodlightConfigurations Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/floodlightConfigurations/id
|
Gets one floodlight configuration by ID. |
list |
GET /userprofiles/profileId/floodlightConfigurations
|
Retrieves a list of floodlight configurations, possibly filtered. |
patch |
PATCH /userprofiles/profileId/floodlightConfigurations
|
Updates an existing floodlight configuration. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/floodlightConfigurations
|
Updates an existing floodlight configuration. |
InventoryItems
For InventoryItems Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/projects/projectId/inventoryItems/id
|
Gets one inventory item by ID. |
list |
GET /userprofiles/profileId/projects/projectId/inventoryItems
|
Retrieves a list of inventory items, possibly filtered. This method supports paging. |
Languages
For Languages Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
list |
GET /userprofiles/profileId/languages
|
Retrieves a list of languages. |
Metros
For Metros Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
list |
GET /userprofiles/profileId/metros
|
Retrieves a list of metros. |
MobileApps
For MobileApps Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/mobileApps/id
|
Gets one mobile app by ID. |
list |
GET /userprofiles/profileId/mobileApps
|
Retrieves list of available mobile apps. |
MobileCarriers
For MobileCarriers Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/mobileCarriers/id
|
Gets one mobile carrier by ID. |
list |
GET /userprofiles/profileId/mobileCarriers
|
Retrieves a list of mobile carriers. |
OperatingSystemVersions
For OperatingSystemVersions Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/operatingSystemVersions/id
|
Gets one operating system version by ID. |
list |
GET /userprofiles/profileId/operatingSystemVersions
|
Retrieves a list of operating system versions. |
OperatingSystems
For OperatingSystems Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/operatingSystems/dartId
|
Gets one operating system by DART ID. |
list |
GET /userprofiles/profileId/operatingSystems
|
Retrieves a list of operating systems. |
OrderDocuments
For OrderDocuments Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/projects/projectId/orderDocuments/id
|
Gets one order document by ID. |
list |
GET /userprofiles/profileId/projects/projectId/orderDocuments
|
Retrieves a list of order documents, possibly filtered. This method supports paging. |
Orders
For Orders Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/projects/projectId/orders/id
|
Gets one order by ID. |
list |
GET /userprofiles/profileId/projects/projectId/orders
|
Retrieves a list of orders, possibly filtered. This method supports paging. |
PlacementGroups
For PlacementGroups Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/placementGroups/id
|
Gets one placement group by ID. |
insert |
POST /userprofiles/profileId/placementGroups
|
Inserts a new placement group. |
list |
GET /userprofiles/profileId/placementGroups
|
Retrieves a list of placement groups, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/placementGroups
|
Updates an existing placement group. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/placementGroups
|
Updates an existing placement group. |
PlacementStrategies
For PlacementStrategies Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
delete |
DELETE /userprofiles/profileId/placementStrategies/id
|
Deletes an existing placement strategy. |
get |
GET /userprofiles/profileId/placementStrategies/id
|
Gets one placement strategy by ID. |
insert |
POST /userprofiles/profileId/placementStrategies
|
Inserts a new placement strategy. |
list |
GET /userprofiles/profileId/placementStrategies
|
Retrieves a list of placement strategies, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/placementStrategies
|
Updates an existing placement strategy. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/placementStrategies
|
Updates an existing placement strategy. |
Placements
For Placements Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
generatetags |
POST /userprofiles/profileId/placements/generatetags
|
Generates tags for a placement. |
get |
GET /userprofiles/profileId/placements/id
|
Gets one placement by ID. |
insert |
POST /userprofiles/profileId/placements
|
Inserts a new placement. |
list |
GET /userprofiles/profileId/placements
|
Retrieves a list of placements, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/placements
|
Updates an existing placement. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/placements
|
Updates an existing placement. |
PlatformTypes
For PlatformTypes Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/platformTypes/id
|
Gets one platform type by ID. |
list |
GET /userprofiles/profileId/platformTypes
|
Retrieves a list of platform types. |
PostalCodes
For PostalCodes Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/postalCodes/code
|
Gets one postal code by ID. |
list |
GET /userprofiles/profileId/postalCodes
|
Retrieves a list of postal codes. |
Projects
For Projects Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/projects/id
|
Gets one project by ID. |
list |
GET /userprofiles/profileId/projects
|
Retrieves a list of projects, possibly filtered. This method supports paging. |
Regions
For Regions Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
list |
GET /userprofiles/profileId/regions
|
Retrieves a list of regions. |
RemarketingListShares
For RemarketingListShares Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/remarketingListShares/remarketingListId
|
Gets one remarketing list share by remarketing list ID. |
patch |
PATCH /userprofiles/profileId/remarketingListShares
|
Updates an existing remarketing list share. This method supports patch semantics.
Required query parameters:
remarketingListId |
update |
PUT /userprofiles/profileId/remarketingListShares
|
Updates an existing remarketing list share. |
RemarketingLists
For RemarketingLists Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/remarketingLists/id
|
Gets one remarketing list by ID. |
insert |
POST /userprofiles/profileId/remarketingLists
|
Inserts a new remarketing list. |
list |
GET /userprofiles/profileId/remarketingLists
|
Retrieves a list of remarketing lists, possibly filtered. This method supports paging.
Required query parameters:
advertiserId |
patch |
PATCH /userprofiles/profileId/remarketingLists
|
Updates an existing remarketing list. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/remarketingLists
|
Updates an existing remarketing list. |
Reports
For Reports Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
delete |
DELETE /userprofiles/profileId/reports/reportId
|
Deletes a report by its ID. |
get |
GET /userprofiles/profileId/reports/reportId
|
Retrieves a report by its ID. |
insert |
POST /userprofiles/profileId/reports
|
Creates a report. |
list |
GET /userprofiles/profileId/reports
|
Retrieves a list of reports. |
patch |
PATCH /userprofiles/profileId/reports/reportId
|
Updates a report. This method supports patch semantics. |
run |
POST /userprofiles/profileId/reports/reportId/run
|
Runs a report. |
update |
PUT /userprofiles/profileId/reports/reportId
|
Updates a report. |
Reports.compatibleFields
For Reports.compatibleFields Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
query |
POST /userprofiles/profileId/reports/compatiblefields/query
|
Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions. |
Reports.files
For Reports.files Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/reports/reportId/files/fileId
|
Retrieves a report file by its report ID and file ID. This method supports media download. |
list |
GET /userprofiles/profileId/reports/reportId/files
|
Lists files for a report. |
Sites
For Sites Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/sites/id
|
Gets one site by ID. |
insert |
POST /userprofiles/profileId/sites
|
Inserts a new site. |
list |
GET /userprofiles/profileId/sites
|
Retrieves a list of sites, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/sites
|
Updates an existing site. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/sites
|
Updates an existing site. |
Sizes
For Sizes Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/sizes/id
|
Gets one size by ID. |
insert |
POST /userprofiles/profileId/sizes
|
Inserts a new size. |
list |
GET /userprofiles/profileId/sizes
|
Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI. |
Subaccounts
For Subaccounts Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/subaccounts/id
|
Gets one subaccount by ID. |
insert |
POST /userprofiles/profileId/subaccounts
|
Inserts a new subaccount. |
list |
GET /userprofiles/profileId/subaccounts
|
Gets a list of subaccounts, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/subaccounts
|
Updates an existing subaccount. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/subaccounts
|
Updates an existing subaccount. |
TargetableRemarketingLists
For TargetableRemarketingLists Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/targetableRemarketingLists/id
|
Gets one remarketing list by ID. |
list |
GET /userprofiles/profileId/targetableRemarketingLists
|
Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.
Required query parameters:
advertiserId |
TargetingTemplates
For TargetingTemplates Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/targetingTemplates/id
|
Gets one targeting template by ID. |
insert |
POST /userprofiles/profileId/targetingTemplates
|
Inserts a new targeting template. |
list |
GET /userprofiles/profileId/targetingTemplates
|
Retrieves a list of targeting templates, optionally filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/targetingTemplates
|
Updates an existing targeting template. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/targetingTemplates
|
Updates an existing targeting template. |
UserProfiles
For UserProfiles Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId
|
Gets one user profile by ID. |
list |
GET /userprofiles
|
Retrieves a list of user profiles for a user. |
UserRolePermissionGroups
For UserRolePermissionGroups Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/userRolePermissionGroups/id
|
Gets one user role permission group by ID. |
list |
GET /userprofiles/profileId/userRolePermissionGroups
|
Gets a list of all supported user role permission groups. |
UserRolePermissions
For UserRolePermissions Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/userRolePermissions/id
|
Gets one user role permission by ID. |
list |
GET /userprofiles/profileId/userRolePermissions
|
Gets a list of user role permissions, possibly filtered. |
UserRoles
For UserRoles Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
delete |
DELETE /userprofiles/profileId/userRoles/id
|
Deletes an existing user role. |
get |
GET /userprofiles/profileId/userRoles/id
|
Gets one user role by ID. |
insert |
POST /userprofiles/profileId/userRoles
|
Inserts a new user role. |
list |
GET /userprofiles/profileId/userRoles
|
Retrieves a list of user roles, possibly filtered. This method supports paging. |
patch |
PATCH /userprofiles/profileId/userRoles
|
Updates an existing user role. This method supports patch semantics.
Required query parameters:
id |
update |
PUT /userprofiles/profileId/userRoles
|
Updates an existing user role. |
VideoFormats
For VideoFormats Resource details, see the resource representation page.
Method | HTTP request | Description |
---|---|---|
URIs relative to https://www.googleapis.com/dfareporting/v3.3, unless otherwise noted | ||
get |
GET /userprofiles/profileId/videoFormats/id
|
Gets one video format by ID. |
list |
GET /userprofiles/profileId/videoFormats
|
Lists available video formats. |