2026-06-09
▼ ▲ dfareporting.mobileCarriers.get
Path : userprofiles/{+profileId}/mobileCarriers/{+id}
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
id
Required : Yes
Location : path
Description : Mobile carrier ID.
Format : int64
Pattern : ^[^/]+$
Type : string
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/mobileCarriers/{mobileCarriersId}
Description : Gets one mobile carrier by ID.
HTTP Method : GET
▼ ▲ dfareporting.mobileCarriers.list
Path : userprofiles/{+profileId}/mobileCarriers
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Flat Path : userprofiles/{userprofilesId}/mobileCarriers
Parameter Order : profileId
HTTP Method : GET
Description : Retrieves a list of mobile carriers.
▼ ▲ dfareporting.orders.get
Flat Path : userprofiles/{userprofilesId}/projects/{projectId}/orders/{ordersId}
Parameter Order :
Path : userprofiles/{+profileId}/projects/{projectId}/orders/{+id}
Parameters :
projectId
Type : string
Format : int64
Description : Project ID for orders.
Location : path
Required : Yes
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
id
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : Order ID.
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one order by ID.
▼ ▲ dfareporting.orders.list
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Retrieves a list of orders, possibly filtered. This method supports paging.
HTTP Method : GET
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/projects/{projectId}/orders
Path : userprofiles/{+profileId}/projects/{projectId}/orders
Parameters :
pageToken
Type : string
Description : Value of the nextPageToken from the previous result page.
Location : query
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
siteId
Repeated : Yes
Type : string
Description : Select only orders that are associated with these site IDs.
Format : int64
Location : query
sortField
Type : string
Enum :
Default : ID
Enum Descriptions :
Description : Field by which to sort the list.
Location : query
ids
Repeated : Yes
Type : string
Location : query
Description : Select only orders with these IDs.
Format : int64
searchString
Location : query
Type : string
Description : Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order".
sortOrder
Enum Descriptions :
Description : Order of sorted results.
Location : query
Type : string
Enum :
Default : ASCENDING
projectId
Type : string
Format : int64
Description : Project ID for orders.
Location : path
Required : Yes
maxResults
Location : query
Format : int32
Description : Maximum number of results to return.
Default : 1000
Type : integer
▼ ▲ dfareporting.remarketingLists.list
Flat Path : userprofiles/{userprofilesId}/remarketingLists
Parameter Order :
Path : userprofiles/{+profileId}/remarketingLists
Parameters :
advertiserId
Type : string
Description : Required. Select only remarketing lists owned by this advertiser.
Format : int64
Required : Yes
Location : query
maxResults
Default : 1000
Type : integer
Location : query
Format : int32
Description : Maximum number of results to return.
sortOrder
Type : string
Enum :
Default : ASCENDING
Enum Descriptions :
Description : Order of sorted results.
Location : query
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
active
Type : boolean
Description : Select only active or only inactive remarketing lists.
Location : query
floodlightActivityId
Description : Select only remarketing lists that have this floodlight activity ID.
Type : string
Format : int64
Location : query
sortField
Location : query
Description : Field by which to sort the list.
Enum Descriptions :
Default : ID
Enum :
Type : string
name
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
Type : string
Location : query
pageToken
Location : query
Description : Value of the nextPageToken from the previous result page.
Type : string
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Retrieves a list of remarketing lists, possibly filtered. This method supports paging.
▼ ▲ dfareporting.remarketingLists.insert
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/remarketingLists
Path : userprofiles/{+profileId}/remarketingLists
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Inserts a new remarketing list.
HTTP Method : POST
▼ ▲ dfareporting.remarketingLists.update
Description : Updates an existing remarketing list.
HTTP Method : PUT
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/remarketingLists
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/remarketingLists
▼ ▲ dfareporting.remarketingLists.patch
Description : Updates an existing remarketing list. This method supports patch semantics.
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/remarketingLists
Parameters :
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
id
Type : string
Description : Required. RemarketingList ID.
Format : int64
Required : Yes
Location : query
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/remarketingLists
▼ ▲ dfareporting.remarketingLists.get
HTTP Method : GET
Description : Gets one remarketing list by ID.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/remarketingLists/{+id}
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
id
Required : Yes
Location : path
Description : Remarketing list ID.
Format : int64
Pattern : ^[^/]+$
Type : string
Flat Path : userprofiles/{userprofilesId}/remarketingLists/{remarketingListsId}
Parameter Order :
▼ ▲ dfareporting.mobileApps.get
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Gets one mobile app by ID.
HTTP Method : GET
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/mobileApps/{mobileAppsId}
Path : userprofiles/{+profileId}/mobileApps/{+id}
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
id
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Mobile app ID.
▼ ▲ dfareporting.mobileApps.list
Path : userprofiles/{+profileId}/mobileApps
Parameters :
pageToken
Type : string
Description : Value of the nextPageToken from the previous result page.
Location : query
ids
Description : Select only apps with these IDs.
Repeated : Yes
Type : string
Location : query
searchString
Location : query
Type : string
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app".
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
maxResults
Description : Maximum number of results to return.
Format : int32
Location : query
Type : integer
Default : 1000
directories
Repeated : Yes
Type : string
Enum :
Enum Descriptions :
Description : Select only apps from these directories.
Location : query
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/mobileApps
Description : Retrieves list of available mobile apps.
HTTP Method : GET
▼ ▲ dfareporting.ads.insert
Path : userprofiles/{+profileId}/ads
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Flat Path : userprofiles/{userprofilesId}/ads
Parameter Order : profileId
HTTP Method : POST
Description : Inserts a new ad.
▼ ▲ dfareporting.ads.update
Path : userprofiles/{+profileId}/ads
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/ads
Description : Updates an existing ad.
HTTP Method : PUT
▼ ▲ dfareporting.ads.list
Path : userprofiles/{+profileId}/ads
Parameters :
audienceSegmentIds
Repeated : Yes
Type : string
Location : query
Description : Select only ads with these audience segment IDs.
Format : int64
active
Description : Select only active ads.
Type : boolean
Location : query
sortField
Enum Descriptions :
Description : Field by which to sort the list.
Location : query
Type : string
Enum :
Default : ID
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
creativeOptimizationConfigurationIds
Repeated : Yes
Type : string
Location : query
Format : int64
Description : Select only ads with these creative optimization configuration IDs.
creativeIds
Location : query
Format : int64
Description : Select only ads with these creative IDs assigned.
Repeated : Yes
Type : string
compatibility
Location : query
Description : Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard.
Enum Descriptions :
Enum :
Type : string
placementIds
Description : Select only ads with these placement IDs assigned.
Format : int64
Location : query
Repeated : Yes
Type : string
sslRequired
Location : query
Type : boolean
Description : Select only ads that require SSL.
archived
Type : boolean
Description : Select only archived ads.
Location : query
ids
Repeated : Yes
Type : string
Location : query
Format : int64
Description : Select only ads with these IDs.
overriddenEventTagId
Location : query
Type : string
Format : int64
Description : Select only ads with this event tag override ID.
sizeIds
Location : query
Format : int64
Description : Select only ads with these size IDs.
Repeated : Yes
Type : string
type
Repeated : Yes
Type : string
Enum :
Location : query
Enum Descriptions :
Description : Select only ads with these types.
pageToken
Description : Value of the nextPageToken from the previous result page.
Type : string
Location : query
dynamicClickTracker
Location : query
Type : boolean
Description : Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both.
landingPageIds
Repeated : Yes
Type : string
Description : Select only ads with these landing page IDs.
Format : int64
Location : query
remarketingListIds
Repeated : Yes
Type : string
Format : int64
Description : Select only ads whose list targeting expression use these remarketing list IDs.
Location : query
campaignIds
Location : query
Format : int64
Description : Select only ads with these campaign IDs.
Repeated : Yes
Type : string
sslCompliant
Location : query
Description : Select only ads that are SSL-compliant.
Type : boolean
advertiserId
Description : Select only ads with this advertiser ID.
Type : string
Format : int64
Location : query
maxResults
Location : query
Description : Maximum number of results to return.
Format : int32
Default : 1000
Type : integer
sortOrder
Type : string
Enum :
Default : ASCENDING
Enum Descriptions :
Description : Order of sorted results.
Location : query
searchString
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad".
Type : string
Location : query
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/ads
Description : Retrieves a list of ads, possibly filtered. This method supports paging.
HTTP Method : GET
▼ ▲ dfareporting.ads.get
HTTP Method : GET
Description : Gets one ad by ID.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/ads/{+id}
Parameters :
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
id
Description : Ad ID.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
Flat Path : userprofiles/{userprofilesId}/ads/{adsId}
Parameter Order :
▼ ▲ dfareporting.ads.patch
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : PATCH
Description : Updates an existing ad. This method supports patch semantics.
Flat Path : userprofiles/{userprofilesId}/ads
Parameter Order :
Path : userprofiles/{+profileId}/ads
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
id
Description : Required. RemarketingList ID.
Format : int64
Required : Yes
Location : query
Type : string
▼ ▲ dfareporting.creativeFieldValues.get
HTTP Method : GET
Description : Gets one creative field value by ID.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues/{+id}
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
id
Format : int64
Description : Creative Field Value ID
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
creativeFieldId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Creative field ID for this creative field value.
Format : int64
Flat Path : userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}/creativeFieldValues/{creativeFieldValuesId}
Parameter Order :
▼ ▲ dfareporting.creativeFieldValues.patch
Path : userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
id
Type : string
Format : int64
Description : CreativeFieldValue ID.
Location : query
Required : Yes
creativeFieldId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : CreativeField ID.
Location : path
Required : Yes
Flat Path : userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}/creativeFieldValues
Parameter Order :
HTTP Method : PATCH
Description : Updates an existing creative field value. This method supports patch semantics.
▼ ▲ dfareporting.creativeFieldValues.delete
Parameter Order :
Scopes : https://www.googleapis.com/auth/dfatrafficking
Flat Path : userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}/creativeFieldValues/{creativeFieldValuesId}
Description : Deletes an existing creative field value.
Path : userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues/{+id}
HTTP Method : DELETE
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
id
Type : string
Pattern : ^[^/]+$
Format : int64
Description : Creative Field Value ID
Location : path
Required : Yes
creativeFieldId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : Creative field ID for this creative field value.
▼ ▲ dfareporting.creativeFieldValues.list
HTTP Method : GET
Description : Retrieves a list of creative field values, possibly filtered. This method supports paging.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues
Parameters :
sortField
Default : ID
Type : string
Enum :
Location : query
Enum Descriptions :
Description : Field by which to sort the list.
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
maxResults
Type : integer
Default : 1000
Description : Maximum number of results to return.
Format : int32
Location : query
creativeFieldId
Location : path
Required : Yes
Format : int64
Description : Creative field ID for this creative field value.
Type : string
Pattern : ^[^/]+$
pageToken
Location : query
Type : string
Description : Value of the nextPageToken from the previous result page.
sortOrder
Location : query
Description : Order of sorted results.
Enum Descriptions :
Default : ASCENDING
Enum :
Type : string
searchString
Type : string
Description : Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.
Location : query
ids
Location : query
Format : int64
Description : Select only creative field values with these IDs.
Repeated : Yes
Type : string
Flat Path : userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}/creativeFieldValues
Parameter Order :
▼ ▲ dfareporting.creativeFieldValues.insert
HTTP Method : POST
Description : Inserts a new creative field value.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues
Parameters :
creativeFieldId
Pattern : ^[^/]+$
Type : string
Description : Creative field ID for this creative field value.
Format : int64
Required : Yes
Location : path
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
Flat Path : userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}/creativeFieldValues
Parameter Order :
▼ ▲ dfareporting.creativeFieldValues.update
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}/creativeFieldValues
Path : userprofiles/{+profileId}/creativeFields/{+creativeFieldId}/creativeFieldValues
Parameters :
creativeFieldId
Format : int64
Description : Creative field ID for this creative field value.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Updates an existing creative field value.
HTTP Method : PUT
▼ ▲ dfareporting.userRolePermissionGroups.get
Flat Path : userprofiles/{userprofilesId}/userRolePermissionGroups/{userRolePermissionGroupsId}
Parameter Order :
Path : userprofiles/{+profileId}/userRolePermissionGroups/{+id}
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
id
Format : int64
Description : User role permission group ID.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one user role permission group by ID.
▼ ▲ dfareporting.userRolePermissionGroups.list
Description : Gets a list of all supported user role permission groups.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/userRolePermissionGroups
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/userRolePermissionGroups
▼ ▲ dfareporting.advertiserLandingPages.insert
Path : userprofiles/{+profileId}/advertiserLandingPages
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Flat Path : userprofiles/{userprofilesId}/advertiserLandingPages
Parameter Order : profileId
HTTP Method : POST
Description : Inserts a new landing page.
▼ ▲ dfareporting.advertiserLandingPages.update
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Updates an existing landing page.
HTTP Method : PUT
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/advertiserLandingPages
Path : userprofiles/{+profileId}/advertiserLandingPages
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
▼ ▲ dfareporting.advertiserLandingPages.list
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Retrieves a list of landing pages.
Flat Path : userprofiles/{userprofilesId}/advertiserLandingPages
Parameter Order : profileId
Path : userprofiles/{+profileId}/advertiserLandingPages
Parameters :
ids
Format : int64
Description : Select only landing pages with these IDs.
Location : query
Repeated : Yes
Type : string
searchString
Location : query
Type : string
Description : Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage".
archived
Location : query
Type : boolean
Description : Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.
sortOrder
Location : query
Enum Descriptions :
Description : Order of sorted results.
Default : ASCENDING
Type : string
Enum :
campaignIds
Description : Select only landing pages that are associated with these campaigns.
Format : int64
Location : query
Repeated : Yes
Type : string
maxResults
Location : query
Description : Maximum number of results to return.
Format : int32
Default : 1000
Type : integer
advertiserIds
Repeated : Yes
Type : string
Location : query
Format : int64
Description : Select only landing pages that belong to these advertisers.
subaccountId
Location : query
Type : string
Format : int64
Description : Select only landing pages that belong to this subaccount.
pageToken
Location : query
Description : Value of the nextPageToken from the previous result page.
Type : string
sortField
Type : string
Enum :
Default : ID
Enum Descriptions :
Description : Field by which to sort the list.
Location : query
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
▼ ▲ dfareporting.advertiserLandingPages.get
Flat Path : userprofiles/{userprofilesId}/advertiserLandingPages/{advertiserLandingPagesId}
Parameter Order :
Path : userprofiles/{+profileId}/advertiserLandingPages/{+id}
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
id
Pattern : ^[^/]+$
Type : string
Description : Landing page ID.
Format : int64
Required : Yes
Location : path
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one landing page by ID.
▼ ▲ dfareporting.advertiserLandingPages.patch
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/advertiserLandingPages
Path : userprofiles/{+profileId}/advertiserLandingPages
Parameters :
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
id
Description : Required. Landing Page ID.
Format : int64
Required : Yes
Location : query
Type : string
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Updates an existing landing page. This method supports patch semantics.
HTTP Method : PATCH
▼ ▲ dfareporting.placements.list
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Retrieves a list of placements, possibly filtered. This method supports paging.
Flat Path : userprofiles/{userprofilesId}/placements
Parameter Order : profileId
Path : userprofiles/{+profileId}/placements
Parameters :
ids
Location : query
Format : int64
Description : Select only placements with these IDs.
Repeated : Yes
Type : string
compatibilities
Enum :
Repeated : Yes
Type : string
Location : query
Description : Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.
Enum Descriptions :
activeStatus
Description : Select only placements with these active statuses.
Enum Descriptions :
Location : query
Enum :
Repeated : Yes
Type : string
paymentSource
Type : string
Enum :
Enum Descriptions :
Description : Select only placements with this payment source.
Location : query
placementStrategyIds
Repeated : Yes
Type : string
Location : query
Description : Select only placements that are associated with these placement strategies.
Format : int64
contentCategoryIds
Location : query
Format : int64
Description : Select only placements that are associated with these content categories.
Repeated : Yes
Type : string
advertiserIds
Repeated : Yes
Type : string
Location : query
Description : Select only placements that belong to these advertisers.
Format : int64
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
groupIds
Location : query
Format : int64
Description : Select only placements that belong to these placement groups.
Repeated : Yes
Type : string
sortField
Description : Field by which to sort the list.
Enum Descriptions :
Location : query
Enum :
Type : string
Default : ID
sortOrder
Default : ASCENDING
Enum :
Type : string
Location : query
Description : Order of sorted results.
Enum Descriptions :
searchString
Location : query
Type : string
Description : Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement" .
maxResults
Default : 1000
Type : integer
Location : query
Format : int32
Description : Maximum number of results to return.
siteIds
Repeated : Yes
Type : string
Location : query
Format : int64
Description : Select only placements that are associated with these sites.
directorySiteIds
Location : query
Description : Select only placements that are associated with these directory sites.
Format : int64
Repeated : Yes
Type : string
maxStartDate
Location : query
Description : Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
Type : string
campaignIds
Description : Select only placements that belong to these campaigns.
Format : int64
Location : query
Repeated : Yes
Type : string
minEndDate
Type : string
Description : Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
Location : query
pricingTypes
Repeated : Yes
Type : string
Enum :
Enum Descriptions :
Description : Select only placements with these pricing types.
Location : query
pageToken
Location : query
Description : Value of the nextPageToken from the previous result page.
Type : string
minStartDate
Location : query
Type : string
Description : Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
sizeIds
Description : Select only placements that are associated with these sizes.
Format : int64
Location : query
Repeated : Yes
Type : string
maxEndDate
Description : Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
Type : string
Location : query
▼ ▲ dfareporting.placements.insert
HTTP Method : POST
Description : Inserts a new placement.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/placements
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Flat Path : userprofiles/{userprofilesId}/placements
Parameter Order : profileId
▼ ▲ dfareporting.placements.update
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Updates an existing placement.
HTTP Method : PUT
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/placements
Path : userprofiles/{+profileId}/placements
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
▼ ▲ dfareporting.placements.patch
Path : userprofiles/{+profileId}/placements
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
id
Format : int64
Description : Required. Placement ID.
Location : query
Required : Yes
Type : string
Flat Path : userprofiles/{userprofilesId}/placements
Parameter Order :
HTTP Method : PATCH
Description : Updates an existing placement. This method supports patch semantics.
▼ ▲ dfareporting.placements.get
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Gets one placement by ID.
HTTP Method : GET
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/placements/{placementsId}
Path : userprofiles/{+profileId}/placements/{+id}
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
id
Type : string
Pattern : ^[^/]+$
Format : int64
Description : Placement ID.
Location : path
Required : Yes
▼ ▲ dfareporting.placements.generatetags
HTTP Method : POST
Description : Generates tags for a placement.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/placements/generatetags
Parameters :
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
placementIds
Repeated : Yes
Type : string
Description : Generate tags for these placements.
Format : int64
Location : query
campaignId
Type : string
Format : int64
Description : Generate placements belonging to this campaign. This is a required field.
Location : query
tagFormats
Description : Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.
Enum Descriptions :
Location : query
Enum :
Repeated : Yes
Type : string
Flat Path : userprofiles/{userprofilesId}/placements/generatetags
Parameter Order : profileId
▼ ▲ dfareporting.placementStrategies.delete
Flat Path : userprofiles/{userprofilesId}/placementStrategies/{placementStrategiesId}
Parameter Order :
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/placementStrategies/{+id}
HTTP Method : DELETE
Parameters :
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
id
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Placement strategy ID.
Format : int64
Description : Deletes an existing placement strategy.
▼ ▲ dfareporting.placementStrategies.patch
Path : userprofiles/{+profileId}/placementStrategies
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
id
Type : string
Required : Yes
Location : query
Description : Required. PlacementStrategy ID.
Format : int64
Flat Path : userprofiles/{userprofilesId}/placementStrategies
Parameter Order :
HTTP Method : PATCH
Description : Updates an existing placement strategy. This method supports patch semantics.
▼ ▲ dfareporting.placementStrategies.get
Description : Gets one placement strategy by ID.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/placementStrategies/{+id}
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
id
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Placement strategy ID.
Format : int64
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/placementStrategies/{placementStrategiesId}
▼ ▲ dfareporting.placementStrategies.insert
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/placementStrategies
Path : userprofiles/{+profileId}/placementStrategies
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Inserts a new placement strategy.
HTTP Method : POST
▼ ▲ dfareporting.placementStrategies.update
Description : Updates an existing placement strategy.
HTTP Method : PUT
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/placementStrategies
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/placementStrategies
▼ ▲ dfareporting.placementStrategies.list
Flat Path : userprofiles/{userprofilesId}/placementStrategies
Parameter Order : profileId
Path : userprofiles/{+profileId}/placementStrategies
Parameters :
ids
Description : Select only placement strategies with these IDs.
Format : int64
Location : query
Repeated : Yes
Type : string
searchString
Location : query
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy".
Type : string
pageToken
Location : query
Type : string
Description : Value of the nextPageToken from the previous result page.
sortOrder
Enum :
Type : string
Default : ASCENDING
Description : Order of sorted results.
Enum Descriptions :
Location : query
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
maxResults
Type : integer
Default : 1000
Description : Maximum number of results to return.
Format : int32
Location : query
sortField
Location : query
Enum Descriptions :
Description : Field by which to sort the list.
Default : ID
Type : string
Enum :
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Retrieves a list of placement strategies, possibly filtered. This method supports paging.
▼ ▲ dfareporting.accounts.update
HTTP Method : PUT
Description : Updates an existing account.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/accounts
Parameters :
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
Flat Path : userprofiles/{userprofilesId}/accounts
Parameter Order : profileId
▼ ▲ dfareporting.accounts.get
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one account by ID.
Flat Path : userprofiles/{userprofilesId}/accounts/{accountsId}
Parameter Order :
Path : userprofiles/{+profileId}/accounts/{+id}
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
id
Required : Yes
Location : path
Description : Account ID.
Format : int64
Pattern : ^[^/]+$
Type : string
▼ ▲ dfareporting.accounts.patch
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/accounts
Path : userprofiles/{+profileId}/accounts
Parameters :
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
id
Type : string
Location : query
Required : Yes
Format : int64
Description : Required. Account ID.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Updates an existing account. This method supports patch semantics.
HTTP Method : PATCH
▼ ▲ dfareporting.accounts.list
Path : userprofiles/{+profileId}/accounts
Parameters :
ids
Location : query
Format : int64
Description : Select only accounts with these IDs.
Repeated : Yes
Type : string
searchString
Location : query
Type : string
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account".
pageToken
Type : string
Description : Value of the nextPageToken from the previous result page.
Location : query
sortOrder
Enum :
Type : string
Default : ASCENDING
Description : Order of sorted results.
Enum Descriptions :
Location : query
active
Location : query
Description : Select only active accounts. Don't set this field to select both active and non-active accounts.
Type : boolean
sortField
Location : query
Enum Descriptions :
Description : Field by which to sort the list.
Default : ID
Type : string
Enum :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
maxResults
Default : 1000
Type : integer
Location : query
Format : int32
Description : Maximum number of results to return.
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/accounts
Description : Retrieves the list of accounts, possibly filtered. This method supports paging.
HTTP Method : GET
▼ ▲ dfareporting.billingProfiles.update
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Updates an existing billing profile.
HTTP Method : PUT
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/billingProfiles
Path : userprofiles/{+profileId}/billingProfiles
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
▼ ▲ dfareporting.billingProfiles.get
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/billingProfiles/{billingProfilesId}
Path : userprofiles/{+profileId}/billingProfiles/{+id}
Parameters :
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
id
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Billing Profile ID.
Format : int64
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Gets one billing profile by ID.
HTTP Method : GET
▼ ▲ dfareporting.billingProfiles.list
Path : userprofiles/{+profileId}/billingProfiles
Parameters :
sortOrder
Location : query
Description : Order of sorted results.
Enum Descriptions :
Default : ASCENDING
Enum :
Type : string
ids
Description : Select only billing profile with these IDs.
Format : int64
Location : query
Repeated : Yes
Type : string
maxResults
Format : int32
Description : Maximum number of results to return.
Location : query
Type : integer
Default : 1000
currency_code
Location : query
Type : string
Description : Select only billing profile with currency.
status
Location : query
Description : Select only billing profile with the specified status.
Enum Descriptions :
Enum :
Repeated : Yes
Type : string
pageToken
Location : query
Type : string
Description : Value of the nextPageToken from the previous result page.
subaccountIds
Repeated : Yes
Type : string
Format : int64
Description : Select only billing profile with the specified subaccount.When only_suggestion is true, only a single subaccount_id is supported.
Location : query
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
onlySuggestion
Location : query
Description : Select only billing profile which is suggested for the currency_code & subaccount_id using the Billing Suggestion API.
Type : boolean
name
Location : query
Type : string
Description : Allows searching for billing profiles by name. Wildcards (*) are allowed. For example, "profile*2020" will return objects with names like "profile June 2020", "profile April 2020", or simply "profile 2020". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "profile" will match objects with name "my profile", "profile 2021", or simply "profile".
sortField
Type : string
Enum :
Default : ID
Enum Descriptions :
Description : Field by which to sort the list.
Location : query
Flat Path : userprofiles/{userprofilesId}/billingProfiles
Parameter Order : profileId
HTTP Method : GET
Description : Retrieves a list of billing profiles, possibly filtered. This method supports paging.
▼ ▲ dfareporting.remarketingListShares.update
HTTP Method : PUT
Description : Updates an existing remarketing list share.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/remarketingListShares
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Flat Path : userprofiles/{userprofilesId}/remarketingListShares
Parameter Order : profileId
▼ ▲ dfareporting.remarketingListShares.patch
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : PATCH
Description : Updates an existing remarketing list share. This method supports patch semantics.
Flat Path : userprofiles/{userprofilesId}/remarketingListShares
Parameter Order :
Path : userprofiles/{+profileId}/remarketingListShares
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
id
Type : string
Required : Yes
Location : query
Description : Required. RemarketingList ID.
Format : int64
▼ ▲ dfareporting.remarketingListShares.get
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/remarketingListShares/{remarketingListSharesId}
Path : userprofiles/{+profileId}/remarketingListShares/{+remarketingListId}
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
remarketingListId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : Remarketing list ID.
Location : path
Required : Yes
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Gets one remarketing list share by remarketing list ID.
HTTP Method : GET
▼ ▲ dfareporting.dynamicFeeds.insert
Description : Inserts a new dynamic feed.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : studio/dynamicFeeds
Flat Path : studio/dynamicFeeds
▼ ▲ dfareporting.dynamicFeeds.retransform
Parameter Order : dynamicFeedId
Flat Path : studio/dynamicFeeds/{dynamicFeedsId}/retransform
Path : studio/dynamicFeeds/{+dynamicFeedId}/retransform
Parameters :
dynamicFeedId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : Required. Dynamic feed ID.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Retransforms a dynamic feed. Only draft feeds can be retransformed (i.e. the feed has not been published).
HTTP Method : POST
▼ ▲ dfareporting.dynamicFeeds.update
Path : studio/dynamicFeeds
Flat Path : studio/dynamicFeeds
Description : Updates a new dynamic feed. For draft feeds, only Element can be updated. For published feeds, only FeedSchedule can be updated. Other fields will be ignored.
HTTP Method : PUT
▼ ▲ dfareporting.dynamicFeeds.get
Description : Gets a dynamic feed by ID.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : studio/dynamicFeeds/{+dynamicFeedId}
Parameters :
dynamicFeedId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : Required. Dynamic feed ID.
Location : path
Required : Yes
Parameter Order : dynamicFeedId
Flat Path : studio/dynamicFeeds/{dynamicFeedsId}
▼ ▲ dfareporting.eventTags.get
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/eventTags/{eventTagsId}
Path : userprofiles/{+profileId}/eventTags/{+id}
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
id
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Event tag ID.
Format : int64
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Gets one event tag by ID.
HTTP Method : GET
▼ ▲ dfareporting.eventTags.patch
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : PATCH
Description : Updates an existing event tag. This method supports patch semantics.
Flat Path : userprofiles/{userprofilesId}/eventTags
Parameter Order :
Path : userprofiles/{+profileId}/eventTags
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
id
Type : string
Location : query
Required : Yes
Format : int64
Description : Required. EventTag ID.
▼ ▲ dfareporting.eventTags.delete
Description : Deletes an existing event tag.
Path : userprofiles/{+profileId}/eventTags/{+id}
HTTP Method : DELETE
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
id
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Event tag ID.
Format : int64
Parameter Order :
Scopes : https://www.googleapis.com/auth/dfatrafficking
Flat Path : userprofiles/{userprofilesId}/eventTags/{eventTagsId}
▼ ▲ dfareporting.eventTags.list
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Retrieves a list of event tags, possibly filtered.
HTTP Method : GET
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/eventTags
Path : userprofiles/{+profileId}/eventTags
Parameters :
sortField
Description : Field by which to sort the list.
Enum Descriptions :
Location : query
Enum :
Type : string
Default : ID
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
campaignId
Location : query
Type : string
Format : int64
Description : Select only event tags that belong to this campaign.
adId
Location : query
Description : Select only event tags that belong to this ad.
Type : string
Format : int64
definitionsOnly
Location : query
Description : Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags.
Type : boolean
enabled
Location : query
Type : boolean
Description : Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well.
eventTagTypes
Enum Descriptions :
Description : Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking.
Location : query
Repeated : Yes
Type : string
Enum :
advertiserId
Description : Select only event tags that belong to this advertiser.
Type : string
Format : int64
Location : query
sortOrder
Location : query
Description : Order of sorted results.
Enum Descriptions :
Default : ASCENDING
Enum :
Type : string
ids
Description : Select only event tags with these IDs.
Format : int64
Location : query
Repeated : Yes
Type : string
searchString
Location : query
Type : string
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag".
▼ ▲ dfareporting.eventTags.insert
Path : userprofiles/{+profileId}/eventTags
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Flat Path : userprofiles/{userprofilesId}/eventTags
Parameter Order : profileId
HTTP Method : POST
Description : Inserts a new event tag.
▼ ▲ dfareporting.eventTags.update
Path : userprofiles/{+profileId}/eventTags
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/eventTags
Description : Updates an existing event tag.
HTTP Method : PUT
▼ ▲ dfareporting.floodlightConfigurations.list
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Retrieves a list of floodlight configurations, possibly filtered.
Flat Path : userprofiles/{userprofilesId}/floodlightConfigurations
Parameter Order : profileId
Path : userprofiles/{+profileId}/floodlightConfigurations
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
ids
Repeated : Yes
Type : string
Description : Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.
Format : int64
Location : query
▼ ▲ dfareporting.floodlightConfigurations.get
Flat Path : userprofiles/{userprofilesId}/floodlightConfigurations/{floodlightConfigurationsId}
Parameter Order :
Path : userprofiles/{+profileId}/floodlightConfigurations/{+id}
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
id
Pattern : ^[^/]+$
Type : string
Description : Floodlight configuration ID.
Format : int64
Required : Yes
Location : path
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one floodlight configuration by ID.
▼ ▲ dfareporting.floodlightConfigurations.patch
Path : userprofiles/{+profileId}/floodlightConfigurations
Parameters :
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
id
Description : Required. EventTag ID.
Format : int64
Required : Yes
Location : query
Type : string
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/floodlightConfigurations
Description : Updates an existing floodlight configuration. This method supports patch semantics.
HTTP Method : PATCH
▼ ▲ dfareporting.floodlightConfigurations.update
Path : userprofiles/{+profileId}/floodlightConfigurations
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Flat Path : userprofiles/{userprofilesId}/floodlightConfigurations
Parameter Order : profileId
HTTP Method : PUT
Description : Updates an existing floodlight configuration.
▼ ▲ dfareporting.creativeFields.delete
Path : userprofiles/{+profileId}/creativeFields/{+id}
HTTP Method : DELETE
Parameters :
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
id
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : Creative Field ID
Description : Deletes an existing creative field.
Flat Path : userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}
Parameter Order :
▼ ▲ dfareporting.creativeFields.get
Flat Path : userprofiles/{userprofilesId}/creativeFields/{creativeFieldsId}
Parameter Order :
Path : userprofiles/{+profileId}/creativeFields/{+id}
Parameters :
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
id
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : Creative Field ID
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one creative field by ID.
▼ ▲ dfareporting.creativeFields.patch
Path : userprofiles/{+profileId}/creativeFields
Parameters :
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
id
Required : Yes
Location : query
Description : CreativeField ID.
Format : int64
Type : string
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/creativeFields
Description : Updates an existing creative field. This method supports patch semantics.
HTTP Method : PATCH
▼ ▲ dfareporting.creativeFields.insert
Path : userprofiles/{+profileId}/creativeFields
Parameters :
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/creativeFields
Description : Inserts a new creative field.
HTTP Method : POST
▼ ▲ dfareporting.creativeFields.update
HTTP Method : PUT
Description : Updates an existing creative field.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/creativeFields
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Flat Path : userprofiles/{userprofilesId}/creativeFields
Parameter Order : profileId
▼ ▲ dfareporting.creativeFields.list
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Retrieves a list of creative fields, possibly filtered. This method supports paging.
HTTP Method : GET
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/creativeFields
Path : userprofiles/{+profileId}/creativeFields
Parameters :
sortField
Location : query
Description : Field by which to sort the list.
Enum Descriptions :
Default : ID
Enum :
Type : string
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
maxResults
Default : 1000
Type : integer
Location : query
Format : int32
Description : Maximum number of results to return.
advertiserIds
Location : query
Description : Select only creative fields that belong to these advertisers.
Format : int64
Repeated : Yes
Type : string
ids
Description : Select only creative fields with these IDs.
Format : int64
Location : query
Repeated : Yes
Type : string
searchString
Location : query
Type : string
Description : Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield".
pageToken
Type : string
Description : Value of the nextPageToken from the previous result page.
Location : query
sortOrder
Type : string
Enum :
Default : ASCENDING
Enum Descriptions :
Description : Order of sorted results.
Location : query
▼ ▲ dfareporting.regions.list
HTTP Method : GET
Description : Retrieves a list of regions.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/regions
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Flat Path : userprofiles/{userprofilesId}/regions
Parameter Order : profileId
▼ ▲ dfareporting.advertisers.get
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one advertiser by ID.
Flat Path : userprofiles/{userprofilesId}/advertisers/{advertisersId}
Parameter Order :
Path : userprofiles/{+profileId}/advertisers/{+id}
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
id
Location : path
Required : Yes
Format : int64
Description : Advertiser ID.
Type : string
Pattern : ^[^/]+$
▼ ▲ dfareporting.advertisers.patch
HTTP Method : PATCH
Description : Updates an existing advertiser. This method supports patch semantics.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/advertisers
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
id
Description : Required. Advertiser ID.
Format : int64
Required : Yes
Location : query
Type : string
Flat Path : userprofiles/{userprofilesId}/advertisers
Parameter Order :
▼ ▲ dfareporting.advertisers.list
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/advertisers
Path : userprofiles/{+profileId}/advertisers
Parameters :
status
Enum :
Type : string
Description : Select only advertisers with the specified status.
Enum Descriptions :
Location : query
onlyParent
Description : Select only advertisers which use another advertiser's floodlight configuration.
Type : boolean
Location : query
ids
Repeated : Yes
Type : string
Location : query
Format : int64
Description : Select only advertisers with these IDs.
sortField
Default : ID
Type : string
Enum :
Location : query
Enum Descriptions :
Description : Field by which to sort the list.
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
floodlightConfigurationIds
Location : query
Format : int64
Description : Select only advertisers with these floodlight configuration IDs.
Repeated : Yes
Type : string
advertiserGroupIds
Repeated : Yes
Type : string
Description : Select only advertisers with these advertiser group IDs.
Format : int64
Location : query
includeAdvertisersWithoutGroupsOnly
Type : boolean
Description : Select only advertisers which do not belong to any advertiser group.
Location : query
subaccountId
Location : query
Description : Select only advertisers with these subaccount IDs.
Type : string
Format : int64
maxResults
Description : Maximum number of results to return.
Format : int32
Location : query
Type : integer
Default : 1000
sortOrder
Description : Order of sorted results.
Enum Descriptions :
Location : query
Enum :
Type : string
Default : ASCENDING
searchString
Location : query
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser" .
Type : string
pageToken
Location : query
Type : string
Description : Value of the nextPageToken from the previous result page.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Retrieves a list of advertisers, possibly filtered. This method supports paging.
HTTP Method : GET
▼ ▲ dfareporting.advertisers.update
Description : Updates an existing advertiser.
HTTP Method : PUT
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/advertisers
Parameters :
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/advertisers
▼ ▲ dfareporting.advertisers.insert
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/advertisers
Path : userprofiles/{+profileId}/advertisers
Parameters :
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Inserts a new advertiser.
HTTP Method : POST
▼ ▲ dfareporting.placementGroups.list
Description : Retrieves a list of placement groups, possibly filtered. This method supports paging.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/placementGroups
Parameters :
campaignIds
Repeated : Yes
Type : string
Description : Select only placement groups that belong to these campaigns.
Format : int64
Location : query
minEndDate
Location : query
Type : string
Description : Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".
siteIds
Description : Select only placement groups that are associated with these sites.
Format : int64
Location : query
Repeated : Yes
Type : string
directorySiteIds
Repeated : Yes
Type : string
Location : query
Format : int64
Description : Select only placement groups that are associated with these directory sites.
maxStartDate
Location : query
Description : Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".
Type : string
maxResults
Location : query
Description : Maximum number of results to return.
Format : int32
Default : 800
Type : integer
searchString
Location : query
Description : Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup".
Type : string
sortOrder
Default : ASCENDING
Type : string
Enum :
Location : query
Enum Descriptions :
Description : Order of sorted results.
maxEndDate
Location : query
Type : string
Description : Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".
minStartDate
Type : string
Description : Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".
Location : query
pricingTypes
Enum Descriptions :
Description : Select only placement groups with these pricing types.
Location : query
Repeated : Yes
Type : string
Enum :
pageToken
Location : query
Description : Value of the nextPageToken from the previous result page.
Type : string
placementGroupType
Enum Descriptions :
Description : Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.
Location : query
Type : string
Enum :
ids
Description : Select only placement groups with these IDs.
Format : int64
Location : query
Repeated : Yes
Type : string
activeStatus
Enum Descriptions :
Description : Select only placements with these active statuses.
Location : query
Repeated : Yes
Type : string
Enum :
sortField
Location : query
Description : Field by which to sort the list.
Enum Descriptions :
Default : ID
Enum :
Type : string
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
advertiserIds
Repeated : Yes
Type : string
Description : Select only placement groups that belong to these advertisers.
Format : int64
Location : query
contentCategoryIds
Repeated : Yes
Type : string
Format : int64
Description : Select only placement groups that are associated with these content categories.
Location : query
placementStrategyIds
Format : int64
Description : Select only placement groups that are associated with these placement strategies.
Location : query
Repeated : Yes
Type : string
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/placementGroups
▼ ▲ dfareporting.placementGroups.update
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Updates an existing placement group.
HTTP Method : PUT
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/placementGroups
Path : userprofiles/{+profileId}/placementGroups
Parameters :
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
▼ ▲ dfareporting.placementGroups.insert
Path : userprofiles/{+profileId}/placementGroups
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
Flat Path : userprofiles/{userprofilesId}/placementGroups
Parameter Order : profileId
HTTP Method : POST
Description : Inserts a new placement group.
▼ ▲ dfareporting.placementGroups.patch
Path : userprofiles/{+profileId}/placementGroups
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
id
Type : string
Required : Yes
Location : query
Description : Required. Placement ID.
Format : int64
Flat Path : userprofiles/{userprofilesId}/placementGroups
Parameter Order :
HTTP Method : PATCH
Description : Updates an existing placement group. This method supports patch semantics.
▼ ▲ dfareporting.placementGroups.get
Flat Path : userprofiles/{userprofilesId}/placementGroups/{placementGroupsId}
Parameter Order :
Path : userprofiles/{+profileId}/placementGroups/{+id}
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
id
Type : string
Pattern : ^[^/]+$
Format : int64
Description : Placement group ID.
Location : path
Required : Yes
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one placement group by ID.
▼ ▲ dfareporting.tvCampaignSummaries.list
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Retrieves a list of TV campaign summaries.
Flat Path : userprofiles/{userprofilesId}/tvCampaignSummaries
Parameter Order : profileId
Path : userprofiles/{+profileId}/tvCampaignSummaries
Parameters :
accountId
Description : Required. Account ID associated with this request.
Type : string
Format : int64
Location : query
name
Type : string
Description : Required. Search string to filter the list of TV campaign summaries. Matches any substring. Required field.
Location : query
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. User profile ID associated with this request.
Format : int64
▼ ▲ dfareporting.accountActiveAdSummaries.get
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Gets the account's active ad summary by account ID.
HTTP Method : GET
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/accountActiveAdSummaries/{accountActiveAdSummariesId}
Path : userprofiles/{+profileId}/accountActiveAdSummaries/{+summaryAccountId}
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
summaryAccountId
Required : Yes
Location : path
Description : Account ID.
Format : int64
Pattern : ^[^/]+$
Type : string
▼ ▲ dfareporting.contentCategories.insert
Flat Path : userprofiles/{userprofilesId}/contentCategories
Parameter Order : profileId
Path : userprofiles/{+profileId}/contentCategories
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : POST
Description : Inserts a new content category.
▼ ▲ dfareporting.contentCategories.update
Description : Updates an existing content category.
HTTP Method : PUT
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/contentCategories
Parameters :
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/contentCategories
▼ ▲ dfareporting.contentCategories.list
Path : userprofiles/{+profileId}/contentCategories
Parameters :
pageToken
Type : string
Description : Value of the nextPageToken from the previous result page.
Location : query
sortOrder
Description : Order of sorted results.
Enum Descriptions :
Location : query
Enum :
Type : string
Default : ASCENDING
ids
Format : int64
Description : Select only content categories with these IDs.
Location : query
Repeated : Yes
Type : string
searchString
Type : string
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory".
Location : query
sortField
Default : ID
Enum :
Type : string
Location : query
Description : Field by which to sort the list.
Enum Descriptions :
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
maxResults
Type : integer
Default : 1000
Format : int32
Description : Maximum number of results to return.
Location : query
Flat Path : userprofiles/{userprofilesId}/contentCategories
Parameter Order : profileId
HTTP Method : GET
Description : Retrieves a list of content categories, possibly filtered. This method supports paging.
▼ ▲ dfareporting.contentCategories.delete
Path : userprofiles/{+profileId}/contentCategories/{+id}
HTTP Method : DELETE
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
id
Required : Yes
Location : path
Description : Content category ID.
Format : int64
Pattern : ^[^/]+$
Type : string
Description : Deletes an existing content category.
Flat Path : userprofiles/{userprofilesId}/contentCategories/{contentCategoriesId}
Parameter Order :
▼ ▲ dfareporting.contentCategories.get
Description : Gets one content category by ID.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/contentCategories/{+id}
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
id
Required : Yes
Location : path
Description : Content category ID.
Format : int64
Pattern : ^[^/]+$
Type : string
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/contentCategories/{contentCategoriesId}
▼ ▲ dfareporting.contentCategories.patch
Flat Path : userprofiles/{userprofilesId}/contentCategories
Parameter Order :
Path : userprofiles/{+profileId}/contentCategories
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
id
Location : query
Required : Yes
Format : int64
Description : Required. ContentCategory ID.
Type : string
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : PATCH
Description : Updates an existing content category. This method supports patch semantics.
▼ ▲ dfareporting.studioCreatives.insert
HTTP Method : POST
Description : Inserts a new studio creative.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : studio/creatives
Flat Path : studio/creatives
▼ ▲ dfareporting.studioCreatives.publish
Path : studio/creatives/{+studioCreativeId}/publish
HTTP Method : POST
Parameters :
studioCreativeId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : Required. Studio creative ID.
Description : Publish for a studio creative.
Flat Path : studio/creatives/{creativesId}/publish
Parameter Order : studioCreativeId
▼ ▲ dfareporting.studioCreatives.get
Path : studio/creatives/{+studioCreativeId}
Parameters :
studioCreativeId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. Studio creative ID.
Format : int64
Parameter Order : studioCreativeId
Flat Path : studio/creatives/{creativesId}
Description : Gets a studio creative by ID.
HTTP Method : GET
▼ ▲ dfareporting.billingRates.list
Flat Path : userprofiles/{userprofilesId}/billingProfiles/{billingProfilesId}/billingRates
Parameter Order :
Path : userprofiles/{+profileId}/billingProfiles/{+billingProfileId}/billingRates
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
billingProfileId
Location : path
Required : Yes
Format : int64
Description : Billing profile ID of this billing rate.
Type : string
Pattern : ^[^/]+$
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Retrieves a list of billing rates. This method supports paging.
▼ ▲ dfareporting.targetingTemplates.patch
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/targetingTemplates
Path : userprofiles/{+profileId}/targetingTemplates
Parameters :
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
id
Type : string
Required : Yes
Location : query
Description : Required. RemarketingList ID.
Format : int64
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Updates an existing targeting template. This method supports patch semantics.
HTTP Method : PATCH
▼ ▲ dfareporting.targetingTemplates.get
Flat Path : userprofiles/{userprofilesId}/targetingTemplates/{targetingTemplatesId}
Parameter Order :
Path : userprofiles/{+profileId}/targetingTemplates/{+id}
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
id
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Targeting template ID.
Format : int64
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one targeting template by ID.
▼ ▲ dfareporting.targetingTemplates.update
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Updates an existing targeting template.
HTTP Method : PUT
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/targetingTemplates
Path : userprofiles/{+profileId}/targetingTemplates
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
▼ ▲ dfareporting.targetingTemplates.insert
Path : userprofiles/{+profileId}/targetingTemplates
Parameters :
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/targetingTemplates
Description : Inserts a new targeting template.
HTTP Method : POST
▼ ▲ dfareporting.targetingTemplates.list
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/targetingTemplates
Path : userprofiles/{+profileId}/targetingTemplates
Parameters :
ids
Repeated : Yes
Type : string
Location : query
Description : Select only targeting templates with these IDs.
Format : int64
searchString
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template".
Type : string
Location : query
pageToken
Location : query
Type : string
Description : Value of the nextPageToken from the previous result page.
sortOrder
Type : string
Enum :
Default : ASCENDING
Enum Descriptions :
Description : Order of sorted results.
Location : query
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
advertiserId
Description : Select only targeting templates with this advertiser ID.
Type : string
Format : int64
Location : query
maxResults
Format : int32
Description : Maximum number of results to return.
Location : query
Type : integer
Default : 1000
sortField
Location : query
Description : Field by which to sort the list.
Enum Descriptions :
Default : ID
Enum :
Type : string
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Retrieves a list of targeting templates, optionally filtered. This method supports paging.
HTTP Method : GET
▼ ▲ dfareporting.changeLogs.get
Description : Gets one change log by ID.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/changeLogs/{+id}
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
id
Location : path
Required : Yes
Format : int64
Description : Change log ID.
Type : string
Pattern : ^[^/]+$
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/changeLogs/{changeLogsId}
▼ ▲ dfareporting.changeLogs.list
Path : userprofiles/{+profileId}/changeLogs
Parameters :
maxChangeTime
Location : query
Type : string
Description : Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
pageToken
Location : query
Type : string
Description : Value of the nextPageToken from the previous result page.
userProfileIds
Location : query
Description : Select only change logs with these user profile IDs.
Format : int64
Repeated : Yes
Type : string
objectType
Enum :
Type : string
Description : Select only change logs with the specified object type.
Enum Descriptions :
Location : query
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
action
Location : query
Description : Select only change logs with the specified action.
Enum Descriptions :
Enum :
Type : string
ids
Location : query
Description : Select only change logs with these IDs.
Format : int64
Repeated : Yes
Type : string
searchString
Description : Select only change logs whose object ID, user name, old or new values match the search string.
Type : string
Location : query
objectIds
Location : query
Format : int64
Description : Select only change logs with these object IDs.
Repeated : Yes
Type : string
minChangeTime
Description : Select only change logs whose change time is after the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset.
Type : string
Location : query
maxResults
Default : 1000
Type : integer
Location : query
Format : int32
Description : Maximum number of results to return.
Flat Path : userprofiles/{userprofilesId}/changeLogs
Parameter Order : profileId
HTTP Method : GET
Description : Retrieves a list of change logs. This method supports paging.
▼ ▲ dfareporting.creativeAssets.insert
Path : userprofiles/{+profileId}/creativeAssets/{+advertiserId}/creativeAssets
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
advertiserId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : Advertiser ID of this creative. This is a required field.
Location : path
Required : Yes
Flat Path : userprofiles/{userprofilesId}/creativeAssets/{creativeAssetsId}/creativeAssets
Supportsmediaupload : Yes
Parameter Order :
HTTP Method : POST
Mediaupload :
Accept : */*
Protocols :
Simple :
Multipart : Yes
Path : /upload/dfareporting/v4/userprofiles/{+profileId}/creativeAssets/{+advertiserId}/creativeAssets
Maxsize : 1073741824
Description : Inserts a new creative asset.
▼ ▲ dfareporting.dynamicProfiles.generateCode
Parameter Order : dynamicProfileId
Flat Path : studio/dynamicProfiles/{dynamicProfilesId}/generateCode
Path : studio/dynamicProfiles/{+dynamicProfileId}/generateCode
Parameters :
dynamicProfileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : Required. Dynamic profile ID.
Location : path
Required : Yes
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Generates code for a dynamic profile, which will need unescaping.
HTTP Method : GET
▼ ▲ dfareporting.dynamicProfiles.publish
Parameter Order : dynamicProfileId
Scopes : https://www.googleapis.com/auth/dfatrafficking
Flat Path : studio/dynamicProfiles/{dynamicProfilesId}/publish
Description : Publish for a dynamic profile.
Path : studio/dynamicProfiles/{+dynamicProfileId}/publish
HTTP Method : POST
Parameters :
dynamicProfileId
Format : int64
Description : Required. Dynamic profile ID.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
▼ ▲ dfareporting.dynamicProfiles.get
Path : studio/dynamicProfiles/{+dynamicProfileId}
Parameters :
dynamicProfileId
Location : path
Required : Yes
Format : int64
Description : Required. Dynamic profile ID.
Type : string
Pattern : ^[^/]+$
Flat Path : studio/dynamicProfiles/{dynamicProfilesId}
Parameter Order : dynamicProfileId
HTTP Method : GET
Description : Gets a dynamic profile by ID.
▼ ▲ dfareporting.dynamicProfiles.update
Description : Updates an existing dynamic profile.
HTTP Method : PUT
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : studio/dynamicProfiles
Flat Path : studio/dynamicProfiles
▼ ▲ dfareporting.dynamicProfiles.insert
Flat Path : studio/dynamicProfiles
Path : studio/dynamicProfiles
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Inserts a new dynamic profile.
HTTP Method : POST
▼ ▲ dfareporting.userRolePermissions.get
Path : userprofiles/{+profileId}/userRolePermissions/{+id}
Parameters :
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
id
Format : int64
Description : User role permission ID.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
Flat Path : userprofiles/{userprofilesId}/userRolePermissions/{userRolePermissionsId}
Parameter Order :
HTTP Method : GET
Description : Gets one user role permission by ID.
▼ ▲ dfareporting.userRolePermissions.list
Path : userprofiles/{+profileId}/userRolePermissions
Parameters :
ids
Repeated : Yes
Type : string
Description : Select only user role permissions with these IDs.
Format : int64
Location : query
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
Flat Path : userprofiles/{userprofilesId}/userRolePermissions
Parameter Order : profileId
HTTP Method : GET
Description : Gets a list of user role permissions, possibly filtered.
▼ ▲ dfareporting.floodlightActivities.delete
Path : userprofiles/{+profileId}/floodlightActivities/{+id}
HTTP Method : DELETE
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
id
Pattern : ^[^/]+$
Type : string
Description : Floodlight activity ID.
Format : int64
Required : Yes
Location : path
Description : Deletes an existing floodlight activity.
Flat Path : userprofiles/{userprofilesId}/floodlightActivities/{floodlightActivitiesId}
Parameter Order :
▼ ▲ dfareporting.floodlightActivities.get
Description : Gets one floodlight activity by ID.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/floodlightActivities/{+id}
Parameters :
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
id
Type : string
Pattern : ^[^/]+$
Format : int64
Description : Floodlight activity ID.
Location : path
Required : Yes
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/floodlightActivities/{floodlightActivitiesId}
▼ ▲ dfareporting.floodlightActivities.patch
Description : Updates an existing floodlight activity. This method supports patch semantics.
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/floodlightActivities
Parameters :
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
id
Type : string
Required : Yes
Location : query
Description : Required. EventTag ID.
Format : int64
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/floodlightActivities
▼ ▲ dfareporting.floodlightActivities.insert
Flat Path : userprofiles/{userprofilesId}/floodlightActivities
Parameter Order : profileId
Path : userprofiles/{+profileId}/floodlightActivities
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : POST
Description : Inserts a new floodlight activity.
▼ ▲ dfareporting.floodlightActivities.update
Flat Path : userprofiles/{userprofilesId}/floodlightActivities
Parameter Order : profileId
Path : userprofiles/{+profileId}/floodlightActivities
Parameters :
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : PUT
Description : Updates an existing floodlight activity.
▼ ▲ dfareporting.floodlightActivities.generatetag
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/floodlightActivities/generatetag
Path : userprofiles/{+profileId}/floodlightActivities/generatetag
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
floodlightActivityId
Type : string
Format : int64
Description : Floodlight activity ID for which we want to generate a tag.
Location : query
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Generates a tag for a floodlight activity.
HTTP Method : POST
▼ ▲ dfareporting.floodlightActivities.list
Path : userprofiles/{+profileId}/floodlightActivities
Parameters :
floodlightActivityGroupType
Location : query
Enum Descriptions :
Description : Select only floodlight activities with the specified floodlight activity group type.
Type : string
Enum :
floodlightActivityGroupName
Location : query
Description : Select only floodlight activities with the specified floodlight activity group name.
Type : string
ids
Repeated : Yes
Type : string
Description : Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
Format : int64
Location : query
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
sortField
Location : query
Enum Descriptions :
Description : Field by which to sort the list.
Default : ID
Type : string
Enum :
floodlightConfigurationId
Type : string
Format : int64
Description : Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
Location : query
advertiserId
Location : query
Description : Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
Type : string
Format : int64
maxResults
Description : Maximum number of results to return.
Format : int32
Location : query
Type : integer
Default : 1000
searchString
Location : query
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity".
Type : string
sortOrder
Enum :
Type : string
Default : ASCENDING
Description : Order of sorted results.
Enum Descriptions :
Location : query
floodlightActivityGroupIds
Format : int64
Description : Select only floodlight activities with the specified floodlight activity group IDs.
Location : query
Repeated : Yes
Type : string
floodlightActivityGroupTagString
Type : string
Description : Select only floodlight activities with the specified floodlight activity group tag string.
Location : query
tagString
Location : query
Type : string
Description : Select only floodlight activities with the specified tag string.
pageToken
Description : Value of the nextPageToken from the previous result page.
Type : string
Location : query
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/floodlightActivities
Description : Retrieves a list of floodlight activities, possibly filtered. This method supports paging.
HTTP Method : GET
▼ ▲ dfareporting.floodlightActivityGroups.get
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/floodlightActivityGroups/{floodlightActivityGroupsId}
Path : userprofiles/{+profileId}/floodlightActivityGroups/{+id}
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
id
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : Floodlight activity Group ID.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Gets one floodlight activity group by ID.
HTTP Method : GET
▼ ▲ dfareporting.floodlightActivityGroups.patch
Path : userprofiles/{+profileId}/floodlightActivityGroups
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
id
Type : string
Format : int64
Description : Required. EventTag ID.
Location : query
Required : Yes
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/floodlightActivityGroups
Description : Updates an existing floodlight activity group. This method supports patch semantics.
HTTP Method : PATCH
▼ ▲ dfareporting.floodlightActivityGroups.update
HTTP Method : PUT
Description : Updates an existing floodlight activity group.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/floodlightActivityGroups
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Flat Path : userprofiles/{userprofilesId}/floodlightActivityGroups
Parameter Order : profileId
▼ ▲ dfareporting.floodlightActivityGroups.insert
Description : Inserts a new floodlight activity group.
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/floodlightActivityGroups
Parameters :
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/floodlightActivityGroups
▼ ▲ dfareporting.floodlightActivityGroups.list
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.
HTTP Method : GET
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/floodlightActivityGroups
Path : userprofiles/{+profileId}/floodlightActivityGroups
Parameters :
pageToken
Description : Value of the nextPageToken from the previous result page.
Type : string
Location : query
floodlightConfigurationId
Type : string
Format : int64
Description : Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.
Location : query
type
Description : Select only floodlight activity groups with the specified floodlight activity group type.
Enum Descriptions :
Location : query
Enum :
Type : string
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
sortField
Default : ID
Type : string
Enum :
Location : query
Enum Descriptions :
Description : Field by which to sort the list.
sortOrder
Enum :
Type : string
Default : ASCENDING
Description : Order of sorted results.
Enum Descriptions :
Location : query
ids
Description : Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
Format : int64
Location : query
Repeated : Yes
Type : string
searchString
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup".
Type : string
Location : query
advertiserId
Location : query
Description : Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
Type : string
Format : int64
maxResults
Type : integer
Default : 1000
Description : Maximum number of results to return.
Format : int32
Location : query
▼ ▲ dfareporting.userRoles.list
Description : Retrieves a list of user roles, possibly filtered. This method supports paging.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/userRoles
Parameters :
maxResults
Location : query
Format : int32
Description : Maximum number of results to return.
Default : 1000
Type : integer
sortOrder
Default : ASCENDING
Type : string
Enum :
Location : query
Enum Descriptions :
Description : Order of sorted results.
ids
Repeated : Yes
Type : string
Format : int64
Description : Select only user roles with the specified IDs.
Location : query
searchString
Location : query
Type : string
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole".
sortField
Description : Field by which to sort the list.
Enum Descriptions :
Location : query
Enum :
Type : string
Default : ID
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
accountUserRoleOnly
Location : query
Description : Select only account level user roles not associated with any specific subaccount.
Type : boolean
pageToken
Location : query
Description : Value of the nextPageToken from the previous result page.
Type : string
subaccountId
Location : query
Type : string
Format : int64
Description : Select only user roles that belong to this subaccount.
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/userRoles
▼ ▲ dfareporting.userRoles.insert
Flat Path : userprofiles/{userprofilesId}/userRoles
Parameter Order : profileId
Path : userprofiles/{+profileId}/userRoles
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : POST
Description : Inserts a new user role.
▼ ▲ dfareporting.userRoles.update
Path : userprofiles/{+profileId}/userRoles
Parameters :
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
Flat Path : userprofiles/{userprofilesId}/userRoles
Parameter Order : profileId
HTTP Method : PUT
Description : Updates an existing user role.
▼ ▲ dfareporting.userRoles.patch
Path : userprofiles/{+profileId}/userRoles
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
id
Location : query
Required : Yes
Format : int64
Description : Required. UserRole ID.
Type : string
Flat Path : userprofiles/{userprofilesId}/userRoles
Parameter Order :
HTTP Method : PATCH
Description : Updates an existing user role. This method supports patch semantics.
▼ ▲ dfareporting.userRoles.get
Flat Path : userprofiles/{userprofilesId}/userRoles/{userRolesId}
Parameter Order :
Path : userprofiles/{+profileId}/userRoles/{+id}
Parameters :
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
id
Required : Yes
Location : path
Description : User role ID.
Format : int64
Pattern : ^[^/]+$
Type : string
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one user role by ID.
▼ ▲ dfareporting.userRoles.delete
Flat Path : userprofiles/{userprofilesId}/userRoles/{userRolesId}
Parameter Order :
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/userRoles/{+id}
HTTP Method : DELETE
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
id
Format : int64
Description : User role ID.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
Description : Deletes an existing user role.
▼ ▲ dfareporting.countries.list
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Retrieves a list of countries.
HTTP Method : GET
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/countries
Path : userprofiles/{+profileId}/countries
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
▼ ▲ dfareporting.countries.get
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/countries/{countriesId}
Path : userprofiles/{+profileId}/countries/{+dartId}
Parameters :
dartId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : Country DART ID.
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Gets one country by ID.
HTTP Method : GET
▼ ▲ dfareporting.languages.list
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Retrieves a list of languages.
HTTP Method : GET
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/languages
Path : userprofiles/{+profileId}/languages
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
▼ ▲ dfareporting.sizes.insert
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Inserts a new size.
HTTP Method : POST
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/sizes
Path : userprofiles/{+profileId}/sizes
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
▼ ▲ dfareporting.sizes.list
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : 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.
Flat Path : userprofiles/{userprofilesId}/sizes
Parameter Order : profileId
Path : userprofiles/{+profileId}/sizes
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
height
Type : integer
Format : int32
Description : Select only sizes with this height.
Location : query
width
Type : integer
Format : int32
Description : Select only sizes with this width.
Location : query
iabStandard
Location : query
Type : boolean
Description : Select only IAB standard sizes.
ids
Description : Select only sizes with these IDs.
Format : int64
Location : query
Repeated : Yes
Type : string
▼ ▲ dfareporting.sizes.get
HTTP Method : GET
Description : Gets one size by ID.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/sizes/{+id}
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
id
Required : Yes
Location : path
Description : Size ID.
Format : int64
Pattern : ^[^/]+$
Type : string
Flat Path : userprofiles/{userprofilesId}/sizes/{sizesId}
Parameter Order :
▼ ▲ dfareporting.sites.list
Flat Path : userprofiles/{userprofilesId}/sites
Parameter Order : profileId
Path : userprofiles/{+profileId}/sites
Parameters :
approved
Description : Select only approved sites.
Type : boolean
Location : query
subaccountId
Description : Select only sites with this subaccount ID.
Type : string
Format : int64
Location : query
sortField
Enum :
Type : string
Default : ID
Description : Field by which to sort the list.
Enum Descriptions :
Location : query
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
acceptsPublisherPaidPlacements
Location : query
Description : Select only sites that accept publisher paid placements.
Type : boolean
acceptsInterstitialPlacements
Type : boolean
Description : This search filter is no longer supported and will have no effect on the results returned.
Location : query
acceptsInStreamVideoPlacements
Location : query
Type : boolean
Description : This search filter is no longer supported and will have no effect on the results returned.
ids
Location : query
Format : int64
Description : Select only sites with these IDs.
Repeated : Yes
Type : string
adWordsSite
Type : boolean
Description : Select only AdWords sites.
Location : query
unmappedSite
Type : boolean
Description : Select only sites that have not been mapped to a directory site.
Location : query
pageToken
Type : string
Description : Value of the nextPageToken from the previous result page.
Location : query
sortOrder
Location : query
Enum Descriptions :
Description : Order of sorted results.
Default : ASCENDING
Type : string
Enum :
searchString
Location : query
Type : string
Description : Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site".
directorySiteIds
Description : Select only sites with these directory site IDs.
Format : int64
Location : query
Repeated : Yes
Type : string
campaignIds
Repeated : Yes
Type : string
Location : query
Description : Select only sites with these campaign IDs.
Format : int64
maxResults
Location : query
Format : int32
Description : Maximum number of results to return.
Default : 1000
Type : integer
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Retrieves a list of sites, possibly filtered. This method supports paging.
▼ ▲ dfareporting.sites.update
Path : userprofiles/{+profileId}/sites
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/sites
Description : Updates an existing site.
HTTP Method : PUT
▼ ▲ dfareporting.sites.insert
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Inserts a new site.
HTTP Method : POST
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/sites
Path : userprofiles/{+profileId}/sites
Parameters :
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
▼ ▲ dfareporting.sites.patch
Flat Path : userprofiles/{userprofilesId}/sites
Parameter Order :
Path : userprofiles/{+profileId}/sites
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
id
Type : string
Format : int64
Description : Required. Site ID.
Location : query
Required : Yes
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : PATCH
Description : Updates an existing site. This method supports patch semantics.
▼ ▲ dfareporting.sites.get
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one site by ID.
Flat Path : userprofiles/{userprofilesId}/sites/{sitesId}
Parameter Order :
Path : userprofiles/{+profileId}/sites/{+id}
Parameters :
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
id
Location : path
Required : Yes
Format : int64
Description : Site ID.
Type : string
Pattern : ^[^/]+$
▼ ▲ dfareporting.accountPermissions.list
Path : userprofiles/{+profileId}/accountPermissions
Parameters :
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/accountPermissions
Description : Retrieves the list of account permissions.
HTTP Method : GET
▼ ▲ dfareporting.accountPermissions.get
Path : userprofiles/{+profileId}/accountPermissions/{+id}
Parameters :
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
id
Required : Yes
Location : path
Description : Account permission ID.
Format : int64
Pattern : ^[^/]+$
Type : string
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/accountPermissions/{accountPermissionsId}
Description : Gets one account permission by ID.
HTTP Method : GET
▼ ▲ dfareporting.campaignCreativeAssociations.insert
Flat Path : userprofiles/{userprofilesId}/campaigns/{campaignsId}/campaignCreativeAssociations
Parameter Order :
Path : userprofiles/{+profileId}/campaigns/{+campaignId}/campaignCreativeAssociations
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
campaignId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Campaign ID in this association.
Format : int64
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : POST
Description : 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.
▼ ▲ dfareporting.campaignCreativeAssociations.list
Path : userprofiles/{+profileId}/campaigns/{+campaignId}/campaignCreativeAssociations
Parameters :
pageToken
Location : query
Type : string
Description : Value of the nextPageToken from the previous result page.
sortOrder
Location : query
Enum Descriptions :
Description : Order of sorted results.
Default : ASCENDING
Type : string
Enum :
campaignId
Format : int64
Description : Campaign ID in this association.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
maxResults
Description : Maximum number of results to return.
Format : int32
Location : query
Type : integer
Default : 1000
Flat Path : userprofiles/{userprofilesId}/campaigns/{campaignsId}/campaignCreativeAssociations
Parameter Order :
HTTP Method : GET
Description : Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.
▼ ▲ dfareporting.cities.list
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/cities
Path : userprofiles/{+profileId}/cities
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
namePrefix
Location : query
Type : string
Description : Select only cities with names starting with this prefix.
countryDartIds
Repeated : Yes
Type : string
Location : query
Description : Select only cities from these countries.
Format : int64
dartIds
Description : Select only cities with these DART IDs.
Format : int64
Location : query
Repeated : Yes
Type : string
regionDartIds
Repeated : Yes
Type : string
Format : int64
Description : Select only cities from these regions.
Location : query
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Retrieves a list of cities, possibly filtered.
HTTP Method : GET
▼ ▲ dfareporting.dimensionValues.query
Path : userprofiles/{profileId}/dimensionvalues/query
Parameters :
profileId
Required : Yes
Location : path
Description : The Campaign Manager 360 user profile ID.
Format : int64
Type : string
maxResults
Format : int32
Description : Maximum number of results to return.
Location : query
Type : integer
Default : 100
pageToken
Location : query
Type : string
Description : The value of the nextToken from the previous result page.
Parameter Order : profileId
Flat Path : userprofiles/{profileId}/dimensionvalues/query
Description : Retrieves list of report dimension values for a list of filters.
HTTP Method : POST
▼ ▲ dfareporting.metros.list
Description : Retrieves a list of metros.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/metros
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/metros
▼ ▲ dfareporting.subaccounts.update
Path : userprofiles/{+profileId}/subaccounts
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/subaccounts
Description : Updates an existing subaccount.
HTTP Method : PUT
▼ ▲ dfareporting.subaccounts.insert
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Inserts a new subaccount.
HTTP Method : POST
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/subaccounts
Path : userprofiles/{+profileId}/subaccounts
Parameters :
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
▼ ▲ dfareporting.subaccounts.list
Description : Gets a list of subaccounts, possibly filtered. This method supports paging.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/subaccounts
Parameters :
pageToken
Location : query
Type : string
Description : Value of the nextPageToken from the previous result page.
sortOrder
Enum :
Type : string
Default : ASCENDING
Description : Order of sorted results.
Enum Descriptions :
Location : query
ids
Repeated : Yes
Type : string
Format : int64
Description : Select only subaccounts with these IDs.
Location : query
searchString
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount" .
Type : string
Location : query
sortField
Type : string
Enum :
Default : ID
Enum Descriptions :
Description : Field by which to sort the list.
Location : query
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
maxResults
Default : 1000
Type : integer
Location : query
Description : Maximum number of results to return.
Format : int32
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/subaccounts
▼ ▲ dfareporting.subaccounts.patch
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : PATCH
Description : Updates an existing subaccount. This method supports patch semantics.
Flat Path : userprofiles/{userprofilesId}/subaccounts
Parameter Order :
Path : userprofiles/{+profileId}/subaccounts
Parameters :
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
id
Location : query
Required : Yes
Format : int64
Description : Required. Subaccount ID.
Type : string
▼ ▲ dfareporting.subaccounts.get
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one subaccount by ID.
Flat Path : userprofiles/{userprofilesId}/subaccounts/{subaccountsId}
Parameter Order :
Path : userprofiles/{+profileId}/subaccounts/{+id}
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
id
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Subaccount ID.
Format : int64
▼ ▲ dfareporting.creativeGroups.update
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : PUT
Description : Updates an existing creative group.
Flat Path : userprofiles/{userprofilesId}/creativeGroups
Parameter Order : profileId
Path : userprofiles/{+profileId}/creativeGroups
Parameters :
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
▼ ▲ dfareporting.creativeGroups.insert
Flat Path : userprofiles/{userprofilesId}/creativeGroups
Parameter Order : profileId
Path : userprofiles/{+profileId}/creativeGroups
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : POST
Description : Inserts a new creative group.
▼ ▲ dfareporting.creativeGroups.list
Description : Retrieves a list of creative groups, possibly filtered. This method supports paging.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/creativeGroups
Parameters :
maxResults
Type : integer
Default : 1000
Format : int32
Description : Maximum number of results to return.
Location : query
groupNumber
Location : query
Description : Select only creative groups that belong to this subgroup.
Type : integer
Format : int32
ids
Location : query
Format : int64
Description : Select only creative groups with these IDs.
Repeated : Yes
Type : string
searchString
Description : Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup".
Type : string
Location : query
sortOrder
Type : string
Enum :
Default : ASCENDING
Enum Descriptions :
Description : Order of sorted results.
Location : query
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
sortField
Type : string
Enum :
Default : ID
Enum Descriptions :
Description : Field by which to sort the list.
Location : query
pageToken
Location : query
Description : Value of the nextPageToken from the previous result page.
Type : string
advertiserIds
Location : query
Description : Select only creative groups that belong to these advertisers.
Format : int64
Repeated : Yes
Type : string
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/creativeGroups
▼ ▲ dfareporting.creativeGroups.get
Path : userprofiles/{+profileId}/creativeGroups/{+id}
Parameters :
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
id
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : Creative group ID.
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/creativeGroups/{creativeGroupsId}
Description : Gets one creative group by ID.
HTTP Method : GET
▼ ▲ dfareporting.creativeGroups.patch
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/creativeGroups
Path : userprofiles/{+profileId}/creativeGroups
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
id
Type : string
Location : query
Required : Yes
Format : int64
Description : Required. Creative Group ID.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Updates an existing creative group. This method supports patch semantics.
HTTP Method : PATCH
▼ ▲ dfareporting.postalCodes.get
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Gets one postal code by ID.
HTTP Method : GET
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/postalCodes/{postalCodesId}
Path : userprofiles/{+profileId}/postalCodes/{+code}
Parameters :
code
Pattern : ^[^/]+$
Type : string
Description : Postal code ID.
Required : Yes
Location : path
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
▼ ▲ dfareporting.postalCodes.list
Path : userprofiles/{+profileId}/postalCodes
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/postalCodes
Description : Retrieves a list of postal codes.
HTTP Method : GET
▼ ▲ dfareporting.billingAssignments.insert
Path : userprofiles/{+profileId}/billingProfiles/{+billingProfileId}/billingAssignments
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
billingProfileId
Pattern : ^[^/]+$
Type : string
Description : Billing profile ID of this billing assignment.
Format : int64
Required : Yes
Location : path
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/billingProfiles/{billingProfilesId}/billingAssignments
Description : Inserts a new billing assignment and returns the new assignment. Only one of advertiser_id or campaign_id is support per request. If the new assignment has no effect (assigning a campaign to the parent advertiser billing profile or assigning an advertiser to the account billing profile), no assignment will be returned.
HTTP Method : POST
▼ ▲ dfareporting.billingAssignments.list
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/billingProfiles/{billingProfilesId}/billingAssignments
Path : userprofiles/{+profileId}/billingProfiles/{+billingProfileId}/billingAssignments
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
billingProfileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Billing profile ID of this billing assignment.
Format : int64
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Retrieves a list of billing assignments.
HTTP Method : GET
▼ ▲ dfareporting.reports.update
Flat Path : userprofiles/{profileId}/reports/{reportId}
Parameter Order :
Path : userprofiles/{profileId}/reports/{reportId}
Parameters :
profileId
Required : Yes
Location : path
Description : The Campaign Manager 360 user profile ID.
Format : int64
Type : string
reportId
Required : Yes
Location : path
Description : The ID of the report.
Format : int64
Type : string
Scopes : https://www.googleapis.com/auth/dfareporting
HTTP Method : PUT
Description : Updates a report.
▼ ▲ dfareporting.reports.insert
HTTP Method : POST
Description : Creates a report.
Scopes : https://www.googleapis.com/auth/dfareporting
Path : userprofiles/{profileId}/reports
Parameters :
profileId
Type : string
Description : The Campaign Manager 360 user profile ID.
Format : int64
Required : Yes
Location : path
Flat Path : userprofiles/{profileId}/reports
Parameter Order : profileId
▼ ▲ dfareporting.reports.run
Flat Path : userprofiles/{profileId}/reports/{reportId}/run
Parameter Order :
Path : userprofiles/{profileId}/reports/{reportId}/run
Parameters :
profileId
Format : int64
Description : The Campaign Manager 360 user profile ID.
Location : path
Required : Yes
Type : string
reportId
Type : string
Description : The ID of the report.
Format : int64
Required : Yes
Location : path
synchronous
Default : false
Location : query
Type : boolean
Description : If set and true, tries to run the report synchronously.
Scopes : https://www.googleapis.com/auth/dfareporting
HTTP Method : POST
Description : Runs a report.
▼ ▲ dfareporting.reports.list
Path : userprofiles/{profileId}/reports
Parameters :
sortField
Type : string
Enum :
Default : LAST_MODIFIED_TIME
Enum Descriptions :
Description : The field by which to sort the list.
Location : query
profileId
Format : int64
Description : The Campaign Manager 360 user profile ID.
Location : path
Required : Yes
Type : string
maxResults
Default : 10
Type : integer
Location : query
Description : Maximum number of results to return.
Format : int32
pageToken
Location : query
Type : string
Description : The value of the nextToken from the previous result page.
scope
Type : string
Enum :
Default : MINE
Enum Descriptions :
Description : The scope that defines which results are returned.
Location : query
sortOrder
Default : DESCENDING
Type : string
Enum :
Location : query
Enum Descriptions :
Description : Order of sorted results.
Parameter Order : profileId
Flat Path : userprofiles/{profileId}/reports
Description : Retrieves list of reports.
HTTP Method : GET
▼ ▲ dfareporting.reports.delete
Path : userprofiles/{profileId}/reports/{reportId}
HTTP Method : DELETE
Parameters :
profileId
Type : string
Location : path
Required : Yes
Format : int64
Description : The Campaign Manager 360 user profile ID.
reportId
Type : string
Required : Yes
Location : path
Description : The ID of the report.
Format : int64
Description : Deletes a report by its ID.
Flat Path : userprofiles/{profileId}/reports/{reportId}
Parameter Order :
▼ ▲ dfareporting.reports.get
Description : Retrieves a report by its ID.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/dfareporting
Path : userprofiles/{profileId}/reports/{reportId}
Parameters :
reportId
Format : int64
Description : The ID of the report.
Location : path
Required : Yes
Type : string
profileId
Description : The Campaign Manager 360 user profile ID.
Format : int64
Required : Yes
Location : path
Type : string
Parameter Order :
Flat Path : userprofiles/{profileId}/reports/{reportId}
▼ ▲ dfareporting.reports.patch
Scopes : https://www.googleapis.com/auth/dfareporting
Description : Updates an existing report. This method supports patch semantics.
HTTP Method : PATCH
Parameter Order :
Flat Path : userprofiles/{profileId}/reports/{reportId}
Path : userprofiles/{profileId}/reports/{reportId}
Parameters :
reportId
Format : int64
Description : The ID of the report.
Location : path
Required : Yes
Type : string
profileId
Description : The Campaign Manager 360 user profile ID.
Format : int64
Required : Yes
Location : path
Type : string
▼ ▲ dfareporting.reports.files.get
Path : userprofiles/{profileId}/reports/{reportId}/files/{fileId}
Parameters :
reportId
Format : int64
Description : The ID of the report.
Location : path
Required : Yes
Type : string
fileId
Required : Yes
Location : path
Description : The ID of the report file.
Format : int64
Type : string
profileId
Type : string
Required : Yes
Location : path
Description : The Campaign Manager 360 user profile ID.
Format : int64
Flat Path : userprofiles/{profileId}/reports/{reportId}/files/{fileId}
Parameter Order :
HTTP Method : GET
Supportsmediadownload : Yes
Description : Retrieves a report file by its report ID and file ID. This method supports media download.
▼ ▲ dfareporting.reports.files.list
Scopes : https://www.googleapis.com/auth/dfareporting
Description : Lists files for a report.
HTTP Method : GET
Parameter Order :
Flat Path : userprofiles/{profileId}/reports/{reportId}/files
Path : userprofiles/{profileId}/reports/{reportId}/files
Parameters :
profileId
Description : The Campaign Manager 360 user profile ID.
Format : int64
Required : Yes
Location : path
Type : string
maxResults
Type : integer
Default : 10
Description : Maximum number of results to return.
Format : int32
Location : query
sortField
Enum Descriptions :
Description : The field by which to sort the list.
Location : query
Type : string
Enum :
Default : LAST_MODIFIED_TIME
sortOrder
Enum :
Type : string
Default : DESCENDING
Description : Order of sorted results.
Enum Descriptions :
Location : query
pageToken
Type : string
Description : The value of the nextToken from the previous result page.
Location : query
reportId
Format : int64
Description : The ID of the parent report.
Location : path
Required : Yes
Type : string
▼ ▲ dfareporting.reports.compatibleFields.query
Scopes : https://www.googleapis.com/auth/dfareporting
Description : 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.
HTTP Method : POST
Parameter Order : profileId
Flat Path : userprofiles/{profileId}/reports/compatiblefields/query
Path : userprofiles/{profileId}/reports/compatiblefields/query
Parameters :
profileId
Description : The Campaign Manager 360 user profile ID.
Format : int64
Required : Yes
Location : path
Type : string
▼ ▲ dfareporting.connectionTypes.list
Flat Path : userprofiles/{userprofilesId}/connectionTypes
Parameter Order : profileId
Path : userprofiles/{+profileId}/connectionTypes
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Retrieves a list of connection types.
▼ ▲ dfareporting.connectionTypes.get
Path : userprofiles/{+profileId}/connectionTypes/{+id}
Parameters :
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
id
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : Connection type ID.
Format : int64
Flat Path : userprofiles/{userprofilesId}/connectionTypes/{connectionTypesId}
Parameter Order :
HTTP Method : GET
Description : Gets one connection type by ID.
▼ ▲ dfareporting.projects.list
Description : Retrieves a list of projects, possibly filtered. This method supports paging .
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/projects
Parameters :
ids
Location : query
Format : int64
Description : Select only projects with these IDs.
Repeated : Yes
Type : string
searchString
Location : query
Type : string
Description : Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project".
pageToken
Location : query
Description : Value of the nextPageToken from the previous result page.
Type : string
sortOrder
Type : string
Enum :
Default : ASCENDING
Enum Descriptions :
Description : Order of sorted results.
Location : query
advertiserIds
Location : query
Description : Select only projects with these advertiser IDs.
Format : int64
Repeated : Yes
Type : string
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
maxResults
Location : query
Format : int32
Description : Maximum number of results to return.
Default : 1000
Type : integer
sortField
Default : ID
Type : string
Enum :
Location : query
Enum Descriptions :
Description : Field by which to sort the list.
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/projects
▼ ▲ dfareporting.projects.get
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one project by ID.
Flat Path : userprofiles/{userprofilesId}/projects/{projectsId}
Parameter Order :
Path : userprofiles/{+profileId}/projects/{+id}
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
id
Type : string
Pattern : ^[^/]+$
Format : int64
Description : Project ID.
Location : path
Required : Yes
▼ ▲ dfareporting.videoFormats.get
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Gets one video format by ID.
HTTP Method : GET
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/videoFormats/{videoFormatsId}
Path : userprofiles/{+profileId}/videoFormats/{+id}
Parameters :
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
id
Required : Yes
Location : path
Description : Video format ID.
Format : int32
Pattern : ^[^/]+$
Type : integer
▼ ▲ dfareporting.videoFormats.list
Flat Path : userprofiles/{userprofilesId}/videoFormats
Parameter Order : profileId
Path : userprofiles/{+profileId}/videoFormats
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Lists available video formats.
▼ ▲ dfareporting.browsers.list
Path : userprofiles/{+profileId}/browsers
Parameters :
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/browsers
Description : Retrieves a list of browsers.
HTTP Method : GET
▼ ▲ dfareporting.dynamicTargetingKeys.list
Path : userprofiles/{+profileId}/dynamicTargetingKeys
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
objectId
Description : Select only dynamic targeting keys with this object ID.
Type : string
Format : int64
Location : query
advertiserId
Location : query
Type : string
Format : int64
Description : Select only dynamic targeting keys whose object has this advertiser ID.
objectType
Location : query
Description : Select only dynamic targeting keys with this object type.
Enum Descriptions :
Enum :
Type : string
names
Description : Select only dynamic targeting keys exactly matching these names.
Repeated : Yes
Type : string
Location : query
Flat Path : userprofiles/{userprofilesId}/dynamicTargetingKeys
Parameter Order : profileId
HTTP Method : GET
Description : Retrieves a list of dynamic targeting keys.
▼ ▲ dfareporting.dynamicTargetingKeys.delete
Path : userprofiles/{+profileId}/dynamicTargetingKeys/{+objectId}
HTTP Method : DELETE
Parameters :
objectType
Location : query
Required : Yes
Enum Descriptions :
Description : Required. Type of the object of this dynamic targeting key. This is a required field.
Type : string
Enum :
name
Type : string
Description : Required. Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase.
Location : query
Required : Yes
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
objectId
Location : path
Required : Yes
Format : int64
Description : ID of the object of this dynamic targeting key. This is a required field.
Type : string
Pattern : ^[^/]+$
Description : Deletes an existing dynamic targeting key.
Flat Path : userprofiles/{userprofilesId}/dynamicTargetingKeys/{dynamicTargetingKeysId}
Parameter Order :
▼ ▲ dfareporting.dynamicTargetingKeys.insert
HTTP Method : POST
Description : 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.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/dynamicTargetingKeys
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Flat Path : userprofiles/{userprofilesId}/dynamicTargetingKeys
Parameter Order : profileId
▼ ▲ dfareporting.userProfiles.list
Flat Path : userprofiles
Path : userprofiles
Scopes :
Description : Retrieves list of user profiles for a user.
HTTP Method : GET
▼ ▲ dfareporting.userProfiles.get
Description : Gets one user profile by ID.
HTTP Method : GET
Scopes :
Path : userprofiles/{profileId}
Parameters :
profileId
Type : string
Description : The user profile ID.
Format : int64
Required : Yes
Location : path
Parameter Order : profileId
Flat Path : userprofiles/{profileId}
▼ ▲ dfareporting.advertiserInvoices.list
Flat Path : userprofiles/{userprofilesId}/advertisers/{advertisersId}/invoices
Parameter Order :
Path : userprofiles/{+profileId}/advertisers/{+advertiserId}/invoices
Parameters :
issueMonth
Description : Month for which invoices are needed in the format YYYYMM. Required field
Type : string
Location : query
pageToken
Description : Value of the nextPageToken from the previous result page.
Type : string
Location : query
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
advertiserId
Description : Advertiser ID of this invoice.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
maxResults
Location : query
Format : int32
Description : Maximum number of results to return.
Default : 1000
Type : integer
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Retrieves a list of invoices for a particular issue month. The api only works if the billing profile invoice level is set to either advertiser or campaign non-consolidated invoice level.
▼ ▲ dfareporting.studioCreativeAssets.insert
Path : studio/creativeAssets
Flat Path : studio/creativeAssets
Supportsmediaupload : Yes
Mediaupload :
Accept : */*
Protocols :
Simple :
Path : /upload/dfareporting/v4/studio/creativeAssets
Multipart : Yes
Maxsize : 1073741824
Description : Inserts a new studio creative asset.
HTTP Method : POST
▼ ▲ dfareporting.operatingSystemVersions.get
Flat Path : userprofiles/{userprofilesId}/operatingSystemVersions/{operatingSystemVersionsId}
Parameter Order :
Path : userprofiles/{+profileId}/operatingSystemVersions/{+id}
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
id
Required : Yes
Location : path
Description : Operating system version ID.
Format : int64
Pattern : ^[^/]+$
Type : string
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one operating system version by ID.
▼ ▲ dfareporting.operatingSystemVersions.list
Path : userprofiles/{+profileId}/operatingSystemVersions
Parameters :
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/operatingSystemVersions
Description : Retrieves a list of operating system versions.
HTTP Method : GET
▼ ▲ dfareporting.creatives.get
Path : userprofiles/{+profileId}/creatives/{+id}
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
id
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : Creative ID.
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/creatives/{creativesId}
Description : Gets one creative by ID.
HTTP Method : GET
▼ ▲ dfareporting.creatives.patch
Path : userprofiles/{+profileId}/creatives
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
id
Description : Required. Creative ID.
Format : int64
Required : Yes
Location : query
Type : string
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/creatives
Description : Updates an existing creative. This method supports patch semantics.
HTTP Method : PATCH
▼ ▲ dfareporting.creatives.update
Path : userprofiles/{+profileId}/creatives
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/creatives
Description : Updates an existing creative.
HTTP Method : PUT
▼ ▲ dfareporting.creatives.insert
HTTP Method : POST
Description : Inserts a new creative.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/creatives
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Flat Path : userprofiles/{userprofilesId}/creatives
Parameter Order : profileId
▼ ▲ dfareporting.creatives.list
Flat Path : userprofiles/{userprofilesId}/creatives
Parameter Order : profileId
Path : userprofiles/{+profileId}/creatives
Parameters :
companionCreativeIds
Description : Select only in-stream video creatives with these companion IDs.
Format : int64
Location : query
Repeated : Yes
Type : string
creativeFieldIds
Repeated : Yes
Type : string
Description : Select only creatives with these creative field IDs.
Format : int64
Location : query
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
studioCreativeId
Location : query
Description : Select only creatives corresponding to this Studio creative ID.
Type : string
Format : int64
active
Type : boolean
Description : Select only active creatives. Leave blank to select active and inactive creatives.
Location : query
sortField
Enum :
Type : string
Default : ID
Description : Field by which to sort the list.
Enum Descriptions :
Location : query
archived
Description : Select only archived creatives. Leave blank to select archived and unarchived creatives.
Type : boolean
Location : query
ids
Repeated : Yes
Type : string
Description : Select only creatives with these IDs.
Format : int64
Location : query
pageToken
Location : query
Description : Value of the nextPageToken from the previous result page.
Type : string
sizeIds
Repeated : Yes
Type : string
Location : query
Description : Select only creatives with these size IDs.
Format : int64
campaignId
Location : query
Type : string
Format : int64
Description : Select only creatives with this campaign ID.
types
Location : query
Description : Select only creatives with these creative types.
Enum Descriptions :
Enum :
Repeated : Yes
Type : string
sortOrder
Location : query
Description : Order of sorted results.
Enum Descriptions :
Default : ASCENDING
Enum :
Type : string
searchString
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative".
Type : string
Location : query
advertiserId
Type : string
Format : int64
Description : Select only creatives with this advertiser ID.
Location : query
maxResults
Location : query
Format : int32
Description : Maximum number of results to return.
Default : 1000
Type : integer
renderingIds
Format : int64
Description : Select only creatives with these rendering IDs.
Location : query
Repeated : Yes
Type : string
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Retrieves a list of creatives, possibly filtered. This method supports paging.
▼ ▲ dfareporting.advertiserGroups.list
Path : userprofiles/{+profileId}/advertiserGroups
Parameters :
ids
Location : query
Description : Select only advertiser groups with these IDs.
Format : int64
Repeated : Yes
Type : string
searchString
Type : string
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".
Location : query
pageToken
Description : Value of the nextPageToken from the previous result page.
Type : string
Location : query
sortOrder
Default : ASCENDING
Type : string
Enum :
Location : query
Enum Descriptions :
Description : Order of sorted results.
sortField
Default : ID
Type : string
Enum :
Location : query
Enum Descriptions :
Description : Field by which to sort the list.
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
maxResults
Location : query
Format : int32
Description : Maximum number of results to return.
Default : 1000
Type : integer
Flat Path : userprofiles/{userprofilesId}/advertiserGroups
Parameter Order : profileId
HTTP Method : GET
Description : Retrieves a list of advertiser groups, possibly filtered. This method supports paging.
▼ ▲ dfareporting.advertiserGroups.update
Path : userprofiles/{+profileId}/advertiserGroups
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/advertiserGroups
Description : Updates an existing advertiser group.
HTTP Method : PUT
▼ ▲ dfareporting.advertiserGroups.insert
Path : userprofiles/{+profileId}/advertiserGroups
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Flat Path : userprofiles/{userprofilesId}/advertiserGroups
Parameter Order : profileId
HTTP Method : POST
Description : Inserts a new advertiser group.
▼ ▲ dfareporting.advertiserGroups.get
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/advertiserGroups/{advertiserGroupsId}
Path : userprofiles/{+profileId}/advertiserGroups/{+id}
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
id
Format : int64
Description : Advertiser group ID.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Gets one advertiser group by ID.
HTTP Method : GET
▼ ▲ dfareporting.advertiserGroups.patch
Path : userprofiles/{+profileId}/advertiserGroups
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
id
Description : Required. Advertiser Group ID.
Format : int64
Required : Yes
Location : query
Type : string
Flat Path : userprofiles/{userprofilesId}/advertiserGroups
Parameter Order :
HTTP Method : PATCH
Description : Updates an existing advertiser group. This method supports patch semantics.
▼ ▲ dfareporting.advertiserGroups.delete
Description : Deletes an existing advertiser group.
Path : userprofiles/{+profileId}/advertiserGroups/{+id}
HTTP Method : DELETE
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
id
Pattern : ^[^/]+$
Type : string
Description : Advertiser group ID.
Format : int64
Required : Yes
Location : path
Parameter Order :
Scopes : https://www.googleapis.com/auth/dfatrafficking
Flat Path : userprofiles/{userprofilesId}/advertiserGroups/{advertiserGroupsId}
▼ ▲ dfareporting.operatingSystems.get
Path : userprofiles/{+profileId}/operatingSystems/{+dartId}
Parameters :
dartId
Pattern : ^[^/]+$
Type : string
Description : Operating system DART ID.
Format : int64
Required : Yes
Location : path
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Flat Path : userprofiles/{userprofilesId}/operatingSystems/{operatingSystemsId}
Parameter Order :
HTTP Method : GET
Description : Gets one operating system by DART ID.
▼ ▲ dfareporting.operatingSystems.list
HTTP Method : GET
Description : Retrieves a list of operating systems.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/operatingSystems
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Flat Path : userprofiles/{userprofilesId}/operatingSystems
Parameter Order : profileId
▼ ▲ dfareporting.tvCampaignDetails.get
Description : Gets one TvCampaignDetail by ID.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/tvCampaignDetails/{+id}
Parameters :
accountId
Location : query
Type : string
Format : int64
Description : Required. Account ID associated with this request.
profileId
Required : Yes
Location : path
Description : Required. User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
id
Location : path
Required : Yes
Description : Required. TV Campaign ID.
Type : string
Pattern : ^[^/]+$
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/tvCampaignDetails/{tvCampaignDetailsId}
▼ ▲ dfareporting.accountUserProfiles.insert
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Inserts a new account user profile.
HTTP Method : POST
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/accountUserProfiles
Path : userprofiles/{+profileId}/accountUserProfiles
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
▼ ▲ dfareporting.accountUserProfiles.update
Flat Path : userprofiles/{userprofilesId}/accountUserProfiles
Parameter Order : profileId
Path : userprofiles/{+profileId}/accountUserProfiles
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : PUT
Description : Updates an existing account user profile.
▼ ▲ dfareporting.accountUserProfiles.list
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/accountUserProfiles
Path : userprofiles/{+profileId}/accountUserProfiles
Parameters :
active
Location : query
Description : Select only active user profiles.
Type : boolean
sortField
Type : string
Enum :
Default : ID
Enum Descriptions :
Description : Field by which to sort the list.
Location : query
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
userRoleId
Description : Select only user profiles with the specified user role ID.
Type : string
Format : int64
Location : query
subaccountId
Location : query
Description : Select only user profiles with the specified subaccount ID.
Type : string
Format : int64
pageToken
Location : query
Description : Value of the nextPageToken from the previous result page.
Type : string
maxResults
Default : 1000
Type : integer
Location : query
Format : int32
Description : Maximum number of results to return.
ids
Repeated : Yes
Type : string
Format : int64
Description : Select only user profiles with these IDs.
Location : query
searchString
Type : string
Description : Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile".
Location : query
sortOrder
Description : Order of sorted results.
Enum Descriptions :
Location : query
Enum :
Type : string
Default : ASCENDING
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Retrieves a list of account user profiles, possibly filtered. This method supports paging.
HTTP Method : GET
▼ ▲ dfareporting.accountUserProfiles.get
Path : userprofiles/{profileId}/accountUserProfiles/{+id}
Parameters :
profileId
Type : string
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
id
Description : User profile ID.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
Flat Path : userprofiles/{profileId}/accountUserProfiles/{accountUserProfilesId}
Parameter Order :
HTTP Method : GET
Description : Gets one account user profile by ID.
▼ ▲ dfareporting.accountUserProfiles.patch
Flat Path : userprofiles/{userprofilesId}/accountUserProfiles
Parameter Order :
Path : userprofiles/{+profileId}/accountUserProfiles
Parameters :
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
id
Type : string
Required : Yes
Location : query
Description : Required. AccountUserProfile ID.
Format : int64
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : PATCH
Description : Updates an existing account user profile. This method supports patch semantics.
▼ ▲ dfareporting.files.list
Parameter Order : profileId
Flat Path : userprofiles/{profileId}/files
Path : userprofiles/{profileId}/files
Parameters :
sortField
Location : query
Description : The field by which to sort the list.
Enum Descriptions :
Default : LAST_MODIFIED_TIME
Enum :
Type : string
profileId
Required : Yes
Location : path
Description : The Campaign Manager 360 user profile ID.
Format : int64
Type : string
maxResults
Location : query
Format : int32
Description : Maximum number of results to return.
Default : 10
Type : integer
pageToken
Location : query
Type : string
Description : The value of the nextToken from the previous result page.
scope
Location : query
Enum Descriptions :
Description : The scope that defines which results are returned.
Default : MINE
Type : string
Enum :
sortOrder
Location : query
Enum Descriptions :
Description : Order of sorted results.
Default : DESCENDING
Type : string
Enum :
Scopes : https://www.googleapis.com/auth/dfareporting
Description : Lists files for a user profile.
HTTP Method : GET
▼ ▲ dfareporting.files.get
Parameter Order :
Flat Path : reports/{reportId}/files/{fileId}
Path : reports/{reportId}/files/{fileId}
Parameters :
reportId
Location : path
Required : Yes
Format : int64
Description : The ID of the report.
Type : string
fileId
Required : Yes
Location : path
Description : The ID of the report file.
Format : int64
Type : string
Scopes : https://www.googleapis.com/auth/dfareporting
Supportsmediadownload : Yes
Description : Retrieves a report file by its report ID and file ID. This method supports media download.
HTTP Method : GET
▼ ▲ dfareporting.accountPermissionGroups.get
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one account permission group by ID.
Flat Path : userprofiles/{userprofilesId}/accountPermissionGroups/{accountPermissionGroupsId}
Parameter Order :
Path : userprofiles/{+profileId}/accountPermissionGroups/{+id}
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
id
Pattern : ^[^/]+$
Type : string
Description : Account permission group ID.
Format : int64
Required : Yes
Location : path
▼ ▲ dfareporting.accountPermissionGroups.list
Flat Path : userprofiles/{userprofilesId}/accountPermissionGroups
Parameter Order : profileId
Path : userprofiles/{+profileId}/accountPermissionGroups
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Retrieves the list of account permission groups.
▼ ▲ dfareporting.platformTypes.list
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Retrieves a list of platform types.
Flat Path : userprofiles/{userprofilesId}/platformTypes
Parameter Order : profileId
Path : userprofiles/{+profileId}/platformTypes
Parameters :
profileId
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Type : string
Pattern : ^[^/]+$
▼ ▲ dfareporting.platformTypes.get
Path : userprofiles/{+profileId}/platformTypes/{+id}
Parameters :
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
id
Type : string
Pattern : ^[^/]+$
Format : int64
Description : Platform type ID.
Location : path
Required : Yes
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/platformTypes/{platformTypesId}
Description : Gets one platform type by ID.
HTTP Method : GET
▼ ▲ dfareporting.campaigns.update
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : PUT
Description : Updates an existing campaign.
Flat Path : userprofiles/{userprofilesId}/campaigns
Parameter Order : profileId
Path : userprofiles/{+profileId}/campaigns
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
▼ ▲ dfareporting.campaigns.insert
Path : userprofiles/{+profileId}/campaigns
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/campaigns
Description : Inserts a new campaign.
HTTP Method : POST
▼ ▲ dfareporting.campaigns.list
Flat Path : userprofiles/{userprofilesId}/campaigns
Parameter Order : profileId
Path : userprofiles/{+profileId}/campaigns
Parameters :
excludedIds
Repeated : Yes
Type : string
Location : query
Description : Exclude campaigns with these IDs.
Format : int64
maxResults
Format : int32
Description : Maximum number of results to return.
Location : query
Type : integer
Default : 1000
sortOrder
Description : Order of sorted results.
Enum Descriptions :
Location : query
Enum :
Type : string
Default : ASCENDING
searchString
Description : Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign".
Type : string
Location : query
overriddenEventTagId
Type : string
Format : int64
Description : Select only campaigns that have overridden this event tag ID.
Location : query
atLeastOneOptimizationActivity
Description : Select only campaigns that have at least one optimization activity.
Type : boolean
Location : query
pageToken
Location : query
Description : Value of the nextPageToken from the previous result page.
Type : string
archived
Type : boolean
Description : Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
Location : query
ids
Location : query
Format : int64
Description : Select only campaigns with these IDs.
Repeated : Yes
Type : string
sortField
Location : query
Description : Field by which to sort the list.
Enum Descriptions :
Default : ID
Enum :
Type : string
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
advertiserGroupIds
Format : int64
Description : Select only campaigns whose advertisers belong to these advertiser groups.
Location : query
Repeated : Yes
Type : string
advertiserIds
Location : query
Description : Select only campaigns that belong to these advertisers.
Format : int64
Repeated : Yes
Type : string
subaccountId
Location : query
Description : Select only campaigns that belong to this subaccount.
Type : string
Format : int64
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Retrieves a list of campaigns, possibly filtered. This method supports paging.
▼ ▲ dfareporting.campaigns.get
HTTP Method : GET
Description : Gets one campaign by ID.
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/campaigns/{+id}
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
id
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : Campaign ID.
Flat Path : userprofiles/{userprofilesId}/campaigns/{campaignsId}
Parameter Order :
▼ ▲ dfareporting.campaigns.patch
Description : Updates an existing campaign. This method supports patch semantics.
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/dfatrafficking
Path : userprofiles/{+profileId}/campaigns
Parameters :
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
id
Type : string
Format : int64
Description : Required. Campaign ID.
Location : query
Required : Yes
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/campaigns
▼ ▲ dfareporting.conversions.batchinsert
Path : userprofiles/{profileId}/conversions/batchinsert
Parameters :
profileId
Type : string
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Parameter Order : profileId
Flat Path : userprofiles/{profileId}/conversions/batchinsert
Description : Inserts conversions.
HTTP Method : POST
▼ ▲ dfareporting.conversions.batchupdate
Path : userprofiles/{profileId}/conversions/batchupdate
Parameters :
profileId
Type : string
Format : int64
Description : User profile ID associated with this request.
Location : path
Required : Yes
Flat Path : userprofiles/{profileId}/conversions/batchupdate
Parameter Order : profileId
HTTP Method : POST
Description : Updates existing conversions.
▼ ▲ dfareporting.inventoryItems.list
Path : userprofiles/{+profileId}/projects/{projectId}/inventoryItems
Parameters :
siteId
Location : query
Format : int64
Description : Select only inventory items that are associated with these sites.
Repeated : Yes
Type : string
sortField
Description : Field by which to sort the list.
Enum Descriptions :
Location : query
Enum :
Type : string
Default : ID
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
orderId
Location : query
Description : Select only inventory items that belong to specified orders.
Format : int64
Repeated : Yes
Type : string
type
Enum :
Type : string
Location : query
Description : Select only inventory items with this type.
Enum Descriptions :
pageToken
Description : Value of the nextPageToken from the previous result page.
Type : string
Location : query
maxResults
Location : query
Format : int32
Description : Maximum number of results to return.
Default : 1000
Type : integer
inPlan
Location : query
Type : boolean
Description : Select only inventory items that are in plan.
projectId
Type : string
Format : int64
Description : Project ID for order documents.
Location : path
Required : Yes
sortOrder
Default : ASCENDING
Enum :
Type : string
Location : query
Description : Order of sorted results.
Enum Descriptions :
ids
Description : Select only inventory items with these IDs.
Format : int64
Location : query
Repeated : Yes
Type : string
Flat Path : userprofiles/{userprofilesId}/projects/{projectId}/inventoryItems
Parameter Order :
HTTP Method : GET
Description : Retrieves a list of inventory items, possibly filtered. This method supports paging.
▼ ▲ dfareporting.inventoryItems.get
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one inventory item by ID.
Flat Path : userprofiles/{userprofilesId}/projects/{projectId}/inventoryItems/{inventoryItemsId}
Parameter Order :
Path : userprofiles/{+profileId}/projects/{projectId}/inventoryItems/{+id}
Parameters :
profileId
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
Type : string
Pattern : ^[^/]+$
id
Pattern : ^[^/]+$
Type : string
Description : Inventory item ID.
Format : int64
Required : Yes
Location : path
projectId
Type : string
Format : int64
Description : Project ID for order documents.
Location : path
Required : Yes
▼ ▲ dfareporting.directorySites.insert
Flat Path : userprofiles/{userprofilesId}/directorySites
Parameter Order : profileId
Path : userprofiles/{+profileId}/directorySites
Parameters :
profileId
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
Pattern : ^[^/]+$
Type : string
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : POST
Description : Inserts a new directory site.
▼ ▲ dfareporting.directorySites.list
Parameter Order : profileId
Flat Path : userprofiles/{userprofilesId}/directorySites
Path : userprofiles/{+profileId}/directorySites
Parameters :
pageToken
Location : query
Type : string
Description : Value of the nextPageToken from the previous result page.
profileId
Pattern : ^[^/]+$
Type : string
Required : Yes
Location : path
Description : User profile ID associated with this request.
Format : int64
acceptsPublisherPaidPlacements
Location : query
Type : boolean
Description : Select only directory sites that accept publisher paid placements. This field can be left blank.
active
Description : Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
Type : boolean
Location : query
sortField
Enum Descriptions :
Description : Field by which to sort the list.
Location : query
Type : string
Enum :
Default : ID
dfpNetworkCode
Location : query
Description : Select only directory sites with this Ad Manager network code.
Type : string
ids
Description : Select only directory sites with these IDs.
Format : int64
Location : query
Repeated : Yes
Type : string
searchString
Type : string
Description : Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site".
Location : query
sortOrder
Location : query
Description : Order of sorted results.
Enum Descriptions :
Default : ASCENDING
Enum :
Type : string
acceptsInterstitialPlacements
Type : boolean
Description : This search filter is no longer supported and will have no effect on the results returned.
Location : query
acceptsInStreamVideoPlacements
Type : boolean
Description : This search filter is no longer supported and will have no effect on the results returned.
Location : query
maxResults
Format : int32
Description : Maximum number of results to return.
Location : query
Type : integer
Default : 1000
Scopes : https://www.googleapis.com/auth/dfatrafficking
Description : Retrieves a list of directory sites, possibly filtered. This method supports paging.
HTTP Method : GET
▼ ▲ dfareporting.directorySites.get
Flat Path : userprofiles/{userprofilesId}/directorySites/{directorySitesId}
Parameter Order :
Path : userprofiles/{+profileId}/directorySites/{+id}
Parameters :
profileId
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
Pattern : ^[^/]+$
Type : string
id
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : Directory site ID.
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Gets one directory site by ID.
▼ ▲ dfareporting.targetableRemarketingLists.list
Flat Path : userprofiles/{userprofilesId}/targetableRemarketingLists
Parameter Order :
Path : userprofiles/{+profileId}/targetableRemarketingLists
Parameters :
active
Location : query
Description : Select only active or only inactive targetable remarketing lists.
Type : boolean
sortField
Default : ID
Type : string
Enum :
Location : query
Enum Descriptions :
Description : Field by which to sort the list.
name
Description : Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list".
Type : string
Location : query
profileId
Type : string
Pattern : ^[^/]+$
Location : path
Required : Yes
Format : int64
Description : User profile ID associated with this request.
advertiserId
Location : query
Required : Yes
Format : int64
Description : Required. Select only targetable remarketing lists targetable by these advertisers.
Type : string
maxResults
Default : 1000
Type : integer
Location : query
Format : int32
Description : Maximum number of results to return.
pageToken
Location : query
Type : string
Description : Value of the nextPageToken from the previous result page.
sortOrder
Location : query
Enum Descriptions :
Description : Order of sorted results.
Default : ASCENDING
Type : string
Enum :
Scopes : https://www.googleapis.com/auth/dfatrafficking
HTTP Method : GET
Description : Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.
▼ ▲ dfareporting.targetableRemarketingLists.get
Path : userprofiles/{+profileId}/targetableRemarketingLists/{+id}
Parameters :
profileId
Pattern : ^[^/]+$
Type : string
Description : User profile ID associated with this request.
Format : int64
Required : Yes
Location : path
id
Location : path
Required : Yes
Format : int64
Description : Remarketing list ID.
Type : string
Pattern : ^[^/]+$
Parameter Order :
Flat Path : userprofiles/{userprofilesId}/targetableRemarketingLists/{targetableRemarketingListsId}
Description : Gets one remarketing list by ID.
HTTP Method : GET