Index: discovery/googleapis/dfareporting__v2.2.json |
diff --git a/discovery/googleapis/dfareporting__v2.0.json b/discovery/googleapis/dfareporting__v2.2.json |
similarity index 86% |
copy from discovery/googleapis/dfareporting__v2.0.json |
copy to discovery/googleapis/dfareporting__v2.2.json |
index 9337464fefb8703dae9f76b3780eff0f04073e2f..4893f064d2453e5197d8e64b28e06aaf6c58aba9 100644 |
--- a/discovery/googleapis/dfareporting__v2.0.json |
+++ b/discovery/googleapis/dfareporting__v2.2.json |
@@ -11,18 +11,18 @@ |
} |
} |
}, |
- "basePath": "/dfareporting/v2.0/", |
- "baseUrl": "https://www.googleapis.com/dfareporting/v2.0/", |
+ "basePath": "/dfareporting/v2.2/", |
+ "baseUrl": "https://www.googleapis.com/dfareporting/v2.2/", |
"batchPath": "batch", |
"description": "Manage your DoubleClick Campaign Manager ad campaigns and reports.", |
"discoveryVersion": "v1", |
"documentationLink": "https://developers.google.com/doubleclick-advertisers/reporting/", |
- "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/14gemQgeOwkk8XbVog9HBJLI5Js\"", |
+ "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/qexyTX_0gifZ9lTG0KLr53MQrI4\"", |
"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.0", |
+ "id": "dfareporting:v2.2", |
"kind": "discovery#restDescription", |
"name": "dfareporting", |
"ownerDomain": "google.com", |
@@ -264,6 +264,33 @@ |
"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.", |
"httpMethod": "GET", |
@@ -750,6 +777,7 @@ |
"RICH_MEDIA_MULTI_FLOATING", |
"RICH_MEDIA_PEEL_DOWN", |
"TRACKING_TEXT", |
+ "VAST_REDIRECT", |
"VPAID_LINEAR", |
"VPAID_NON_LINEAR" |
], |
@@ -776,6 +804,7 @@ |
"", |
"", |
"", |
+ "", |
"" |
], |
"location": "query", |
@@ -1881,6 +1910,7 @@ |
"ACTION_PUSH", |
"ACTION_REMOVE", |
"ACTION_SEND", |
+ "ACTION_SHARE", |
"ACTION_UNASSIGN", |
"ACTION_UNLINK", |
"ACTION_UPDATE" |
@@ -1901,6 +1931,7 @@ |
"", |
"", |
"", |
+ "", |
"" |
], |
"location": "query", |
@@ -2108,6 +2139,38 @@ |
}, |
"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", |
@@ -2435,11 +2498,11 @@ |
"protocols": { |
"resumable": { |
"multipart": true, |
- "path": "/resumable/upload/dfareporting/v2.0/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets" |
+ "path": "/resumable/upload/dfareporting/v2.2/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets" |
}, |
"simple": { |
"multipart": true, |
- "path": "/upload/dfareporting/v2.0/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets" |
+ "path": "/upload/dfareporting/v2.2/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets" |
} |
} |
}, |
@@ -3402,6 +3465,7 @@ |
"RICH_MEDIA_MULTI_FLOATING", |
"RICH_MEDIA_PEEL_DOWN", |
"TRACKING_TEXT", |
+ "VAST_REDIRECT", |
"VPAID_LINEAR", |
"VPAID_NON_LINEAR" |
], |
@@ -3428,6 +3492,7 @@ |
"", |
"", |
"", |
+ "", |
"" |
], |
"location": "query", |
@@ -3701,6 +3766,33 @@ |
"https://www.googleapis.com/auth/dfatrafficking" |
] |
}, |
+ "insert": { |
+ "description": "Inserts a new directory site.", |
+ "httpMethod": "POST", |
+ "id": "dfareporting.directorySites.insert", |
+ "parameterOrder": [ |
+ "profileId" |
+ ], |
+ "parameters": { |
+ "profileId": { |
+ "description": "User profile ID associated with this request.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/directorySites", |
+ "request": { |
+ "$ref": "DirectorySite" |
+ }, |
+ "response": { |
+ "$ref": "DirectorySite" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
"list": { |
"description": "Retrieves a list of directory sites, possibly filtered.", |
"httpMethod": "GET", |
@@ -3930,12 +4022,12 @@ |
"type": "string" |
}, |
"definitionsOnly": { |
- "description": "Examine only the specified ad or campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign is examined as well. In addition, when set to false, the status field is examined as well along with the enabledByDefault field.", |
+ "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" |
}, |
"enabled": { |
- "description": "Select only enabled event tags. 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.", |
+ "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" |
}, |
@@ -4876,6 +4968,145 @@ |
} |
} |
}, |
+ "inventoryItems": { |
+ "methods": { |
+ "get": { |
+ "description": "Gets one inventory item by ID.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.inventoryItems.get", |
+ "parameterOrder": [ |
+ "profileId", |
+ "projectId", |
+ "id" |
+ ], |
+ "parameters": { |
+ "id": { |
+ "description": "Inventory item 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" |
+ }, |
+ "projectId": { |
+ "description": "Project ID for order documents.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}", |
+ "response": { |
+ "$ref": "InventoryItem" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
+ "list": { |
+ "description": "Retrieves a list of inventory items, possibly filtered.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.inventoryItems.list", |
+ "parameterOrder": [ |
+ "profileId", |
+ "projectId" |
+ ], |
+ "parameters": { |
+ "ids": { |
+ "description": "Select only inventory items with these IDs.", |
+ "format": "int64", |
+ "location": "query", |
+ "repeated": true, |
+ "type": "string" |
+ }, |
+ "inPlan": { |
+ "description": "Select only inventory items that are in plan.", |
+ "location": "query", |
+ "type": "boolean" |
+ }, |
+ "maxResults": { |
+ "description": "Maximum number of results to return.", |
+ "format": "int32", |
+ "location": "query", |
+ "type": "integer" |
+ }, |
+ "orderId": { |
+ "description": "Select only inventory items that belong to specified orders.", |
+ "format": "int64", |
+ "location": "query", |
+ "repeated": true, |
+ "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" |
+ }, |
+ "projectId": { |
+ "description": "Project ID for order documents.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ }, |
+ "siteId": { |
+ "description": "Select only inventory items that are associated with these sites.", |
+ "format": "int64", |
+ "location": "query", |
+ "repeated": true, |
+ "type": "string" |
+ }, |
+ "sortField": { |
+ "description": "Field by which to sort the list.", |
+ "enum": [ |
+ "ID", |
+ "NAME" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "sortOrder": { |
+ "description": "Order of sorted results, default is ASCENDING.", |
+ "enum": [ |
+ "ASCENDING", |
+ "DESCENDING" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/projects/{projectId}/inventoryItems", |
+ "response": { |
+ "$ref": "InventoryItemsListResponse" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ } |
+ } |
+ }, |
"landingPages": { |
"methods": { |
"delete": { |
@@ -5132,42 +5363,22 @@ |
}, |
"mobileCarriers": { |
"methods": { |
- "list": { |
- "description": "Retrieves a list of mobile carriers.", |
+ "get": { |
+ "description": "Gets one mobile carrier by ID.", |
"httpMethod": "GET", |
- "id": "dfareporting.mobileCarriers.list", |
+ "id": "dfareporting.mobileCarriers.get", |
"parameterOrder": [ |
- "profileId" |
+ "profileId", |
+ "id" |
], |
"parameters": { |
- "profileId": { |
- "description": "User profile ID associated with this request.", |
+ "id": { |
+ "description": "Mobile carrier ID.", |
"format": "int64", |
"location": "path", |
"required": true, |
"type": "string" |
- } |
- }, |
- "path": "userprofiles/{profileId}/mobileCarriers", |
- "response": { |
- "$ref": "MobileCarriersListResponse" |
- }, |
- "scopes": [ |
- "https://www.googleapis.com/auth/dfatrafficking" |
- ] |
- } |
- } |
- }, |
- "operatingSystemVersions": { |
- "methods": { |
- "list": { |
- "description": "Retrieves a list of operating system versions.", |
- "httpMethod": "GET", |
- "id": "dfareporting.operatingSystemVersions.list", |
- "parameterOrder": [ |
- "profileId" |
- ], |
- "parameters": { |
+ }, |
"profileId": { |
"description": "User profile ID associated with this request.", |
"format": "int64", |
@@ -5176,22 +5387,18 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/operatingSystemVersions", |
+ "path": "userprofiles/{profileId}/mobileCarriers/{id}", |
"response": { |
- "$ref": "OperatingSystemVersionsListResponse" |
+ "$ref": "MobileCarrier" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
] |
- } |
- } |
- }, |
- "operatingSystems": { |
- "methods": { |
+ }, |
"list": { |
- "description": "Retrieves a list of operating systems.", |
+ "description": "Retrieves a list of mobile carriers.", |
"httpMethod": "GET", |
- "id": "dfareporting.operatingSystems.list", |
+ "id": "dfareporting.mobileCarriers.list", |
"parameterOrder": [ |
"profileId" |
], |
@@ -5204,9 +5411,9 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/operatingSystems", |
+ "path": "userprofiles/{profileId}/mobileCarriers", |
"response": { |
- "$ref": "OperatingSystemsListResponse" |
+ "$ref": "MobileCarriersListResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
@@ -5214,19 +5421,19 @@ |
} |
} |
}, |
- "placementGroups": { |
+ "operatingSystemVersions": { |
"methods": { |
"get": { |
- "description": "Gets one placement group by ID.", |
+ "description": "Gets one operating system version by ID.", |
"httpMethod": "GET", |
- "id": "dfareporting.placementGroups.get", |
+ "id": "dfareporting.operatingSystemVersions.get", |
"parameterOrder": [ |
"profileId", |
"id" |
], |
"parameters": { |
"id": { |
- "description": "Placement group ID.", |
+ "description": "Operating system version ID.", |
"format": "int64", |
"location": "path", |
"required": true, |
@@ -5240,18 +5447,18 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/placementGroups/{id}", |
+ "path": "userprofiles/{profileId}/operatingSystemVersions/{id}", |
"response": { |
- "$ref": "PlacementGroup" |
+ "$ref": "OperatingSystemVersion" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
] |
}, |
- "insert": { |
- "description": "Inserts a new placement group.", |
- "httpMethod": "POST", |
- "id": "dfareporting.placementGroups.insert", |
+ "list": { |
+ "description": "Retrieves a list of operating system versions.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.operatingSystemVersions.list", |
"parameterOrder": [ |
"profileId" |
], |
@@ -5264,60 +5471,134 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/placementGroups", |
- "request": { |
- "$ref": "PlacementGroup" |
+ "path": "userprofiles/{profileId}/operatingSystemVersions", |
+ "response": { |
+ "$ref": "OperatingSystemVersionsListResponse" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ } |
+ } |
+ }, |
+ "operatingSystems": { |
+ "methods": { |
+ "get": { |
+ "description": "Gets one operating system by DART ID.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.operatingSystems.get", |
+ "parameterOrder": [ |
+ "profileId", |
+ "dartId" |
+ ], |
+ "parameters": { |
+ "dartId": { |
+ "description": "Operating system 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}/operatingSystems/{dartId}", |
"response": { |
- "$ref": "PlacementGroup" |
+ "$ref": "OperatingSystem" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
] |
}, |
"list": { |
- "description": "Retrieves a list of placement groups, possibly filtered.", |
+ "description": "Retrieves a list of operating systems.", |
"httpMethod": "GET", |
- "id": "dfareporting.placementGroups.list", |
+ "id": "dfareporting.operatingSystems.list", |
"parameterOrder": [ |
"profileId" |
], |
"parameters": { |
- "advertiserIds": { |
- "description": "Select only placement groups that belong to these advertisers.", |
+ "profileId": { |
+ "description": "User profile ID associated with this request.", |
"format": "int64", |
- "location": "query", |
- "repeated": true, |
+ "location": "path", |
+ "required": true, |
"type": "string" |
- }, |
- "archived": { |
- "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.", |
- "location": "query", |
- "type": "boolean" |
- }, |
- "campaignIds": { |
- "description": "Select only placement groups that belong to these campaigns.", |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/operatingSystems", |
+ "response": { |
+ "$ref": "OperatingSystemsListResponse" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ } |
+ } |
+ }, |
+ "orderDocuments": { |
+ "methods": { |
+ "get": { |
+ "description": "Gets one order document by ID.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.orderDocuments.get", |
+ "parameterOrder": [ |
+ "profileId", |
+ "projectId", |
+ "id" |
+ ], |
+ "parameters": { |
+ "id": { |
+ "description": "Order document ID.", |
"format": "int64", |
- "location": "query", |
- "repeated": true, |
+ "location": "path", |
+ "required": true, |
"type": "string" |
}, |
- "contentCategoryIds": { |
- "description": "Select only placement groups that are associated with these content categories.", |
+ "profileId": { |
+ "description": "User profile ID associated with this request.", |
"format": "int64", |
- "location": "query", |
- "repeated": true, |
+ "location": "path", |
+ "required": true, |
"type": "string" |
}, |
- "directorySiteIds": { |
- "description": "Select only placement groups that are associated with these directory sites.", |
+ "projectId": { |
+ "description": "Project ID for order documents.", |
"format": "int64", |
- "location": "query", |
- "repeated": true, |
+ "location": "path", |
+ "required": true, |
"type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}", |
+ "response": { |
+ "$ref": "OrderDocument" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
+ "list": { |
+ "description": "Retrieves a list of order documents, possibly filtered.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.orderDocuments.list", |
+ "parameterOrder": [ |
+ "profileId", |
+ "projectId" |
+ ], |
+ "parameters": { |
+ "approved": { |
+ "description": "Select only order documents that have been approved by at least one user.", |
+ "location": "query", |
+ "type": "boolean" |
}, |
"ids": { |
- "description": "Select only placement groups with these IDs.", |
+ "description": "Select only order documents with these IDs.", |
"format": "int64", |
"location": "query", |
"repeated": true, |
@@ -5329,49 +5610,16 @@ |
"location": "query", |
"type": "integer" |
}, |
- "pageToken": { |
- "description": "Value of the nextPageToken from the previous result page.", |
- "location": "query", |
- "type": "string" |
- }, |
- "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.", |
- "enum": [ |
- "PLACEMENT_PACKAGE", |
- "PLACEMENT_ROADBLOCK" |
- ], |
- "enumDescriptions": [ |
- "", |
- "" |
- ], |
- "location": "query", |
- "type": "string" |
- }, |
- "placementStrategyIds": { |
- "description": "Select only placement groups that are associated with these placement strategies.", |
+ "orderId": { |
+ "description": "Select only order documents for specified orders.", |
"format": "int64", |
"location": "query", |
"repeated": true, |
"type": "string" |
}, |
- "pricingTypes": { |
- "description": "Select only placement groups with these pricing types.", |
- "enum": [ |
- "PRICING_TYPE_CPA", |
- "PRICING_TYPE_CPC", |
- "PRICING_TYPE_CPM", |
- "PRICING_TYPE_FLAT_RATE_CLICKS", |
- "PRICING_TYPE_FLAT_RATE_IMPRESSIONS" |
- ], |
- "enumDescriptions": [ |
- "", |
- "", |
- "", |
- "", |
- "" |
- ], |
+ "pageToken": { |
+ "description": "Value of the nextPageToken from the previous result page.", |
"location": "query", |
- "repeated": true, |
"type": "string" |
}, |
"profileId": { |
@@ -5381,13 +5629,20 @@ |
"required": true, |
"type": "string" |
}, |
+ "projectId": { |
+ "description": "Project ID for order documents.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ }, |
"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\".", |
+ "description": "Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, \"orderdocument*2015\" will return order documents with names like \"orderdocument June 2015\", \"orderdocument April 2015\", or simply \"orderdocument 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"orderdocument\" will match order documents with name \"my orderdocument\", \"orderdocument 2015\", or simply \"orderdocument\".", |
"location": "query", |
"type": "string" |
}, |
- "siteIds": { |
- "description": "Select only placement groups that are associated with these sites.", |
+ "siteId": { |
+ "description": "Select only order documents that are associated with these sites.", |
"format": "int64", |
"location": "query", |
"repeated": true, |
@@ -5420,27 +5675,32 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/placementGroups", |
+ "path": "userprofiles/{profileId}/projects/{projectId}/orderDocuments", |
"response": { |
- "$ref": "PlacementGroupsListResponse" |
+ "$ref": "OrderDocumentsListResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
] |
- }, |
- "patch": { |
- "description": "Updates an existing placement group. This method supports patch semantics.", |
- "httpMethod": "PATCH", |
- "id": "dfareporting.placementGroups.patch", |
+ } |
+ } |
+ }, |
+ "orders": { |
+ "methods": { |
+ "get": { |
+ "description": "Gets one order by ID.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.orders.get", |
"parameterOrder": [ |
"profileId", |
+ "projectId", |
"id" |
], |
"parameters": { |
"id": { |
- "description": "Placement group ID.", |
+ "description": "Order ID.", |
"format": "int64", |
- "location": "query", |
+ "location": "path", |
"required": true, |
"type": "string" |
}, |
@@ -5450,64 +5710,48 @@ |
"location": "path", |
"required": true, |
"type": "string" |
- } |
- }, |
- "path": "userprofiles/{profileId}/placementGroups", |
- "request": { |
- "$ref": "PlacementGroup" |
- }, |
- "response": { |
- "$ref": "PlacementGroup" |
- }, |
- "scopes": [ |
- "https://www.googleapis.com/auth/dfatrafficking" |
- ] |
- }, |
- "update": { |
- "description": "Updates an existing placement group.", |
- "httpMethod": "PUT", |
- "id": "dfareporting.placementGroups.update", |
- "parameterOrder": [ |
- "profileId" |
- ], |
- "parameters": { |
- "profileId": { |
- "description": "User profile ID associated with this request.", |
+ }, |
+ "projectId": { |
+ "description": "Project ID for orders.", |
"format": "int64", |
"location": "path", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/placementGroups", |
- "request": { |
- "$ref": "PlacementGroup" |
- }, |
+ "path": "userprofiles/{profileId}/projects/{projectId}/orders/{id}", |
"response": { |
- "$ref": "PlacementGroup" |
+ "$ref": "Order" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
] |
- } |
- } |
- }, |
- "placementStrategies": { |
- "methods": { |
- "delete": { |
- "description": "Deletes an existing placement strategy.", |
- "httpMethod": "DELETE", |
- "id": "dfareporting.placementStrategies.delete", |
+ }, |
+ "list": { |
+ "description": "Retrieves a list of orders, possibly filtered.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.orders.list", |
"parameterOrder": [ |
"profileId", |
- "id" |
+ "projectId" |
], |
"parameters": { |
- "id": { |
- "description": "Placement strategy ID.", |
+ "ids": { |
+ "description": "Select only orders with these IDs.", |
"format": "int64", |
- "location": "path", |
- "required": true, |
+ "location": "query", |
+ "repeated": true, |
+ "type": "string" |
+ }, |
+ "maxResults": { |
+ "description": "Maximum number of results to return.", |
+ "format": "int32", |
+ "location": "query", |
+ "type": "integer" |
+ }, |
+ "pageToken": { |
+ "description": "Value of the nextPageToken from the previous result page.", |
+ "location": "query", |
"type": "string" |
}, |
"profileId": { |
@@ -5516,24 +5760,76 @@ |
"location": "path", |
"required": true, |
"type": "string" |
- } |
- }, |
- "path": "userprofiles/{profileId}/placementStrategies/{id}", |
- "scopes": [ |
- "https://www.googleapis.com/auth/dfatrafficking" |
- ] |
- }, |
- "get": { |
- "description": "Gets one placement strategy by ID.", |
- "httpMethod": "GET", |
- "id": "dfareporting.placementStrategies.get", |
- "parameterOrder": [ |
+ }, |
+ "projectId": { |
+ "description": "Project ID for orders.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ }, |
+ "searchString": { |
+ "description": "Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, \"order*2015\" will return orders with names like \"order June 2015\", \"order April 2015\", or simply \"order 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"order\" will match orders with name \"my order\", \"order 2015\", or simply \"order\".", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "siteId": { |
+ "description": "Select only orders that are associated with these site IDs.", |
+ "format": "int64", |
+ "location": "query", |
+ "repeated": true, |
+ "type": "string" |
+ }, |
+ "sortField": { |
+ "description": "Field by which to sort the list.", |
+ "enum": [ |
+ "ID", |
+ "NAME" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "sortOrder": { |
+ "description": "Order of sorted results, default is ASCENDING.", |
+ "enum": [ |
+ "ASCENDING", |
+ "DESCENDING" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/projects/{projectId}/orders", |
+ "response": { |
+ "$ref": "OrdersListResponse" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ } |
+ } |
+ }, |
+ "placementGroups": { |
+ "methods": { |
+ "get": { |
+ "description": "Gets one placement group by ID.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.placementGroups.get", |
+ "parameterOrder": [ |
"profileId", |
"id" |
], |
"parameters": { |
"id": { |
- "description": "Placement strategy ID.", |
+ "description": "Placement group ID.", |
"format": "int64", |
"location": "path", |
"required": true, |
@@ -5547,18 +5843,18 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/placementStrategies/{id}", |
+ "path": "userprofiles/{profileId}/placementGroups/{id}", |
"response": { |
- "$ref": "PlacementStrategy" |
+ "$ref": "PlacementGroup" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
] |
}, |
"insert": { |
- "description": "Inserts a new placement strategy.", |
+ "description": "Inserts a new placement group.", |
"httpMethod": "POST", |
- "id": "dfareporting.placementStrategies.insert", |
+ "id": "dfareporting.placementGroups.insert", |
"parameterOrder": [ |
"profileId" |
], |
@@ -5571,43 +5867,136 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/placementStrategies", |
+ "path": "userprofiles/{profileId}/placementGroups", |
"request": { |
- "$ref": "PlacementStrategy" |
+ "$ref": "PlacementGroup" |
}, |
"response": { |
- "$ref": "PlacementStrategy" |
+ "$ref": "PlacementGroup" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
] |
}, |
"list": { |
- "description": "Retrieves a list of placement strategies, possibly filtered.", |
+ "description": "Retrieves a list of placement groups, possibly filtered.", |
"httpMethod": "GET", |
- "id": "dfareporting.placementStrategies.list", |
+ "id": "dfareporting.placementGroups.list", |
"parameterOrder": [ |
"profileId" |
], |
"parameters": { |
+ "advertiserIds": { |
+ "description": "Select only placement groups that belong to these advertisers.", |
+ "format": "int64", |
+ "location": "query", |
+ "repeated": true, |
+ "type": "string" |
+ }, |
+ "archived": { |
+ "description": "Select only archived placements. Don't set this field to select both archived and non-archived placements.", |
+ "location": "query", |
+ "type": "boolean" |
+ }, |
+ "campaignIds": { |
+ "description": "Select only placement groups that belong to these campaigns.", |
+ "format": "int64", |
+ "location": "query", |
+ "repeated": true, |
+ "type": "string" |
+ }, |
+ "contentCategoryIds": { |
+ "description": "Select only placement groups that are associated with these content categories.", |
+ "format": "int64", |
+ "location": "query", |
+ "repeated": true, |
+ "type": "string" |
+ }, |
+ "directorySiteIds": { |
+ "description": "Select only placement groups that are associated with these directory sites.", |
+ "format": "int64", |
+ "location": "query", |
+ "repeated": true, |
+ "type": "string" |
+ }, |
"ids": { |
- "description": "Select only placement strategies with these IDs.", |
+ "description": "Select only placement groups with these IDs.", |
"format": "int64", |
"location": "query", |
"repeated": true, |
"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.", |
"format": "int32", |
"location": "query", |
"type": "integer" |
}, |
+ "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" |
}, |
+ "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.", |
+ "enum": [ |
+ "PLACEMENT_PACKAGE", |
+ "PLACEMENT_ROADBLOCK" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "placementStrategyIds": { |
+ "description": "Select only placement groups that are associated with these placement strategies.", |
+ "format": "int64", |
+ "location": "query", |
+ "repeated": true, |
+ "type": "string" |
+ }, |
+ "pricingTypes": { |
+ "description": "Select only placement groups with these pricing types.", |
+ "enum": [ |
+ "PRICING_TYPE_CPA", |
+ "PRICING_TYPE_CPC", |
+ "PRICING_TYPE_CPM", |
+ "PRICING_TYPE_FLAT_RATE_CLICKS", |
+ "PRICING_TYPE_FLAT_RATE_IMPRESSIONS" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "", |
+ "", |
+ "", |
+ "" |
+ ], |
+ "location": "query", |
+ "repeated": true, |
+ "type": "string" |
+ }, |
"profileId": { |
"description": "User profile ID associated with this request.", |
"format": "int64", |
@@ -5616,8 +6005,15 @@ |
"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\".", |
+ "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" |
+ }, |
+ "siteIds": { |
+ "description": "Select only placement groups that are associated with these sites.", |
+ "format": "int64", |
"location": "query", |
+ "repeated": true, |
"type": "string" |
}, |
"sortField": { |
@@ -5647,25 +6043,25 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/placementStrategies", |
+ "path": "userprofiles/{profileId}/placementGroups", |
"response": { |
- "$ref": "PlacementStrategiesListResponse" |
+ "$ref": "PlacementGroupsListResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
] |
}, |
"patch": { |
- "description": "Updates an existing placement strategy. This method supports patch semantics.", |
+ "description": "Updates an existing placement group. This method supports patch semantics.", |
"httpMethod": "PATCH", |
- "id": "dfareporting.placementStrategies.patch", |
+ "id": "dfareporting.placementGroups.patch", |
"parameterOrder": [ |
"profileId", |
"id" |
], |
"parameters": { |
"id": { |
- "description": "Placement strategy ID.", |
+ "description": "Placement group ID.", |
"format": "int64", |
"location": "query", |
"required": true, |
@@ -5679,21 +6075,21 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/placementStrategies", |
+ "path": "userprofiles/{profileId}/placementGroups", |
"request": { |
- "$ref": "PlacementStrategy" |
+ "$ref": "PlacementGroup" |
}, |
"response": { |
- "$ref": "PlacementStrategy" |
+ "$ref": "PlacementGroup" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
] |
}, |
"update": { |
- "description": "Updates an existing placement strategy.", |
+ "description": "Updates an existing placement group.", |
"httpMethod": "PUT", |
- "id": "dfareporting.placementStrategies.update", |
+ "id": "dfareporting.placementGroups.update", |
"parameterOrder": [ |
"profileId" |
], |
@@ -5706,12 +6102,12 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/placementStrategies", |
+ "path": "userprofiles/{profileId}/placementGroups", |
"request": { |
- "$ref": "PlacementStrategy" |
+ "$ref": "PlacementGroup" |
}, |
"response": { |
- "$ref": "PlacementStrategy" |
+ "$ref": "PlacementGroup" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
@@ -5719,27 +6115,51 @@ |
} |
} |
}, |
- "placements": { |
+ "placementStrategies": { |
"methods": { |
- "generatetags": { |
- "description": "Generates tags for a placement.", |
- "httpMethod": "POST", |
- "id": "dfareporting.placements.generatetags", |
+ "delete": { |
+ "description": "Deletes an existing placement strategy.", |
+ "httpMethod": "DELETE", |
+ "id": "dfareporting.placementStrategies.delete", |
"parameterOrder": [ |
- "profileId" |
+ "profileId", |
+ "id" |
], |
"parameters": { |
- "campaignId": { |
- "description": "Generate placements belonging to this campaign. This is a required field.", |
+ "id": { |
+ "description": "Placement strategy ID.", |
"format": "int64", |
- "location": "query", |
+ "location": "path", |
+ "required": true, |
"type": "string" |
}, |
- "placementIds": { |
- "description": "Generate tags for these placements.", |
+ "profileId": { |
+ "description": "User profile ID associated with this request.", |
"format": "int64", |
- "location": "query", |
- "repeated": true, |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/placementStrategies/{id}", |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
+ "get": { |
+ "description": "Gets one placement strategy by ID.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.placementStrategies.get", |
+ "parameterOrder": [ |
+ "profileId", |
+ "id" |
+ ], |
+ "parameters": { |
+ "id": { |
+ "description": "Placement strategy ID.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
"type": "string" |
}, |
"profileId": { |
@@ -5748,19 +6168,227 @@ |
"location": "path", |
"required": true, |
"type": "string" |
- }, |
- "tagFormats": { |
- "description": "Tag formats to generate for these placements.", |
- "enum": [ |
- "PLACEMENT_TAG_CLICK_COMMANDS", |
- "PLACEMENT_TAG_IFRAME_ILAYER", |
- "PLACEMENT_TAG_IFRAME_JAVASCRIPT", |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/placementStrategies/{id}", |
+ "response": { |
+ "$ref": "PlacementStrategy" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
+ "insert": { |
+ "description": "Inserts a new placement strategy.", |
+ "httpMethod": "POST", |
+ "id": "dfareporting.placementStrategies.insert", |
+ "parameterOrder": [ |
+ "profileId" |
+ ], |
+ "parameters": { |
+ "profileId": { |
+ "description": "User profile ID associated with this request.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/placementStrategies", |
+ "request": { |
+ "$ref": "PlacementStrategy" |
+ }, |
+ "response": { |
+ "$ref": "PlacementStrategy" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
+ "list": { |
+ "description": "Retrieves a list of placement strategies, possibly filtered.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.placementStrategies.list", |
+ "parameterOrder": [ |
+ "profileId" |
+ ], |
+ "parameters": { |
+ "ids": { |
+ "description": "Select only placement strategies with these IDs.", |
+ "format": "int64", |
+ "location": "query", |
+ "repeated": true, |
+ "type": "string" |
+ }, |
+ "maxResults": { |
+ "description": "Maximum number of results to return.", |
+ "format": "int32", |
+ "location": "query", |
+ "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, \"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.", |
+ "enum": [ |
+ "ID", |
+ "NAME" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "sortOrder": { |
+ "description": "Order of sorted results, default is ASCENDING.", |
+ "enum": [ |
+ "ASCENDING", |
+ "DESCENDING" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/placementStrategies", |
+ "response": { |
+ "$ref": "PlacementStrategiesListResponse" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
+ "patch": { |
+ "description": "Updates an existing placement strategy. This method supports patch semantics.", |
+ "httpMethod": "PATCH", |
+ "id": "dfareporting.placementStrategies.patch", |
+ "parameterOrder": [ |
+ "profileId", |
+ "id" |
+ ], |
+ "parameters": { |
+ "id": { |
+ "description": "Placement strategy 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}/placementStrategies", |
+ "request": { |
+ "$ref": "PlacementStrategy" |
+ }, |
+ "response": { |
+ "$ref": "PlacementStrategy" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
+ "update": { |
+ "description": "Updates an existing placement strategy.", |
+ "httpMethod": "PUT", |
+ "id": "dfareporting.placementStrategies.update", |
+ "parameterOrder": [ |
+ "profileId" |
+ ], |
+ "parameters": { |
+ "profileId": { |
+ "description": "User profile ID associated with this request.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/placementStrategies", |
+ "request": { |
+ "$ref": "PlacementStrategy" |
+ }, |
+ "response": { |
+ "$ref": "PlacementStrategy" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ } |
+ } |
+ }, |
+ "placements": { |
+ "methods": { |
+ "generatetags": { |
+ "description": "Generates tags for a placement.", |
+ "httpMethod": "POST", |
+ "id": "dfareporting.placements.generatetags", |
+ "parameterOrder": [ |
+ "profileId" |
+ ], |
+ "parameters": { |
+ "campaignId": { |
+ "description": "Generate placements belonging to this campaign. This is a required field.", |
+ "format": "int64", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "placementIds": { |
+ "description": "Generate tags for these placements.", |
+ "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" |
+ }, |
+ "tagFormats": { |
+ "description": "Tag formats to generate for these placements.", |
+ "enum": [ |
+ "PLACEMENT_TAG_CLICK_COMMANDS", |
+ "PLACEMENT_TAG_IFRAME_ILAYER", |
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT", |
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY", |
"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH", |
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3", |
"PLACEMENT_TAG_INTERNAL_REDIRECT", |
"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT", |
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY", |
"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT", |
"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT", |
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY", |
"PLACEMENT_TAG_JAVASCRIPT", |
+ "PLACEMENT_TAG_JAVASCRIPT_LEGACY", |
"PLACEMENT_TAG_STANDARD", |
"PLACEMENT_TAG_TRACKING", |
"PLACEMENT_TAG_TRACKING_IFRAME", |
@@ -5779,6 +6407,11 @@ |
"", |
"", |
"", |
+ "", |
+ "", |
+ "", |
+ "", |
+ "", |
"" |
], |
"location": "query", |
@@ -5928,12 +6561,32 @@ |
"repeated": true, |
"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.", |
"format": "int32", |
"location": "query", |
"type": "integer" |
}, |
+ "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", |
@@ -6032,27 +6685,454 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/placements", |
+ "path": "userprofiles/{profileId}/placements", |
+ "response": { |
+ "$ref": "PlacementsListResponse" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
+ "patch": { |
+ "description": "Updates an existing placement. This method supports patch semantics.", |
+ "httpMethod": "PATCH", |
+ "id": "dfareporting.placements.patch", |
+ "parameterOrder": [ |
+ "profileId", |
+ "id" |
+ ], |
+ "parameters": { |
+ "id": { |
+ "description": "Placement 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}/placements", |
+ "request": { |
+ "$ref": "Placement" |
+ }, |
+ "response": { |
+ "$ref": "Placement" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
+ "update": { |
+ "description": "Updates an existing placement.", |
+ "httpMethod": "PUT", |
+ "id": "dfareporting.placements.update", |
+ "parameterOrder": [ |
+ "profileId" |
+ ], |
+ "parameters": { |
+ "profileId": { |
+ "description": "User profile ID associated with this request.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/placements", |
+ "request": { |
+ "$ref": "Placement" |
+ }, |
+ "response": { |
+ "$ref": "Placement" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ } |
+ } |
+ }, |
+ "platformTypes": { |
+ "methods": { |
+ "get": { |
+ "description": "Gets one platform type by ID.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.platformTypes.get", |
+ "parameterOrder": [ |
+ "profileId", |
+ "id" |
+ ], |
+ "parameters": { |
+ "id": { |
+ "description": "Platform 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}/platformTypes/{id}", |
+ "response": { |
+ "$ref": "PlatformType" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
+ "list": { |
+ "description": "Retrieves a list of platform types.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.platformTypes.list", |
+ "parameterOrder": [ |
+ "profileId" |
+ ], |
+ "parameters": { |
+ "profileId": { |
+ "description": "User profile ID associated with this request.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/platformTypes", |
+ "response": { |
+ "$ref": "PlatformTypesListResponse" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ } |
+ } |
+ }, |
+ "postalCodes": { |
+ "methods": { |
+ "get": { |
+ "description": "Gets one postal code by ID.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.postalCodes.get", |
+ "parameterOrder": [ |
+ "profileId", |
+ "code" |
+ ], |
+ "parameters": { |
+ "code": { |
+ "description": "Postal code ID.", |
+ "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}/postalCodes/{code}", |
+ "response": { |
+ "$ref": "PostalCode" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
+ "list": { |
+ "description": "Retrieves a list of postal codes.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.postalCodes.list", |
+ "parameterOrder": [ |
+ "profileId" |
+ ], |
+ "parameters": { |
+ "profileId": { |
+ "description": "User profile ID associated with this request.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/postalCodes", |
+ "response": { |
+ "$ref": "PostalCodesListResponse" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ } |
+ } |
+ }, |
+ "projects": { |
+ "methods": { |
+ "get": { |
+ "description": "Gets one project by ID.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.projects.get", |
+ "parameterOrder": [ |
+ "profileId", |
+ "id" |
+ ], |
+ "parameters": { |
+ "id": { |
+ "description": "Project 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}/projects/{id}", |
+ "response": { |
+ "$ref": "Project" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
+ "list": { |
+ "description": "Retrieves a list of projects, possibly filtered.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.projects.list", |
+ "parameterOrder": [ |
+ "profileId" |
+ ], |
+ "parameters": { |
+ "advertiserIds": { |
+ "description": "Select only projects with these advertiser IDs.", |
+ "format": "int64", |
+ "location": "query", |
+ "repeated": true, |
+ "type": "string" |
+ }, |
+ "ids": { |
+ "description": "Select only projects with these IDs.", |
+ "format": "int64", |
+ "location": "query", |
+ "repeated": true, |
+ "type": "string" |
+ }, |
+ "maxResults": { |
+ "description": "Maximum number of results to return.", |
+ "format": "int32", |
+ "location": "query", |
+ "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 projects by name or ID. Wildcards (*) are allowed. For example, \"project*2015\" will return projects with names like \"project June 2015\", \"project April 2015\", or simply \"project 2015\". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of \"project\" will match projects with name \"my project\", \"project 2015\", or simply \"project\".", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "sortField": { |
+ "description": "Field by which to sort the list.", |
+ "enum": [ |
+ "ID", |
+ "NAME" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "sortOrder": { |
+ "description": "Order of sorted results, default is ASCENDING.", |
+ "enum": [ |
+ "ASCENDING", |
+ "DESCENDING" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/projects", |
+ "response": { |
+ "$ref": "ProjectsListResponse" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ } |
+ } |
+ }, |
+ "regions": { |
+ "methods": { |
+ "list": { |
+ "description": "Retrieves a list of regions.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.regions.list", |
+ "parameterOrder": [ |
+ "profileId" |
+ ], |
+ "parameters": { |
+ "profileId": { |
+ "description": "User profile ID associated with this request.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/regions", |
+ "response": { |
+ "$ref": "RegionsListResponse" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ } |
+ } |
+ }, |
+ "remarketingListShares": { |
+ "methods": { |
+ "get": { |
+ "description": "Gets one remarketing list share by remarketing list ID.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.remarketingListShares.get", |
+ "parameterOrder": [ |
+ "profileId", |
+ "remarketingListId" |
+ ], |
+ "parameters": { |
+ "profileId": { |
+ "description": "User profile ID associated with this request.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ }, |
+ "remarketingListId": { |
+ "description": "Remarketing list ID.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/remarketingListShares/{remarketingListId}", |
+ "response": { |
+ "$ref": "RemarketingListShare" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
+ "patch": { |
+ "description": "Updates an existing remarketing list share. This method supports patch semantics.", |
+ "httpMethod": "PATCH", |
+ "id": "dfareporting.remarketingListShares.patch", |
+ "parameterOrder": [ |
+ "profileId", |
+ "remarketingListId" |
+ ], |
+ "parameters": { |
+ "profileId": { |
+ "description": "User profile ID associated with this request.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ }, |
+ "remarketingListId": { |
+ "description": "Remarketing list ID.", |
+ "format": "int64", |
+ "location": "query", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/remarketingListShares", |
+ "request": { |
+ "$ref": "RemarketingListShare" |
+ }, |
+ "response": { |
+ "$ref": "RemarketingListShare" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
+ "update": { |
+ "description": "Updates an existing remarketing list share.", |
+ "httpMethod": "PUT", |
+ "id": "dfareporting.remarketingListShares.update", |
+ "parameterOrder": [ |
+ "profileId" |
+ ], |
+ "parameters": { |
+ "profileId": { |
+ "description": "User profile ID associated with this request.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/remarketingListShares", |
+ "request": { |
+ "$ref": "RemarketingListShare" |
+ }, |
"response": { |
- "$ref": "PlacementsListResponse" |
+ "$ref": "RemarketingListShare" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
] |
- }, |
- "patch": { |
- "description": "Updates an existing placement. This method supports patch semantics.", |
- "httpMethod": "PATCH", |
- "id": "dfareporting.placements.patch", |
+ } |
+ } |
+ }, |
+ "remarketingLists": { |
+ "methods": { |
+ "get": { |
+ "description": "Gets one remarketing list by ID.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.remarketingLists.get", |
"parameterOrder": [ |
"profileId", |
"id" |
], |
"parameters": { |
"id": { |
- "description": "Placement ID.", |
+ "description": "Remarketing list ID.", |
"format": "int64", |
- "location": "query", |
+ "location": "path", |
"required": true, |
"type": "string" |
}, |
@@ -6064,21 +7144,18 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/placements", |
- "request": { |
- "$ref": "Placement" |
- }, |
+ "path": "userprofiles/{profileId}/remarketingLists/{id}", |
"response": { |
- "$ref": "Placement" |
+ "$ref": "RemarketingList" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
] |
}, |
- "update": { |
- "description": "Updates an existing placement.", |
- "httpMethod": "PUT", |
- "id": "dfareporting.placements.update", |
+ "insert": { |
+ "description": "Inserts a new remarketing list.", |
+ "httpMethod": "POST", |
+ "id": "dfareporting.remarketingLists.insert", |
"parameterOrder": [ |
"profileId" |
], |
@@ -6091,57 +7168,118 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/placements", |
+ "path": "userprofiles/{profileId}/remarketingLists", |
"request": { |
- "$ref": "Placement" |
+ "$ref": "RemarketingList" |
}, |
"response": { |
- "$ref": "Placement" |
+ "$ref": "RemarketingList" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
] |
- } |
- } |
- }, |
- "platformTypes": { |
- "methods": { |
+ }, |
"list": { |
- "description": "Retrieves a list of platform types.", |
+ "description": "Retrieves a list of remarketing lists, possibly filtered.", |
"httpMethod": "GET", |
- "id": "dfareporting.platformTypes.list", |
+ "id": "dfareporting.remarketingLists.list", |
"parameterOrder": [ |
- "profileId" |
+ "profileId", |
+ "advertiserId" |
], |
"parameters": { |
+ "active": { |
+ "description": "Select only active or only inactive remarketing lists.", |
+ "location": "query", |
+ "type": "boolean" |
+ }, |
+ "advertiserId": { |
+ "description": "Select only remarketing lists owned by this advertiser.", |
+ "format": "int64", |
+ "location": "query", |
+ "required": true, |
+ "type": "string" |
+ }, |
+ "floodlightActivityId": { |
+ "description": "Select only remarketing lists that have this floodlight activity ID.", |
+ "format": "int64", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "maxResults": { |
+ "description": "Maximum number of results to return.", |
+ "format": "int32", |
+ "location": "query", |
+ "type": "integer" |
+ }, |
+ "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" |
+ }, |
"profileId": { |
"description": "User profile ID associated with this request.", |
"format": "int64", |
"location": "path", |
"required": true, |
"type": "string" |
+ }, |
+ "sortField": { |
+ "description": "Field by which to sort the list.", |
+ "enum": [ |
+ "ID", |
+ "NAME" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "sortOrder": { |
+ "description": "Order of sorted results, default is ASCENDING.", |
+ "enum": [ |
+ "ASCENDING", |
+ "DESCENDING" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "location": "query", |
+ "type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/platformTypes", |
+ "path": "userprofiles/{profileId}/remarketingLists", |
"response": { |
- "$ref": "PlatformTypesListResponse" |
+ "$ref": "RemarketingListsListResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
] |
- } |
- } |
- }, |
- "postalCodes": { |
- "methods": { |
- "list": { |
- "description": "Retrieves a list of postal codes.", |
- "httpMethod": "GET", |
- "id": "dfareporting.postalCodes.list", |
+ }, |
+ "patch": { |
+ "description": "Updates an existing remarketing list. This method supports patch semantics.", |
+ "httpMethod": "PATCH", |
+ "id": "dfareporting.remarketingLists.patch", |
"parameterOrder": [ |
- "profileId" |
+ "profileId", |
+ "id" |
], |
"parameters": { |
+ "id": { |
+ "description": "Remarketing list ID.", |
+ "format": "int64", |
+ "location": "query", |
+ "required": true, |
+ "type": "string" |
+ }, |
"profileId": { |
"description": "User profile ID associated with this request.", |
"format": "int64", |
@@ -6150,22 +7288,21 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/postalCodes", |
+ "path": "userprofiles/{profileId}/remarketingLists", |
+ "request": { |
+ "$ref": "RemarketingList" |
+ }, |
"response": { |
- "$ref": "PostalCodesListResponse" |
+ "$ref": "RemarketingList" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
] |
- } |
- } |
- }, |
- "regions": { |
- "methods": { |
- "list": { |
- "description": "Retrieves a list of regions.", |
- "httpMethod": "GET", |
- "id": "dfareporting.regions.list", |
+ }, |
+ "update": { |
+ "description": "Updates an existing remarketing list.", |
+ "httpMethod": "PUT", |
+ "id": "dfareporting.remarketingLists.update", |
"parameterOrder": [ |
"profileId" |
], |
@@ -6178,9 +7315,12 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/regions", |
+ "path": "userprofiles/{profileId}/remarketingLists", |
+ "request": { |
+ "$ref": "RemarketingList" |
+ }, |
"response": { |
- "$ref": "RegionsListResponse" |
+ "$ref": "RemarketingList" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
@@ -7163,12 +8303,127 @@ |
"type": "string" |
} |
}, |
- "path": "userprofiles/{profileId}/subaccounts", |
- "request": { |
- "$ref": "Subaccount" |
- }, |
+ "path": "userprofiles/{profileId}/subaccounts", |
+ "request": { |
+ "$ref": "Subaccount" |
+ }, |
+ "response": { |
+ "$ref": "Subaccount" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ } |
+ } |
+ }, |
+ "targetableRemarketingLists": { |
+ "methods": { |
+ "get": { |
+ "description": "Gets one remarketing list by ID.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.targetableRemarketingLists.get", |
+ "parameterOrder": [ |
+ "profileId", |
+ "id" |
+ ], |
+ "parameters": { |
+ "id": { |
+ "description": "Remarketing list 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}/targetableRemarketingLists/{id}", |
+ "response": { |
+ "$ref": "TargetableRemarketingList" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/dfatrafficking" |
+ ] |
+ }, |
+ "list": { |
+ "description": "Retrieves a list of targetable remarketing lists, possibly filtered.", |
+ "httpMethod": "GET", |
+ "id": "dfareporting.targetableRemarketingLists.list", |
+ "parameterOrder": [ |
+ "profileId", |
+ "advertiserId" |
+ ], |
+ "parameters": { |
+ "active": { |
+ "description": "Select only active or only inactive targetable remarketing lists.", |
+ "location": "query", |
+ "type": "boolean" |
+ }, |
+ "advertiserId": { |
+ "description": "Select only targetable remarketing lists targetable by these advertisers.", |
+ "format": "int64", |
+ "location": "query", |
+ "required": true, |
+ "type": "string" |
+ }, |
+ "maxResults": { |
+ "description": "Maximum number of results to return.", |
+ "format": "int32", |
+ "location": "query", |
+ "type": "integer" |
+ }, |
+ "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" |
+ }, |
+ "profileId": { |
+ "description": "User profile ID associated with this request.", |
+ "format": "int64", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ }, |
+ "sortField": { |
+ "description": "Field by which to sort the list.", |
+ "enum": [ |
+ "ID", |
+ "NAME" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "sortOrder": { |
+ "description": "Order of sorted results, default is ASCENDING.", |
+ "enum": [ |
+ "ASCENDING", |
+ "DESCENDING" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "location": "query", |
+ "type": "string" |
+ } |
+ }, |
+ "path": "userprofiles/{profileId}/targetableRemarketingLists", |
"response": { |
- "$ref": "Subaccount" |
+ "$ref": "TargetableRemarketingListsListResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/dfatrafficking" |
@@ -7584,7 +8839,7 @@ |
} |
} |
}, |
- "revision": "20150326", |
+ "revision": "20150717", |
"rootUrl": "https://www.googleapis.com/", |
"schemas": { |
"Account": { |
@@ -8182,7 +9437,7 @@ |
}, |
"type": "array" |
}, |
- "remarketing_list_expression": { |
+ "remarketingListExpression": { |
"$ref": "ListTargetingExpression", |
"description": "Applicable when type is AD_SERVING_STANDARD_AD. Remarketing list targeting expression for this ad." |
}, |
@@ -8231,6 +9486,70 @@ |
}, |
"type": "object" |
}, |
+ "AdSlot": { |
+ "description": "Ad Slot", |
+ "id": "AdSlot", |
+ "properties": { |
+ "comment": { |
+ "description": "Comment for this ad slot.", |
+ "type": "string" |
+ }, |
+ "compatibility": { |
+ "description": "Ad slot compatibility. WEB and WEB_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.", |
+ "enum": [ |
+ "PLANNING_RENDERING_ENVIRONMENT_TYPE_APP", |
+ "PLANNING_RENDERING_ENVIRONMENT_TYPE_APP_INTERSTITIAL", |
+ "PLANNING_RENDERING_ENVIRONMENT_TYPE_IN_STREAM_VIDEO", |
+ "PLANNING_RENDERING_ENVIRONMENT_TYPE_WEB", |
+ "PLANNING_RENDERING_ENVIRONMENT_TYPE_WEB_INTERSTITIAL" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "", |
+ "", |
+ "", |
+ "" |
+ ], |
+ "type": "string" |
+ }, |
+ "height": { |
+ "description": "Height of this ad slot.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "linkedPlacementId": { |
+ "description": "ID of the placement from an external platform that is linked to this ad slot.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "name": { |
+ "description": "Name of this ad slot.", |
+ "type": "string" |
+ }, |
+ "paymentSourceType": { |
+ "description": "Payment source type of this ad slot.", |
+ "enum": [ |
+ "PLANNING_PAYMENT_SOURCE_TYPE_AGENCY_PAID", |
+ "PLANNING_PAYMENT_SOURCE_TYPE_PUBLISHER_PAID" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "type": "string" |
+ }, |
+ "primary": { |
+ "description": "Primary ad slot of a roadblock inventory item.", |
+ "type": "boolean" |
+ }, |
+ "width": { |
+ "description": "Width of this ad slot.", |
+ "format": "int64", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
"AdsListResponse": { |
"description": "Ad List Response", |
"id": "AdsListResponse", |
@@ -8308,6 +9627,11 @@ |
"description": "Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.", |
"type": "string" |
}, |
+ "originalFloodlightConfigurationId": { |
+ "description": "Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
"status": { |
"description": "Status of this advertiser.", |
"enum": [ |
@@ -8324,6 +9648,10 @@ |
"description": "Subaccount ID of this advertiser.This is a read-only field that can be left blank.", |
"format": "int64", |
"type": "string" |
+ }, |
+ "suspended": { |
+ "description": "Suspension status of this advertiser.", |
+ "type": "boolean" |
} |
}, |
"type": "object" |
@@ -8887,6 +10215,10 @@ |
"description": "Click-through URL", |
"id": "ClickThroughUrl", |
"properties": { |
+ "computedClickThroughUrl": { |
+ "description": "Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: \n- If defaultLandingPage is enabled then the campaign's default landing page URL is assigned to this field.\n- If defaultLandingPage is not enabled and a landingPageId is specified then that landing page's URL is assigned to this field.\n- If neither of the above cases apply, then the customClickThroughUrl is assigned to this field.", |
+ "type": "string" |
+ }, |
"customClickThroughUrl": { |
"description": "Custom click-through URL. Applicable if the defaultLandingPage field is set to false and the landingPageId field is left unset.", |
"type": "string" |
@@ -9038,10 +10370,6 @@ |
"format": "int64", |
"type": "string" |
}, |
- "description": { |
- "description": "Description of this content category.", |
- "type": "string" |
- }, |
"id": { |
"description": "ID of this content category. This is a read-only, auto-generated field.", |
"format": "int64", |
@@ -9373,6 +10701,10 @@ |
}, |
"type": "array" |
}, |
+ "convertFlashToHtml5": { |
+ "description": "Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative types: ENHANCED_BANNER and FLASH_INPAGE.", |
+ "type": "boolean" |
+ }, |
"counterCustomEvents": { |
"description": "List of counter events configured for the creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", |
"items": { |
@@ -9485,6 +10817,10 @@ |
"description": "Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types.", |
"type": "boolean" |
}, |
+ "sslOverride": { |
+ "description": "Whether creative should be treated as SSL compliant even if the system scan shows it's not.", |
+ "type": "boolean" |
+ }, |
"studioAdvertiserId": { |
"description": "Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID.", |
"format": "int64", |
@@ -9556,6 +10892,7 @@ |
"RICH_MEDIA_MULTI_FLOATING", |
"RICH_MEDIA_PEEL_DOWN", |
"TRACKING_TEXT", |
+ "VAST_REDIRECT", |
"VPAID_LINEAR", |
"VPAID_NON_LINEAR" |
], |
@@ -9582,6 +10919,7 @@ |
"", |
"", |
"", |
+ "", |
"" |
], |
"type": "string" |
@@ -10375,10 +11713,6 @@ |
"description": "Creative Custom Event.", |
"id": "CreativeCustomEvent", |
"properties": { |
- "active": { |
- "description": "Whether the event is active.", |
- "type": "boolean" |
- }, |
"advertiserCustomEventName": { |
"description": "User-entered name for the event.", |
"type": "string" |
@@ -11317,6 +12651,10 @@ |
"description": "Contains properties of a Site Directory contact.", |
"id": "DirectorySiteContact", |
"properties": { |
+ "address": { |
+ "description": "Address of this directory site contact.", |
+ "type": "string" |
+ }, |
"email": { |
"description": "Email address of this directory site contact.", |
"type": "string" |
@@ -11339,6 +12677,10 @@ |
"description": "Last name of this directory site contact.", |
"type": "string" |
}, |
+ "phone": { |
+ "description": "Phone number of this directory site contact.", |
+ "type": "string" |
+ }, |
"role": { |
"description": "Directory site contact role.", |
"enum": [ |
@@ -11353,6 +12695,10 @@ |
], |
"type": "string" |
}, |
+ "title": { |
+ "description": "Title or designation of this directory site contact.", |
+ "type": "string" |
+ }, |
"type": { |
"description": "Directory site contact type.", |
"enum": [ |
@@ -11508,6 +12854,10 @@ |
"description": "Whether this event tag should be automatically enabled for all of the advertiser's campaigns and ads.", |
"type": "boolean" |
}, |
+ "excludeFromAdxRequests": { |
+ "description": "Whether to remove this event tag from ads that are trafficked through DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag uses a pixel that is unapproved for Ad Exchange bids on one or more networks, such as the Google Display Network.", |
+ "type": "boolean" |
+ }, |
"id": { |
"description": "ID of this event tag. This is a read-only, auto-generated field.", |
"format": "int64", |
@@ -11543,7 +12893,7 @@ |
"type": "array" |
}, |
"sslCompliant": { |
- "description": "Whether this tag is SSL-compliant or not.", |
+ "description": "Whether this tag is SSL-compliant or not. This is a read-only field.", |
"type": "boolean" |
}, |
"status": { |
@@ -11732,6 +13082,33 @@ |
}, |
"type": "object" |
}, |
+ "Flight": { |
+ "description": "Flight", |
+ "id": "Flight", |
+ "properties": { |
+ "endDate": { |
+ "description": "Inventory item flight end date.", |
+ "format": "date", |
+ "type": "string" |
+ }, |
+ "rateOrCost": { |
+ "description": "Rate or cost of this flight.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "startDate": { |
+ "description": "Inventory item flight start date.", |
+ "format": "date", |
+ "type": "string" |
+ }, |
+ "units": { |
+ "description": "Units of this flight.", |
+ "format": "int64", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
"FloodlightActivitiesGenerateTagResponse": { |
"description": "Floodlight Activity GenerateTag Response", |
"id": "FloodlightActivitiesGenerateTagResponse", |
@@ -11886,246 +13263,86 @@ |
"imageTagEnabled": { |
"description": "Whether the image tag is enabled for this activity.", |
"type": "boolean" |
- }, |
- "kind": { |
- "default": "dfareporting#floodlightActivity", |
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivity\".", |
- "type": "string" |
- }, |
- "name": { |
- "description": "Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.", |
- "type": "string" |
- }, |
- "notes": { |
- "description": "General notes or implementation instructions for the tag.", |
- "type": "string" |
- }, |
- "publisherTags": { |
- "description": "Publisher dynamic floodlight tags.", |
- "items": { |
- "$ref": "FloodlightActivityPublisherDynamicTag" |
- }, |
- "type": "array" |
- }, |
- "secure": { |
- "description": "Whether this tag should use SSL.", |
- "type": "boolean" |
- }, |
- "sslCompliant": { |
- "description": "Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.", |
- "type": "boolean" |
- }, |
- "sslRequired": { |
- "description": "Whether this floodlight activity must be SSL-compliant.", |
- "type": "boolean" |
- }, |
- "subaccountId": { |
- "description": "Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.", |
- "format": "int64", |
- "type": "string" |
- }, |
- "tagFormat": { |
- "description": "Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.", |
- "enum": [ |
- "HTML", |
- "XHTML" |
- ], |
- "enumDescriptions": [ |
- "", |
- "" |
- ], |
- "type": "string" |
- }, |
- "tagString": { |
- "description": "Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.", |
- "type": "string" |
- }, |
- "userDefinedVariableTypes": { |
- "description": "List of the user-defined variables used by this conversion tag. These map to the \"u[1-20]=\" in the tags. Each of these can have a user defined type.\nAcceptable values are:\n- \"U1\"\n- \"U2\"\n- \"U3\"\n- \"U4\"\n- \"U5\"\n- \"U6\"\n- \"U7\"\n- \"U8\"\n- \"U9\"\n- \"U10\"\n- \"U11\"\n- \"U12\"\n- \"U13\"\n- \"U14\"\n- \"U15\"\n- \"U16\"\n- \"U17\"\n- \"U18\"\n- \"U19\"\n- \"U20\"", |
- "items": { |
- "enum": [ |
- "U1", |
- "U10", |
- "U100", |
- "U11", |
- "U12", |
- "U13", |
- "U14", |
- "U15", |
- "U16", |
- "U17", |
- "U18", |
- "U19", |
- "U2", |
- "U20", |
- "U21", |
- "U22", |
- "U23", |
- "U24", |
- "U25", |
- "U26", |
- "U27", |
- "U28", |
- "U29", |
- "U3", |
- "U30", |
- "U31", |
- "U32", |
- "U33", |
- "U34", |
- "U35", |
- "U36", |
- "U37", |
- "U38", |
- "U39", |
- "U4", |
- "U40", |
- "U41", |
- "U42", |
- "U43", |
- "U44", |
- "U45", |
- "U46", |
- "U47", |
- "U48", |
- "U49", |
- "U5", |
- "U50", |
- "U51", |
- "U52", |
- "U53", |
- "U54", |
- "U55", |
- "U56", |
- "U57", |
- "U58", |
- "U59", |
- "U6", |
- "U60", |
- "U61", |
- "U62", |
- "U63", |
- "U64", |
- "U65", |
- "U66", |
- "U67", |
- "U68", |
- "U69", |
- "U7", |
- "U70", |
- "U71", |
- "U72", |
- "U73", |
- "U74", |
- "U75", |
- "U76", |
- "U77", |
- "U78", |
- "U79", |
- "U8", |
- "U80", |
- "U81", |
- "U82", |
- "U83", |
- "U84", |
- "U85", |
- "U86", |
- "U87", |
- "U88", |
- "U89", |
- "U9", |
- "U90", |
- "U91", |
- "U92", |
- "U93", |
- "U94", |
- "U95", |
- "U96", |
- "U97", |
- "U98", |
- "U99" |
- ], |
- "enumDescriptions": [ |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
+ }, |
+ "kind": { |
+ "default": "dfareporting#floodlightActivity", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightActivity\".", |
+ "type": "string" |
+ }, |
+ "name": { |
+ "description": "Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes.", |
+ "type": "string" |
+ }, |
+ "notes": { |
+ "description": "General notes or implementation instructions for the tag.", |
+ "type": "string" |
+ }, |
+ "publisherTags": { |
+ "description": "Publisher dynamic floodlight tags.", |
+ "items": { |
+ "$ref": "FloodlightActivityPublisherDynamicTag" |
+ }, |
+ "type": "array" |
+ }, |
+ "secure": { |
+ "description": "Whether this tag should use SSL.", |
+ "type": "boolean" |
+ }, |
+ "sslCompliant": { |
+ "description": "Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags.", |
+ "type": "boolean" |
+ }, |
+ "sslRequired": { |
+ "description": "Whether this floodlight activity must be SSL-compliant.", |
+ "type": "boolean" |
+ }, |
+ "subaccountId": { |
+ "description": "Subaccount ID of this floodlight activity. This is a read-only field that can be left blank.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "tagFormat": { |
+ "description": "Tag format type for the floodlight activity. If left blank, the tag format will default to HTML.", |
+ "enum": [ |
+ "HTML", |
+ "XHTML" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "type": "string" |
+ }, |
+ "tagString": { |
+ "description": "Value of the cat= paramter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion.", |
+ "type": "string" |
+ }, |
+ "userDefinedVariableTypes": { |
+ "description": "List of the user-defined variables used by this conversion tag. These map to the \"u[1-20]=\" in the tags. Each of these can have a user defined type.\nAcceptable values are:\n- \"U1\"\n- \"U2\"\n- \"U3\"\n- \"U4\"\n- \"U5\"\n- \"U6\"\n- \"U7\"\n- \"U8\"\n- \"U9\"\n- \"U10\"\n- \"U11\"\n- \"U12\"\n- \"U13\"\n- \"U14\"\n- \"U15\"\n- \"U16\"\n- \"U17\"\n- \"U18\"\n- \"U19\"\n- \"U20\"", |
+ "items": { |
+ "enum": [ |
+ "U1", |
+ "U10", |
+ "U11", |
+ "U12", |
+ "U13", |
+ "U14", |
+ "U15", |
+ "U16", |
+ "U17", |
+ "U18", |
+ "U19", |
+ "U2", |
+ "U20", |
+ "U3", |
+ "U4", |
+ "U5", |
+ "U6", |
+ "U7", |
+ "U8", |
+ "U9" |
+ ], |
+ "enumDescriptions": [ |
"", |
"", |
"", |
@@ -12346,6 +13563,10 @@ |
"$ref": "DimensionValue", |
"description": "Dimension value for the ID of this floodlight configuration. This is a read-only, auto-generated field." |
}, |
+ "inAppAttributionTrackingEnabled": { |
+ "description": "Whether in-app attribution tracking is enabled.", |
+ "type": "boolean" |
+ }, |
"kind": { |
"default": "dfareporting#floodlightConfiguration", |
"description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#floodlightConfiguration\".", |
@@ -12405,6 +13626,13 @@ |
"$ref": "TagSettings", |
"description": "Configuration settings for dynamic and image floodlight tags." |
}, |
+ "thirdPartyAuthenticationTokens": { |
+ "description": "List of third-party authentication tokens enabled for this configuration.", |
+ "items": { |
+ "$ref": "ThirdPartyAuthenticationToken" |
+ }, |
+ "type": "array" |
+ }, |
"userDefinedVariableConfigurations": { |
"description": "List of user defined variables enabled for this configuration.", |
"items": { |
@@ -12569,6 +13797,129 @@ |
}, |
"type": "object" |
}, |
+ "InventoryItem": { |
+ "description": "Represents a buy from the DoubleClick Planning inventory store.", |
+ "id": "InventoryItem", |
+ "properties": { |
+ "accountId": { |
+ "description": "Account ID of this inventory item.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "adSlots": { |
+ "description": "Ad slots of this inventory item. If this inventory item represents a standalone placement, there will be exactly one ad slot. If this inventory item represents a placement group, there will be more than one ad slot, each representing one child placement in that placement group.", |
+ "items": { |
+ "$ref": "AdSlot" |
+ }, |
+ "type": "array" |
+ }, |
+ "advertiserId": { |
+ "description": "Advertiser ID of this inventory item.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "contentCategoryId": { |
+ "description": "Content category ID of this inventory item.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "estimatedClickThroughRate": { |
+ "description": "Estimated click-through rate of this inventory item.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "estimatedConversionRate": { |
+ "description": "Estimated conversion rate of this inventory item.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "id": { |
+ "description": "ID of this inventory item.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "inPlan": { |
+ "description": "Whether this inventory item is in plan.", |
+ "type": "boolean" |
+ }, |
+ "kind": { |
+ "default": "dfareporting#inventoryItem", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItem\".", |
+ "type": "string" |
+ }, |
+ "lastModifiedInfo": { |
+ "$ref": "LastModifiedInfo", |
+ "description": "Information about the most recent modification of this inventory item." |
+ }, |
+ "name": { |
+ "description": "Name of this inventory item. For standalone inventory items, this is the same name as that of its only ad slot. For group inventory items, this can differ from the name of any of its ad slots.", |
+ "type": "string" |
+ }, |
+ "negotiationChannelId": { |
+ "description": "Negotiation channel ID of this inventory item.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "orderId": { |
+ "description": "Order ID of this inventory item.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "placementStrategyId": { |
+ "description": "Placement strategy ID of this inventory item.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "pricing": { |
+ "$ref": "Pricing", |
+ "description": "Pricing of this inventory item." |
+ }, |
+ "projectId": { |
+ "description": "Project ID of this inventory item.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "rfpId": { |
+ "description": "RFP ID of this inventory item.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "siteId": { |
+ "description": "ID of the site this inventory item is associated with.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "subaccountId": { |
+ "description": "Subaccount ID of this inventory item.", |
+ "format": "int64", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "InventoryItemsListResponse": { |
+ "description": "Inventory item List Response", |
+ "id": "InventoryItemsListResponse", |
+ "properties": { |
+ "inventoryItems": { |
+ "description": "Inventory item collection", |
+ "items": { |
+ "$ref": "InventoryItem" |
+ }, |
+ "type": "array" |
+ }, |
+ "kind": { |
+ "default": "dfareporting#inventoryItemsListResponse", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#inventoryItemsListResponse\".", |
+ "type": "string" |
+ }, |
+ "nextPageToken": { |
+ "description": "Pagination token to be used for the next list operation.", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
"KeyValueTargetingExpression": { |
"description": "Key Value Targeting Expression.", |
"id": "KeyValueTargetingExpression", |
@@ -12602,39 +13953,144 @@ |
"description": "Name of this landing page. This is a required field. It must be less than 256 characters long, and must be unique among landing pages of the same campaign.", |
"type": "string" |
}, |
- "url": { |
- "description": "URL of this landing page. This is a required field.", |
+ "url": { |
+ "description": "URL of this landing page. This is a required field.", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "LandingPagesListResponse": { |
+ "description": "Landing Page List Response", |
+ "id": "LandingPagesListResponse", |
+ "properties": { |
+ "kind": { |
+ "default": "dfareporting#landingPagesListResponse", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPagesListResponse\".", |
+ "type": "string" |
+ }, |
+ "landingPages": { |
+ "description": "Landing page collection", |
+ "items": { |
+ "$ref": "LandingPage" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "LastModifiedInfo": { |
+ "description": "Modification timestamp.", |
+ "id": "LastModifiedInfo", |
+ "properties": { |
+ "time": { |
+ "description": "Timestamp of the last change in milliseconds since epoch.", |
+ "format": "int64", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ListPopulationClause": { |
+ "description": "A group clause made up of list population terms representing constraints joined by ORs.", |
+ "id": "ListPopulationClause", |
+ "properties": { |
+ "terms": { |
+ "description": "Terms of this list population clause. Each clause is made up of list population terms representing constraints and are joined by ORs.", |
+ "items": { |
+ "$ref": "ListPopulationTerm" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ListPopulationRule": { |
+ "description": "Remarketing List Population Rule.", |
+ "id": "ListPopulationRule", |
+ "properties": { |
+ "floodlightActivityId": { |
+ "description": "Floodlight activity ID associated with this rule. This field can be left blank.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "floodlightActivityName": { |
+ "description": "Name of floodlight activity associated with this rule. This is a read-only, auto-generated field.", |
+ "type": "string" |
+ }, |
+ "listPopulationClauses": { |
+ "description": "Clauses that make up this list population rule. Clauses are joined by ANDs, and the clauses themselves are made up of list population terms which are joined by ORs.", |
+ "items": { |
+ "$ref": "ListPopulationClause" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ListPopulationTerm": { |
+ "description": "Remarketing List Population Rule Term.", |
+ "id": "ListPopulationTerm", |
+ "properties": { |
+ "contains": { |
+ "description": "Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default.", |
+ "type": "boolean" |
+ }, |
+ "negation": { |
+ "description": "Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.", |
+ "type": "boolean" |
+ }, |
+ "operator": { |
+ "description": "Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.", |
+ "enum": [ |
+ "NUM_EQUALS", |
+ "NUM_GREATER_THAN", |
+ "NUM_GREATER_THAN_EQUAL", |
+ "NUM_LESS_THAN", |
+ "NUM_LESS_THAN_EQUAL", |
+ "STRING_CONTAINS", |
+ "STRING_EQUALS" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "", |
+ "", |
+ "", |
+ "", |
+ "", |
+ "" |
+ ], |
+ "type": "string" |
+ }, |
+ "remarketingListId": { |
+ "description": "ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "type": { |
+ "description": "List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable.", |
+ "enum": [ |
+ "CUSTOM_VARIABLE_TERM", |
+ "LIST_MEMBERSHIP_TERM", |
+ "REFERRER_TERM" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "", |
+ "" |
+ ], |
+ "type": "string" |
+ }, |
+ "value": { |
+ "description": "Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM.", |
"type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "LandingPagesListResponse": { |
- "description": "Landing Page List Response", |
- "id": "LandingPagesListResponse", |
- "properties": { |
- "kind": { |
- "default": "dfareporting#landingPagesListResponse", |
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#landingPagesListResponse\".", |
+ }, |
+ "variableFriendlyName": { |
+ "description": "Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM.", |
"type": "string" |
}, |
- "landingPages": { |
- "description": "Landing page collection", |
- "items": { |
- "$ref": "LandingPage" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "LastModifiedInfo": { |
- "description": "Modification timestamp.", |
- "id": "LastModifiedInfo", |
- "properties": { |
- "time": { |
- "description": "Timestamp of the last change in milliseconds since epoch.", |
- "format": "int64", |
+ "variableName": { |
+ "description": "Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM.", |
"type": "string" |
} |
}, |
@@ -12978,6 +14434,298 @@ |
}, |
"type": "object" |
}, |
+ "Order": { |
+ "description": "Describes properties of a DoubleClick Planning order.", |
+ "id": "Order", |
+ "properties": { |
+ "accountId": { |
+ "description": "Account ID of this order.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "advertiserId": { |
+ "description": "Advertiser ID of this order.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "approverUserProfileIds": { |
+ "description": "IDs for users that have to approve documents created for this order.", |
+ "items": { |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ }, |
+ "buyerInvoiceId": { |
+ "description": "Buyer invoice ID associated with this order.", |
+ "type": "string" |
+ }, |
+ "buyerOrganizationName": { |
+ "description": "Name of the buyer organization.", |
+ "type": "string" |
+ }, |
+ "comments": { |
+ "description": "Comments in this order.", |
+ "type": "string" |
+ }, |
+ "contacts": { |
+ "description": "Contacts for this order.", |
+ "items": { |
+ "$ref": "OrderContact" |
+ }, |
+ "type": "array" |
+ }, |
+ "id": { |
+ "description": "ID of this order. This is a read-only, auto-generated field.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "kind": { |
+ "default": "dfareporting#order", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#order\".", |
+ "type": "string" |
+ }, |
+ "lastModifiedInfo": { |
+ "$ref": "LastModifiedInfo", |
+ "description": "Information about the most recent modification of this order." |
+ }, |
+ "name": { |
+ "description": "Name of this order.", |
+ "type": "string" |
+ }, |
+ "notes": { |
+ "description": "Notes of this order.", |
+ "type": "string" |
+ }, |
+ "planningTermId": { |
+ "description": "ID of the terms and conditions template used in this order.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "projectId": { |
+ "description": "Project ID of this order.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "sellerOrderId": { |
+ "description": "Seller order ID associated with this order.", |
+ "type": "string" |
+ }, |
+ "sellerOrganizationName": { |
+ "description": "Name of the seller organization.", |
+ "type": "string" |
+ }, |
+ "siteId": { |
+ "description": "Site IDs this order is associated with.", |
+ "items": { |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ }, |
+ "siteNames": { |
+ "description": "Free-form site names this order is associated with.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ }, |
+ "subaccountId": { |
+ "description": "Subaccount ID of this order.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "termsAndConditions": { |
+ "description": "Terms and conditions of this order.", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "OrderContact": { |
+ "description": "Contact of an order.", |
+ "id": "OrderContact", |
+ "properties": { |
+ "contactInfo": { |
+ "description": "Free-form information about this contact. It could be any information related to this contact in addition to type, title, name, and signature user profile ID.", |
+ "type": "string" |
+ }, |
+ "contactName": { |
+ "description": "Name of this contact.", |
+ "type": "string" |
+ }, |
+ "contactTitle": { |
+ "description": "Title of this contact.", |
+ "type": "string" |
+ }, |
+ "contactType": { |
+ "description": "Type of this contact.", |
+ "enum": [ |
+ "PLANNING_ORDER_CONTACT_BUYER_BILLING_CONTACT", |
+ "PLANNING_ORDER_CONTACT_BUYER_CONTACT", |
+ "PLANNING_ORDER_CONTACT_SELLER_CONTACT" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "", |
+ "" |
+ ], |
+ "type": "string" |
+ }, |
+ "signatureUserProfileId": { |
+ "description": "ID of the user profile containing the signature that will be embedded into order documents.", |
+ "format": "int64", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "OrderDocument": { |
+ "description": "Contains properties of a DoubleClick Planning order document.", |
+ "id": "OrderDocument", |
+ "properties": { |
+ "accountId": { |
+ "description": "Account ID of this order document.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "advertiserId": { |
+ "description": "Advertiser ID of this order document.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "amendedOrderDocumentId": { |
+ "description": "The amended order document ID of this order document. An order document can be created by optionally amending another order document so that the change history can be preserved.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "approvedByUserProfileIds": { |
+ "description": "IDs of users who have approved this order document.", |
+ "items": { |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ }, |
+ "cancelled": { |
+ "description": "Whether this order document is cancelled.", |
+ "type": "boolean" |
+ }, |
+ "createdInfo": { |
+ "$ref": "LastModifiedInfo", |
+ "description": "Information about the creation of this order document." |
+ }, |
+ "effectiveDate": { |
+ "description": "Effective date of this order document.", |
+ "format": "date", |
+ "type": "string" |
+ }, |
+ "id": { |
+ "description": "ID of this order document.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "kind": { |
+ "default": "dfareporting#orderDocument", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocument\".", |
+ "type": "string" |
+ }, |
+ "lastSentRecipients": { |
+ "description": "List of email addresses that received the last sent document.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ }, |
+ "lastSentTime": { |
+ "description": "Timestamp of the last email sent with this order document.", |
+ "format": "date-time", |
+ "type": "string" |
+ }, |
+ "orderId": { |
+ "description": "ID of the order from which this order document is created.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "projectId": { |
+ "description": "Project ID of this order document.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "signed": { |
+ "description": "Whether this order document has been signed.", |
+ "type": "boolean" |
+ }, |
+ "subaccountId": { |
+ "description": "Subaccount ID of this order document.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "title": { |
+ "description": "Title of this order document.", |
+ "type": "string" |
+ }, |
+ "type": { |
+ "description": "Type of this order document", |
+ "enum": [ |
+ "PLANNING_ORDER_TYPE_CHANGE_ORDER", |
+ "PLANNING_ORDER_TYPE_INSERTION_ORDER" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "OrderDocumentsListResponse": { |
+ "description": "Order document List Response", |
+ "id": "OrderDocumentsListResponse", |
+ "properties": { |
+ "kind": { |
+ "default": "dfareporting#orderDocumentsListResponse", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#orderDocumentsListResponse\".", |
+ "type": "string" |
+ }, |
+ "nextPageToken": { |
+ "description": "Pagination token to be used for the next list operation.", |
+ "type": "string" |
+ }, |
+ "orderDocuments": { |
+ "description": "Order document collection", |
+ "items": { |
+ "$ref": "OrderDocument" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "OrdersListResponse": { |
+ "description": "Order List Response", |
+ "id": "OrdersListResponse", |
+ "properties": { |
+ "kind": { |
+ "default": "dfareporting#ordersListResponse", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#ordersListResponse\".", |
+ "type": "string" |
+ }, |
+ "nextPageToken": { |
+ "description": "Pagination token to be used for the next list operation.", |
+ "type": "string" |
+ }, |
+ "orders": { |
+ "description": "Order collection.", |
+ "items": { |
+ "$ref": "Order" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
"PathToConversionReportCompatibleFields": { |
"description": "Represents fields that are compatible to be selected for a report of type \"PATH_TO_CONVERSION\".", |
"id": "PathToConversionReportCompatibleFields", |
@@ -13214,12 +14962,17 @@ |
"PLACEMENT_TAG_CLICK_COMMANDS", |
"PLACEMENT_TAG_IFRAME_ILAYER", |
"PLACEMENT_TAG_IFRAME_JAVASCRIPT", |
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY", |
"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH", |
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3", |
"PLACEMENT_TAG_INTERNAL_REDIRECT", |
"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT", |
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY", |
"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT", |
"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT", |
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY", |
"PLACEMENT_TAG_JAVASCRIPT", |
+ "PLACEMENT_TAG_JAVASCRIPT_LEGACY", |
"PLACEMENT_TAG_STANDARD", |
"PLACEMENT_TAG_TRACKING", |
"PLACEMENT_TAG_TRACKING_IFRAME", |
@@ -13238,6 +14991,11 @@ |
"", |
"", |
"", |
+ "", |
+ "", |
+ "", |
+ "", |
+ "", |
"" |
], |
"type": "string" |
@@ -13392,10 +15150,6 @@ |
"$ref": "DimensionValue", |
"description": "Dimension value for the ID of the primary placement. This is a read-only, auto-generated field." |
}, |
- "programmaticSetting": { |
- "$ref": "ProgrammaticSetting", |
- "description": "Settings for a programmatic placement." |
- }, |
"siteId": { |
"description": "Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.", |
"format": "int64", |
@@ -13641,6 +15395,10 @@ |
"description": "Contains information about a postal code that can be targeted by ads.", |
"id": "PostalCode", |
"properties": { |
+ "code": { |
+ "description": "Postal code. This is equivalent to the id field.", |
+ "type": "string" |
+ }, |
"countryCode": { |
"description": "Country code of the country to which this postal code belongs.", |
"type": "string" |
@@ -13674,9 +15432,81 @@ |
"postalCodes": { |
"description": "Postal code collection.", |
"items": { |
- "$ref": "PostalCode" |
+ "$ref": "PostalCode" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "Pricing": { |
+ "description": "Pricing Information", |
+ "id": "Pricing", |
+ "properties": { |
+ "capCostType": { |
+ "description": "Cap cost type of this inventory item.", |
+ "enum": [ |
+ "PLANNING_PLACEMENT_CAP_COST_TYPE_CUMULATIVE", |
+ "PLANNING_PLACEMENT_CAP_COST_TYPE_MONTHLY", |
+ "PLANNING_PLACEMENT_CAP_COST_TYPE_NONE" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "", |
+ "" |
+ ], |
+ "type": "string" |
+ }, |
+ "endDate": { |
+ "description": "End date of this inventory item.", |
+ "format": "date", |
+ "type": "string" |
+ }, |
+ "flights": { |
+ "description": "Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time.", |
+ "items": { |
+ "$ref": "Flight" |
}, |
"type": "array" |
+ }, |
+ "groupType": { |
+ "description": "Group type of this inventory item if it represents a placement group. Is null otherwise. There are two type of placement groups: PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items that acts as a single pricing point for a group of tags. PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items 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 inventory items to be marked as primary.", |
+ "enum": [ |
+ "PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE", |
+ "PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "type": "string" |
+ }, |
+ "pricingType": { |
+ "description": "Pricing type of this inventory item.", |
+ "enum": [ |
+ "PLANNING_PLACEMENT_PRICING_TYPE_CLICKS", |
+ "PLANNING_PLACEMENT_PRICING_TYPE_CPA", |
+ "PLANNING_PLACEMENT_PRICING_TYPE_CPC", |
+ "PLANNING_PLACEMENT_PRICING_TYPE_CPM", |
+ "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_CLICKS", |
+ "PLANNING_PLACEMENT_PRICING_TYPE_FLAT_RATE_IMPRESSIONS", |
+ "PLANNING_PLACEMENT_PRICING_TYPE_IMPRESSIONS" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "", |
+ "", |
+ "", |
+ "", |
+ "", |
+ "" |
+ ], |
+ "type": "string" |
+ }, |
+ "startDate": { |
+ "description": "Start date of this inventory item.", |
+ "format": "date", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -13786,39 +15616,154 @@ |
}, |
"type": "object" |
}, |
- "ProgrammaticSetting": { |
- "description": "Programmatic Setting", |
- "id": "ProgrammaticSetting", |
+ "Project": { |
+ "description": "Contains properties of a DoubleClick Planning project.", |
+ "id": "Project", |
"properties": { |
- "adxDealIds": { |
- "description": "Adx deal IDs assigned to the placement.", |
- "items": { |
- "format": "int64", |
- "type": "string" |
- }, |
- "type": "array" |
+ "accountId": { |
+ "description": "Account ID of this project.", |
+ "format": "int64", |
+ "type": "string" |
}, |
- "insertionOrderId": { |
- "description": "Insertion order ID.", |
+ "advertiserId": { |
+ "description": "Advertiser ID of this project.", |
+ "format": "int64", |
"type": "string" |
}, |
- "insertionOrderIdStatus": { |
- "description": "Whether insertion order ID has been placed in DFP. This is a read-only field.", |
- "type": "boolean" |
+ "audienceAgeGroup": { |
+ "description": "Audience age group of this project.", |
+ "enum": [ |
+ "PLANNING_AUDIENCE_AGE_18_24", |
+ "PLANNING_AUDIENCE_AGE_25_34", |
+ "PLANNING_AUDIENCE_AGE_35_44", |
+ "PLANNING_AUDIENCE_AGE_45_54", |
+ "PLANNING_AUDIENCE_AGE_55_64", |
+ "PLANNING_AUDIENCE_AGE_65_OR_MORE", |
+ "PLANNING_AUDIENCE_AGE_UNKNOWN" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "", |
+ "", |
+ "", |
+ "", |
+ "", |
+ "" |
+ ], |
+ "type": "string" |
+ }, |
+ "audienceGender": { |
+ "description": "Audience gender of this project.", |
+ "enum": [ |
+ "PLANNING_AUDIENCE_GENDER_FEMALE", |
+ "PLANNING_AUDIENCE_GENDER_MALE" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "type": "string" |
}, |
- "mediaCostNanos": { |
- "description": "Media cost for the programmatic placement.", |
+ "budget": { |
+ "description": "Budget of this project in the currency specified by the current account. The value stored in this field represents only the non-fractional amount. For example, for USD, the smallest value that can be represented by this field is 1 US dollar.", |
"format": "int64", |
"type": "string" |
}, |
- "programmatic": { |
- "description": "Whether programmatic is enabled.", |
- "type": "boolean" |
+ "clientBillingCode": { |
+ "description": "Client billing code of this project.", |
+ "type": "string" |
}, |
- "traffickerEmails": { |
- "description": "Trafficker emails assigned to the placement.", |
+ "clientName": { |
+ "description": "Name of the project client.", |
+ "type": "string" |
+ }, |
+ "endDate": { |
+ "description": "End date of the project.", |
+ "format": "date", |
+ "type": "string" |
+ }, |
+ "id": { |
+ "description": "ID of this project. This is a read-only, auto-generated field.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "kind": { |
+ "default": "dfareporting#project", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#project\".", |
+ "type": "string" |
+ }, |
+ "lastModifiedInfo": { |
+ "$ref": "LastModifiedInfo", |
+ "description": "Information about the most recent modification of this project." |
+ }, |
+ "name": { |
+ "description": "Name of this project.", |
+ "type": "string" |
+ }, |
+ "overview": { |
+ "description": "Overview of this project.", |
+ "type": "string" |
+ }, |
+ "startDate": { |
+ "description": "Start date of the project.", |
+ "format": "date", |
+ "type": "string" |
+ }, |
+ "subaccountId": { |
+ "description": "Subaccount ID of this project.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "targetClicks": { |
+ "description": "Number of clicks that the advertiser is targeting.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "targetConversions": { |
+ "description": "Number of conversions that the advertiser is targeting.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "targetCpaNanos": { |
+ "description": "CPA that the advertiser is targeting.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "targetCpcNanos": { |
+ "description": "CPC that the advertiser is targeting.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "targetCpmNanos": { |
+ "description": "CPM that the advertiser is targeting.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "targetImpressions": { |
+ "description": "Number of impressions that the advertiser is targeting.", |
+ "format": "int64", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ProjectsListResponse": { |
+ "description": "Project List Response", |
+ "id": "ProjectsListResponse", |
+ "properties": { |
+ "kind": { |
+ "default": "dfareporting#projectsListResponse", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#projectsListResponse\".", |
+ "type": "string" |
+ }, |
+ "nextPageToken": { |
+ "description": "Pagination token to be used for the next list operation.", |
+ "type": "string" |
+ }, |
+ "projects": { |
+ "description": "Project collection.", |
"items": { |
- "type": "string" |
+ "$ref": "Project" |
}, |
"type": "array" |
} |
@@ -13862,103 +15807,239 @@ |
}, |
"type": "array" |
}, |
- "reachByFrequencyMetrics": { |
- "description": "Metrics which are compatible to be selected in the \"reachByFrequencyMetricNames\" section of the report.", |
- "items": { |
- "$ref": "Metric" |
- }, |
- "type": "array" |
- } |
- }, |
- "type": "object" |
- }, |
- "Recipient": { |
- "description": "Represents a recipient.", |
- "id": "Recipient", |
- "properties": { |
- "deliveryType": { |
- "annotations": { |
- "required": [ |
- "dfareporting.reports.insert", |
- "dfareporting.reports.update" |
- ] |
- }, |
- "description": "The delivery type for the recipient.", |
+ "reachByFrequencyMetrics": { |
+ "description": "Metrics which are compatible to be selected in the \"reachByFrequencyMetricNames\" section of the report.", |
+ "items": { |
+ "$ref": "Metric" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "Recipient": { |
+ "description": "Represents a recipient.", |
+ "id": "Recipient", |
+ "properties": { |
+ "deliveryType": { |
+ "annotations": { |
+ "required": [ |
+ "dfareporting.reports.insert", |
+ "dfareporting.reports.update" |
+ ] |
+ }, |
+ "description": "The delivery type for the recipient.", |
+ "enum": [ |
+ "ATTACHMENT", |
+ "LINK" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "" |
+ ], |
+ "type": "string" |
+ }, |
+ "email": { |
+ "annotations": { |
+ "required": [ |
+ "dfareporting.reports.insert", |
+ "dfareporting.reports.update" |
+ ] |
+ }, |
+ "description": "The email address of the recipient.", |
+ "type": "string" |
+ }, |
+ "kind": { |
+ "default": "dfareporting#recipient", |
+ "description": "The kind of resource this is, in this case dfareporting#recipient.", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "Region": { |
+ "description": "Contains information about a region that can be targeted by ads.", |
+ "id": "Region", |
+ "properties": { |
+ "countryCode": { |
+ "description": "Country code of the country to which this region belongs.", |
+ "type": "string" |
+ }, |
+ "countryDartId": { |
+ "description": "DART ID of the country to which this region belongs.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "dartId": { |
+ "description": "DART ID of this region.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "kind": { |
+ "default": "dfareporting#region", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#region\".", |
+ "type": "string" |
+ }, |
+ "name": { |
+ "description": "Name of this region.", |
+ "type": "string" |
+ }, |
+ "regionCode": { |
+ "description": "Region code.", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "RegionsListResponse": { |
+ "description": "Region List Response", |
+ "id": "RegionsListResponse", |
+ "properties": { |
+ "kind": { |
+ "default": "dfareporting#regionsListResponse", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#regionsListResponse\".", |
+ "type": "string" |
+ }, |
+ "regions": { |
+ "description": "Region collection.", |
+ "items": { |
+ "$ref": "Region" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "RemarketingList": { |
+ "description": "Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource.", |
+ "id": "RemarketingList", |
+ "properties": { |
+ "accountId": { |
+ "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "active": { |
+ "description": "Whether this remarketing list is active.", |
+ "type": "boolean" |
+ }, |
+ "advertiserId": { |
+ "description": "Dimension value for the advertiser ID that owns this remarketing list. This is a required field.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "advertiserIdDimensionValue": { |
+ "$ref": "DimensionValue", |
+ "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field." |
+ }, |
+ "description": { |
+ "description": "Remarketing list description.", |
+ "type": "string" |
+ }, |
+ "id": { |
+ "description": "Remarketing list ID. This is a read-only, auto-generated field.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "kind": { |
+ "default": "dfareporting#remarketingList", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingList\".", |
+ "type": "string" |
+ }, |
+ "lifeSpan": { |
+ "description": "Number of days that a user should remain in the remarketing list without an impression.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "listPopulationRule": { |
+ "$ref": "ListPopulationRule", |
+ "description": "Rule used to populate the remarketing list with users." |
+ }, |
+ "listSize": { |
+ "description": "Number of users currently in the list. This is a read-only field.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "listSource": { |
+ "description": "Product from which this remarketing list was originated.", |
"enum": [ |
- "ATTACHMENT", |
- "LINK" |
+ "REMARKETING_LIST_SOURCE_DBM", |
+ "REMARKETING_LIST_SOURCE_DFA", |
+ "REMARKETING_LIST_SOURCE_DMP", |
+ "REMARKETING_LIST_SOURCE_GA", |
+ "REMARKETING_LIST_SOURCE_OTHER" |
], |
"enumDescriptions": [ |
"", |
+ "", |
+ "", |
+ "", |
"" |
], |
"type": "string" |
}, |
- "email": { |
- "annotations": { |
- "required": [ |
- "dfareporting.reports.insert", |
- "dfareporting.reports.update" |
- ] |
- }, |
- "description": "The email address of the recipient.", |
+ "name": { |
+ "description": "Name of the remarketing list. This is a required field. Must be no greater than 128 characters long.", |
"type": "string" |
}, |
- "kind": { |
- "default": "dfareporting#recipient", |
- "description": "The kind of resource this is, in this case dfareporting#recipient.", |
+ "subaccountId": { |
+ "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.", |
+ "format": "int64", |
"type": "string" |
} |
}, |
"type": "object" |
}, |
- "Region": { |
- "description": "Contains information about a region that can be targeted by ads.", |
- "id": "Region", |
+ "RemarketingListShare": { |
+ "description": "Contains properties of a remarketing list's sharing information. Sharing allows other accounts or advertisers to target to your remarketing lists. This resource can be used to manage remarketing list sharing to other accounts and advertisers.", |
+ "id": "RemarketingListShare", |
"properties": { |
- "countryCode": { |
- "description": "Country code of the country to which this region belongs.", |
- "type": "string" |
- }, |
- "countryDartId": { |
- "description": "DART ID of the country to which this region belongs.", |
- "format": "int64", |
+ "kind": { |
+ "default": "dfareporting#remarketingListShare", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListShare\".", |
"type": "string" |
}, |
- "dartId": { |
- "description": "DART ID of this region.", |
+ "remarketingListId": { |
+ "description": "Remarketing list ID. This is a read-only, auto-generated field.", |
"format": "int64", |
"type": "string" |
}, |
- "kind": { |
- "default": "dfareporting#region", |
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#region\".", |
- "type": "string" |
- }, |
- "name": { |
- "description": "Name of this region.", |
- "type": "string" |
+ "sharedAccountIds": { |
+ "description": "Accounts that the remarketing list is shared with.", |
+ "items": { |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "type": "array" |
}, |
- "regionCode": { |
- "description": "Region code.", |
- "type": "string" |
+ "sharedAdvertiserIds": { |
+ "description": "Advertisers that the remarketing list is shared with.", |
+ "items": { |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
}, |
- "RegionsListResponse": { |
- "description": "Region List Response", |
- "id": "RegionsListResponse", |
+ "RemarketingListsListResponse": { |
+ "description": "Remarketing list response", |
+ "id": "RemarketingListsListResponse", |
"properties": { |
"kind": { |
- "default": "dfareporting#regionsListResponse", |
- "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#regionsListResponse\".", |
+ "default": "dfareporting#remarketingListsListResponse", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#remarketingListsListResponse\".", |
"type": "string" |
}, |
- "regions": { |
- "description": "Region collection.", |
+ "nextPageToken": { |
+ "description": "Pagination token to be used for the next list operation.", |
+ "type": "string" |
+ }, |
+ "remarketingLists": { |
+ "description": "Remarketing list collection.", |
"items": { |
- "$ref": "Region" |
+ "$ref": "RemarketingList" |
}, |
"type": "array" |
} |
@@ -14683,6 +16764,10 @@ |
"description": "Site Contact", |
"id": "SiteContact", |
"properties": { |
+ "address": { |
+ "description": "Address of this site contact.", |
+ "type": "string" |
+ }, |
"contactType": { |
"description": "Site contact type.", |
"enum": [ |
@@ -14711,6 +16796,14 @@ |
"lastName": { |
"description": "Last name of this site contact.", |
"type": "string" |
+ }, |
+ "phone": { |
+ "description": "Primary phone number of this site contact.", |
+ "type": "string" |
+ }, |
+ "title": { |
+ "description": "Title or designation of this site contact.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -14760,7 +16853,7 @@ |
"type": "string" |
}, |
"sites": { |
- "description": "Site collection", |
+ "description": "Site collection.", |
"items": { |
"$ref": "Site" |
}, |
@@ -14928,12 +17021,17 @@ |
"PLACEMENT_TAG_CLICK_COMMANDS", |
"PLACEMENT_TAG_IFRAME_ILAYER", |
"PLACEMENT_TAG_IFRAME_JAVASCRIPT", |
+ "PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY", |
"PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH", |
+ "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3", |
"PLACEMENT_TAG_INTERNAL_REDIRECT", |
"PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT", |
+ "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY", |
"PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT", |
"PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT", |
+ "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY", |
"PLACEMENT_TAG_JAVASCRIPT", |
+ "PLACEMENT_TAG_JAVASCRIPT_LEGACY", |
"PLACEMENT_TAG_STANDARD", |
"PLACEMENT_TAG_TRACKING", |
"PLACEMENT_TAG_TRACKING_IFRAME", |
@@ -14952,6 +17050,11 @@ |
"", |
"", |
"", |
+ "", |
+ "", |
+ "", |
+ "", |
+ "", |
"" |
], |
"type": "string" |
@@ -15036,6 +17139,105 @@ |
}, |
"type": "object" |
}, |
+ "TargetableRemarketingList": { |
+ "description": "Contains properties of a targetable remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource.", |
+ "id": "TargetableRemarketingList", |
+ "properties": { |
+ "accountId": { |
+ "description": "Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "active": { |
+ "description": "Whether this targetable remarketing list is active.", |
+ "type": "boolean" |
+ }, |
+ "advertiserId": { |
+ "description": "Dimension value for the advertiser ID that owns this targetable remarketing list.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "advertiserIdDimensionValue": { |
+ "$ref": "DimensionValue", |
+ "description": "Dimension value for the ID of the advertiser." |
+ }, |
+ "description": { |
+ "description": "Targetable remarketing list description.", |
+ "type": "string" |
+ }, |
+ "id": { |
+ "description": "Targetable remarketing list ID.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "kind": { |
+ "default": "dfareporting#targetableRemarketingList", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingList\".", |
+ "type": "string" |
+ }, |
+ "lifeSpan": { |
+ "description": "Number of days that a user should remain in the targetable remarketing list without an impression.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "listSize": { |
+ "description": "Number of users currently in the list. This is a read-only field.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
+ "listSource": { |
+ "description": "Product from which this targetable remarketing list was originated.", |
+ "enum": [ |
+ "REMARKETING_LIST_SOURCE_DBM", |
+ "REMARKETING_LIST_SOURCE_DFA", |
+ "REMARKETING_LIST_SOURCE_DMP", |
+ "REMARKETING_LIST_SOURCE_GA", |
+ "REMARKETING_LIST_SOURCE_OTHER" |
+ ], |
+ "enumDescriptions": [ |
+ "", |
+ "", |
+ "", |
+ "", |
+ "" |
+ ], |
+ "type": "string" |
+ }, |
+ "name": { |
+ "description": "Name of the targetable remarketing list. Is no greater than 128 characters long.", |
+ "type": "string" |
+ }, |
+ "subaccountId": { |
+ "description": "Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests.", |
+ "format": "int64", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "TargetableRemarketingListsListResponse": { |
+ "description": "Targetable remarketing list response", |
+ "id": "TargetableRemarketingListsListResponse", |
+ "properties": { |
+ "kind": { |
+ "default": "dfareporting#targetableRemarketingListsListResponse", |
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#targetableRemarketingListsListResponse\".", |
+ "type": "string" |
+ }, |
+ "nextPageToken": { |
+ "description": "Pagination token to be used for the next list operation.", |
+ "type": "string" |
+ }, |
+ "targetableRemarketingLists": { |
+ "description": "Targetable remarketing list collection.", |
+ "items": { |
+ "$ref": "TargetableRemarketingList" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
"TechnologyTargeting": { |
"description": "Technology Targeting.", |
"id": "TechnologyTargeting", |
@@ -15085,6 +17287,21 @@ |
}, |
"type": "object" |
}, |
+ "ThirdPartyAuthenticationToken": { |
+ "description": "Third Party Authentication Token", |
+ "id": "ThirdPartyAuthenticationToken", |
+ "properties": { |
+ "name": { |
+ "description": "Name of the third-party authentication token.", |
+ "type": "string" |
+ }, |
+ "value": { |
+ "description": "Value of the third-party authentication token. This is a read-only, auto-generated field.", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
"ThirdPartyTrackingUrl": { |
"description": "Third-party Tracking URL.", |
"id": "ThirdPartyTrackingUrl", |
@@ -15163,7 +17380,6 @@ |
"enum": [ |
"U1", |
"U10", |
- "U100", |
"U11", |
"U12", |
"U13", |
@@ -15175,92 +17391,13 @@ |
"U19", |
"U2", |
"U20", |
- "U21", |
- "U22", |
- "U23", |
- "U24", |
- "U25", |
- "U26", |
- "U27", |
- "U28", |
- "U29", |
"U3", |
- "U30", |
- "U31", |
- "U32", |
- "U33", |
- "U34", |
- "U35", |
- "U36", |
- "U37", |
- "U38", |
- "U39", |
"U4", |
- "U40", |
- "U41", |
- "U42", |
- "U43", |
- "U44", |
- "U45", |
- "U46", |
- "U47", |
- "U48", |
- "U49", |
"U5", |
- "U50", |
- "U51", |
- "U52", |
- "U53", |
- "U54", |
- "U55", |
- "U56", |
- "U57", |
- "U58", |
- "U59", |
"U6", |
- "U60", |
- "U61", |
- "U62", |
- "U63", |
- "U64", |
- "U65", |
- "U66", |
- "U67", |
- "U68", |
- "U69", |
"U7", |
- "U70", |
- "U71", |
- "U72", |
- "U73", |
- "U74", |
- "U75", |
- "U76", |
- "U77", |
- "U78", |
- "U79", |
"U8", |
- "U80", |
- "U81", |
- "U82", |
- "U83", |
- "U84", |
- "U85", |
- "U86", |
- "U87", |
- "U88", |
- "U89", |
- "U9", |
- "U90", |
- "U91", |
- "U92", |
- "U93", |
- "U94", |
- "U95", |
- "U96", |
- "U97", |
- "U98", |
- "U99" |
+ "U9" |
], |
"enumDescriptions": [ |
"", |
@@ -15282,86 +17419,6 @@ |
"", |
"", |
"", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
- "", |
"" |
], |
"type": "string" |
@@ -15609,7 +17666,7 @@ |
"type": "object" |
} |
}, |
- "servicePath": "dfareporting/v2.0/", |
+ "servicePath": "dfareporting/v2.2/", |
"title": "DCM/DFA Reporting And Trafficking API", |
- "version": "v2.0" |
+ "version": "v2.2" |
} |