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