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