blob: ed88d00e636bc36a2689ca7ae9745a6731783c35 [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/ddmconversions": {
"description": "Manage DoubleClick Digital Marketing conversions"
},
"https://www.googleapis.com/auth/dfareporting": {
"description": "View and manage DoubleClick for Advertisers reports"
},
"https://www.googleapis.com/auth/dfatrafficking": {
"description": "View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns"
}
}
}
},
"basePath": "/dfareporting/v2.8/",
"baseUrl": "https://www.googleapis.com/dfareporting/v2.8/",
"batchPath": "batch/dfareporting/v2.8",
"description": "Manages your DoubleClick Campaign Manager ad campaigns and reports.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/doubleclick-advertisers/",
"etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/b8e9X2OV7HztttOOjjAf6lAujg0\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
"x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
},
"id": "dfareporting:v2.8",
"kind": "discovery#restDescription",
"name": "dfareporting",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"alt": {
"default": "json",
"description": "Data format for the response.",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query",
"type": "string"
},
"userIp": {
"description": "Deprecated. Please use quotaUser instead.",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"accountActiveAdSummaries": {
"methods": {
"get": {
"description": "Gets the account's active ad summary by account ID.",
"httpMethod": "GET",
"id": "dfareporting.accountActiveAdSummaries.get",
"parameterOrder": [
"profileId",
"summaryAccountId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"summaryAccountId": {
"description": "Account ID.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}",
"response": {
"$ref": "AccountActiveAdSummary"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"accountPermissionGroups": {
"methods": {
"get": {
"description": "Gets one account permission group by ID.",
"httpMethod": "GET",
"id": "dfareporting.accountPermissionGroups.get",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Account permission group ID.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/accountPermissionGroups/{id}",
"response": {
"$ref": "AccountPermissionGroup"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves the list of account permission groups.",
"httpMethod": "GET",
"id": "dfareporting.accountPermissionGroups.list",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/accountPermissionGroups",
"response": {
"$ref": "AccountPermissionGroupsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"accountPermissions": {
"methods": {
"get": {
"description": "Gets one account permission by ID.",
"httpMethod": "GET",
"id": "dfareporting.accountPermissions.get",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Account permission ID.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/accountPermissions/{id}",
"response": {
"$ref": "AccountPermission"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves the list of account permissions.",
"httpMethod": "GET",
"id": "dfareporting.accountPermissions.list",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/accountPermissions",
"response": {
"$ref": "AccountPermissionsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"accountUserProfiles": {
"methods": {
"get": {
"description": "Gets one account user profile by ID.",
"httpMethod": "GET",
"id": "dfareporting.accountUserProfiles.get",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "User profile ID.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/accountUserProfiles/{id}",
"response": {
"$ref": "AccountUserProfile"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"insert": {
"description": "Inserts a new account user profile.",
"httpMethod": "POST",
"id": "dfareporting.accountUserProfiles.insert",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/accountUserProfiles",
"request": {
"$ref": "AccountUserProfile"
},
"response": {
"$ref": "AccountUserProfile"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves a list of account user profiles, possibly filtered. This method supports paging.",
"httpMethod": "GET",
"id": "dfareporting.accountUserProfiles.list",
"parameterOrder": [
"profileId"
],
"parameters": {
"active": {
"description": "Select only active user profiles.",
"location": "query",
"type": "boolean"
},
"ids": {
"description": "Select only user profiles with these IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"maxResults": {
"default": "1000",
"description": "Maximum number of results to return.",
"format": "int32",
"location": "query",
"maximum": "1000",
"minimum": "0",
"type": "integer"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"location": "query",
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"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": {
"default": "ID",
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
},
"sortOrder": {
"default": "ASCENDING",
"description": "Order of sorted results.",
"enum": [
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
},
"subaccountId": {
"description": "Select only user profiles with the specified subaccount ID.",
"format": "int64",
"location": "query",
"type": "string"
},
"userRoleId": {
"description": "Select only user profiles with the specified user role ID.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "userprofiles/{profileId}/accountUserProfiles",
"response": {
"$ref": "AccountUserProfilesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"patch": {
"description": "Updates an existing account user profile. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "dfareporting.accountUserProfiles.patch",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "User profile ID.",
"format": "int64",
"location": "query",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/accountUserProfiles",
"request": {
"$ref": "AccountUserProfile"
},
"response": {
"$ref": "AccountUserProfile"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"update": {
"description": "Updates an existing account user profile.",
"httpMethod": "PUT",
"id": "dfareporting.accountUserProfiles.update",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/accountUserProfiles",
"request": {
"$ref": "AccountUserProfile"
},
"response": {
"$ref": "AccountUserProfile"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"accounts": {
"methods": {
"get": {
"description": "Gets one account by ID.",
"httpMethod": "GET",
"id": "dfareporting.accounts.get",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Account ID.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/accounts/{id}",
"response": {
"$ref": "Account"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves the list of accounts, possibly filtered. This method supports paging.",
"httpMethod": "GET",
"id": "dfareporting.accounts.list",
"parameterOrder": [
"profileId"
],
"parameters": {
"active": {
"description": "Select only active accounts. Don't set this field to select both active and non-active accounts.",
"location": "query",
"type": "boolean"
},
"ids": {
"description": "Select only accounts with these IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"maxResults": {
"default": "1000",
"description": "Maximum number of results to return.",
"format": "int32",
"location": "query",
"maximum": "1000",
"minimum": "0",
"type": "integer"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"location": "query",
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"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"
},
"sortField": {
"default": "ID",
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
},
"sortOrder": {
"default": "ASCENDING",
"description": "Order of sorted results.",
"enum": [
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
}
},
"path": "userprofiles/{profileId}/accounts",
"response": {
"$ref": "AccountsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"patch": {
"description": "Updates an existing account. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "dfareporting.accounts.patch",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Account ID.",
"format": "int64",
"location": "query",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/accounts",
"request": {
"$ref": "Account"
},
"response": {
"$ref": "Account"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"update": {
"description": "Updates an existing account.",
"httpMethod": "PUT",
"id": "dfareporting.accounts.update",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/accounts",
"request": {
"$ref": "Account"
},
"response": {
"$ref": "Account"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"ads": {
"methods": {
"get": {
"description": "Gets one ad by ID.",
"httpMethod": "GET",
"id": "dfareporting.ads.get",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Ad ID.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/ads/{id}",
"response": {
"$ref": "Ad"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"insert": {
"description": "Inserts a new ad.",
"httpMethod": "POST",
"id": "dfareporting.ads.insert",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/ads",
"request": {
"$ref": "Ad"
},
"response": {
"$ref": "Ad"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves a list of ads, possibly filtered. This method supports paging.",
"httpMethod": "GET",
"id": "dfareporting.ads.list",
"parameterOrder": [
"profileId"
],
"parameters": {
"active": {
"description": "Select only active ads.",
"location": "query",
"type": "boolean"
},
"advertiserId": {
"description": "Select only ads with this advertiser ID.",
"format": "int64",
"location": "query",
"type": "string"
},
"archived": {
"description": "Select only archived ads.",
"location": "query",
"type": "boolean"
},
"audienceSegmentIds": {
"description": "Select only ads with these audience segment IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"campaignIds": {
"description": "Select only ads with these campaign IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"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.",
"enum": [
"APP",
"APP_INTERSTITIAL",
"DISPLAY",
"DISPLAY_INTERSTITIAL",
"IN_STREAM_AUDIO",
"IN_STREAM_VIDEO"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"location": "query",
"type": "string"
},
"creativeIds": {
"description": "Select only ads with these creative IDs assigned.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"creativeOptimizationConfigurationIds": {
"description": "Select only ads with these creative optimization configuration IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"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"
},
"ids": {
"description": "Select only ads with these IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"landingPageIds": {
"description": "Select only ads with these landing page IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"maxResults": {
"default": "1000",
"description": "Maximum number of results to return.",
"format": "int32",
"location": "query",
"maximum": "1000",
"minimum": "0",
"type": "integer"
},
"overriddenEventTagId": {
"description": "Select only ads with this event tag override ID.",
"format": "int64",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"location": "query",
"type": "string"
},
"placementIds": {
"description": "Select only ads with these placement IDs assigned.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"remarketingListIds": {
"description": "Select only ads whose list targeting expression use these remarketing list IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"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"
},
"sizeIds": {
"description": "Select only ads with these size IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"sortField": {
"default": "ID",
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
},
"sortOrder": {
"default": "ASCENDING",
"description": "Order of sorted results.",
"enum": [
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
},
"sslCompliant": {
"description": "Select only ads that are SSL-compliant.",
"location": "query",
"type": "boolean"
},
"sslRequired": {
"description": "Select only ads that require SSL.",
"location": "query",
"type": "boolean"
},
"type": {
"description": "Select only ads with these types.",
"enum": [
"AD_SERVING_CLICK_TRACKER",
"AD_SERVING_DEFAULT_AD",
"AD_SERVING_STANDARD_AD",
"AD_SERVING_TRACKING"
],
"enumDescriptions": [
"",
"",
"",
""
],
"location": "query",
"repeated": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/ads",
"response": {
"$ref": "AdsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"patch": {
"description": "Updates an existing ad. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "dfareporting.ads.patch",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Ad ID.",
"format": "int64",
"location": "query",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/ads",
"request": {
"$ref": "Ad"
},
"response": {
"$ref": "Ad"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"update": {
"description": "Updates an existing ad.",
"httpMethod": "PUT",
"id": "dfareporting.ads.update",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/ads",
"request": {
"$ref": "Ad"
},
"response": {
"$ref": "Ad"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"advertiserGroups": {
"methods": {
"delete": {
"description": "Deletes an existing advertiser group.",
"httpMethod": "DELETE",
"id": "dfareporting.advertiserGroups.delete",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Advertiser group ID.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/advertiserGroups/{id}",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"get": {
"description": "Gets one advertiser group by ID.",
"httpMethod": "GET",
"id": "dfareporting.advertiserGroups.get",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Advertiser group ID.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/advertiserGroups/{id}",
"response": {
"$ref": "AdvertiserGroup"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"insert": {
"description": "Inserts a new advertiser group.",
"httpMethod": "POST",
"id": "dfareporting.advertiserGroups.insert",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/advertiserGroups",
"request": {
"$ref": "AdvertiserGroup"
},
"response": {
"$ref": "AdvertiserGroup"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves a list of advertiser groups, possibly filtered. This method supports paging.",
"httpMethod": "GET",
"id": "dfareporting.advertiserGroups.list",
"parameterOrder": [
"profileId"
],
"parameters": {
"ids": {
"description": "Select only advertiser groups with these IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"maxResults": {
"default": "1000",
"description": "Maximum number of results to return.",
"format": "int32",
"location": "query",
"maximum": "1000",
"minimum": "0",
"type": "integer"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"location": "query",
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"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": {
"default": "ID",
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
},
"sortOrder": {
"default": "ASCENDING",
"description": "Order of sorted results.",
"enum": [
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
}
},
"path": "userprofiles/{profileId}/advertiserGroups",
"response": {
"$ref": "AdvertiserGroupsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"patch": {
"description": "Updates an existing advertiser group. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "dfareporting.advertiserGroups.patch",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Advertiser group ID.",
"format": "int64",
"location": "query",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/advertiserGroups",
"request": {
"$ref": "AdvertiserGroup"
},
"response": {
"$ref": "AdvertiserGroup"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"update": {
"description": "Updates an existing advertiser group.",
"httpMethod": "PUT",
"id": "dfareporting.advertiserGroups.update",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/advertiserGroups",
"request": {
"$ref": "AdvertiserGroup"
},
"response": {
"$ref": "AdvertiserGroup"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"advertisers": {
"methods": {
"get": {
"description": "Gets one advertiser by ID.",
"httpMethod": "GET",
"id": "dfareporting.advertisers.get",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Advertiser ID.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/advertisers/{id}",
"response": {
"$ref": "Advertiser"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"insert": {
"description": "Inserts a new advertiser.",
"httpMethod": "POST",
"id": "dfareporting.advertisers.insert",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/advertisers",
"request": {
"$ref": "Advertiser"
},
"response": {
"$ref": "Advertiser"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves a list of advertisers, possibly filtered. This method supports paging.",
"httpMethod": "GET",
"id": "dfareporting.advertisers.list",
"parameterOrder": [
"profileId"
],
"parameters": {
"advertiserGroupIds": {
"description": "Select only advertisers with these advertiser group IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"floodlightConfigurationIds": {
"description": "Select only advertisers with these floodlight configuration IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"ids": {
"description": "Select only advertisers with these IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"includeAdvertisersWithoutGroupsOnly": {
"description": "Select only advertisers which do not belong to any advertiser group.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "1000",
"description": "Maximum number of results to return.",
"format": "int32",
"location": "query",
"maximum": "1000",
"minimum": "0",
"type": "integer"
},
"onlyParent": {
"description": "Select only advertisers which use another advertiser's floodlight configuration.",
"location": "query",
"type": "boolean"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"location": "query",
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"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": {
"default": "ID",
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
},
"sortOrder": {
"default": "ASCENDING",
"description": "Order of sorted results.",
"enum": [
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
},
"status": {
"description": "Select only advertisers with the specified status.",
"enum": [
"APPROVED",
"ON_HOLD"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
},
"subaccountId": {
"description": "Select only advertisers with these subaccount IDs.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "userprofiles/{profileId}/advertisers",
"response": {
"$ref": "AdvertisersListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"patch": {
"description": "Updates an existing advertiser. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "dfareporting.advertisers.patch",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Advertiser ID.",
"format": "int64",
"location": "query",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/advertisers",
"request": {
"$ref": "Advertiser"
},
"response": {
"$ref": "Advertiser"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"update": {
"description": "Updates an existing advertiser.",
"httpMethod": "PUT",
"id": "dfareporting.advertisers.update",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/advertisers",
"request": {
"$ref": "Advertiser"
},
"response": {
"$ref": "Advertiser"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"browsers": {
"methods": {
"list": {
"description": "Retrieves a list of browsers.",
"httpMethod": "GET",
"id": "dfareporting.browsers.list",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/browsers",
"response": {
"$ref": "BrowsersListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"campaignCreativeAssociations": {
"methods": {
"insert": {
"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.",
"httpMethod": "POST",
"id": "dfareporting.campaignCreativeAssociations.insert",
"parameterOrder": [
"profileId",
"campaignId"
],
"parameters": {
"campaignId": {
"description": "Campaign ID in this association.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
"request": {
"$ref": "CampaignCreativeAssociation"
},
"response": {
"$ref": "CampaignCreativeAssociation"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.",
"httpMethod": "GET",
"id": "dfareporting.campaignCreativeAssociations.list",
"parameterOrder": [
"profileId",
"campaignId"
],
"parameters": {
"campaignId": {
"description": "Campaign ID in this association.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"default": "1000",
"description": "Maximum number of results to return.",
"format": "int32",
"location": "query",
"maximum": "1000",
"minimum": "0",
"type": "integer"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"location": "query",
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"sortOrder": {
"default": "ASCENDING",
"description": "Order of sorted results.",
"enum": [
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
}
},
"path": "userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations",
"response": {
"$ref": "CampaignCreativeAssociationsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"campaigns": {
"methods": {
"get": {
"description": "Gets one campaign by ID.",
"httpMethod": "GET",
"id": "dfareporting.campaigns.get",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Campaign ID.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/campaigns/{id}",
"response": {
"$ref": "Campaign"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"insert": {
"description": "Inserts a new campaign.",
"httpMethod": "POST",
"id": "dfareporting.campaigns.insert",
"parameterOrder": [
"profileId",
"defaultLandingPageName",
"defaultLandingPageUrl"
],
"parameters": {
"defaultLandingPageName": {
"description": "Default landing page name for this new campaign. Must be less than 256 characters long.",
"location": "query",
"required": true,
"type": "string"
},
"defaultLandingPageUrl": {
"description": "Default landing page URL for this new campaign.",
"location": "query",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/campaigns",
"request": {
"$ref": "Campaign"
},
"response": {
"$ref": "Campaign"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves a list of campaigns, possibly filtered. This method supports paging.",
"httpMethod": "GET",
"id": "dfareporting.campaigns.list",
"parameterOrder": [
"profileId"
],
"parameters": {
"advertiserGroupIds": {
"description": "Select only campaigns whose advertisers belong to these advertiser groups.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"advertiserIds": {
"description": "Select only campaigns that belong to these advertisers.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"archived": {
"description": "Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.",
"location": "query",
"type": "boolean"
},
"atLeastOneOptimizationActivity": {
"description": "Select only campaigns that have at least one optimization activity.",
"location": "query",
"type": "boolean"
},
"excludedIds": {
"description": "Exclude campaigns with these IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"ids": {
"description": "Select only campaigns with these IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"maxResults": {
"default": "1000",
"description": "Maximum number of results to return.",
"format": "int32",
"location": "query",
"maximum": "1000",
"minimum": "0",
"type": "integer"
},
"overriddenEventTagId": {
"description": "Select only campaigns that have overridden this event tag ID.",
"format": "int64",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"location": "query",
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"searchString": {
"description": "Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, \"campaign*2015\" will return campaigns with names like \"campaign June 2015\", \"campaign April 2015\", or simply \"campaign 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"campaign\" will match campaigns with name \"my campaign\", \"campaign 2015\", or simply \"campaign\".",
"location": "query",
"type": "string"
},
"sortField": {
"default": "ID",
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
},
"sortOrder": {
"default": "ASCENDING",
"description": "Order of sorted results.",
"enum": [
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
},
"subaccountId": {
"description": "Select only campaigns that belong to this subaccount.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "userprofiles/{profileId}/campaigns",
"response": {
"$ref": "CampaignsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"patch": {
"description": "Updates an existing campaign. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "dfareporting.campaigns.patch",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Campaign ID.",
"format": "int64",
"location": "query",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/campaigns",
"request": {
"$ref": "Campaign"
},
"response": {
"$ref": "Campaign"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"update": {
"description": "Updates an existing campaign.",
"httpMethod": "PUT",
"id": "dfareporting.campaigns.update",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/campaigns",
"request": {
"$ref": "Campaign"
},
"response": {
"$ref": "Campaign"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"changeLogs": {
"methods": {
"get": {
"description": "Gets one change log by ID.",
"httpMethod": "GET",
"id": "dfareporting.changeLogs.get",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Change log ID.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/changeLogs/{id}",
"response": {
"$ref": "ChangeLog"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves a list of change logs. This method supports paging.",
"httpMethod": "GET",
"id": "dfareporting.changeLogs.list",
"parameterOrder": [
"profileId"
],
"parameters": {
"action": {
"description": "Select only change logs with the specified action.",
"enum": [
"ACTION_ADD",
"ACTION_ASSIGN",
"ACTION_ASSOCIATE",
"ACTION_CREATE",
"ACTION_DELETE",
"ACTION_DISABLE",
"ACTION_EMAIL_TAGS",
"ACTION_ENABLE",
"ACTION_LINK",
"ACTION_MARK_AS_DEFAULT",
"ACTION_PUSH",
"ACTION_REMOVE",
"ACTION_SEND",
"ACTION_SHARE",
"ACTION_UNASSIGN",
"ACTION_UNLINK",
"ACTION_UPDATE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"location": "query",
"type": "string"
},
"ids": {
"description": "Select only change logs with these IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"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"
},
"maxResults": {
"default": "1000",
"description": "Maximum number of results to return.",
"format": "int32",
"location": "query",
"maximum": "1000",
"minimum": "0",
"type": "integer"
},
"minChangeTime": {
"description": "Select only change logs whose change time is before 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"
},
"objectIds": {
"description": "Select only change logs with these object IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"objectType": {
"description": "Select only change logs with the specified object type.",
"enum": [
"OBJECT_ACCOUNT",
"OBJECT_ACCOUNT_BILLING_FEATURE",
"OBJECT_AD",
"OBJECT_ADVERTISER",
"OBJECT_ADVERTISER_GROUP",
"OBJECT_BILLING_ACCOUNT_GROUP",
"OBJECT_BILLING_FEATURE",
"OBJECT_BILLING_MINIMUM_FEE",
"OBJECT_BILLING_PROFILE",
"OBJECT_CAMPAIGN",
"OBJECT_CONTENT_CATEGORY",
"OBJECT_CREATIVE",
"OBJECT_CREATIVE_ASSET",
"OBJECT_CREATIVE_BUNDLE",
"OBJECT_CREATIVE_FIELD",
"OBJECT_CREATIVE_GROUP",
"OBJECT_DFA_SITE",
"OBJECT_EVENT_TAG",
"OBJECT_FLOODLIGHT_ACTIVITY_GROUP",
"OBJECT_FLOODLIGHT_ACTVITY",
"OBJECT_FLOODLIGHT_CONFIGURATION",
"OBJECT_INSTREAM_CREATIVE",
"OBJECT_LANDING_PAGE",
"OBJECT_MEDIA_ORDER",
"OBJECT_PLACEMENT",
"OBJECT_PLACEMENT_STRATEGY",
"OBJECT_PLAYSTORE_LINK",
"OBJECT_PROVIDED_LIST_CLIENT",
"OBJECT_RATE_CARD",
"OBJECT_REMARKETING_LIST",
"OBJECT_RICHMEDIA_CREATIVE",
"OBJECT_SD_SITE",
"OBJECT_SEARCH_LIFT_STUDY",
"OBJECT_SIZE",
"OBJECT_SUBACCOUNT",
"OBJECT_TARGETING_TEMPLATE",
"OBJECT_USER_PROFILE",
"OBJECT_USER_PROFILE_FILTER",
"OBJECT_USER_ROLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"location": "query",
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"searchString": {
"description": "Select only change logs whose object ID, user name, old or new values match the search string.",
"location": "query",
"type": "string"
},
"userProfileIds": {
"description": "Select only change logs with these user profile IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/changeLogs",
"response": {
"$ref": "ChangeLogsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"cities": {
"methods": {
"list": {
"description": "Retrieves a list of cities, possibly filtered.",
"httpMethod": "GET",
"id": "dfareporting.cities.list",
"parameterOrder": [
"profileId"
],
"parameters": {
"countryDartIds": {
"description": "Select only cities from these countries.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"dartIds": {
"description": "Select only cities with these DART IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"namePrefix": {
"description": "Select only cities with names starting with this prefix.",
"location": "query",
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"regionDartIds": {
"description": "Select only cities from these regions.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/cities",
"response": {
"$ref": "CitiesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"connectionTypes": {
"methods": {
"get": {
"description": "Gets one connection type by ID.",
"httpMethod": "GET",
"id": "dfareporting.connectionTypes.get",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Connection type ID.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/connectionTypes/{id}",
"response": {
"$ref": "ConnectionType"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves a list of connection types.",
"httpMethod": "GET",
"id": "dfareporting.connectionTypes.list",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/connectionTypes",
"response": {
"$ref": "ConnectionTypesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"contentCategories": {
"methods": {
"delete": {
"description": "Deletes an existing content category.",
"httpMethod": "DELETE",
"id": "dfareporting.contentCategories.delete",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Content category ID.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/contentCategories/{id}",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"get": {
"description": "Gets one content category by ID.",
"httpMethod": "GET",
"id": "dfareporting.contentCategories.get",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Content category ID.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/contentCategories/{id}",
"response": {
"$ref": "ContentCategory"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"insert": {
"description": "Inserts a new content category.",
"httpMethod": "POST",
"id": "dfareporting.contentCategories.insert",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/contentCategories",
"request": {
"$ref": "ContentCategory"
},
"response": {
"$ref": "ContentCategory"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves a list of content categories, possibly filtered. This method supports paging.",
"httpMethod": "GET",
"id": "dfareporting.contentCategories.list",
"parameterOrder": [
"profileId"
],
"parameters": {
"ids": {
"description": "Select only content categories with these IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"maxResults": {
"default": "1000",
"description": "Maximum number of results to return.",
"format": "int32",
"location": "query",
"maximum": "1000",
"minimum": "0",
"type": "integer"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"location": "query",
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"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": {
"default": "ID",
"description": "Field by which to sort the list.",
"enum": [
"ID",
"NAME"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
},
"sortOrder": {
"default": "ASCENDING",
"description": "Order of sorted results.",
"enum": [
"ASCENDING",
"DESCENDING"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
}
},
"path": "userprofiles/{profileId}/contentCategories",
"response": {
"$ref": "ContentCategoriesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"patch": {
"description": "Updates an existing content category. This method supports patch semantics.",
"httpMethod": "PATCH",
"id": "dfareporting.contentCategories.patch",
"parameterOrder": [
"profileId",
"id"
],
"parameters": {
"id": {
"description": "Content category ID.",
"format": "int64",
"location": "query",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/contentCategories",
"request": {
"$ref": "ContentCategory"
},
"response": {
"$ref": "ContentCategory"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"update": {
"description": "Updates an existing content category.",
"httpMethod": "PUT",
"id": "dfareporting.contentCategories.update",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/contentCategories",
"request": {
"$ref": "ContentCategory"
},
"response": {
"$ref": "ContentCategory"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"conversions": {
"methods": {
"batchinsert": {
"description": "Inserts conversions.",
"httpMethod": "POST",
"id": "dfareporting.conversions.batchinsert",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/conversions/batchinsert",
"request": {
"$ref": "ConversionsBatchInsertRequest"
},
"response": {
"$ref": "ConversionsBatchInsertResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ddmconversions"
]
},
"batchupdate": {
"description": "Updates existing conversions.",
"httpMethod": "POST",
"id": "dfareporting.conversions.batchupdate",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/conversions/batchupdate",
"request": {
"$ref": "ConversionsBatchUpdateRequest"
},
"response": {
"$ref": "ConversionsBatchUpdateResponse"
},
"scopes": [
"https://www.googleapis.com/auth/ddmconversions"
]
}
}
},
"countries": {
"methods": {
"get": {
"description": "Gets one country by ID.",
"httpMethod": "GET",
"id": "dfareporting.countries.get",
"parameterOrder": [
"profileId",
"dartId"
],
"parameters": {
"dartId": {
"description": "Country DART ID.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/countries/{dartId}",
"response": {
"$ref": "Country"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves a list of countries.",
"httpMethod": "GET",
"id": "dfareporting.countries.list",
"parameterOrder": [
"profileId"
],
"parameters": {
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/countries",
"response": {
"$ref": "CountriesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
}
}
},
"creativeAssets": {
"methods": {
"insert": {
"description": "Inserts a new creative asset.",
"httpMethod": "POST",
"id": "dfareporting.creativeAssets.insert",
"mediaUpload": {
"accept": [
"*/*"
],
"maxSize": "1024MB",
"protocols": {
"resumable": {
"multipart": true,
"path": "/resumable/upload/dfareporting/v2.8/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
},
"simple": {
"multipart": true,
"path": "/upload/dfareporting/v2.8/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets"
}
}
},
"parameterOrder": [
"profileId",
"advertiserId"
],
"parameters": {
"advertiserId": {
"description": "Advertiser ID of this creative. This is a required field.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets",
"request": {
"$ref": "CreativeAssetMetadata"
},
"response": {
"$ref": "CreativeAssetMetadata"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
],
"supportsMediaUpload": true
}
}
},
"creativeFieldValues": {
"methods": {
"delete": {
"description": "Deletes an existing creative field value.",
"httpMethod": "DELETE",
"id": "dfareporting.creativeFieldValues.delete",
"parameterOrder": [
"profileId",
"creativeFieldId",
"id"
],
"parameters": {
"creativeFieldId": {
"description": "Creative field ID for this creative field value.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"id": {
"description": "Creative Field Value ID",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"get": {
"description": "Gets one creative field value by ID.",
"httpMethod": "GET",
"id": "dfareporting.creativeFieldValues.get",
"parameterOrder": [
"profileId",
"creativeFieldId",
"id"
],
"parameters": {
"creativeFieldId": {
"description": "Creative field ID for this creative field value.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"id": {
"description": "Creative Field Value ID",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}",
"response": {
"$ref": "CreativeFieldValue"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"insert": {
"description": "Inserts a new creative field value.",
"httpMethod": "POST",
"id": "dfareporting.creativeFieldValues.insert",
"parameterOrder": [
"profileId",
"creativeFieldId"
],
"parameters": {
"creativeFieldId": {
"description": "Creative field ID for this creative field value.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"profileId": {
"description": "User profile ID associated with this request.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues",
"request": {
"$ref": "CreativeFieldValue"
},
"response": {
"$ref": "CreativeFieldValue"
},
"scopes": [
"https://www.googleapis.com/auth/dfatrafficking"
]
},
"list": {
"description": "Retrieves a list of creative field values, possibly filtered. This method supports paging.",
"httpMethod": "GET",
"id": "dfareporting.creativeFieldValues.list",
"parameterOrder": [
"profileId",
"creativeFieldId"
],
"parameters": {
"creativeFieldId": {
"description": "Creative field ID for this creative field value.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"ids": {
"description": "Select only creative field values with these IDs.",
"format": "int64",
"location": "query",
"repeated": true,
"type": "string"
},
"maxResults": {
"default": "1000",
"description": "Maximum number of results to return.",
"format": "int32",
"location": "query",
"maximum": "1000",
"minimum": "0",
"type": "integer"
},
"pageToken": {
"description": "Value of the nextPageToken from the previous result page.",
"location": "query",
"type": "string"