1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="dfareporting_v3_4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_4.inventoryItems.html">inventoryItems</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(profileId, projectId, id, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets one inventory item by ID.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(profileId, projectId, ids=None, inPlan=None, maxResults=None, orderId=None, pageToken=None, siteId=None, sortField=None, sortOrder=None, type=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves a list of inventory items, possibly filtered. This method supports paging.</p> 86<p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88<p class="firstline">Retrieves the next page of results.</p> 89<h3>Method Details</h3> 90<div class="method"> 91 <code class="details" id="close">close()</code> 92 <pre>Close httplib2 connections.</pre> 93</div> 94 95<div class="method"> 96 <code class="details" id="get">get(profileId, projectId, id, x__xgafv=None)</code> 97 <pre>Gets one inventory item by ID. 98 99Args: 100 profileId: string, User profile ID associated with this request. (required) 101 projectId: string, Project ID for order documents. (required) 102 id: string, Inventory item ID. (required) 103 x__xgafv: string, V1 error format. 104 Allowed values 105 1 - v1 error format 106 2 - v2 error format 107 108Returns: 109 An object of the form: 110 111 { # Represents a buy from the Planning inventory store. 112 "accountId": "A String", # Account ID of this inventory item. 113 "adSlots": [ # 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. 114 { # Ad Slot 115 "comment": "A String", # Comment for this ad slot. 116 "compatibility": "A String", # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps 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. 117 "height": "A String", # Height of this ad slot. 118 "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot. 119 "name": "A String", # Name of this ad slot. 120 "paymentSourceType": "A String", # Payment source type of this ad slot. 121 "primary": True or False, # Primary ad slot of a roadblock inventory item. 122 "width": "A String", # Width of this ad slot. 123 }, 124 ], 125 "advertiserId": "A String", # Advertiser ID of this inventory item. 126 "contentCategoryId": "A String", # Content category ID of this inventory item. 127 "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item. 128 "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item. 129 "id": "A String", # ID of this inventory item. 130 "inPlan": True or False, # Whether this inventory item is in plan. 131 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem". 132 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item. 133 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 134 }, 135 "name": "A String", # 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. 136 "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item. 137 "orderId": "A String", # Order ID of this inventory item. 138 "placementStrategyId": "A String", # Placement strategy ID of this inventory item. 139 "pricing": { # Pricing Information # Pricing of this inventory item. 140 "capCostType": "A String", # Cap cost type of this inventory item. 141 "endDate": "A String", 142 "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time. 143 { # Flight 144 "endDate": "A String", 145 "rateOrCost": "A String", # Rate or cost of this flight. 146 "startDate": "A String", 147 "units": "A String", # Units of this flight. 148 }, 149 ], 150 "groupType": "A String", # 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. 151 "pricingType": "A String", # Pricing type of this inventory item. 152 "startDate": "A String", 153 }, 154 "projectId": "A String", # Project ID of this inventory item. 155 "rfpId": "A String", # RFP ID of this inventory item. 156 "siteId": "A String", # ID of the site this inventory item is associated with. 157 "subaccountId": "A String", # Subaccount ID of this inventory item. 158 "type": "A String", # Type of inventory item. 159}</pre> 160</div> 161 162<div class="method"> 163 <code class="details" id="list">list(profileId, projectId, ids=None, inPlan=None, maxResults=None, orderId=None, pageToken=None, siteId=None, sortField=None, sortOrder=None, type=None, x__xgafv=None)</code> 164 <pre>Retrieves a list of inventory items, possibly filtered. This method supports paging. 165 166Args: 167 profileId: string, User profile ID associated with this request. (required) 168 projectId: string, Project ID for order documents. (required) 169 ids: string, Select only inventory items with these IDs. (repeated) 170 inPlan: boolean, Select only inventory items that are in plan. 171 maxResults: integer, Maximum number of results to return. 172 orderId: string, Select only inventory items that belong to specified orders. (repeated) 173 pageToken: string, Value of the nextPageToken from the previous result page. 174 siteId: string, Select only inventory items that are associated with these sites. (repeated) 175 sortField: string, Field by which to sort the list. 176 Allowed values 177 ID - 178 NAME - 179 sortOrder: string, Order of sorted results. 180 Allowed values 181 ASCENDING - 182 DESCENDING - 183 type: string, Select only inventory items with this type. 184 Allowed values 185 PLANNING_PLACEMENT_TYPE_REGULAR - 186 PLANNING_PLACEMENT_TYPE_CREDIT - 187 x__xgafv: string, V1 error format. 188 Allowed values 189 1 - v1 error format 190 2 - v2 error format 191 192Returns: 193 An object of the form: 194 195 { # Inventory item List Response 196 "inventoryItems": [ # Inventory item collection 197 { # Represents a buy from the Planning inventory store. 198 "accountId": "A String", # Account ID of this inventory item. 199 "adSlots": [ # 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. 200 { # Ad Slot 201 "comment": "A String", # Comment for this ad slot. 202 "compatibility": "A String", # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop, mobile devices or in mobile apps 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. 203 "height": "A String", # Height of this ad slot. 204 "linkedPlacementId": "A String", # ID of the placement from an external platform that is linked to this ad slot. 205 "name": "A String", # Name of this ad slot. 206 "paymentSourceType": "A String", # Payment source type of this ad slot. 207 "primary": True or False, # Primary ad slot of a roadblock inventory item. 208 "width": "A String", # Width of this ad slot. 209 }, 210 ], 211 "advertiserId": "A String", # Advertiser ID of this inventory item. 212 "contentCategoryId": "A String", # Content category ID of this inventory item. 213 "estimatedClickThroughRate": "A String", # Estimated click-through rate of this inventory item. 214 "estimatedConversionRate": "A String", # Estimated conversion rate of this inventory item. 215 "id": "A String", # ID of this inventory item. 216 "inPlan": True or False, # Whether this inventory item is in plan. 217 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItem". 218 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this inventory item. 219 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 220 }, 221 "name": "A String", # 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. 222 "negotiationChannelId": "A String", # Negotiation channel ID of this inventory item. 223 "orderId": "A String", # Order ID of this inventory item. 224 "placementStrategyId": "A String", # Placement strategy ID of this inventory item. 225 "pricing": { # Pricing Information # Pricing of this inventory item. 226 "capCostType": "A String", # Cap cost type of this inventory item. 227 "endDate": "A String", 228 "flights": [ # Flights of this inventory item. A flight (a.k.a. pricing period) represents the inventory item pricing information for a specific period of time. 229 { # Flight 230 "endDate": "A String", 231 "rateOrCost": "A String", # Rate or cost of this flight. 232 "startDate": "A String", 233 "units": "A String", # Units of this flight. 234 }, 235 ], 236 "groupType": "A String", # 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. 237 "pricingType": "A String", # Pricing type of this inventory item. 238 "startDate": "A String", 239 }, 240 "projectId": "A String", # Project ID of this inventory item. 241 "rfpId": "A String", # RFP ID of this inventory item. 242 "siteId": "A String", # ID of the site this inventory item is associated with. 243 "subaccountId": "A String", # Subaccount ID of this inventory item. 244 "type": "A String", # Type of inventory item. 245 }, 246 ], 247 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#inventoryItemsListResponse". 248 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 249}</pre> 250</div> 251 252<div class="method"> 253 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 254 <pre>Retrieves the next page of results. 255 256Args: 257 previous_request: The request for the previous page. (required) 258 previous_response: The response from the request for the previous page. (required) 259 260Returns: 261 A request object that you can call 'execute()' on to request the next 262 page. Returns None if there are no more items in the collection. 263 </pre> 264</div> 265 266</body></html>