2023-06-22
▼ ▲ dfareporting.media.upload
Mediaupload:
Accept: */*
Protocols:
Simple:
Path: /upload/dfareporting/v3.5/userprofiles/{+profileId}/creativeAssets/{+advertiserId}/creativeAssets
Multipart: Yes
Maxsize: 1073741824
Parameters:
profileId
Type: string
Description: User profile ID associated with this request.
Location: path
Required: Yes
Format: int64
Pattern: ^[^/]+$
advertiserId
Required: Yes
Type: string
Pattern: ^[^/]+$
Format: int64
Description: Advertiser ID of this creative. This is a required field.
Location: path
Parameter Order:
Flat Path: userprofiles/{userprofilesId}/creativeAssets/{creativeAssetsId}/creativeAssets
Path: userprofiles/{+profileId}/creativeAssets/{+advertiserId}/creativeAssets
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Inserts a new creative asset.
Supportsmediaupload: Yes
HTTP Method: POST
▼ ▲ dfareporting.eventTags.delete
Path: userprofiles/{profileId}/eventTags/{id}
Parameter Order:
Description: Deletes an existing event tag.
Flat Path: userprofiles/{profileId}/eventTags/{id}
Parameters:
id
Format: int64
Description: Event tag ID.
Required: Yes
Location: path
Type: string
profileId
Type: string
Description: User profile ID associated with this request.
Required: Yes
Format: int64
Location: path
HTTP Method: DELETE
▼ ▲ dfareporting.eventTags.update
HTTP Method: PUT
Parameter Order: profileId
Path: userprofiles/{profileId}/eventTags
Parameters:
profileId
Description: User profile ID associated with this request.
Location: path
Required: Yes
Format: int64
Type: string
Description: Updates an existing event tag.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/eventTags
▼ ▲ dfareporting.eventTags.patch
Parameters:
id
Type: string
Location: query
Description: EventTag ID.
Format: int64
Required: Yes
profileId
Required: Yes
Type: string
Description: User profile ID associated with this request.
Format: int64
Location: path
Parameter Order:
Path: userprofiles/{profileId}/eventTags
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: PATCH
Description: Updates an existing event tag. This method supports patch semantics.
Flat Path: userprofiles/{profileId}/eventTags
▼ ▲ dfareporting.eventTags.get
Description: Gets one event tag by ID.
Flat Path: userprofiles/{profileId}/eventTags/{id}
Path: userprofiles/{profileId}/eventTags/{id}
HTTP Method: GET
Parameters:
profileId
Required: Yes
Format: int64
Description: User profile ID associated with this request.
Location: path
Type: string
id
Location: path
Description: Event tag ID.
Type: string
Required: Yes
Format: int64
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order:
▼ ▲ dfareporting.eventTags.list
Parameters:
advertiserId
Location: query
Format: int64
Description: Select only event tags that belong to this advertiser.
Type: string
sortOrder
Default: ASCENDING
Enum:
Description: Order of sorted results.
Enum Descriptions:
Type: string
Location: query
sortField
Enum Descriptions:
Default: ID
Location: query
Enum:
Type: string
Description: Field by which to sort the list.
definitionsOnly
Type: boolean
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.
campaignId
Type: string
Description: Select only event tags that belong to this campaign.
Location: query
Format: int64
searchString
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".
Location: query
Type: string
eventTagTypes
Repeated: Yes
Enum:
Location: query
Enum Descriptions:
Type: string
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.
profileId
Description: User profile ID associated with this request.
Location: path
Required: Yes
Type: string
Format: int64
ids
Repeated: Yes
Format: int64
Description: Select only event tags with these IDs.
Location: query
Type: string
adId
Location: query
Type: string
Format: int64
Description: Select only event tags that belong to this ad.
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.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/eventTags
Parameter Order: profileId
Description: Retrieves a list of event tags, possibly filtered.
Path: userprofiles/{profileId}/eventTags
▼ ▲ dfareporting.eventTags.insert
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/eventTags
Description: Inserts a new event tag.
Flat Path: userprofiles/{profileId}/eventTags
Parameters:
profileId
Required: Yes
Format: int64
Description: User profile ID associated with this request.
Location: path
Type: string
HTTP Method: POST
Parameter Order: profileId
▼ ▲ dfareporting.sites.list
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
campaignIds
Repeated: Yes
Type: string
Format: int64
Location: query
Description: Select only sites with these campaign IDs.
sortOrder
Location: query
Default: ASCENDING
Description: Order of sorted results.
Enum:
Enum Descriptions:
Type: string
acceptsPublisherPaidPlacements
Location: query
Description: Select only sites that accept publisher paid placements.
Type: boolean
ids
Description: Select only sites with these IDs.
Repeated: Yes
Location: query
Type: string
Format: int64
maxResults
Default: 1000
Format: int32
Description: Maximum number of results to return.
Minimum: 0
Type: integer
Location: query
Maximum: 1000
unmappedSite
Type: boolean
Location: query
Description: Select only sites that have not been mapped to a directory site.
directorySiteIds
Type: string
Description: Select only sites with these directory site IDs.
Format: int64
Repeated: Yes
Location: query
searchString
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".
Type: string
Location: query
acceptsInterstitialPlacements
Location: query
Type: boolean
Description: This search filter is no longer supported and will have no effect on the results returned.
pageToken
Description: Value of the nextPageToken from the previous result page.
Location: query
Type: string
subaccountId
Description: Select only sites with this subaccount ID.
Format: int64
Type: string
Location: query
acceptsInStreamVideoPlacements
Location: query
Description: This search filter is no longer supported and will have no effect on the results returned.
Type: boolean
sortField
Enum:
Enum Descriptions:
Location: query
Default: ID
Description: Field by which to sort the list.
Type: string
approved
Description: Select only approved sites.
Type: boolean
Location: query
adWordsSite
Location: query
Description: Select only AdWords sites.
Type: boolean
profileId
Required: Yes
Location: path
Type: string
Description: User profile ID associated with this request.
Format: int64
Flat Path: userprofiles/{profileId}/sites
Parameter Order: profileId
Description: Retrieves a list of sites, possibly filtered. This method supports paging.
Path: userprofiles/{profileId}/sites
▼ ▲ dfareporting.sites.get
Flat Path: userprofiles/{profileId}/sites/{id}
Description: Gets one site by ID.
HTTP Method: GET
Path: userprofiles/{profileId}/sites/{id}
Parameters:
id
Type: string
Description: Site ID.
Location: path
Format: int64
Required: Yes
profileId
Type: string
Location: path
Description: User profile ID associated with this request.
Required: Yes
Format: int64
Parameter Order:
▼ ▲ dfareporting.sites.update
Parameters:
profileId
Location: path
Required: Yes
Type: string
Description: User profile ID associated with this request.
Format: int64
Flat Path: userprofiles/{profileId}/sites
Description: Updates an existing site.
Parameter Order: profileId
Path: userprofiles/{profileId}/sites
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: PUT
▼ ▲ dfareporting.sites.insert
Parameter Order: profileId
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Location: path
Format: int64
Required: Yes
Type: string
Description: User profile ID associated with this request.
Flat Path: userprofiles/{profileId}/sites
Description: Inserts a new site.
HTTP Method: POST
Path: userprofiles/{profileId}/sites
▼ ▲ dfareporting.sites.patch
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Updates an existing site. This method supports patch semantics.
Flat Path: userprofiles/{profileId}/sites
Path: userprofiles/{profileId}/sites
Parameters:
id
Required: Yes
Description: Site ID.
Type: string
Location: query
Format: int64
profileId
Type: string
Required: Yes
Description: User profile ID associated with this request.
Location: path
Format: int64
Parameter Order:
HTTP Method: PATCH
▼ ▲ dfareporting.projects.get
HTTP Method: GET
Flat Path: userprofiles/{profileId}/projects/{id}
Path: userprofiles/{profileId}/projects/{id}
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order:
Parameters:
id
Required: Yes
Format: int64
Description: Project ID.
Location: path
Type: string
profileId
Format: int64
Type: string
Required: Yes
Description: User profile ID associated with this request.
Location: path
Description: Gets one project by ID.
▼ ▲ dfareporting.projects.list
Parameters:
pageToken
Type: string
Location: query
Description: Value of the nextPageToken from the previous result page.
profileId
Format: int64
Type: string
Description: User profile ID associated with this request.
Location: path
Required: Yes
sortField
Description: Field by which to sort the list.
Location: query
Type: string
Enum:
Default: ID
Enum Descriptions:
maxResults
Minimum: 0
Location: query
Default: 1000
Maximum: 1000
Format: int32
Description: Maximum number of results to return.
Type: integer
searchString
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".
Type: string
Location: query
sortOrder
Type: string
Description: Order of sorted results.
Location: query
Enum Descriptions:
Enum:
Default: ASCENDING
ids
Repeated: Yes
Location: query
Description: Select only projects with these IDs.
Type: string
Format: int64
advertiserIds
Repeated: Yes
Format: int64
Description: Select only projects with these advertiser IDs.
Location: query
Type: string
HTTP Method: GET
Path: userprofiles/{profileId}/projects
Flat Path: userprofiles/{profileId}/projects
Parameter Order: profileId
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Retrieves a list of projects, possibly filtered. This method supports paging .
▼ ▲ dfareporting.languages.list
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Required: Yes
Type: string
Format: int64
Location: path
Description: User profile ID associated with this request.
Description: Retrieves a list of languages.
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/languages
Path: userprofiles/{profileId}/languages
▼ ▲ dfareporting.videoFormats.list
HTTP Method: GET
Parameters:
profileId
Description: User profile ID associated with this request.
Format: int64
Type: string
Location: path
Required: Yes
Description: Lists available video formats.
Path: userprofiles/{profileId}/videoFormats
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/videoFormats
▼ ▲ dfareporting.videoFormats.get
Flat Path: userprofiles/{profileId}/videoFormats/{id}
Description: Gets one video format by ID.
HTTP Method: GET
Path: userprofiles/{profileId}/videoFormats/{id}
Parameter Order:
Parameters:
id
Description: Video format ID.
Required: Yes
Type: integer
Location: path
Format: int32
profileId
Format: int64
Type: string
Location: path
Required: Yes
Description: User profile ID associated with this request.
▼ ▲ dfareporting.floodlightConfigurations.list
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Required: Yes
Format: int64
Type: string
Description: User profile ID associated with this request.
Location: path
ids
Repeated: Yes
Type: string
Description: Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned.
Location: query
Format: int64
Parameter Order: profileId
HTTP Method: GET
Flat Path: userprofiles/{profileId}/floodlightConfigurations
Path: userprofiles/{profileId}/floodlightConfigurations
Description: Retrieves a list of floodlight configurations, possibly filtered.
▼ ▲ dfareporting.floodlightConfigurations.patch
Flat Path: userprofiles/{profileId}/floodlightConfigurations
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order:
Path: userprofiles/{profileId}/floodlightConfigurations
HTTP Method: PATCH
Description: Updates an existing floodlight configuration. This method supports patch semantics.
Parameters:
profileId
Required: Yes
Description: User profile ID associated with this request.
Type: string
Location: path
Format: int64
id
Location: query
Format: int64
Required: Yes
Type: string
Description: FloodlightConfiguration ID.
▼ ▲ dfareporting.floodlightConfigurations.get
Path: userprofiles/{profileId}/floodlightConfigurations/{id}
Parameter Order:
HTTP Method: GET
Flat Path: userprofiles/{profileId}/floodlightConfigurations/{id}
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Format: int64
Description: User profile ID associated with this request.
Required: Yes
Location: path
Type: string
id
Format: int64
Location: path
Type: string
Description: Floodlight configuration ID.
Required: Yes
Description: Gets one floodlight configuration by ID.
▼ ▲ dfareporting.floodlightConfigurations.update
HTTP Method: PUT
Path: userprofiles/{profileId}/floodlightConfigurations
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/floodlightConfigurations
Parameters:
profileId
Description: User profile ID associated with this request.
Location: path
Format: int64
Type: string
Required: Yes
Description: Updates an existing floodlight configuration.
▼ ▲ dfareporting.inventoryItems.list
HTTP Method: GET
Path: userprofiles/{profileId}/projects/{projectId}/inventoryItems
Parameters:
maxResults
Location: query
Format: int32
Minimum: 0
Maximum: 1000
Default: 1000
Description: Maximum number of results to return.
Type: integer
siteId
Location: query
Type: string
Description: Select only inventory items that are associated with these sites.
Format: int64
Repeated: Yes
ids
Description: Select only inventory items with these IDs.
Repeated: Yes
Type: string
Format: int64
Location: query
sortField
Enum Descriptions:
Type: string
Enum:
Default: ID
Description: Field by which to sort the list.
Location: query
projectId
Format: int64
Type: string
Location: path
Required: Yes
Description: Project ID for order documents.
type
Type: string
Enum Descriptions:
Description: Select only inventory items with this type.
Location: query
Enum:
orderId
Type: string
Repeated: Yes
Location: query
Description: Select only inventory items that belong to specified orders.
Format: int64
profileId
Required: Yes
Type: string
Format: int64
Location: path
Description: User profile ID associated with this request.
pageToken
Location: query
Type: string
Description: Value of the nextPageToken from the previous result page.
sortOrder
Location: query
Type: string
Default: ASCENDING
Enum:
Enum Descriptions:
Description: Order of sorted results.
inPlan
Type: boolean
Description: Select only inventory items that are in plan.
Location: query
Flat Path: userprofiles/{profileId}/projects/{projectId}/inventoryItems
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order:
Description: Retrieves a list of inventory items, possibly filtered. This method supports paging.
▼ ▲ dfareporting.inventoryItems.get
Flat Path: userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}
HTTP Method: GET
Path: userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
id
Required: Yes
Location: path
Format: int64
Description: Inventory item ID.
Type: string
profileId
Location: path
Type: string
Required: Yes
Format: int64
Description: User profile ID associated with this request.
projectId
Description: Project ID for order documents.
Location: path
Required: Yes
Format: int64
Type: string
Parameter Order:
Description: Gets one inventory item by ID.
▼ ▲ dfareporting.remarketingLists.update
Path: userprofiles/{profileId}/remarketingLists
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Required: Yes
Type: string
Location: path
Format: int64
Description: User profile ID associated with this request.
Flat Path: userprofiles/{profileId}/remarketingLists
Description: Updates an existing remarketing list.
Parameter Order: profileId
HTTP Method: PUT
▼ ▲ dfareporting.remarketingLists.patch
HTTP Method: PATCH
Description: Updates an existing remarketing list. This method supports patch semantics.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/remarketingLists
Path: userprofiles/{profileId}/remarketingLists
Parameters:
id
Required: Yes
Description: RemarketingList ID.
Location: query
Type: string
Format: int64
profileId
Required: Yes
Format: int64
Type: string
Location: path
Description: User profile ID associated with this request.
Parameter Order:
▼ ▲ dfareporting.remarketingLists.list
Path: userprofiles/{profileId}/remarketingLists
Parameter Order:
Parameters:
advertiserId
Type: string
Format: int64
Description: Select only remarketing lists owned by this advertiser.
Required: Yes
Location: query
profileId
Description: User profile ID associated with this request.
Format: int64
Location: path
Type: string
Required: Yes
pageToken
Location: query
Description: Value of the nextPageToken from the previous result page.
Type: string
maxResults
Minimum: 0
Default: 1000
Location: query
Description: Maximum number of results to return.
Maximum: 1000
Type: integer
Format: int32
name
Location: query
Type: string
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".
active
Description: Select only active or only inactive remarketing lists.
Type: boolean
Location: query
floodlightActivityId
Type: string
Format: int64
Location: query
Description: Select only remarketing lists that have this floodlight activity ID.
sortField
Enum:
Enum Descriptions:
Default: ID
Type: string
Description: Field by which to sort the list.
Location: query
sortOrder
Enum:
Location: query
Type: string
Description: Order of sorted results.
Default: ASCENDING
Enum Descriptions:
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: GET
Flat Path: userprofiles/{profileId}/remarketingLists
Description: Retrieves a list of remarketing lists, possibly filtered. This method supports paging.
▼ ▲ dfareporting.remarketingLists.get
Parameters:
profileId
Location: path
Format: int64
Description: User profile ID associated with this request.
Required: Yes
Type: string
id
Location: path
Required: Yes
Format: int64
Description: Remarketing list ID.
Type: string
Path: userprofiles/{profileId}/remarketingLists/{id}
HTTP Method: GET
Flat Path: userprofiles/{profileId}/remarketingLists/{id}
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Gets one remarketing list by ID.
Parameter Order:
▼ ▲ dfareporting.remarketingLists.insert
Description: Inserts a new remarketing list.
Path: userprofiles/{profileId}/remarketingLists
Parameters:
profileId
Required: Yes
Type: string
Location: path
Format: int64
Description: User profile ID associated with this request.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/remarketingLists
Parameter Order: profileId
HTTP Method: POST
▼ ▲ dfareporting.advertiserLandingPages.get
Description: Gets one landing page by ID.
Path: userprofiles/{profileId}/advertiserLandingPages/{id}
Parameter Order:
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/advertiserLandingPages/{id}
Parameters:
profileId
Type: string
Format: int64
Location: path
Required: Yes
Description: User profile ID associated with this request.
id
Description: Landing page ID.
Format: int64
Location: path
Required: Yes
Type: string
HTTP Method: GET
▼ ▲ dfareporting.advertiserLandingPages.update
Flat Path: userprofiles/{profileId}/advertiserLandingPages
Path: userprofiles/{profileId}/advertiserLandingPages
Description: Updates an existing landing page.
HTTP Method: PUT
Parameter Order: profileId
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Type: string
Location: path
Format: int64
Required: Yes
Description: User profile ID associated with this request.
▼ ▲ dfareporting.advertiserLandingPages.insert
Parameter Order: profileId
Description: Inserts a new landing page.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/advertiserLandingPages
Parameters:
profileId
Type: string
Description: User profile ID associated with this request.
Format: int64
Required: Yes
Location: path
Path: userprofiles/{profileId}/advertiserLandingPages
HTTP Method: POST
▼ ▲ dfareporting.advertiserLandingPages.list
HTTP Method: GET
Parameter Order: profileId
Path: userprofiles/{profileId}/advertiserLandingPages
Flat Path: userprofiles/{profileId}/advertiserLandingPages
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
maxResults
Maximum: 1000
Default: 1000
Minimum: 0
Type: integer
Location: query
Format: int32
Description: Maximum number of results to return.
campaignIds
Type: string
Description: Select only landing pages that are associated with these campaigns.
Repeated: Yes
Format: int64
Location: query
subaccountId
Type: string
Format: int64
Location: query
Description: Select only landing pages that belong to this subaccount.
sortField
Enum Descriptions:
Location: query
Default: ID
Description: Field by which to sort the list.
Type: string
Enum:
advertiserIds
Repeated: Yes
Location: query
Type: string
Description: Select only landing pages that belong to these advertisers.
Format: int64
archived
Type: boolean
Description: Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages.
Location: query
ids
Format: int64
Type: string
Description: Select only landing pages with these IDs.
Location: query
Repeated: Yes
pageToken
Location: query
Description: Value of the nextPageToken from the previous result page.
Type: string
sortOrder
Enum Descriptions:
Location: query
Type: string
Enum:
Description: Order of sorted results.
Default: ASCENDING
searchString
Location: query
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".
Type: string
profileId
Type: string
Description: User profile ID associated with this request.
Location: path
Required: Yes
Format: int64
Description: Retrieves a list of landing pages.
▼ ▲ dfareporting.advertiserLandingPages.patch
Description: Updates an existing advertiser landing page. This method supports patch semantics.
Flat Path: userprofiles/{profileId}/advertiserLandingPages
Parameters:
profileId
Type: string
Required: Yes
Description: User profile ID associated with this request.
Format: int64
Location: path
id
Type: string
Location: query
Description: LandingPage ID.
Format: int64
Required: Yes
Parameter Order:
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/advertiserLandingPages
▼ ▲ dfareporting.userRolePermissions.get
Flat Path: userprofiles/{profileId}/userRolePermissions/{id}
HTTP Method: GET
Path: userprofiles/{profileId}/userRolePermissions/{id}
Parameter Order:
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Location: path
Format: int64
Required: Yes
Description: User profile ID associated with this request.
Type: string
id
Format: int64
Required: Yes
Location: path
Type: string
Description: User role permission ID.
Description: Gets one user role permission by ID.
▼ ▲ dfareporting.userRolePermissions.list
Parameters:
ids
Description: Select only user role permissions with these IDs.
Type: string
Repeated: Yes
Location: query
Format: int64
profileId
Location: path
Format: int64
Description: User profile ID associated with this request.
Required: Yes
Type: string
Path: userprofiles/{profileId}/userRolePermissions
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/userRolePermissions
HTTP Method: GET
Description: Gets a list of user role permissions, possibly filtered.
▼ ▲ dfareporting.metros.list
HTTP Method: GET
Parameters:
profileId
Format: int64
Required: Yes
Description: User profile ID associated with this request.
Location: path
Type: string
Description: Retrieves a list of metros.
Flat Path: userprofiles/{profileId}/metros
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order: profileId
Path: userprofiles/{profileId}/metros
▼ ▲ dfareporting.dynamicTargetingKeys.delete
HTTP Method: DELETE
Parameters:
name
Required: Yes
Type: string
Location: query
Description: 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.
objectId
Type: string
Required: Yes
Format: int64
Location: path
Description: ID of the object of this dynamic targeting key. This is a required field.
objectType
Required: Yes
Type: string
Enum Descriptions:
Enum:
Location: query
Description: Type of the object of this dynamic targeting key. This is a required field.
profileId
Required: Yes
Type: string
Description: User profile ID associated with this request.
Format: int64
Location: path
Parameter Order:
Description: Deletes an existing dynamic targeting key.
Flat Path: userprofiles/{profileId}/dynamicTargetingKeys/{objectId}
Path: userprofiles/{profileId}/dynamicTargetingKeys/{objectId}
▼ ▲ dfareporting.dynamicTargetingKeys.list
Description: Retrieves a list of dynamic targeting keys.
Parameter Order: profileId
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Location: path
Format: int64
Type: string
Description: User profile ID associated with this request.
Required: Yes
names
Repeated: Yes
Description: Select only dynamic targeting keys exactly matching these names.
Location: query
Type: string
objectType
Location: query
Enum Descriptions:
Enum:
Description: Select only dynamic targeting keys with this object type.
Type: string
objectId
Type: string
Location: query
Description: Select only dynamic targeting keys with this object ID.
Format: int64
advertiserId
Type: string
Description: Select only dynamic targeting keys whose object has this advertiser ID.
Location: query
Format: int64
Path: userprofiles/{profileId}/dynamicTargetingKeys
HTTP Method: GET
Flat Path: userprofiles/{profileId}/dynamicTargetingKeys
▼ ▲ dfareporting.dynamicTargetingKeys.insert
Flat Path: userprofiles/{profileId}/dynamicTargetingKeys
Parameter Order: profileId
Parameters:
profileId
Location: path
Format: int64
Required: Yes
Type: string
Description: User profile ID associated with this request.
Scopes: https://www.googleapis.com/auth/dfatrafficking
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.
Path: userprofiles/{profileId}/dynamicTargetingKeys
▼ ▲ dfareporting.userRolePermissionGroups.list
HTTP Method: GET
Flat Path: userprofiles/{profileId}/userRolePermissionGroups
Description: Gets a list of all supported user role permission groups.
Parameters:
profileId
Description: User profile ID associated with this request.
Required: Yes
Type: string
Location: path
Format: int64
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order: profileId
Path: userprofiles/{profileId}/userRolePermissionGroups
▼ ▲ dfareporting.userRolePermissionGroups.get
Path: userprofiles/{profileId}/userRolePermissionGroups/{id}
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
id
Type: string
Description: User role permission group ID.
Location: path
Required: Yes
Format: int64
profileId
Location: path
Format: int64
Description: User profile ID associated with this request.
Type: string
Required: Yes
Parameter Order:
Flat Path: userprofiles/{profileId}/userRolePermissionGroups/{id}
HTTP Method: GET
Description: Gets one user role permission group by ID.
▼ ▲ dfareporting.orderDocuments.list
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Retrieves a list of order documents, possibly filtered. This method supports paging.
Path: userprofiles/{profileId}/projects/{projectId}/orderDocuments
Flat Path: userprofiles/{profileId}/projects/{projectId}/orderDocuments
Parameters:
ids
Location: query
Type: string
Repeated: Yes
Description: Select only order documents with these IDs.
Format: int64
orderId
Repeated: Yes
Description: Select only order documents for specified orders.
Location: query
Format: int64
Type: string
sortField
Type: string
Enum:
Description: Field by which to sort the list.
Enum Descriptions:
Default: ID
Location: query
profileId
Type: string
Required: Yes
Location: path
Description: User profile ID associated with this request.
Format: int64
siteId
Format: int64
Description: Select only order documents that are associated with these sites.
Location: query
Repeated: Yes
Type: string
maxResults
Format: int32
Minimum: 0
Location: query
Description: Maximum number of results to return.
Maximum: 1000
Default: 1000
Type: integer
searchString
Description: Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 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 "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument".
Type: string
Location: query
projectId
Required: Yes
Type: string
Location: path
Description: Project ID for order documents.
Format: int64
sortOrder
Enum:
Location: query
Default: ASCENDING
Description: Order of sorted results.
Type: string
Enum Descriptions:
approved
Location: query
Description: Select only order documents that have been approved by at least one user.
Type: boolean
pageToken
Description: Value of the nextPageToken from the previous result page.
Location: query
Type: string
HTTP Method: GET
Parameter Order:
▼ ▲ dfareporting.orderDocuments.get
Parameter Order:
Path: userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}
Parameters:
projectId
Type: string
Format: int64
Location: path
Required: Yes
Description: Project ID for order documents.
id
Type: string
Description: Order document ID.
Format: int64
Location: path
Required: Yes
profileId
Location: path
Description: User profile ID associated with this request.
Type: string
Required: Yes
Format: int64
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Gets one order document by ID.
Flat Path: userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}
▼ ▲ dfareporting.operatingSystemVersions.list
Path: userprofiles/{profileId}/operatingSystemVersions
Parameter Order: profileId
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/operatingSystemVersions
HTTP Method: GET
Description: Retrieves a list of operating system versions.
Parameters:
profileId
Required: Yes
Description: User profile ID associated with this request.
Type: string
Location: path
Format: int64
▼ ▲ dfareporting.operatingSystemVersions.get
Path: userprofiles/{profileId}/operatingSystemVersions/{id}
HTTP Method: GET
Parameter Order:
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/operatingSystemVersions/{id}
Parameters:
id
Description: Operating system version ID.
Format: int64
Location: path
Type: string
Required: Yes
profileId
Type: string
Description: User profile ID associated with this request.
Location: path
Format: int64
Required: Yes
Description: Gets one operating system version by ID.
▼ ▲ dfareporting.userRoles.list
Flat Path: userprofiles/{profileId}/userRoles
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: GET
Parameters:
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".
accountUserRoleOnly
Location: query
Type: boolean
Description: Select only account level user roles not associated with any specific subaccount.
sortField
Location: query
Default: ID
Type: string
Description: Field by which to sort the list.
Enum Descriptions:
Enum:
maxResults
Format: int32
Description: Maximum number of results to return.
Default: 1000
Type: integer
Location: query
Minimum: 0
Maximum: 1000
ids
Description: Select only user roles with the specified IDs.
Repeated: Yes
Format: int64
Location: query
Type: string
profileId
Location: path
Description: User profile ID associated with this request.
Type: string
Format: int64
Required: Yes
sortOrder
Type: string
Location: query
Default: ASCENDING
Enum Descriptions:
Enum:
Description: Order of sorted results.
pageToken
Location: query
Description: Value of the nextPageToken from the previous result page.
Type: string
subaccountId
Description: Select only user roles that belong to this subaccount.
Format: int64
Type: string
Location: query
Path: userprofiles/{profileId}/userRoles
Description: Retrieves a list of user roles, possibly filtered. This method supports paging.
Parameter Order: profileId
▼ ▲ dfareporting.userRoles.get
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/userRoles/{id}
Description: Gets one user role by ID.
Parameter Order:
Parameters:
profileId
Description: User profile ID associated with this request.
Type: string
Required: Yes
Format: int64
Location: path
id
Format: int64
Description: User role ID.
Location: path
Type: string
Required: Yes
Path: userprofiles/{profileId}/userRoles/{id}
HTTP Method: GET
▼ ▲ dfareporting.userRoles.update
Path: userprofiles/{profileId}/userRoles
Description: Updates an existing user role.
Flat Path: userprofiles/{profileId}/userRoles
Parameter Order: profileId
Parameters:
profileId
Location: path
Description: User profile ID associated with this request.
Required: Yes
Format: int64
Type: string
HTTP Method: PUT
▼ ▲ dfareporting.userRoles.delete
Parameter Order:
Flat Path: userprofiles/{profileId}/userRoles/{id}
HTTP Method: DELETE
Parameters:
profileId
Format: int64
Required: Yes
Type: string
Location: path
Description: User profile ID associated with this request.
id
Required: Yes
Description: User role ID.
Format: int64
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/userRoles/{id}
Description: Deletes an existing user role.
▼ ▲ dfareporting.userRoles.patch
Path: userprofiles/{profileId}/userRoles
Description: Updates an existing user role. This method supports patch semantics.
Parameter Order:
Flat Path: userprofiles/{profileId}/userRoles
Parameters:
id
Location: query
Description: UserRole ID.
Required: Yes
Type: string
Format: int64
profileId
Location: path
Type: string
Format: int64
Required: Yes
Description: User profile ID associated with this request.
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: PATCH
▼ ▲ dfareporting.userRoles.insert
Flat Path: userprofiles/{profileId}/userRoles
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order: profileId
HTTP Method: POST
Description: Inserts a new user role.
Parameters:
profileId
Description: User profile ID associated with this request.
Required: Yes
Format: int64
Location: path
Type: string
Path: userprofiles/{profileId}/userRoles
▼ ▲ dfareporting.campaignCreativeAssociations.list
Description: Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.
Parameter Order:
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations
HTTP Method: GET
Path: userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations
Parameters:
profileId
Location: path
Type: string
Format: int64
Description: User profile ID associated with this request.
Required: Yes
campaignId
Type: string
Required: Yes
Description: Campaign ID in this association.
Format: int64
Location: path
pageToken
Type: string
Description: Value of the nextPageToken from the previous result page.
Location: query
sortOrder
Default: ASCENDING
Description: Order of sorted results.
Type: string
Enum:
Location: query
Enum Descriptions:
maxResults
Description: Maximum number of results to return.
Minimum: 0
Type: integer
Maximum: 1000
Default: 1000
Location: query
Format: int32
▼ ▲ dfareporting.campaignCreativeAssociations.insert
Parameters:
campaignId
Location: path
Description: Campaign ID in this association.
Required: Yes
Format: int64
Type: string
profileId
Type: string
Format: int64
Description: User profile ID associated with this request.
Location: path
Required: Yes
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.
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: POST
Parameter Order:
Flat Path: userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations
Path: userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations
▼ ▲ dfareporting.targetingTemplates.list
HTTP Method: GET
Description: Retrieves a list of targeting templates, optionally filtered. This method supports paging.
Parameters:
advertiserId
Description: Select only targeting templates with this advertiser ID.
Type: string
Format: int64
Location: query
searchString
Type: string
Location: query
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".
maxResults
Location: query
Type: integer
Default: 1000
Format: int32
Maximum: 1000
Description: Maximum number of results to return.
Minimum: 0
profileId
Required: Yes
Description: User profile ID associated with this request.
Type: string
Location: path
Format: int64
pageToken
Description: Value of the nextPageToken from the previous result page.
Type: string
Location: query
ids
Format: int64
Description: Select only targeting templates with these IDs.
Location: query
Type: string
Repeated: Yes
sortField
Type: string
Default: ID
Enum:
Enum Descriptions:
Location: query
Description: Field by which to sort the list.
sortOrder
Description: Order of sorted results.
Type: string
Location: query
Enum:
Default: ASCENDING
Enum Descriptions:
Flat Path: userprofiles/{profileId}/targetingTemplates
Path: userprofiles/{profileId}/targetingTemplates
Parameter Order: profileId
▼ ▲ dfareporting.targetingTemplates.update
Path: userprofiles/{profileId}/targetingTemplates
HTTP Method: PUT
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/targetingTemplates
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Type: string
Location: path
Description: User profile ID associated with this request.
Format: int64
Required: Yes
Description: Updates an existing targeting template.
▼ ▲ dfareporting.targetingTemplates.get
HTTP Method: GET
Path: userprofiles/{profileId}/targetingTemplates/{id}
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Gets one targeting template by ID.
Flat Path: userprofiles/{profileId}/targetingTemplates/{id}
Parameter Order:
Parameters:
id
Format: int64
Description: Targeting template ID.
Type: string
Location: path
Required: Yes
profileId
Description: User profile ID associated with this request.
Format: int64
Type: string
Required: Yes
Location: path
▼ ▲ dfareporting.targetingTemplates.insert
Parameters:
profileId
Description: User profile ID associated with this request.
Type: string
Location: path
Format: int64
Required: Yes
HTTP Method: POST
Path: userprofiles/{profileId}/targetingTemplates
Parameter Order: profileId
Description: Inserts a new targeting template.
Flat Path: userprofiles/{profileId}/targetingTemplates
▼ ▲ dfareporting.targetingTemplates.patch
Description: Updates an existing targeting template. This method supports patch semantics.
Parameter Order:
HTTP Method: PATCH
Parameters:
profileId
Required: Yes
Description: User profile ID associated with this request.
Location: path
Format: int64
Type: string
id
Type: string
Format: int64
Required: Yes
Description: TargetingTemplate ID.
Location: query
Flat Path: userprofiles/{profileId}/targetingTemplates
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/targetingTemplates
▼ ▲ dfareporting.changeLogs.list
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: GET
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/changeLogs
Path: userprofiles/{profileId}/changeLogs
Parameters:
maxChangeTime
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.
Location: query
objectType
Enum Descriptions:
Location: query
Enum:
Description: Select only change logs with the specified object type.
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
pageToken
Type: string
Description: Value of the nextPageToken from the previous result page.
Location: query
searchString
Type: string
Location: query
Description: Select only change logs whose object ID, user name, old or new values match the search string.
userProfileIds
Type: string
Description: Select only change logs with these user profile IDs.
Location: query
Format: int64
Repeated: Yes
objectIds
Format: int64
Type: string
Location: query
Description: Select only change logs with these object IDs.
Repeated: Yes
maxResults
Location: query
Type: integer
Minimum: 0
Format: int32
Description: Maximum number of results to return.
Default: 1000
Maximum: 1000
profileId
Type: string
Format: int64
Description: User profile ID associated with this request.
Required: Yes
Location: path
ids
Type: string
Repeated: Yes
Format: int64
Location: query
Description: Select only change logs with these IDs.
action
Enum Descriptions:
Location: query
Enum:
Type: string
Description: Select only change logs with the specified action.
Description: Retrieves a list of change logs. This method supports paging.
▼ ▲ dfareporting.changeLogs.get
Description: Gets one change log by ID.
HTTP Method: GET
Path: userprofiles/{profileId}/changeLogs/{id}
Flat Path: userprofiles/{profileId}/changeLogs/{id}
Parameters:
id
Location: path
Required: Yes
Type: string
Format: int64
Description: Change log ID.
profileId
Type: string
Location: path
Description: User profile ID associated with this request.
Format: int64
Required: Yes
Parameter Order:
▼ ▲ dfareporting.accounts.list
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/accounts
HTTP Method: GET
Description: Retrieves the list of accounts, possibly filtered. This method supports paging.
Parameter Order: profileId
Parameters:
profileId
Description: User profile ID associated with this request.
Format: int64
Type: string
Required: Yes
Location: path
sortOrder
Type: string
Enum:
Description: Order of sorted results.
Location: query
Enum Descriptions:
Default: ASCENDING
searchString
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".
Location: query
Type: string
maxResults
Location: query
Type: integer
Format: int32
Description: Maximum number of results to return.
Minimum: 0
Default: 1000
Maximum: 1000
ids
Location: query
Description: Select only accounts with these IDs.
Repeated: Yes
Type: string
Format: int64
active
Type: boolean
Location: query
Description: Select only active accounts. Don't set this field to select both active and non-active accounts.
sortField
Type: string
Enum:
Enum Descriptions:
Default: ID
Location: query
Description: Field by which to sort the list.
pageToken
Description: Value of the nextPageToken from the previous result page.
Location: query
Type: string
Path: userprofiles/{profileId}/accounts
▼ ▲ dfareporting.accounts.update
Path: userprofiles/{profileId}/accounts
HTTP Method: PUT
Parameters:
profileId
Location: path
Description: User profile ID associated with this request.
Required: Yes
Format: int64
Type: string
Description: Updates an existing account.
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/accounts
▼ ▲ dfareporting.accounts.patch
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/accounts
Parameter Order:
Path: userprofiles/{profileId}/accounts
Parameters:
profileId
Required: Yes
Location: path
Format: int64
Type: string
Description: User profile ID associated with this request.
id
Required: Yes
Description: Account ID.
Type: string
Location: query
Format: int64
Description: Updates an existing account. This method supports patch semantics.
▼ ▲ dfareporting.accounts.get
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order:
Description: Gets one account by ID.
Parameters:
profileId
Format: int64
Required: Yes
Location: path
Description: User profile ID associated with this request.
Type: string
id
Location: path
Format: int64
Required: Yes
Description: Account ID.
Type: string
HTTP Method: GET
Path: userprofiles/{profileId}/accounts/{id}
Flat Path: userprofiles/{profileId}/accounts/{id}
▼ ▲ dfareporting.userProfiles.list
Path: userprofiles
Scopes:
Description: Retrieves list of user profiles for a user.
HTTP Method: GET
Flat Path: userprofiles
▼ ▲ dfareporting.userProfiles.get
Parameter Order: profileId
Scopes:
Parameters:
profileId
Required: Yes
Format: int64
Description: The user profile ID.
Location: path
Type: string
HTTP Method: GET
Flat Path: userprofiles/{profileId}
Path: userprofiles/{profileId}
Description: Gets one user profile by ID.
▼ ▲ dfareporting.orders.list
Flat Path: userprofiles/{profileId}/projects/{projectId}/orders
Parameters:
sortField
Location: query
Enum:
Description: Field by which to sort the list.
Enum Descriptions:
Default: ID
Type: string
ids
Repeated: Yes
Location: query
Format: int64
Description: Select only orders with these IDs.
Type: string
siteId
Description: Select only orders that are associated with these site IDs.
Location: query
Repeated: Yes
Format: int64
Type: string
maxResults
Format: int32
Type: integer
Location: query
Minimum: 0
Maximum: 1000
Description: Maximum number of results to return.
Default: 1000
projectId
Format: int64
Location: path
Type: string
Required: Yes
Description: Project ID for orders.
pageToken
Description: Value of the nextPageToken from the previous result page.
Location: query
Type: string
sortOrder
Type: string
Enum:
Default: ASCENDING
Enum Descriptions:
Location: query
Description: Order of sorted results.
profileId
Type: string
Description: User profile ID associated with this request.
Required: Yes
Format: int64
Location: path
searchString
Location: query
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".
Type: string
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/projects/{projectId}/orders
Description: Retrieves a list of orders, possibly filtered. This method supports paging.
HTTP Method: GET
Parameter Order:
▼ ▲ dfareporting.orders.get
Description: Gets one order by ID.
Path: userprofiles/{profileId}/projects/{projectId}/orders/{id}
Flat Path: userprofiles/{profileId}/projects/{projectId}/orders/{id}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Format: int64
Location: path
Description: User profile ID associated with this request.
Type: string
Required: Yes
id
Required: Yes
Type: string
Description: Order ID.
Location: path
Format: int64
projectId
Required: Yes
Type: string
Format: int64
Description: Project ID for orders.
Location: path
Parameter Order:
▼ ▲ dfareporting.advertisers.update
Parameter Order: profileId
Description: Updates an existing advertiser.
HTTP Method: PUT
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Description: User profile ID associated with this request.
Location: path
Format: int64
Type: string
Required: Yes
Flat Path: userprofiles/{profileId}/advertisers
Path: userprofiles/{profileId}/advertisers
▼ ▲ dfareporting.advertisers.list
Flat Path: userprofiles/{profileId}/advertisers
HTTP Method: GET
Description: Retrieves a list of advertisers, possibly filtered. This method supports paging.
Parameter Order: profileId
Path: userprofiles/{profileId}/advertisers
Parameters:
sortField
Enum:
Description: Field by which to sort the list.
Location: query
Default: ID
Type: string
Enum Descriptions:
sortOrder
Default: ASCENDING
Type: string
Enum:
Location: query
Enum Descriptions:
Description: Order of sorted results.
ids
Description: Select only advertisers with these IDs.
Location: query
Format: int64
Type: string
Repeated: Yes
onlyParent
Type: boolean
Location: query
Description: Select only advertisers which use another advertiser's floodlight configuration.
status
Location: query
Enum Descriptions:
Type: string
Description: Select only advertisers with the specified status.
Enum:
floodlightConfigurationIds
Format: int64
Description: Select only advertisers with these floodlight configuration IDs.
Repeated: Yes
Location: query
Type: string
maxResults
Type: integer
Minimum: 0
Description: Maximum number of results to return.
Location: query
Format: int32
Maximum: 1000
Default: 1000
searchString
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" .
Location: query
Type: string
includeAdvertisersWithoutGroupsOnly
Location: query
Type: boolean
Description: Select only advertisers which do not belong to any advertiser group.
profileId
Type: string
Location: path
Description: User profile ID associated with this request.
Format: int64
Required: Yes
advertiserGroupIds
Location: query
Format: int64
Description: Select only advertisers with these advertiser group IDs.
Repeated: Yes
Type: string
pageToken
Description: Value of the nextPageToken from the previous result page.
Location: query
Type: string
subaccountId
Location: query
Description: Select only advertisers with these subaccount IDs.
Format: int64
Type: string
▼ ▲ dfareporting.advertisers.insert
Parameter Order: profileId
Parameters:
profileId
Format: int64
Required: Yes
Location: path
Type: string
Description: User profile ID associated with this request.
Flat Path: userprofiles/{profileId}/advertisers
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Inserts a new advertiser.
Path: userprofiles/{profileId}/advertisers
▼ ▲ dfareporting.advertisers.patch
Path: userprofiles/{profileId}/advertisers
Flat Path: userprofiles/{profileId}/advertisers
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Updates an existing advertiser. This method supports patch semantics.
Parameters:
id
Format: int64
Required: Yes
Type: string
Description: Advertiser ID.
Location: query
profileId
Format: int64
Required: Yes
Type: string
Description: User profile ID associated with this request.
Location: path
Parameter Order:
▼ ▲ dfareporting.advertisers.get
Parameter Order:
Parameters:
id
Location: path
Required: Yes
Description: Advertiser ID.
Type: string
Format: int64
profileId
Description: User profile ID associated with this request.
Required: Yes
Type: string
Location: path
Format: int64
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/advertisers/{id}
Path: userprofiles/{profileId}/advertisers/{id}
Description: Gets one advertiser by ID.
▼ ▲ dfareporting.files.get
Supportsmediadownload: Yes
Parameters:
fileId
Type: string
Location: path
Required: Yes
Format: int64
Description: The ID of the report file.
reportId
Required: Yes
Location: path
Description: The ID of the report.
Type: string
Format: int64
Scopes: https://www.googleapis.com/auth/dfareporting
Parameter Order:
HTTP Method: GET
Path: reports/{reportId}/files/{fileId}
Description: Retrieves a report file by its report ID and file ID. This method supports media download.
Flat Path: reports/{reportId}/files/{fileId}
▼ ▲ dfareporting.files.list
Path: userprofiles/{profileId}/files
Parameter Order: profileId
Parameters:
sortOrder
Enum Descriptions:
Default: DESCENDING
Type: string
Enum:
Description: Order of sorted results.
Location: query
profileId
Location: path
Required: Yes
Type: string
Description: The Campaign Manager 360 user profile ID.
Format: int64
scope
Enum:
Enum Descriptions:
Type: string
Description: The scope that defines which results are returned.
Default: MINE
Location: query
maxResults
Location: query
Format: int32
Description: Maximum number of results to return.
Maximum: 10
Default: 10
Minimum: 0
Type: integer
sortField
Location: query
Default: LAST_MODIFIED_TIME
Type: string
Enum Descriptions:
Enum:
Description: The field by which to sort the list.
pageToken
Type: string
Description: The value of the nextToken from the previous result page.
Location: query
Description: Lists files for a user profile.
Scopes: https://www.googleapis.com/auth/dfareporting
Flat Path: userprofiles/{profileId}/files
HTTP Method: GET
▼ ▲ dfareporting.countries.list
Path: userprofiles/{profileId}/countries
HTTP Method: GET
Description: Retrieves a list of countries.
Flat Path: userprofiles/{profileId}/countries
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order: profileId
Parameters:
profileId
Required: Yes
Description: User profile ID associated with this request.
Type: string
Format: int64
Location: path
▼ ▲ dfareporting.countries.get
Flat Path: userprofiles/{profileId}/countries/{dartId}
Parameters:
dartId
Description: Country DART ID.
Location: path
Required: Yes
Type: string
Format: int64
profileId
Description: User profile ID associated with this request.
Type: string
Format: int64
Required: Yes
Location: path
Path: userprofiles/{profileId}/countries/{dartId}
Description: Gets one country by ID.
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: GET
Parameter Order:
▼ ▲ dfareporting.creativeFieldValues.delete
Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}
HTTP Method: DELETE
Description: Deletes an existing creative field value.
Parameters:
profileId
Type: string
Required: Yes
Location: path
Description: User profile ID associated with this request.
Format: int64
creativeFieldId
Required: Yes
Type: string
Location: path
Format: int64
Description: Creative field ID for this creative field value.
id
Location: path
Description: Creative Field Value ID
Format: int64
Required: Yes
Type: string
Flat Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order:
▼ ▲ dfareporting.creativeFieldValues.update
Parameter Order:
HTTP Method: PUT
Parameters:
profileId
Description: User profile ID associated with this request.
Location: path
Format: int64
Required: Yes
Type: string
creativeFieldId
Description: Creative field ID for this creative field value.
Format: int64
Location: path
Required: Yes
Type: string
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Updates an existing creative field value.
Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues
Flat Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues
▼ ▲ dfareporting.creativeFieldValues.patch
Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues
Flat Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Updates an existing creative field value. This method supports patch semantics.
Parameter Order:
Parameters:
creativeFieldId
Format: int64
Description: CreativeField ID.
Location: path
Type: string
Required: Yes
profileId
Type: string
Required: Yes
Location: path
Description: User profile ID associated with this request.
Format: int64
id
Description: CreativeFieldValue ID.
Format: int64
Location: query
Required: Yes
Type: string
▼ ▲ dfareporting.creativeFieldValues.list
Flat Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues
Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues
HTTP Method: GET
Parameters:
creativeFieldId
Location: path
Format: int64
Type: string
Description: Creative field ID for this creative field value.
Required: Yes
profileId
Required: Yes
Description: User profile ID associated with this request.
Type: string
Location: path
Format: int64
searchString
Type: string
Location: query
Description: Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed.
ids
Type: string
Location: query
Description: Select only creative field values with these IDs.
Format: int64
Repeated: Yes
maxResults
Type: integer
Description: Maximum number of results to return.
Location: query
Maximum: 1000
Format: int32
Minimum: 0
Default: 1000
sortField
Enum Descriptions:
Default: ID
Type: string
Description: Field by which to sort the list.
Location: query
Enum:
sortOrder
Default: ASCENDING
Enum:
Type: string
Location: query
Enum Descriptions:
Description: Order of sorted results.
pageToken
Type: string
Description: Value of the nextPageToken from the previous result page.
Location: query
Parameter Order:
Description: Retrieves a list of creative field values, possibly filtered. This method supports paging.
▼ ▲ dfareporting.creativeFieldValues.get
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order:
Description: Gets one creative field value by ID.
Parameters:
profileId
Type: string
Required: Yes
Format: int64
Description: User profile ID associated with this request.
Location: path
creativeFieldId
Required: Yes
Description: Creative field ID for this creative field value.
Format: int64
Location: path
Type: string
id
Type: string
Format: int64
Description: Creative Field Value ID
Location: path
Required: Yes
HTTP Method: GET
Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}
Flat Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}
▼ ▲ dfareporting.creativeFieldValues.insert
HTTP Method: POST
Parameter Order:
Description: Inserts a new creative field value.
Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues
Parameters:
creativeFieldId
Format: int64
Location: path
Required: Yes
Description: Creative field ID for this creative field value.
Type: string
profileId
Format: int64
Type: string
Required: Yes
Description: User profile ID associated with this request.
Location: path
▼ ▲ dfareporting.targetableRemarketingLists.get
Parameters:
profileId
Description: User profile ID associated with this request.
Location: path
Format: int64
Type: string
Required: Yes
id
Location: path
Format: int64
Required: Yes
Type: string
Description: Remarketing list ID.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/targetableRemarketingLists/{id}
HTTP Method: GET
Parameter Order:
Path: userprofiles/{profileId}/targetableRemarketingLists/{id}
Description: Gets one remarketing list by ID.
▼ ▲ dfareporting.targetableRemarketingLists.list
HTTP Method: GET
Parameters:
sortField
Description: Field by which to sort the list.
Location: query
Type: string
Enum:
Enum Descriptions:
Default: ID
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
Type: string
Description: Value of the nextPageToken from the previous result page.
Location: query
active
Type: boolean
Location: query
Description: Select only active or only inactive targetable remarketing lists.
profileId
Description: User profile ID associated with this request.
Location: path
Type: string
Required: Yes
Format: int64
maxResults
Maximum: 1000
Type: integer
Default: 1000
Description: Maximum number of results to return.
Format: int32
Location: query
Minimum: 0
sortOrder
Enum Descriptions:
Description: Order of sorted results.
Default: ASCENDING
Location: query
Enum:
Type: string
advertiserId
Description: Select only targetable remarketing lists targetable by these advertisers.
Format: int64
Required: Yes
Type: string
Location: query
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/targetableRemarketingLists
Parameter Order:
Description: Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.
Flat Path: userprofiles/{profileId}/targetableRemarketingLists
▼ ▲ dfareporting.creatives.get
Parameters:
id
Type: string
Required: Yes
Location: path
Description: Creative ID.
Format: int64
profileId
Format: int64
Description: User profile ID associated with this request.
Required: Yes
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: GET
Flat Path: userprofiles/{profileId}/creatives/{id}
Description: Gets one creative by ID.
Path: userprofiles/{profileId}/creatives/{id}
Parameter Order:
▼ ▲ dfareporting.creatives.update
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/creatives
Path: userprofiles/{profileId}/creatives
Description: Updates an existing creative.
HTTP Method: PUT
Parameters:
profileId
Location: path
Type: string
Required: Yes
Description: User profile ID associated with this request.
Format: int64
Parameter Order: profileId
▼ ▲ dfareporting.creatives.insert
Parameter Order: profileId
Parameters:
profileId
Required: Yes
Description: User profile ID associated with this request.
Format: int64
Type: string
Location: path
Description: Inserts a new creative.
Path: userprofiles/{profileId}/creatives
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: POST
Flat Path: userprofiles/{profileId}/creatives
▼ ▲ dfareporting.creatives.list
Path: userprofiles/{profileId}/creatives
Description: Retrieves a list of creatives, possibly filtered. This method supports paging.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/creatives
Parameter Order: profileId
Parameters:
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".
Location: query
Type: string
companionCreativeIds
Type: string
Location: query
Repeated: Yes
Format: int64
Description: Select only in-stream video creatives with these companion IDs.
campaignId
Description: Select only creatives with this campaign ID.
Location: query
Format: int64
Type: string
sortField
Description: Field by which to sort the list.
Default: ID
Enum:
Enum Descriptions:
Location: query
Type: string
maxResults
Type: integer
Default: 1000
Location: query
Format: int32
Minimum: 0
Description: Maximum number of results to return.
Maximum: 1000
types
Location: query
Enum:
Repeated: Yes
Enum Descriptions:
Description: Select only creatives with these creative types.
Type: string
creativeFieldIds
Format: int64
Description: Select only creatives with these creative field IDs.
Location: query
Type: string
Repeated: Yes
studioCreativeId
Description: Select only creatives corresponding to this Studio creative ID.
Format: int64
Type: string
Location: query
active
Description: Select only active creatives. Leave blank to select active and inactive creatives.
Location: query
Type: boolean
advertiserId
Description: Select only creatives with this advertiser ID.
Location: query
Type: string
Format: int64
archived
Type: boolean
Location: query
Description: Select only archived creatives. Leave blank to select archived and unarchived creatives.
renderingIds
Format: int64
Type: string
Repeated: Yes
Description: Select only creatives with these rendering IDs.
Location: query
ids
Description: Select only creatives with these IDs.
Location: query
Format: int64
Type: string
Repeated: Yes
profileId
Type: string
Required: Yes
Location: path
Format: int64
Description: User profile ID associated with this request.
pageToken
Location: query
Type: string
Description: Value of the nextPageToken from the previous result page.
sizeIds
Location: query
Format: int64
Type: string
Repeated: Yes
Description: Select only creatives with these size IDs.
sortOrder
Default: ASCENDING
Enum:
Description: Order of sorted results.
Location: query
Type: string
Enum Descriptions:
HTTP Method: GET
▼ ▲ dfareporting.creatives.patch
HTTP Method: PATCH
Path: userprofiles/{profileId}/creatives
Parameter Order:
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Location: path
Format: int64
Required: Yes
Type: string
Description: User profile ID associated with this request.
id
Type: string
Required: Yes
Description: Creative ID.
Location: query
Format: int64
Description: Updates an existing creative. This method supports patch semantics.
Flat Path: userprofiles/{profileId}/creatives
▼ ▲ dfareporting.browsers.list
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order: profileId
Path: userprofiles/{profileId}/browsers
Parameters:
profileId
Description: User profile ID associated with this request.
Format: int64
Type: string
Required: Yes
Location: path
Description: Retrieves a list of browsers.
Flat Path: userprofiles/{profileId}/browsers
HTTP Method: GET
▼ ▲ dfareporting.dimensionValues.query
Parameter Order: profileId
Parameters:
pageToken
Type: string
Description: The value of the nextToken from the previous result page.
Location: query
maxResults
Minimum: 0
Maximum: 100
Default: 100
Type: integer
Location: query
Description: Maximum number of results to return.
Format: int32
profileId
Format: int64
Location: path
Description: The Campaign Manager 360 user profile ID.
Type: string
Required: Yes
Path: userprofiles/{profileId}/dimensionvalues/query
Description: Retrieves list of report dimension values for a list of filters.
Scopes: https://www.googleapis.com/auth/dfareporting
HTTP Method: POST
Flat Path: userprofiles/{profileId}/dimensionvalues/query
▼ ▲ dfareporting.placementGroups.update
Parameters:
profileId
Type: string
Description: User profile ID associated with this request.
Format: int64
Required: Yes
Location: path
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/placementGroups
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/placementGroups
HTTP Method: PUT
Description: Updates an existing placement group.
▼ ▲ dfareporting.placementGroups.get
Description: Gets one placement group by ID.
HTTP Method: GET
Path: userprofiles/{profileId}/placementGroups/{id}
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/placementGroups/{id}
Parameter Order:
Parameters:
id
Type: string
Required: Yes
Location: path
Description: Placement group ID.
Format: int64
profileId
Location: path
Required: Yes
Type: string
Description: User profile ID associated with this request.
Format: int64
▼ ▲ dfareporting.placementGroups.list
HTTP Method: GET
Parameters:
pageToken
Description: Value of the nextPageToken from the previous result page.
Location: query
Type: string
sortField
Description: Field by which to sort the list.
Location: query
Enum:
Enum Descriptions:
Type: string
Default: ID
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
advertiserIds
Type: string
Location: query
Format: int64
Description: Select only placement groups that belong to these advertisers.
Repeated: Yes
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".
Location: query
Type: string
directorySiteIds
Format: int64
Repeated: Yes
Description: Select only placement groups that are associated with these directory sites.
Location: query
Type: string
placementStrategyIds
Location: query
Description: Select only placement groups that are associated with these placement strategies.
Format: int64
Repeated: Yes
Type: string
pricingTypes
Enum:
Type: string
Location: query
Description: Select only placement groups with these pricing types.
Repeated: Yes
Enum Descriptions:
contentCategoryIds
Repeated: Yes
Format: int64
Location: query
Type: string
Description: Select only placement groups that are associated with these content categories.
minEndDate
Location: query
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".
Type: string
maxStartDate
Type: string
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".
ids
Format: int64
Repeated: Yes
Type: string
Description: Select only placement groups with these IDs.
Location: query
maxResults
Location: query
Minimum: 0
Type: integer
Maximum: 800
Format: int32
Description: Maximum number of results to return.
Default: 800
profileId
Description: User profile ID associated with this request.
Location: path
Type: string
Required: Yes
Format: int64
siteIds
Location: query
Type: string
Description: Select only placement groups that are associated with these sites.
Repeated: Yes
Format: int64
campaignIds
Location: query
Repeated: Yes
Description: Select only placement groups that belong to these campaigns.
Type: string
Format: int64
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
placementGroupType
Type: string
Location: query
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.
Enum:
archived
Type: boolean
Location: query
Description: Select only archived placements. Don't set this field to select both archived and non-archived placements.
sortOrder
Default: ASCENDING
Enum Descriptions:
Enum:
Type: string
Description: Order of sorted results.
Location: query
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Retrieves a list of placement groups, possibly filtered. This method supports paging.
Flat Path: userprofiles/{profileId}/placementGroups
Path: userprofiles/{profileId}/placementGroups
Parameter Order: profileId
▼ ▲ dfareporting.placementGroups.patch
Description: Updates an existing placement group. This method supports patch semantics.
Path: userprofiles/{profileId}/placementGroups
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order:
Parameters:
id
Required: Yes
Description: PlacementGroup ID.
Format: int64
Type: string
Location: query
profileId
Type: string
Description: User profile ID associated with this request.
Required: Yes
Format: int64
Location: path
Flat Path: userprofiles/{profileId}/placementGroups
HTTP Method: PATCH
▼ ▲ dfareporting.placementGroups.insert
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/placementGroups
Description: Inserts a new placement group.
Parameters:
profileId
Required: Yes
Format: int64
Location: path
Description: User profile ID associated with this request.
Type: string
Path: userprofiles/{profileId}/placementGroups
HTTP Method: POST
▼ ▲ dfareporting.advertiserGroups.insert
Flat Path: userprofiles/{profileId}/advertiserGroups
Parameter Order: profileId
Parameters:
profileId
Location: path
Type: string
Required: Yes
Format: int64
Description: User profile ID associated with this request.
Description: Inserts a new advertiser group.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/advertiserGroups
▼ ▲ dfareporting.advertiserGroups.update
Parameters:
profileId
Description: User profile ID associated with this request.
Format: int64
Type: string
Location: path
Required: Yes
Path: userprofiles/{profileId}/advertiserGroups
HTTP Method: PUT
Description: Updates an existing advertiser group.
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/advertiserGroups
▼ ▲ dfareporting.advertiserGroups.patch
Description: Updates an existing advertiser group. This method supports patch semantics.
Path: userprofiles/{profileId}/advertiserGroups
Flat Path: userprofiles/{profileId}/advertiserGroups
Parameter Order:
Parameters:
profileId
Required: Yes
Location: path
Format: int64
Description: User profile ID associated with this request.
Type: string
id
Location: query
Type: string
Format: int64
Description: AdvertiserGroup ID.
Required: Yes
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: PATCH
▼ ▲ dfareporting.advertiserGroups.get
Parameter Order:
Flat Path: userprofiles/{profileId}/advertiserGroups/{id}
HTTP Method: GET
Parameters:
profileId
Required: Yes
Location: path
Type: string
Format: int64
Description: User profile ID associated with this request.
id
Description: Advertiser group ID.
Format: int64
Type: string
Location: path
Required: Yes
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Gets one advertiser group by ID.
Path: userprofiles/{profileId}/advertiserGroups/{id}
▼ ▲ dfareporting.advertiserGroups.delete
Parameters:
id
Location: path
Required: Yes
Format: int64
Description: Advertiser group ID.
Type: string
profileId
Required: Yes
Location: path
Format: int64
Type: string
Description: User profile ID associated with this request.
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/advertiserGroups/{id}
Path: userprofiles/{profileId}/advertiserGroups/{id}
Parameter Order:
Description: Deletes an existing advertiser group.
▼ ▲ dfareporting.advertiserGroups.list
HTTP Method: GET
Path: userprofiles/{profileId}/advertiserGroups
Description: Retrieves a list of advertiser groups, possibly filtered. This method supports paging.
Parameter Order: profileId
Parameters:
profileId
Description: User profile ID associated with this request.
Location: path
Format: int64
Required: Yes
Type: string
sortField
Location: query
Default: ID
Enum Descriptions:
Enum:
Description: Field by which to sort the list.
Type: string
pageToken
Location: query
Description: Value of the nextPageToken from the previous result page.
Type: string
searchString
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".
Type: string
Location: query
ids
Description: Select only advertiser groups with these IDs.
Repeated: Yes
Location: query
Format: int64
Type: string
maxResults
Default: 1000
Description: Maximum number of results to return.
Location: query
Maximum: 1000
Minimum: 0
Type: integer
Format: int32
sortOrder
Enum:
Location: query
Default: ASCENDING
Description: Order of sorted results.
Enum Descriptions:
Type: string
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/advertiserGroups
▼ ▲ dfareporting.campaigns.update
Description: Updates an existing campaign.
Flat Path: userprofiles/{profileId}/campaigns
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Type: string
Description: User profile ID associated with this request.
Location: path
Required: Yes
Format: int64
Path: userprofiles/{profileId}/campaigns
Parameter Order: profileId
HTTP Method: PUT
▼ ▲ dfareporting.campaigns.list
Flat Path: userprofiles/{profileId}/campaigns
Description: Retrieves a list of campaigns, possibly filtered. This method supports paging.
Parameters:
excludedIds
Location: query
Type: string
Format: int64
Description: Exclude campaigns with these IDs.
Repeated: Yes
maxResults
Description: Maximum number of results to return.
Format: int32
Minimum: 0
Default: 1000
Maximum: 1000
Location: query
Type: integer
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
sortOrder
Location: query
Description: Order of sorted results.
Default: ASCENDING
Type: string
Enum:
Enum Descriptions:
archived
Description: Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
Type: boolean
Location: query
atLeastOneOptimizationActivity
Location: query
Type: boolean
Description: Select only campaigns that have at least one optimization activity.
advertiserIds
Description: Select only campaigns that belong to these advertisers.
Type: string
Repeated: Yes
Location: query
Format: int64
sortField
Enum Descriptions:
Description: Field by which to sort the list.
Default: ID
Location: query
Enum:
Type: string
subaccountId
Type: string
Format: int64
Location: query
Description: Select only campaigns that belong to this subaccount.
ids
Repeated: Yes
Location: query
Format: int64
Description: Select only campaigns with these IDs.
Type: string
pageToken
Type: string
Description: Value of the nextPageToken from the previous result page.
Location: query
profileId
Description: User profile ID associated with this request.
Required: Yes
Type: string
Format: int64
Location: path
overriddenEventTagId
Description: Select only campaigns that have overridden this event tag ID.
Location: query
Type: string
Format: int64
advertiserGroupIds
Type: string
Format: int64
Location: query
Description: Select only campaigns whose advertisers belong to these advertiser groups.
Repeated: Yes
Path: userprofiles/{profileId}/campaigns
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: GET
Parameter Order: profileId
▼ ▲ dfareporting.campaigns.patch
Description: Updates an existing campaign. This method supports patch semantics.
Parameter Order:
Parameters:
profileId
Location: path
Format: int64
Description: User profile ID associated with this request.
Type: string
Required: Yes
id
Description: Campaign ID.
Location: query
Format: int64
Type: string
Required: Yes
Path: userprofiles/{profileId}/campaigns
HTTP Method: PATCH
Flat Path: userprofiles/{profileId}/campaigns
▼ ▲ dfareporting.campaigns.insert
Flat Path: userprofiles/{profileId}/campaigns
Path: userprofiles/{profileId}/campaigns
Parameter Order: profileId
Description: Inserts a new campaign.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Required: Yes
Description: User profile ID associated with this request.
Location: path
Type: string
Format: int64
HTTP Method: POST
▼ ▲ dfareporting.campaigns.get
Parameters:
id
Description: Campaign ID.
Type: string
Location: path
Format: int64
Required: Yes
profileId
Description: User profile ID associated with this request.
Location: path
Type: string
Format: int64
Required: Yes
Description: Gets one campaign by ID.
HTTP Method: GET
Flat Path: userprofiles/{profileId}/campaigns/{id}
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order:
Path: userprofiles/{profileId}/campaigns/{id}
▼ ▲ dfareporting.creativeFields.get
Flat Path: userprofiles/{profileId}/creativeFields/{id}
HTTP Method: GET
Parameters:
profileId
Location: path
Format: int64
Type: string
Description: User profile ID associated with this request.
Required: Yes
id
Required: Yes
Type: string
Description: Creative Field ID
Location: path
Format: int64
Path: userprofiles/{profileId}/creativeFields/{id}
Description: Gets one creative field by ID.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order:
▼ ▲ dfareporting.creativeFields.list
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/creativeFields
Parameter Order: profileId
Path: userprofiles/{profileId}/creativeFields
Parameters:
sortOrder
Location: query
Type: string
Description: Order of sorted results.
Default: ASCENDING
Enum:
Enum Descriptions:
searchString
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".
Location: query
advertiserIds
Format: int64
Location: query
Type: string
Description: Select only creative fields that belong to these advertisers.
Repeated: Yes
sortField
Type: string
Enum Descriptions:
Enum:
Description: Field by which to sort the list.
Location: query
Default: ID
pageToken
Type: string
Location: query
Description: Value of the nextPageToken from the previous result page.
maxResults
Format: int32
Maximum: 1000
Default: 1000
Type: integer
Description: Maximum number of results to return.
Location: query
Minimum: 0
ids
Description: Select only creative fields with these IDs.
Repeated: Yes
Location: query
Format: int64
Type: string
profileId
Required: Yes
Format: int64
Type: string
Description: User profile ID associated with this request.
Location: path
Description: Retrieves a list of creative fields, possibly filtered. This method supports paging.
▼ ▲ dfareporting.creativeFields.update
HTTP Method: PUT
Flat Path: userprofiles/{profileId}/creativeFields
Path: userprofiles/{profileId}/creativeFields
Description: Updates an existing creative field.
Parameters:
profileId
Format: int64
Required: Yes
Description: User profile ID associated with this request.
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order: profileId
▼ ▲ dfareporting.creativeFields.patch
Description: Updates an existing creative field. This method supports patch semantics.
HTTP Method: PATCH
Flat Path: userprofiles/{profileId}/creativeFields
Parameters:
profileId
Type: string
Location: path
Description: User profile ID associated with this request.
Required: Yes
Format: int64
id
Location: query
Description: CreativeField ID.
Type: string
Format: int64
Required: Yes
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/creativeFields
Parameter Order:
▼ ▲ dfareporting.creativeFields.delete
Path: userprofiles/{profileId}/creativeFields/{id}
Description: Deletes an existing creative field.
Parameter Order:
Flat Path: userprofiles/{profileId}/creativeFields/{id}
Parameters:
profileId
Description: User profile ID associated with this request.
Required: Yes
Type: string
Location: path
Format: int64
id
Format: int64
Type: string
Required: Yes
Description: Creative Field ID
Location: path
HTTP Method: DELETE
▼ ▲ dfareporting.creativeFields.insert
Parameter Order: profileId
Description: Inserts a new creative field.
Parameters:
profileId
Description: User profile ID associated with this request.
Type: string
Location: path
Required: Yes
Format: int64
Flat Path: userprofiles/{profileId}/creativeFields
Path: userprofiles/{profileId}/creativeFields
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: POST
▼ ▲ dfareporting.placements.insert
Parameters:
profileId
Description: User profile ID associated with this request.
Location: path
Type: string
Required: Yes
Format: int64
Parameter Order: profileId
Description: Inserts a new placement.
HTTP Method: POST
Flat Path: userprofiles/{profileId}/placements
Path: userprofiles/{profileId}/placements
▼ ▲ dfareporting.placements.patch
Path: userprofiles/{profileId}/placements
Flat Path: userprofiles/{profileId}/placements
Description: Updates an existing placement. This method supports patch semantics.
Parameters:
id
Required: Yes
Format: int64
Description: Placement ID.
Type: string
Location: query
profileId
Format: int64
Description: User profile ID associated with this request.
Required: Yes
Type: string
Location: path
Parameter Order:
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: PATCH
▼ ▲ dfareporting.placements.get
Flat Path: userprofiles/{profileId}/placements/{id}
Parameter Order:
Path: userprofiles/{profileId}/placements/{id}
Description: Gets one placement by ID.
HTTP Method: GET
Parameters:
profileId
Required: Yes
Format: int64
Description: User profile ID associated with this request.
Type: string
Location: path
id
Type: string
Description: Placement ID.
Format: int64
Required: Yes
Location: path
▼ ▲ dfareporting.placements.list
Parameters:
sizeIds
Description: Select only placements that are associated with these sizes.
Type: string
Format: int64
Repeated: Yes
Location: query
placementStrategyIds
Format: int64
Type: string
Description: Select only placements that are associated with these placement strategies.
Location: query
Repeated: Yes
sortOrder
Enum:
Description: Order of sorted results.
Location: query
Enum Descriptions:
Default: ASCENDING
Type: string
compatibilities
Enum:
Repeated: Yes
Location: query
Type: string
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:
advertiserIds
Type: string
Location: query
Description: Select only placements that belong to these advertisers.
Repeated: Yes
Format: int64
directorySiteIds
Repeated: Yes
Location: query
Format: int64
Description: Select only placements that are associated with these directory sites.
Type: string
siteIds
Type: string
Format: int64
Repeated: Yes
Description: Select only placements that are associated with these sites.
Location: query
maxStartDate
Location: query
Type: string
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".
paymentSource
Enum Descriptions:
Description: Select only placements with this payment source.
Type: string
Location: query
Enum:
archived
Location: query
Description: Select only archived placements. Don't set this field to select both archived and non-archived placements.
Type: boolean
contentCategoryIds
Format: int64
Repeated: Yes
Location: query
Type: string
Description: Select only placements that are associated with these content categories.
maxResults
Format: int32
Description: Maximum number of results to return.
Type: integer
Maximum: 1000
Default: 1000
Location: query
Minimum: 0
pricingTypes
Enum Descriptions:
Type: string
Location: query
Description: Select only placements with these pricing types.
Enum:
Repeated: Yes
campaignIds
Description: Select only placements that belong to these campaigns.
Location: query
Format: int64
Type: string
Repeated: Yes
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".
pageToken
Location: query
Type: string
Description: Value of the nextPageToken from the previous result page.
minEndDate
Type: string
Location: query
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".
profileId
Description: User profile ID associated with this request.
Required: Yes
Location: path
Format: int64
Type: string
searchString
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" .
Location: query
groupIds
Description: Select only placements that belong to these placement groups.
Type: string
Location: query
Format: int64
Repeated: Yes
sortField
Location: query
Type: string
Default: ID
Enum:
Description: Field by which to sort the list.
Enum Descriptions:
ids
Location: query
Format: int64
Type: string
Repeated: Yes
Description: Select only placements with these IDs.
maxEndDate
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".
Location: query
Flat Path: userprofiles/{profileId}/placements
Path: userprofiles/{profileId}/placements
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Retrieves a list of placements, possibly filtered. This method supports paging.
HTTP Method: GET
Parameter Order: profileId
▼ ▲ dfareporting.placements.update
Flat Path: userprofiles/{profileId}/placements
Parameter Order: profileId
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Format: int64
Description: User profile ID associated with this request.
Type: string
Location: path
Required: Yes
Description: Updates an existing placement.
Path: userprofiles/{profileId}/placements
HTTP Method: PUT
▼ ▲ dfareporting.placements.generatetags
HTTP Method: POST
Path: userprofiles/{profileId}/placements/generatetags
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/placements/generatetags
Parameters:
campaignId
Location: query
Format: int64
Type: string
Description: Generate placements belonging to this campaign. This is a required field.
tagFormats
Location: query
Enum Descriptions:
Description: Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements.
Repeated: Yes
Enum:
Type: string
placementIds
Repeated: Yes
Description: Generate tags for these placements.
Location: query
Type: string
Format: int64
profileId
Required: Yes
Type: string
Description: User profile ID associated with this request.
Format: int64
Location: path
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Generates tags for a placement.
▼ ▲ dfareporting.mobileApps.list
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
searchString
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".
Location: query
pageToken
Type: string
Location: query
Description: Value of the nextPageToken from the previous result page.
maxResults
Location: query
Type: integer
Minimum: 0
Maximum: 1000
Default: 1000
Description: Maximum number of results to return.
Format: int32
ids
Description: Select only apps with these IDs.
Repeated: Yes
Type: string
Location: query
directories
Repeated: Yes
Enum Descriptions:
Type: string
Location: query
Description: Select only apps from these directories.
Enum:
profileId
Description: User profile ID associated with this request.
Location: path
Type: string
Format: int64
Required: Yes
Parameter Order: profileId
Description: Retrieves list of available mobile apps.
Flat Path: userprofiles/{profileId}/mobileApps
HTTP Method: GET
Path: userprofiles/{profileId}/mobileApps
▼ ▲ dfareporting.mobileApps.get
Path: userprofiles/{profileId}/mobileApps/{id}
Parameter Order:
HTTP Method: GET
Parameters:
id
Type: string
Required: Yes
Description: Mobile app ID.
Location: path
profileId
Type: string
Format: int64
Required: Yes
Location: path
Description: User profile ID associated with this request.
Flat Path: userprofiles/{profileId}/mobileApps/{id}
Description: Gets one mobile app by ID.
▼ ▲ dfareporting.regions.list
Description: Retrieves a list of regions.
Path: userprofiles/{profileId}/regions
Parameter Order: profileId
Parameters:
profileId
Description: User profile ID associated with this request.
Format: int64
Location: path
Required: Yes
Type: string
HTTP Method: GET
Flat Path: userprofiles/{profileId}/regions
▼ ▲ dfareporting.directorySites.get
Path: userprofiles/{profileId}/directorySites/{id}
Parameter Order:
Parameters:
profileId
Required: Yes
Format: int64
Type: string
Description: User profile ID associated with this request.
Location: path
id
Required: Yes
Description: Directory site ID.
Type: string
Format: int64
Location: path
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/directorySites/{id}
HTTP Method: GET
Description: Gets one directory site by ID.
▼ ▲ dfareporting.directorySites.list
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/directorySites
Path: userprofiles/{profileId}/directorySites
HTTP Method: GET
Parameters:
acceptsPublisherPaidPlacements
Description: Select only directory sites that accept publisher paid placements. This field can be left blank.
Location: query
Type: boolean
maxResults
Default: 1000
Type: integer
Description: Maximum number of results to return.
Minimum: 0
Maximum: 1000
Format: int32
Location: query
ids
Repeated: Yes
Description: Select only directory sites with these IDs.
Format: int64
Type: string
Location: query
active
Location: query
Description: Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
Type: boolean
acceptsInStreamVideoPlacements
Description: This search filter is no longer supported and will have no effect on the results returned.
Location: query
Type: boolean
acceptsInterstitialPlacements
Location: query
Type: boolean
Description: This search filter is no longer supported and will have no effect on the results returned.
pageToken
Location: query
Type: string
Description: Value of the nextPageToken from the previous result page.
searchString
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
Type: string
sortField
Default: ID
Location: query
Type: string
Enum:
Description: Field by which to sort the list.
Enum Descriptions:
dfpNetworkCode
Location: query
Description: Select only directory sites with this Ad Manager network code.
Type: string
sortOrder
Location: query
Enum:
Default: ASCENDING
Type: string
Description: Order of sorted results.
Enum Descriptions:
profileId
Location: path
Description: User profile ID associated with this request.
Type: string
Required: Yes
Format: int64
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Retrieves a list of directory sites, possibly filtered. This method supports paging.
▼ ▲ dfareporting.directorySites.insert
Parameters:
profileId
Format: int64
Description: User profile ID associated with this request.
Location: path
Required: Yes
Type: string
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/directorySites
Description: Inserts a new directory site.
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/directorySites
▼ ▲ dfareporting.reports.files.list
Path: userprofiles/{profileId}/reports/{reportId}/files
Description: Lists files for a report.
Scopes: https://www.googleapis.com/auth/dfareporting
HTTP Method: GET
Parameter Order:
Flat Path: userprofiles/{profileId}/reports/{reportId}/files
Parameters:
pageToken
Type: string
Description: The value of the nextToken from the previous result page.
Location: query
maxResults
Type: integer
Location: query
Format: int32
Description: Maximum number of results to return.
Default: 10
Maximum: 10
Minimum: 0
profileId
Location: path
Required: Yes
Description: The Campaign Manager 360 user profile ID.
Type: string
Format: int64
sortOrder
Default: DESCENDING
Enum Descriptions:
Enum:
Description: Order of sorted results.
Location: query
Type: string
reportId
Location: path
Description: The ID of the parent report.
Format: int64
Required: Yes
Type: string
sortField
Enum Descriptions:
Location: query
Type: string
Default: LAST_MODIFIED_TIME
Enum:
Description: The field by which to sort the list.
▼ ▲ dfareporting.reports.files.get
Scopes: https://www.googleapis.com/auth/dfareporting
Parameter Order:
HTTP Method: GET
Flat Path: userprofiles/{profileId}/reports/{reportId}/files/{fileId}
Path: userprofiles/{profileId}/reports/{reportId}/files/{fileId}
Parameters:
reportId
Location: path
Description: The ID of the report.
Required: Yes
Type: string
Format: int64
fileId
Location: path
Description: The ID of the report file.
Format: int64
Required: Yes
Type: string
profileId
Location: path
Type: string
Description: The Campaign Manager 360 user profile ID.
Format: int64
Required: Yes
Supportsmediadownload: Yes
Description: Retrieves a report file by its report ID and file ID. This method supports media download.
▼ ▲ dfareporting.reports.compatibleFields.query
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.
Flat Path: userprofiles/{profileId}/reports/compatiblefields/query
HTTP Method: POST
Parameters:
profileId
Description: The Campaign Manager 360 user profile ID.
Type: string
Required: Yes
Format: int64
Location: path
Parameter Order: profileId
Scopes: https://www.googleapis.com/auth/dfareporting
Path: userprofiles/{profileId}/reports/compatiblefields/query
▼ ▲ dfareporting.reports.list
Path: userprofiles/{profileId}/reports
Parameter Order: profileId
Parameters:
pageToken
Description: The value of the nextToken from the previous result page.
Type: string
Location: query
scope
Default: MINE
Enum:
Description: The scope that defines which results are returned.
Type: string
Enum Descriptions:
Location: query
maxResults
Description: Maximum number of results to return.
Default: 10
Format: int32
Type: integer
Maximum: 10
Minimum: 0
Location: query
profileId
Required: Yes
Type: string
Format: int64
Location: path
Description: The Campaign Manager 360 user profile ID.
sortField
Location: query
Enum Descriptions:
Type: string
Enum:
Description: The field by which to sort the list.
Default: LAST_MODIFIED_TIME
sortOrder
Enum:
Enum Descriptions:
Description: Order of sorted results.
Default: DESCENDING
Type: string
Location: query
Description: Retrieves list of reports.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/dfareporting
Flat Path: userprofiles/{profileId}/reports
▼ ▲ dfareporting.reports.insert
Path: userprofiles/{profileId}/reports
Parameters:
profileId
Type: string
Location: path
Required: Yes
Description: The Campaign Manager 360 user profile ID.
Format: int64
Parameter Order: profileId
HTTP Method: POST
Description: Creates a report.
Scopes: https://www.googleapis.com/auth/dfareporting
Flat Path: userprofiles/{profileId}/reports
▼ ▲ dfareporting.reports.update
Parameter Order:
Description: Updates a report.
HTTP Method: PUT
Flat Path: userprofiles/{profileId}/reports/{reportId}
Scopes: https://www.googleapis.com/auth/dfareporting
Path: userprofiles/{profileId}/reports/{reportId}
Parameters:
profileId
Type: string
Location: path
Format: int64
Description: The Campaign Manager 360 user profile ID.
Required: Yes
reportId
Type: string
Format: int64
Required: Yes
Description: The ID of the report.
Location: path
▼ ▲ dfareporting.reports.get
HTTP Method: GET
Path: userprofiles/{profileId}/reports/{reportId}
Parameters:
profileId
Type: string
Format: int64
Required: Yes
Description: The Campaign Manager 360 user profile ID.
Location: path
reportId
Location: path
Required: Yes
Format: int64
Description: The ID of the report.
Type: string
Flat Path: userprofiles/{profileId}/reports/{reportId}
Scopes: https://www.googleapis.com/auth/dfareporting
Description: Retrieves a report by its ID.
Parameter Order:
▼ ▲ dfareporting.reports.patch
Parameter Order:
Parameters:
reportId
Type: string
Required: Yes
Format: int64
Description: The ID of the report.
Location: path
profileId
Type: string
Required: Yes
Location: path
Format: int64
Description: The DFA user profile ID.
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/dfareporting
Description: Updates an existing report. This method supports patch semantics.
Path: userprofiles/{profileId}/reports/{reportId}
Flat Path: userprofiles/{profileId}/reports/{reportId}
▼ ▲ dfareporting.reports.delete
Flat Path: userprofiles/{profileId}/reports/{reportId}
HTTP Method: DELETE
Description: Deletes a report by its ID.
Path: userprofiles/{profileId}/reports/{reportId}
Parameter Order:
Scopes: https://www.googleapis.com/auth/dfareporting
Parameters:
profileId
Required: Yes
Description: The Campaign Manager 360 user profile ID.
Location: path
Type: string
Format: int64
reportId
Location: path
Format: int64
Description: The ID of the report.
Type: string
Required: Yes
▼ ▲ dfareporting.reports.run
Path: userprofiles/{profileId}/reports/{reportId}/run
Flat Path: userprofiles/{profileId}/reports/{reportId}/run
HTTP Method: POST
Description: Runs a report.
Parameters:
synchronous
Type: boolean
Description: If set and true, tries to run the report synchronously.
Default: false
Location: query
profileId
Required: Yes
Description: The Campaign Manager 360 user profile ID.
Type: string
Location: path
Format: int64
reportId
Location: path
Required: Yes
Format: int64
Description: The ID of the report.
Type: string
Parameter Order:
▼ ▲ dfareporting.accountPermissions.list
HTTP Method: GET
Path: userprofiles/{profileId}/accountPermissions
Description: Retrieves the list of account permissions.
Parameter Order: profileId
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/accountPermissions
Parameters:
profileId
Description: User profile ID associated with this request.
Location: path
Required: Yes
Type: string
Format: int64
▼ ▲ dfareporting.accountPermissions.get
Flat Path: userprofiles/{profileId}/accountPermissions/{id}
Description: Gets one account permission by ID.
Parameters:
profileId
Location: path
Type: string
Description: User profile ID associated with this request.
Required: Yes
Format: int64
id
Format: int64
Required: Yes
Location: path
Type: string
Description: Account permission ID.
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: GET
Path: userprofiles/{profileId}/accountPermissions/{id}
Parameter Order:
▼ ▲ dfareporting.platformTypes.get
HTTP Method: GET
Path: userprofiles/{profileId}/platformTypes/{id}
Description: Gets one platform type by ID.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Type: string
Required: Yes
Description: User profile ID associated with this request.
Location: path
Format: int64
id
Location: path
Type: string
Format: int64
Required: Yes
Description: Platform type ID.
Flat Path: userprofiles/{profileId}/platformTypes/{id}
Parameter Order:
▼ ▲ dfareporting.platformTypes.list
Parameter Order: profileId
HTTP Method: GET
Description: Retrieves a list of platform types.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/platformTypes
Parameters:
profileId
Type: string
Required: Yes
Description: User profile ID associated with this request.
Location: path
Format: int64
Flat Path: userprofiles/{profileId}/platformTypes
▼ ▲ dfareporting.cities.list
Parameters:
dartIds
Description: Select only cities with these DART IDs.
Type: string
Repeated: Yes
Format: int64
Location: query
countryDartIds
Format: int64
Description: Select only cities from these countries.
Type: string
Repeated: Yes
Location: query
profileId
Description: User profile ID associated with this request.
Required: Yes
Location: path
Format: int64
Type: string
namePrefix
Location: query
Description: Select only cities with names starting with this prefix.
Type: string
regionDartIds
Description: Select only cities from these regions.
Type: string
Repeated: Yes
Format: int64
Location: query
Flat Path: userprofiles/{profileId}/cities
Description: Retrieves a list of cities, possibly filtered.
Parameter Order: profileId
HTTP Method: GET
Path: userprofiles/{profileId}/cities
▼ ▲ dfareporting.floodlightActivities.update
Parameters:
profileId
Required: Yes
Type: string
Location: path
Description: User profile ID associated with this request.
Format: int64
Flat Path: userprofiles/{profileId}/floodlightActivities
HTTP Method: PUT
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/floodlightActivities
Description: Updates an existing floodlight activity.
Parameter Order: profileId
▼ ▲ dfareporting.floodlightActivities.get
Parameters:
profileId
Required: Yes
Location: path
Format: int64
Description: User profile ID associated with this request.
Type: string
id
Description: Floodlight activity ID.
Required: Yes
Format: int64
Type: string
Location: path
Parameter Order:
Description: Gets one floodlight activity by ID.
Path: userprofiles/{profileId}/floodlightActivities/{id}
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: GET
Flat Path: userprofiles/{profileId}/floodlightActivities/{id}
▼ ▲ dfareporting.floodlightActivities.patch
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/floodlightActivities
Parameters:
profileId
Required: Yes
Type: string
Description: User profile ID associated with this request.
Format: int64
Location: path
id
Type: string
Format: int64
Required: Yes
Description: FloodlightActivity ID.
Location: query
Parameter Order:
HTTP Method: PATCH
Description: Updates an existing floodlight activity. This method supports patch semantics.
Flat Path: userprofiles/{profileId}/floodlightActivities
▼ ▲ dfareporting.floodlightActivities.list
Parameters:
pageToken
Type: string
Description: Value of the nextPageToken from the previous result page.
Location: query
sortField
Description: Field by which to sort the list.
Default: ID
Location: query
Type: string
Enum Descriptions:
Enum:
maxResults
Maximum: 1000
Description: Maximum number of results to return.
Location: query
Format: int32
Minimum: 0
Type: integer
Default: 1000
floodlightActivityGroupTagString
Type: string
Location: query
Description: Select only floodlight activities with the specified floodlight activity group tag string.
floodlightActivityGroupIds
Repeated: Yes
Type: string
Format: int64
Description: Select only floodlight activities with the specified floodlight activity group IDs.
Location: query
floodlightActivityGroupName
Location: query
Type: string
Description: Select only floodlight activities with the specified floodlight activity group name.
profileId
Format: int64
Location: path
Description: User profile ID associated with this request.
Type: string
Required: Yes
sortOrder
Enum Descriptions:
Type: string
Default: ASCENDING
Description: Order of sorted results.
Enum:
Location: query
floodlightConfigurationId
Location: query
Format: int64
Type: string
Description: Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
searchString
Type: string
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".
Location: query
floodlightActivityGroupType
Enum:
Enum Descriptions:
Type: string
Description: Select only floodlight activities with the specified floodlight activity group type.
Location: query
ids
Type: string
Repeated: Yes
Format: int64
Location: query
Description: Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
advertiserId
Location: query
Format: int64
Type: string
Description: Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
tagString
Location: query
Description: Select only floodlight activities with the specified tag string.
Type: string
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/floodlightActivities
Path: userprofiles/{profileId}/floodlightActivities
HTTP Method: GET
Description: Retrieves a list of floodlight activities, possibly filtered. This method supports paging.
▼ ▲ dfareporting.floodlightActivities.delete
Description: Deletes an existing floodlight activity.
Flat Path: userprofiles/{profileId}/floodlightActivities/{id}
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
id
Description: Floodlight activity ID.
Required: Yes
Type: string
Format: int64
Location: path
profileId
Format: int64
Description: User profile ID associated with this request.
Required: Yes
Type: string
Location: path
Path: userprofiles/{profileId}/floodlightActivities/{id}
Parameter Order:
▼ ▲ dfareporting.floodlightActivities.generatetag
HTTP Method: POST
Description: Generates a tag for a floodlight activity.
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/floodlightActivities/generatetag
Path: userprofiles/{profileId}/floodlightActivities/generatetag
Parameters:
floodlightActivityId
Type: string
Location: query
Format: int64
Description: Floodlight activity ID for which we want to generate a tag.
profileId
Required: Yes
Format: int64
Type: string
Location: path
Description: User profile ID associated with this request.
▼ ▲ dfareporting.floodlightActivities.insert
Description: Inserts a new floodlight activity.
Parameter Order: profileId
Path: userprofiles/{profileId}/floodlightActivities
HTTP Method: POST
Parameters:
profileId
Required: Yes
Location: path
Type: string
Description: User profile ID associated with this request.
Format: int64
Flat Path: userprofiles/{profileId}/floodlightActivities
▼ ▲ dfareporting.accountUserProfiles.update
Path: userprofiles/{profileId}/accountUserProfiles
Parameter Order: profileId
Description: Updates an existing account user profile.
Flat Path: userprofiles/{profileId}/accountUserProfiles
Parameters:
profileId
Description: User profile ID associated with this request.
Required: Yes
Format: int64
Location: path
Type: string
HTTP Method: PUT
▼ ▲ dfareporting.accountUserProfiles.list
Path: userprofiles/{profileId}/accountUserProfiles
Parameters:
profileId
Location: path
Type: string
Description: User profile ID associated with this request.
Format: int64
Required: Yes
active
Description: Select only active user profiles.
Type: boolean
Location: query
userRoleId
Description: Select only user profiles with the specified user role ID.
Location: query
Format: int64
Type: string
ids
Format: int64
Location: query
Repeated: Yes
Description: Select only user profiles with these IDs.
Type: string
sortOrder
Type: string
Default: ASCENDING
Enum:
Location: query
Enum Descriptions:
Description: Order of sorted results.
sortField
Location: query
Default: ID
Enum Descriptions:
Enum:
Type: string
Description: Field by which to sort the list.
subaccountId
Format: int64
Type: string
Location: query
Description: Select only user profiles with the specified subaccount ID.
maxResults
Format: int32
Maximum: 1000
Description: Maximum number of results to return.
Default: 1000
Type: integer
Minimum: 0
Location: query
pageToken
Type: string
Description: Value of the nextPageToken from the previous result page.
Location: query
searchString
Location: query
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".
Type: string
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Retrieves a list of account user profiles, possibly filtered. This method supports paging.
Flat Path: userprofiles/{profileId}/accountUserProfiles
Parameter Order: profileId
▼ ▲ dfareporting.accountUserProfiles.insert
HTTP Method: POST
Flat Path: userprofiles/{profileId}/accountUserProfiles
Parameters:
profileId
Required: Yes
Location: path
Type: string
Format: int64
Description: User profile ID associated with this request.
Description: Inserts a new account user profile.
Parameter Order: profileId
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/accountUserProfiles
▼ ▲ dfareporting.accountUserProfiles.get
Parameter Order:
Description: Gets one account user profile by ID.
Flat Path: userprofiles/{profileId}/accountUserProfiles/{id}
Parameters:
profileId
Description: User profile ID associated with this request.
Location: path
Type: string
Format: int64
Required: Yes
id
Required: Yes
Description: User profile ID.
Format: int64
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/accountUserProfiles/{id}
HTTP Method: GET
▼ ▲ dfareporting.accountUserProfiles.patch
Flat Path: userprofiles/{profileId}/accountUserProfiles
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/accountUserProfiles
Description: Updates an existing account user profile. This method supports patch semantics.
Parameters:
profileId
Type: string
Format: int64
Required: Yes
Description: User profile ID associated with this request.
Location: path
id
Required: Yes
Type: string
Format: int64
Location: query
Description: AccountUserProfile ID.
Parameter Order:
HTTP Method: PATCH
▼ ▲ dfareporting.creativeAssets.insert
Mediaupload:
Maxsize: 1073741824
Accept: */*
Protocols:
Simple:
Multipart: Yes
Path: /upload/dfareporting/v3.5/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets
Scopes: https://www.googleapis.com/auth/dfatrafficking
Supportsmediaupload: Yes
Flat Path: userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets
Path: userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets
Parameter Order:
Description: Inserts a new creative asset.
HTTP Method: POST
Parameters:
profileId
Location: path
Description: User profile ID associated with this request.
Type: string
Format: int64
Required: Yes
advertiserId
Type: string
Location: path
Description: Advertiser ID of this creative. This is a required field.
Required: Yes
Format: int64
▼ ▲ dfareporting.connectionTypes.get
Description: Gets one connection type by ID.
Parameters:
id
Description: Connection type ID.
Required: Yes
Type: string
Location: path
Format: int64
profileId
Format: int64
Location: path
Type: string
Required: Yes
Description: User profile ID associated with this request.
Parameter Order:
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/connectionTypes/{id}
HTTP Method: GET
Path: userprofiles/{profileId}/connectionTypes/{id}
▼ ▲ dfareporting.connectionTypes.list
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order: profileId
Parameters:
profileId
Type: string
Required: Yes
Description: User profile ID associated with this request.
Location: path
Format: int64
Flat Path: userprofiles/{profileId}/connectionTypes
HTTP Method: GET
Path: userprofiles/{profileId}/connectionTypes
Description: Retrieves a list of connection types.
▼ ▲ dfareporting.floodlightActivityGroups.insert
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/floodlightActivityGroups
Description: Inserts a new floodlight activity group.
Parameters:
profileId
Required: Yes
Location: path
Type: string
Description: User profile ID associated with this request.
Format: int64
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/floodlightActivityGroups
HTTP Method: POST
▼ ▲ dfareporting.floodlightActivityGroups.list
Description: Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.
Flat Path: userprofiles/{profileId}/floodlightActivityGroups
Parameters:
sortOrder
Description: Order of sorted results.
Enum Descriptions:
Default: ASCENDING
Location: query
Type: string
Enum:
type
Location: query
Description: Select only floodlight activity groups with the specified floodlight activity group type.
Enum Descriptions:
Type: string
Enum:
floodlightConfigurationId
Location: query
Type: string
Description: Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.
Format: int64
advertiserId
Format: int64
Type: string
Description: Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
Location: query
ids
Format: int64
Description: Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
Type: string
Repeated: Yes
Location: query
profileId
Type: string
Description: User profile ID associated with this request.
Location: path
Format: int64
Required: Yes
pageToken
Location: query
Type: string
Description: Value of the nextPageToken from the previous result page.
searchString
Type: string
Location: query
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".
maxResults
Location: query
Minimum: 0
Default: 1000
Description: Maximum number of results to return.
Type: integer
Format: int32
Maximum: 1000
sortField
Location: query
Default: ID
Enum:
Enum Descriptions:
Type: string
Description: Field by which to sort the list.
Path: userprofiles/{profileId}/floodlightActivityGroups
Parameter Order: profileId
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: GET
▼ ▲ dfareporting.floodlightActivityGroups.get
Flat Path: userprofiles/{profileId}/floodlightActivityGroups/{id}
Parameters:
id
Location: path
Description: Floodlight activity Group ID.
Required: Yes
Format: int64
Type: string
profileId
Format: int64
Location: path
Type: string
Required: Yes
Description: User profile ID associated with this request.
Description: Gets one floodlight activity group by ID.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order:
Path: userprofiles/{profileId}/floodlightActivityGroups/{id}
HTTP Method: GET
▼ ▲ dfareporting.floodlightActivityGroups.update
Flat Path: userprofiles/{profileId}/floodlightActivityGroups
Parameter Order: profileId
Parameters:
profileId
Format: int64
Description: User profile ID associated with this request.
Location: path
Type: string
Required: Yes
Path: userprofiles/{profileId}/floodlightActivityGroups
HTTP Method: PUT
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Updates an existing floodlight activity group.
▼ ▲ dfareporting.floodlightActivityGroups.patch
Parameters:
id
Description: FloodlightActivityGroup ID.
Type: string
Required: Yes
Location: query
Format: int64
profileId
Location: path
Type: string
Description: User profile ID associated with this request.
Required: Yes
Format: int64
HTTP Method: PATCH
Path: userprofiles/{profileId}/floodlightActivityGroups
Description: Updates an existing floodlight activity group. This method supports patch semantics.
Parameter Order:
Flat Path: userprofiles/{profileId}/floodlightActivityGroups
▼ ▲ dfareporting.operatingSystems.list
Path: userprofiles/{profileId}/operatingSystems
Description: Retrieves a list of operating systems.
Parameters:
profileId
Required: Yes
Description: User profile ID associated with this request.
Type: string
Location: path
Format: int64
Flat Path: userprofiles/{profileId}/operatingSystems
HTTP Method: GET
Parameter Order: profileId
▼ ▲ dfareporting.operatingSystems.get
HTTP Method: GET
Parameters:
dartId
Type: string
Required: Yes
Location: path
Description: Operating system DART ID.
Format: int64
profileId
Description: User profile ID associated with this request.
Type: string
Location: path
Format: int64
Required: Yes
Parameter Order:
Path: userprofiles/{profileId}/operatingSystems/{dartId}
Flat Path: userprofiles/{profileId}/operatingSystems/{dartId}
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Gets one operating system by DART ID.
▼ ▲ dfareporting.accountPermissionGroups.list
Path: userprofiles/{profileId}/accountPermissionGroups
Parameter Order: profileId
HTTP Method: GET
Parameters:
profileId
Location: path
Format: int64
Type: string
Required: Yes
Description: User profile ID associated with this request.
Description: Retrieves the list of account permission groups.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/accountPermissionGroups
▼ ▲ dfareporting.accountPermissionGroups.get
Parameters:
profileId
Location: path
Type: string
Required: Yes
Description: User profile ID associated with this request.
Format: int64
id
Type: string
Location: path
Format: int64
Description: Account permission group ID.
Required: Yes
Parameter Order:
Flat Path: userprofiles/{profileId}/accountPermissionGroups/{id}
Path: userprofiles/{profileId}/accountPermissionGroups/{id}
Description: Gets one account permission group by ID.
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: GET
▼ ▲ dfareporting.conversions.batchinsert
Parameter Order: profileId
HTTP Method: POST
Path: userprofiles/{profileId}/conversions/batchinsert
Scopes: https://www.googleapis.com/auth/ddmconversions
Flat Path: userprofiles/{profileId}/conversions/batchinsert
Parameters:
profileId
Description: User profile ID associated with this request.
Type: string
Location: path
Format: int64
Required: Yes
Description: Inserts conversions.
▼ ▲ dfareporting.conversions.batchupdate
Parameters:
profileId
Description: User profile ID associated with this request.
Location: path
Type: string
Required: Yes
Format: int64
Flat Path: userprofiles/{profileId}/conversions/batchupdate
Scopes: https://www.googleapis.com/auth/ddmconversions
Path: userprofiles/{profileId}/conversions/batchupdate
Description: Updates existing conversions.
Parameter Order: profileId
HTTP Method: POST
▼ ▲ dfareporting.placementStrategies.patch
Flat Path: userprofiles/{profileId}/placementStrategies
Path: userprofiles/{profileId}/placementStrategies
Parameters:
id
Required: Yes
Format: int64
Type: string
Location: query
Description: PlacementStrategy ID.
profileId
Format: int64
Location: path
Description: User profile ID associated with this request.
Type: string
Required: Yes
Parameter Order:
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: PATCH
Description: Updates an existing placement strategy. This method supports patch semantics.
▼ ▲ dfareporting.placementStrategies.update
Flat Path: userprofiles/{profileId}/placementStrategies
Path: userprofiles/{profileId}/placementStrategies
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Updates an existing placement strategy.
HTTP Method: PUT
Parameter Order: profileId
Parameters:
profileId
Location: path
Required: Yes
Format: int64
Description: User profile ID associated with this request.
Type: string
▼ ▲ dfareporting.placementStrategies.get
Parameter Order:
HTTP Method: GET
Description: Gets one placement strategy by ID.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
id
Location: path
Format: int64
Description: Placement strategy ID.
Required: Yes
Type: string
profileId
Format: int64
Location: path
Description: User profile ID associated with this request.
Type: string
Required: Yes
Flat Path: userprofiles/{profileId}/placementStrategies/{id}
Path: userprofiles/{profileId}/placementStrategies/{id}
▼ ▲ dfareporting.placementStrategies.insert
Parameters:
profileId
Description: User profile ID associated with this request.
Required: Yes
Format: int64
Type: string
Location: path
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order: profileId
Path: userprofiles/{profileId}/placementStrategies
HTTP Method: POST
Description: Inserts a new placement strategy.
Flat Path: userprofiles/{profileId}/placementStrategies
▼ ▲ dfareporting.placementStrategies.list
Description: Retrieves a list of placement strategies, possibly filtered. This method supports paging.
Parameter Order: profileId
HTTP Method: GET
Path: userprofiles/{profileId}/placementStrategies
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
searchString
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".
Location: query
Type: string
ids
Location: query
Format: int64
Description: Select only placement strategies with these IDs.
Repeated: Yes
Type: string
pageToken
Location: query
Description: Value of the nextPageToken from the previous result page.
Type: string
sortField
Default: ID
Description: Field by which to sort the list.
Type: string
Location: query
Enum Descriptions:
Enum:
maxResults
Format: int32
Minimum: 0
Description: Maximum number of results to return.
Default: 1000
Location: query
Type: integer
Maximum: 1000
profileId
Format: int64
Location: path
Required: Yes
Type: string
Description: User profile ID associated with this request.
sortOrder
Enum Descriptions:
Description: Order of sorted results.
Location: query
Default: ASCENDING
Type: string
Enum:
Flat Path: userprofiles/{profileId}/placementStrategies
▼ ▲ dfareporting.placementStrategies.delete
HTTP Method: DELETE
Path: userprofiles/{profileId}/placementStrategies/{id}
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/placementStrategies/{id}
Description: Deletes an existing placement strategy.
Parameters:
profileId
Format: int64
Required: Yes
Location: path
Description: User profile ID associated with this request.
Type: string
id
Type: string
Format: int64
Location: path
Required: Yes
Description: Placement strategy ID.
Parameter Order:
▼ ▲ dfareporting.ads.update
HTTP Method: PUT
Parameter Order: profileId
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/ads
Parameters:
profileId
Location: path
Format: int64
Description: User profile ID associated with this request.
Type: string
Required: Yes
Path: userprofiles/{profileId}/ads
Description: Updates an existing ad.
▼ ▲ dfareporting.ads.patch
HTTP Method: PATCH
Flat Path: userprofiles/{profileId}/ads
Path: userprofiles/{profileId}/ads
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Updates an existing ad. This method supports patch semantics.
Parameters:
profileId
Type: string
Format: int64
Required: Yes
Location: path
Description: User profile ID associated with this request.
id
Required: Yes
Description: Ad ID.
Type: string
Format: int64
Location: query
Parameter Order:
▼ ▲ dfareporting.ads.insert
Description: Inserts a new ad.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/ads
Parameter Order: profileId
Parameters:
profileId
Format: int64
Required: Yes
Type: string
Location: path
Description: User profile ID associated with this request.
Flat Path: userprofiles/{profileId}/ads
HTTP Method: POST
▼ ▲ dfareporting.ads.list
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order: profileId
Path: userprofiles/{profileId}/ads
Description: Retrieves a list of ads, possibly filtered. This method supports paging.
Parameters:
remarketingListIds
Description: Select only ads whose list targeting expression use these remarketing list IDs.
Repeated: Yes
Type: string
Location: query
Format: int64
sslCompliant
Location: query
Description: Select only ads that are SSL-compliant.
Type: boolean
profileId
Type: string
Description: User profile ID associated with this request.
Location: path
Format: int64
Required: Yes
dynamicClickTracker
Location: query
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.
Type: boolean
compatibility
Enum Descriptions:
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.
Location: query
Enum:
Type: string
placementIds
Type: string
Location: query
Repeated: Yes
Description: Select only ads with these placement IDs assigned.
Format: int64
active
Location: query
Description: Select only active ads.
Type: boolean
sortField
Description: Field by which to sort the list.
Enum Descriptions:
Location: query
Enum:
Type: string
Default: ID
campaignIds
Format: int64
Repeated: Yes
Type: string
Description: Select only ads with these campaign IDs.
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".
Location: query
Type: string
sslRequired
Location: query
Type: boolean
Description: Select only ads that require SSL.
maxResults
Location: query
Minimum: 0
Description: Maximum number of results to return.
Default: 1000
Format: int32
Maximum: 1000
Type: integer
type
Description: Select only ads with these types.
Enum:
Location: query
Enum Descriptions:
Type: string
Repeated: Yes
pageToken
Location: query
Type: string
Description: Value of the nextPageToken from the previous result page.
audienceSegmentIds
Type: string
Format: int64
Repeated: Yes
Location: query
Description: Select only ads with these audience segment IDs.
creativeIds
Format: int64
Description: Select only ads with these creative IDs assigned.
Repeated: Yes
Location: query
Type: string
overriddenEventTagId
Format: int64
Location: query
Description: Select only ads with this event tag override ID.
Type: string
ids
Description: Select only ads with these IDs.
Format: int64
Type: string
Location: query
Repeated: Yes
archived
Location: query
Type: boolean
Description: Select only archived ads.
sizeIds
Location: query
Description: Select only ads with these size IDs.
Format: int64
Type: string
Repeated: Yes
creativeOptimizationConfigurationIds
Format: int64
Repeated: Yes
Location: query
Description: Select only ads with these creative optimization configuration IDs.
Type: string
advertiserId
Type: string
Location: query
Description: Select only ads with this advertiser ID.
Format: int64
landingPageIds
Location: query
Description: Select only ads with these landing page IDs.
Type: string
Format: int64
Repeated: Yes
sortOrder
Enum:
Location: query
Default: ASCENDING
Description: Order of sorted results.
Enum Descriptions:
Type: string
HTTP Method: GET
Flat Path: userprofiles/{profileId}/ads
▼ ▲ dfareporting.ads.get
Path: userprofiles/{profileId}/ads/{id}
Parameter Order:
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/ads/{id}
HTTP Method: GET
Description: Gets one ad by ID.
Parameters:
id
Type: string
Description: Ad ID.
Location: path
Required: Yes
Format: int64
profileId
Description: User profile ID associated with this request.
Required: Yes
Location: path
Type: string
Format: int64
▼ ▲ dfareporting.sizes.insert
Description: Inserts a new size.
Parameters:
profileId
Format: int64
Description: User profile ID associated with this request.
Location: path
Type: string
Required: Yes
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/sizes
Parameter Order: profileId
Path: userprofiles/{profileId}/sizes
HTTP Method: POST
▼ ▲ dfareporting.sizes.list
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.
HTTP Method: GET
Parameter Order: profileId
Parameters:
ids
Repeated: Yes
Location: query
Description: Select only sizes with these IDs.
Type: string
Format: int64
iabStandard
Description: Select only IAB standard sizes.
Location: query
Type: boolean
height
Type: integer
Description: Select only sizes with this height.
Location: query
Minimum: 0
Maximum: 32767
Format: int32
profileId
Location: path
Format: int64
Required: Yes
Type: string
Description: User profile ID associated with this request.
width
Minimum: 0
Format: int32
Location: query
Type: integer
Description: Select only sizes with this width.
Maximum: 32767
Flat Path: userprofiles/{profileId}/sizes
Path: userprofiles/{profileId}/sizes
▼ ▲ dfareporting.sizes.get
Parameters:
profileId
Required: Yes
Description: User profile ID associated with this request.
Format: int64
Location: path
Type: string
id
Location: path
Format: int64
Description: Size ID.
Required: Yes
Type: string
Path: userprofiles/{profileId}/sizes/{id}
Description: Gets one size by ID.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/sizes/{id}
Parameter Order:
HTTP Method: GET
▼ ▲ dfareporting.subaccounts.patch
Path: userprofiles/{profileId}/subaccounts
Parameters:
profileId
Type: string
Format: int64
Description: User profile ID associated with this request.
Location: path
Required: Yes
id
Description: Subaccount ID.
Required: Yes
Location: query
Type: string
Format: int64
Parameter Order:
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: PATCH
Flat Path: userprofiles/{profileId}/subaccounts
Description: Updates an existing subaccount. This method supports patch semantics.
▼ ▲ dfareporting.subaccounts.update
Flat Path: userprofiles/{profileId}/subaccounts
Parameters:
profileId
Required: Yes
Description: User profile ID associated with this request.
Format: int64
Location: path
Type: string
Path: userprofiles/{profileId}/subaccounts
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Updates an existing subaccount.
HTTP Method: PUT
Parameter Order: profileId
▼ ▲ dfareporting.subaccounts.insert
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order: profileId
Description: Inserts a new subaccount.
Flat Path: userprofiles/{profileId}/subaccounts
Path: userprofiles/{profileId}/subaccounts
HTTP Method: POST
Parameters:
profileId
Location: path
Type: string
Description: User profile ID associated with this request.
Format: int64
Required: Yes
▼ ▲ dfareporting.subaccounts.get
Parameter Order:
Description: Gets one subaccount by ID.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/subaccounts/{id}
HTTP Method: GET
Parameters:
id
Description: Subaccount ID.
Required: Yes
Format: int64
Location: path
Type: string
profileId
Type: string
Description: User profile ID associated with this request.
Format: int64
Location: path
Required: Yes
Flat Path: userprofiles/{profileId}/subaccounts/{id}
▼ ▲ dfareporting.subaccounts.list
Path: userprofiles/{profileId}/subaccounts
Description: Gets a list of subaccounts, possibly filtered. This method supports paging.
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: GET
Parameters:
maxResults
Location: query
Minimum: 0
Default: 1000
Type: integer
Maximum: 1000
Format: int32
Description: Maximum number of results to return.
sortField
Enum:
Description: Field by which to sort the list.
Type: string
Enum Descriptions:
Default: ID
Location: query
profileId
Description: User profile ID associated with this request.
Type: string
Format: int64
Location: path
Required: Yes
ids
Format: int64
Type: string
Repeated: Yes
Location: query
Description: Select only subaccounts with these IDs.
searchString
Location: query
Type: string
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" .
sortOrder
Description: Order of sorted results.
Enum Descriptions:
Type: string
Default: ASCENDING
Enum:
Location: query
pageToken
Type: string
Location: query
Description: Value of the nextPageToken from the previous result page.
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/subaccounts
▼ ▲ dfareporting.mobileCarriers.list
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Retrieves a list of mobile carriers.
Flat Path: userprofiles/{profileId}/mobileCarriers
Parameter Order: profileId
Parameters:
profileId
Location: path
Description: User profile ID associated with this request.
Format: int64
Required: Yes
Type: string
Path: userprofiles/{profileId}/mobileCarriers
▼ ▲ dfareporting.mobileCarriers.get
Flat Path: userprofiles/{profileId}/mobileCarriers/{id}
Description: Gets one mobile carrier by ID.
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: GET
Parameters:
id
Location: path
Format: int64
Type: string
Description: Mobile carrier ID.
Required: Yes
profileId
Required: Yes
Type: string
Format: int64
Location: path
Description: User profile ID associated with this request.
Parameter Order:
Path: userprofiles/{profileId}/mobileCarriers/{id}
▼ ▲ dfareporting.accountActiveAdSummaries.get
Description: Gets the account's active ad summary by account ID.
Flat Path: userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}
Path: userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Required: Yes
Description: User profile ID associated with this request.
Location: path
Format: int64
Type: string
summaryAccountId
Description: Account ID.
Required: Yes
Format: int64
Location: path
Type: string
HTTP Method: GET
Parameter Order:
▼ ▲ dfareporting.postalCodes.get
Parameters:
profileId
Description: User profile ID associated with this request.
Type: string
Location: path
Format: int64
Required: Yes
code
Required: Yes
Description: Postal code ID.
Location: path
Type: string
Flat Path: userprofiles/{profileId}/postalCodes/{code}
Description: Gets one postal code by ID.
Parameter Order:
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/postalCodes/{code}
HTTP Method: GET
▼ ▲ dfareporting.postalCodes.list
Description: Retrieves a list of postal codes.
Parameters:
profileId
Required: Yes
Description: User profile ID associated with this request.
Location: path
Format: int64
Type: string
HTTP Method: GET
Parameter Order: profileId
Path: userprofiles/{profileId}/postalCodes
Flat Path: userprofiles/{profileId}/postalCodes
▼ ▲ dfareporting.remarketingListShares.update
Parameters:
profileId
Format: int64
Required: Yes
Description: User profile ID associated with this request.
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: PUT
Description: Updates an existing remarketing list share.
Parameter Order: profileId
Flat Path: userprofiles/{profileId}/remarketingListShares
Path: userprofiles/{profileId}/remarketingListShares
▼ ▲ dfareporting.remarketingListShares.patch
Description: Updates an existing remarketing list share. This method supports patch semantics.
Parameters:
profileId
Description: User profile ID associated with this request.
Required: Yes
Location: path
Format: int64
Type: string
id
Type: string
Description: RemarketingList ID.
Location: query
Required: Yes
Format: int64
Flat Path: userprofiles/{profileId}/remarketingListShares
Parameter Order:
Path: userprofiles/{profileId}/remarketingListShares
HTTP Method: PATCH
▼ ▲ dfareporting.remarketingListShares.get
Parameters:
profileId
Required: Yes
Type: string
Description: User profile ID associated with this request.
Format: int64
Location: path
remarketingListId
Description: Remarketing list ID.
Format: int64
Type: string
Location: path
Required: Yes
Description: Gets one remarketing list share by remarketing list ID.
Parameter Order:
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/remarketingListShares/{remarketingListId}
Path: userprofiles/{profileId}/remarketingListShares/{remarketingListId}
HTTP Method: GET
▼ ▲ dfareporting.creativeGroups.get
Description: Gets one creative group by ID.
Parameter Order:
Path: userprofiles/{profileId}/creativeGroups/{id}
Parameters:
id
Location: path
Type: string
Description: Creative group ID.
Format: int64
Required: Yes
profileId
Location: path
Format: int64
Type: string
Description: User profile ID associated with this request.
Required: Yes
HTTP Method: GET
Flat Path: userprofiles/{profileId}/creativeGroups/{id}
▼ ▲ dfareporting.creativeGroups.insert
HTTP Method: POST
Path: userprofiles/{profileId}/creativeGroups
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
profileId
Type: string
Description: User profile ID associated with this request.
Location: path
Format: int64
Required: Yes
Description: Inserts a new creative group.
Flat Path: userprofiles/{profileId}/creativeGroups
Parameter Order: profileId
▼ ▲ dfareporting.creativeGroups.list
Flat Path: userprofiles/{profileId}/creativeGroups
Path: userprofiles/{profileId}/creativeGroups
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameters:
searchString
Location: query
Type: string
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".
ids
Repeated: Yes
Type: string
Description: Select only creative groups with these IDs.
Format: int64
Location: query
pageToken
Type: string
Location: query
Description: Value of the nextPageToken from the previous result page.
sortField
Type: string
Enum:
Enum Descriptions:
Default: ID
Location: query
Description: Field by which to sort the list.
maxResults
Description: Maximum number of results to return.
Default: 1000
Type: integer
Minimum: 0
Maximum: 1000
Format: int32
Location: query
groupNumber
Location: query
Minimum: 1
Format: int32
Type: integer
Maximum: 2
Description: Select only creative groups that belong to this subgroup.
advertiserIds
Description: Select only creative groups that belong to these advertisers.
Format: int64
Location: query
Repeated: Yes
Type: string
profileId
Description: User profile ID associated with this request.
Format: int64
Required: Yes
Type: string
Location: path
sortOrder
Type: string
Enum:
Location: query
Enum Descriptions:
Description: Order of sorted results.
Default: ASCENDING
HTTP Method: GET
Description: Retrieves a list of creative groups, possibly filtered. This method supports paging.
Parameter Order: profileId
▼ ▲ dfareporting.creativeGroups.update
Flat Path: userprofiles/{profileId}/creativeGroups
HTTP Method: PUT
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/creativeGroups
Parameter Order: profileId
Parameters:
profileId
Description: User profile ID associated with this request.
Required: Yes
Format: int64
Location: path
Type: string
Description: Updates an existing creative group.
▼ ▲ dfareporting.creativeGroups.patch
Scopes: https://www.googleapis.com/auth/dfatrafficking
Flat Path: userprofiles/{profileId}/creativeGroups
Description: Updates an existing creative group. This method supports patch semantics.
HTTP Method: PATCH
Parameter Order:
Path: userprofiles/{profileId}/creativeGroups
Parameters:
id
Type: string
Format: int64
Location: query
Description: CreativeGroup ID.
Required: Yes
profileId
Required: Yes
Format: int64
Type: string
Location: path
Description: User profile ID associated with this request.
▼ ▲ dfareporting.contentCategories.list
Path: userprofiles/{profileId}/contentCategories
Parameters:
sortOrder
Enum:
Default: ASCENDING
Location: query
Type: string
Description: Order of sorted results.
Enum Descriptions:
searchString
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
Type: string
sortField
Description: Field by which to sort the list.
Location: query
Enum Descriptions:
Type: string
Default: ID
Enum:
pageToken
Description: Value of the nextPageToken from the previous result page.
Type: string
Location: query
profileId
Required: Yes
Format: int64
Location: path
Description: User profile ID associated with this request.
Type: string
ids
Repeated: Yes
Location: query
Type: string
Format: int64
Description: Select only content categories with these IDs.
maxResults
Type: integer
Format: int32
Maximum: 1000
Default: 1000
Location: query
Minimum: 0
Description: Maximum number of results to return.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Parameter Order: profileId
Description: Retrieves a list of content categories, possibly filtered. This method supports paging.
HTTP Method: GET
Flat Path: userprofiles/{profileId}/contentCategories
▼ ▲ dfareporting.contentCategories.patch
Parameter Order:
Flat Path: userprofiles/{profileId}/contentCategories
Parameters:
id
Description: ContentCategory ID.
Required: Yes
Format: int64
Location: query
Type: string
profileId
Format: int64
Description: User profile ID associated with this request.
Required: Yes
Location: path
Type: string
Description: Updates an existing content category. This method supports patch semantics.
Path: userprofiles/{profileId}/contentCategories
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: PATCH
▼ ▲ dfareporting.contentCategories.delete
HTTP Method: DELETE
Flat Path: userprofiles/{profileId}/contentCategories/{id}
Parameter Order:
Parameters:
id
Description: Content category ID.
Type: string
Location: path
Required: Yes
Format: int64
profileId
Format: int64
Type: string
Required: Yes
Description: User profile ID associated with this request.
Location: path
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Deletes an existing content category.
Path: userprofiles/{profileId}/contentCategories/{id}
▼ ▲ dfareporting.contentCategories.update
Parameter Order: profileId
Scopes: https://www.googleapis.com/auth/dfatrafficking
Path: userprofiles/{profileId}/contentCategories
Description: Updates an existing content category.
HTTP Method: PUT
Parameters:
profileId
Location: path
Type: string
Format: int64
Required: Yes
Description: User profile ID associated with this request.
Flat Path: userprofiles/{profileId}/contentCategories
▼ ▲ dfareporting.contentCategories.get
Flat Path: userprofiles/{profileId}/contentCategories/{id}
Parameters:
profileId
Location: path
Description: User profile ID associated with this request.
Format: int64
Type: string
Required: Yes
id
Type: string
Required: Yes
Location: path
Format: int64
Description: Content category ID.
Scopes: https://www.googleapis.com/auth/dfatrafficking
Description: Gets one content category by ID.
HTTP Method: GET
Path: userprofiles/{profileId}/contentCategories/{id}
Parameter Order:
▼ ▲ dfareporting.contentCategories.insert
Description: Inserts a new content category.
Scopes: https://www.googleapis.com/auth/dfatrafficking
HTTP Method: POST
Path: userprofiles/{profileId}/contentCategories
Flat Path: userprofiles/{profileId}/contentCategories
Parameter Order: profileId
Parameters:
profileId
Location: path
Type: string
Format: int64
Description: User profile ID associated with this request.
Required: Yes