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