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="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.inventorySources.html">inventorySources</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(inventorySourceId, partnerId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets an inventory source.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.</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(inventorySourceId, partnerId=None, x__xgafv=None)</code> 97 <pre>Gets an inventory source. 98 99Args: 100 inventorySourceId: string, Required. The ID of the inventory source to fetch. (required) 101 partnerId: string, Required. The ID of the DV360 partner to which the fetched inventory source is permissioned. 102 x__xgafv: string, V1 error format. 103 Allowed values 104 1 - v1 error format 105 2 - v2 error format 106 107Returns: 108 An object of the form: 109 110 { # An inventory source. 111 "commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery. 112 "creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages. 113 { # Creative requirements configuration for the inventory source. 114 "creativeType": "A String", # The type of creative that can be assigned to the inventory source. 115 "displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`. 116 "creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source. 117 "heightPixels": 42, # The height in pixels. 118 "widthPixels": 42, # The width in pixels. 119 }, 120 }, 121 "videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`. 122 "duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source. 123 }, 124 }, 125 ], 126 "dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges. 127 "deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. 128 "displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes. 129 "exchange": "A String", # The exchange to which the inventory source belongs. 130 "inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system. 131 "inventorySourceType": "A String", # Denotes the type of the inventory source. 132 "name": "A String", # Output only. The resource name of the inventory source. 133 "publisherName": "A String", # The publisher/seller name of the inventory source. 134 "rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source. 135 "inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`. 136 "minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources. 137 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 138 "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. 139 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 140 }, 141 "rate": { # Represents an amount of money with its currency type. # The rate for the inventory source. 142 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 143 "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. 144 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 145 }, 146 "unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller. 147 }, 148 "status": { # The status related settings of the inventory source. # The status settings of the inventory source. 149 "configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. 150 "entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`. 151 "entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`. 152 "sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`. 153 "sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`. 154 }, 155 "timeRange": { # A time range. # The time range when this inventory source starts and stops serving. 156 "endTime": "A String", # Required. The upper bound of a time range, inclusive. 157 "startTime": "A String", # Required. The lower bound of a time range, inclusive. 158 }, 159 "updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system. 160}</pre> 161</div> 162 163<div class="method"> 164 <code class="details" id="list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code> 165 <pre>Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results. 166 167Args: 168 advertiserId: string, The ID of the advertiser that has access to the inventory source. 169 filter: string, Allows filtering by inventory source properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `status.entityStatus` - `commitment` - `deliveryMethod` - `rateDetails.rateType` - `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. 170 orderBy: string, Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. 171 pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. 172 pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. 173 partnerId: string, The ID of the partner that has access to the inventory source. 174 x__xgafv: string, V1 error format. 175 Allowed values 176 1 - v1 error format 177 2 - v2 error format 178 179Returns: 180 An object of the form: 181 182 { 183 "inventorySources": [ # The list of inventory sources. This list will be absent if empty. 184 { # An inventory source. 185 "commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery. 186 "creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages. 187 { # Creative requirements configuration for the inventory source. 188 "creativeType": "A String", # The type of creative that can be assigned to the inventory source. 189 "displayCreativeConfig": { # The configuration for display creatives. # The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`. 190 "creativeSize": { # Dimensions. # The size requirements for display creatives that can be assigned to the inventory source. 191 "heightPixels": 42, # The height in pixels. 192 "widthPixels": 42, # The width in pixels. 193 }, 194 }, 195 "videoCreativeConfig": { # The configuration for video creatives. # The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`. 196 "duration": "A String", # The duration requirements for the video creatives that can be assigned to the inventory source. 197 }, 198 }, 199 ], 200 "dealId": "A String", # The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges. 201 "deliveryMethod": "A String", # The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. 202 "displayName": "A String", # The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes. 203 "exchange": "A String", # The exchange to which the inventory source belongs. 204 "inventorySourceId": "A String", # Output only. The unique ID of the inventory source. Assigned by the system. 205 "inventorySourceType": "A String", # Denotes the type of the inventory source. 206 "name": "A String", # Output only. The resource name of the inventory source. 207 "publisherName": "A String", # The publisher/seller name of the inventory source. 208 "rateDetails": { # The rate related settings of the inventory source. # Required. The rate details of the inventory source. 209 "inventorySourceRateType": "A String", # The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`. 210 "minimumSpend": { # Represents an amount of money with its currency type. # Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources. 211 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 212 "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. 213 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 214 }, 215 "rate": { # Represents an amount of money with its currency type. # The rate for the inventory source. 216 "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. 217 "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. 218 "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. 219 }, 220 "unitsPurchased": "A String", # Required for guaranteed inventory sources. The number of impressions guaranteed by the seller. 221 }, 222 "status": { # The status related settings of the inventory source. # The status settings of the inventory source. 223 "configStatus": "A String", # Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. 224 "entityPauseReason": "A String", # The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`. 225 "entityStatus": "A String", # Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`. 226 "sellerPauseReason": "A String", # Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`. 227 "sellerStatus": "A String", # Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`. 228 }, 229 "timeRange": { # A time range. # The time range when this inventory source starts and stops serving. 230 "endTime": "A String", # Required. The upper bound of a time range, inclusive. 231 "startTime": "A String", # Required. The lower bound of a time range, inclusive. 232 }, 233 "updateTime": "A String", # Output only. The timestamp when the inventory source was last updated. Assigned by the system. 234 }, 235 ], 236 "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySources` method to retrieve the next page of results. 237}</pre> 238</div> 239 240<div class="method"> 241 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 242 <pre>Retrieves the next page of results. 243 244Args: 245 previous_request: The request for the previous page. (required) 246 previous_response: The response from the request for the previous page. (required) 247 248Returns: 249 A request object that you can call 'execute()' on to request the next 250 page. Returns None if there are no more items in the collection. 251 </pre> 252</div> 253 254</body></html>