docs/dyn/displayvideo_v1.sdfdownloadtasks.html - platform/external/python/google-api-python-client - Gitiles

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <h1><a href="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.sdfdownloadtasks.html">sdfdownloadtasks</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="displayvideo_v1.sdfdownloadtasks.operations.html">operations()</a></code>
 </p>
 <p class="firstline">Returns the operations Resource.</p>

 <p class="toc_element">
   <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Creates an SDF Download Task. Returns an</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="create">create(body=None, x__xgafv=None)</code>
   <pre>Creates an SDF Download Task. Returns an
 Operation.

 An SDF Download Task is a long-running, asynchronous operation. The
 metadata type of this operation is
 SdfDownloadTaskMetadata. If the request is successful, the
 response type of the operation is
 SdfDownloadTask. The response will not include the download files,
 which must be retrieved with
 media.download. The state of
 operation can be retrieved with
 sdfdownloadtask.operations.get.

 Any errors can be found in the
 error.message. Note
 that error.details is expected to be
 empty.

 Args:
   body: object, The request body.
     The object takes the form of:

 { # Request message for [SdfDownloadTaskService.CreateSdfDownloadTask].
     &quot;advertiserId&quot;: &quot;A String&quot;, # The ID of the advertiser to download SDF for.
     &quot;parentEntityFilter&quot;: { # A filtering option that filters on selected file types belonging to a chosen # Filters on selected file types. The entities in each file are filtered
         #  by a chosen set of filter entities. The filter entities must be the same
         #  type as, or a parent type of, the selected file types.
         # set of filter entities.
       &quot;fileType&quot;: [ # Required. File types that will be returned.
         &quot;A String&quot;,
       ],
       &quot;filterType&quot;: &quot;A String&quot;, # Required. Filter type used to filter fetched entities.
       &quot;filterIds&quot;: [ # The IDs of the specified filter type. This is used to filter entities to
           # fetch. If filter type is not `FILTER_TYPE_NONE`, at least one ID must be
           # specified.
         &quot;A String&quot;,
       ],
     },
     &quot;idFilter&quot;: { # A filtering option that filters entities by their entity IDs. # Filters on entities by their entity IDs.
       &quot;adGroupAdIds&quot;: [ # TrueView Ads to download by ID. All IDs must belong to the same
           # Advertiser or
           # Partner specified in
           # CreateSdfDownloadTaskRequest.
         &quot;A String&quot;,
       ],
       &quot;adGroupIds&quot;: [ # TrueView Ad Groups to download by ID. All IDs must belong to the same
           # Advertiser or
           # Partner specified in
           # CreateSdfDownloadTaskRequest.
         &quot;A String&quot;,
       ],
       &quot;campaignIds&quot;: [ # Campaigns to download by ID. All IDs must belong to the same
           # Advertiser or
           # Partner specified in
           # CreateSdfDownloadTaskRequest.
         &quot;A String&quot;,
       ],
       &quot;insertionOrderIds&quot;: [ # Insertion Orders to download by ID. All IDs must belong to the same
           # Advertiser or
           # Partner specified in
           # CreateSdfDownloadTaskRequest.
         &quot;A String&quot;,
       ],
       &quot;mediaProductIds&quot;: [ # Media Products to download by ID. All IDs must belong to the same
           # Advertiser or
           # Partner specified in
           # CreateSdfDownloadTaskRequest.
         &quot;A String&quot;,
       ],
       &quot;lineItemIds&quot;: [ # Line Items to download by ID. All IDs must belong to the same
           # Advertiser or
           # Partner specified in
           # CreateSdfDownloadTaskRequest.
         &quot;A String&quot;,
       ],
     },
     &quot;partnerId&quot;: &quot;A String&quot;, # The ID of the partner to download SDF for.
     &quot;version&quot;: &quot;A String&quot;, # Required. The SDF version of the downloaded file. If set to
         # `SDF_VERSION_UNSPECIFIED`, this will default to the version specified by
         # the advertiser or partner identified by `root_id`. An advertiser inherits
         # its SDF version from its partner unless configured otherwise.
     &quot;inventorySourceFilter&quot;: { # A filtering option for filtering on Inventory Source entities. # Filters on Inventory Sources by their IDs.
       &quot;inventorySourceIds&quot;: [ # Inventory Sources to download by ID. All IDs must belong to the same
           # Advertiser or
           # Partner specified in
           # CreateSdfDownloadTaskRequest. Leave empty to download all Inventory
           # Sources for the selected Advertiser or Partner.
         &quot;A String&quot;,
       ],
     },
   }

   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # This resource represents a long-running operation that is the result of a
       # network API call.
     &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
         # If `true`, the operation is completed, and either `error` or `response` is
         # available.
     &quot;response&quot;: { # The normal response of the operation in case of success.  If the original
         # method returns no data on success, such as `Delete`, the response is
         # `google.protobuf.Empty`.  If the original method is standard
         # `Get`/`Create`/`Update`, the response should be the resource.  For other
         # methods, the response should have the type `XxxResponse`, where `Xxx`
         # is the original method name.  For example, if the original method name
         # is `TakeSnapshot()`, the inferred response type is
         # `TakeSnapshotResponse`.
       &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
     },
     &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
         # originally returns it. If you use the default HTTP mapping, the
         # `name` should be a resource name ending with `operations/{unique_id}`.
     &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
         # different programming environments, including REST APIs and RPC APIs. It is
         # used by [gRPC](https://github.com/grpc). Each `Status` message contains
         # three pieces of data: error code, error message, and error details.
         #
         # You can find out more about this error model and how to work with it in the
         # [API Design Guide](https://cloud.google.com/apis/design/errors).
       &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
       &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
           # user-facing error message should be localized and sent in the
           # google.rpc.Status.details field, or localized by the client.
       &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
           # message types for APIs to use.
         {
           &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
         },
       ],
     },
     &quot;metadata&quot;: { # Service-specific metadata associated with the operation.  It typically
         # contains progress information and common metadata such as create time.
         # Some services might not provide such metadata.  Any method that returns a
         # long-running operation should document the metadata type, if any.
       &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
     },
   }</pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<h1><a href="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.sdfdownloadtasks.html">sdfdownloadtasks</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="displayvideo_v1.sdfdownloadtasks.operations.html">operations()</a></code>
	</p>
	<p class="firstline">Returns the operations Resource.</p>

	<p class="toc_element">
	<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Creates an SDF Download Task. Returns an</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="create">create(body=None, x__xgafv=None)</code>
	<pre>Creates an SDF Download Task. Returns an
	Operation.

	An SDF Download Task is a long-running, asynchronous operation. The
	metadata type of this operation is
	SdfDownloadTaskMetadata. If the request is successful, the
	response type of the operation is
	SdfDownloadTask. The response will not include the download files,
	which must be retrieved with
	media.download. The state of
	operation can be retrieved with
	sdfdownloadtask.operations.get.

	Any errors can be found in the
	error.message. Note
	that error.details is expected to be
	empty.

	Args:
	body: object, The request body.
	The object takes the form of:

	{ # Request message for [SdfDownloadTaskService.CreateSdfDownloadTask].
	"advertiserId": "A String", # The ID of the advertiser to download SDF for.
	"parentEntityFilter": { # A filtering option that filters on selected file types belonging to a chosen # Filters on selected file types. The entities in each file are filtered
	# by a chosen set of filter entities. The filter entities must be the same
	# type as, or a parent type of, the selected file types.
	# set of filter entities.
	"fileType": [ # Required. File types that will be returned.
	"A String",
	],
	"filterType": "A String", # Required. Filter type used to filter fetched entities.
	"filterIds": [ # The IDs of the specified filter type. This is used to filter entities to
	# fetch. If filter type is not `FILTER_TYPE_NONE`, at least one ID must be
	# specified.
	"A String",
	],
	},
	"idFilter": { # A filtering option that filters entities by their entity IDs. # Filters on entities by their entity IDs.
	"adGroupAdIds": [ # TrueView Ads to download by ID. All IDs must belong to the same
	# Advertiser or
	# Partner specified in
	# CreateSdfDownloadTaskRequest.
	"A String",
	],
	"adGroupIds": [ # TrueView Ad Groups to download by ID. All IDs must belong to the same
	# Advertiser or
	# Partner specified in
	# CreateSdfDownloadTaskRequest.
	"A String",
	],
	"campaignIds": [ # Campaigns to download by ID. All IDs must belong to the same
	# Advertiser or
	# Partner specified in
	# CreateSdfDownloadTaskRequest.
	"A String",
	],
	"insertionOrderIds": [ # Insertion Orders to download by ID. All IDs must belong to the same
	# Advertiser or
	# Partner specified in
	# CreateSdfDownloadTaskRequest.
	"A String",
	],
	"mediaProductIds": [ # Media Products to download by ID. All IDs must belong to the same
	# Advertiser or
	# Partner specified in
	# CreateSdfDownloadTaskRequest.
	"A String",
	],
	"lineItemIds": [ # Line Items to download by ID. All IDs must belong to the same
	# Advertiser or
	# Partner specified in
	# CreateSdfDownloadTaskRequest.
	"A String",
	],
	},
	"partnerId": "A String", # The ID of the partner to download SDF for.
	"version": "A String", # Required. The SDF version of the downloaded file. If set to
	# `SDF_VERSION_UNSPECIFIED`, this will default to the version specified by
	# the advertiser or partner identified by `root_id`. An advertiser inherits
	# its SDF version from its partner unless configured otherwise.
	"inventorySourceFilter": { # A filtering option for filtering on Inventory Source entities. # Filters on Inventory Sources by their IDs.
	"inventorySourceIds": [ # Inventory Sources to download by ID. All IDs must belong to the same
	# Advertiser or
	# Partner specified in
	# CreateSdfDownloadTaskRequest. Leave empty to download all Inventory
	# Sources for the selected Advertiser or Partner.
	"A String",
	],
	},
	}

	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # This resource represents a long-running operation that is the result of a
	# network API call.
	"done": True or False, # If the value is `false`, it means the operation is still in progress.
	# If `true`, the operation is completed, and either `error` or `response` is
	# available.
	"response": { # The normal response of the operation in case of success. If the original
	# method returns no data on success, such as `Delete`, the response is
	# `google.protobuf.Empty`. If the original method is standard
	# `Get`/`Create`/`Update`, the response should be the resource. For other
	# methods, the response should have the type `XxxResponse`, where `Xxx`
	# is the original method name. For example, if the original method name
	# is `TakeSnapshot()`, the inferred response type is
	# `TakeSnapshotResponse`.
	"a_key": "", # Properties of the object. Contains field @type with type URL.
	},
	"name": "A String", # The server-assigned name, which is only unique within the same service that
	# originally returns it. If you use the default HTTP mapping, the
	# `name` should be a resource name ending with `operations/{unique_id}`.
	"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
	# different programming environments, including REST APIs and RPC APIs. It is
	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
	# three pieces of data: error code, error message, and error details.
	#
	# You can find out more about this error model and how to work with it in the
	# [API Design Guide](https://cloud.google.com/apis/design/errors).
	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
	"message": "A String", # A developer-facing error message, which should be in English. Any
	# user-facing error message should be localized and sent in the
	# google.rpc.Status.details field, or localized by the client.
	"details": [ # A list of messages that carry the error details. There is a common set of
	# message types for APIs to use.
	{
	"a_key": "", # Properties of the object. Contains field @type with type URL.
	},
	],
	},
	"metadata": { # Service-specific metadata associated with the operation. It typically
	# contains progress information and common metadata such as create time.
	# Some services might not provide such metadata. Any method that returns a
	# long-running operation should document the metadata type, if any.
	"a_key": "", # Properties of the object. Contains field @type with type URL.
	},
	}</pre>
	</div>

	</body></html>