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