| { |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "https://www.googleapis.com/auth/display-video": { |
| "description": "Create, see, edit, and permanently delete your Display \u0026 Video 360 entities and reports" |
| }, |
| "https://www.googleapis.com/auth/doubleclickbidmanager": { |
| "description": "View and manage your reports in DoubleClick Bid Manager" |
| } |
| } |
| } |
| }, |
| "basePath": "", |
| "baseUrl": "https://displayvideo.googleapis.com/", |
| "batchPath": "batch", |
| "canonicalName": "Display Video", |
| "description": "Display \u0026 Video 360 API allows users to manage and create campaigns and reports.", |
| "discoveryVersion": "v1", |
| "documentationLink": "https://developers.google.com/display-video/", |
| "fullyEncodeReservedExpansion": true, |
| "icons": { |
| "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| }, |
| "id": "displayvideo:v1", |
| "kind": "discovery#restDescription", |
| "mtlsRootUrl": "https://displayvideo.mtls.googleapis.com/", |
| "name": "displayvideo", |
| "ownerDomain": "google.com", |
| "ownerName": "Google", |
| "parameters": { |
| "$.xgafv": { |
| "description": "V1 error format.", |
| "enum": [ |
| "1", |
| "2" |
| ], |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ], |
| "location": "query", |
| "type": "string" |
| }, |
| "access_token": { |
| "description": "OAuth access token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "alt": { |
| "default": "json", |
| "description": "Data format for response.", |
| "enum": [ |
| "json", |
| "media", |
| "proto" |
| ], |
| "enumDescriptions": [ |
| "Responses with Content-Type of application/json", |
| "Media download with context-dependent Content-Type", |
| "Responses with Content-Type of application/x-protobuf" |
| ], |
| "location": "query", |
| "type": "string" |
| }, |
| "callback": { |
| "description": "JSONP", |
| "location": "query", |
| "type": "string" |
| }, |
| "fields": { |
| "description": "Selector specifying which fields to include in a partial response.", |
| "location": "query", |
| "type": "string" |
| }, |
| "key": { |
| "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "oauth_token": { |
| "description": "OAuth 2.0 token for the current user.", |
| "location": "query", |
| "type": "string" |
| }, |
| "prettyPrint": { |
| "default": "true", |
| "description": "Returns response with indentations and line breaks.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "quotaUser": { |
| "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
| "location": "query", |
| "type": "string" |
| }, |
| "uploadType": { |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| }, |
| "upload_protocol": { |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "protocol": "rest", |
| "resources": { |
| "media": { |
| "methods": { |
| "download": { |
| "description": "Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.`\n\n**Note**: Download requests will not be successful without including `alt=media` query string.", |
| "flatPath": "download/{downloadId}", |
| "httpMethod": "GET", |
| "id": "displayvideo.media.download", |
| "parameterOrder": [ |
| "resourceName" |
| ], |
| "parameters": { |
| "resourceName": { |
| "description": "Name of the media that is being downloaded. See\nReadRequest.resource_name.", |
| "location": "path", |
| "pattern": "^.*$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "download/{+resourceName}", |
| "response": { |
| "$ref": "GoogleBytestreamMedia" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/display-video", |
| "https://www.googleapis.com/auth/doubleclickbidmanager" |
| ], |
| "supportsMediaDownload": true |
| } |
| } |
| }, |
| "sdfdownloadtasks": { |
| "methods": { |
| "create": { |
| "description": "Creates an SDF Download Task. Returns an\nOperation.\n\nAn SDF Download Task is a long-running, asynchronous operation. The\nmetadata type of this operation is\nSdfDownloadTaskMetadata. If the request is successful, the\nresponse type of the operation is\nSdfDownloadTask. The response will not include the download files,\nwhich must be retrieved with\nmedia.download. The state of\noperation can be retrieved with\nsdfdownloadtask.operations.get.\n\nAny errors can be found in the\nerror.message. Note\nthat error.details is expected to be\nempty.", |
| "flatPath": "v1/sdfdownloadtasks", |
| "httpMethod": "POST", |
| "id": "displayvideo.sdfdownloadtasks.create", |
| "parameterOrder": [], |
| "parameters": {}, |
| "path": "v1/sdfdownloadtasks", |
| "request": { |
| "$ref": "CreateSdfDownloadTaskRequest" |
| }, |
| "response": { |
| "$ref": "Operation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/display-video" |
| ] |
| } |
| }, |
| "resources": { |
| "operations": { |
| "methods": { |
| "get": { |
| "description": "Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.", |
| "flatPath": "v1/sdfdownloadtasks/operations/{operationsId}", |
| "httpMethod": "GET", |
| "id": "displayvideo.sdfdownloadtasks.operations.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The name of the operation resource.", |
| "location": "path", |
| "pattern": "^sdfdownloadtasks/operations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1/{+name}", |
| "response": { |
| "$ref": "Operation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/display-video", |
| "https://www.googleapis.com/auth/doubleclickbidmanager" |
| ] |
| } |
| } |
| } |
| } |
| } |
| }, |
| "revision": "20200302", |
| "rootUrl": "https://displayvideo.googleapis.com/", |
| "schemas": { |
| "CreateSdfDownloadTaskRequest": { |
| "description": "Request message for [SdfDownloadTaskService.CreateSdfDownloadTask].", |
| "id": "CreateSdfDownloadTaskRequest", |
| "properties": { |
| "advertiserId": { |
| "description": "The ID of the advertiser to download SDF for.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "idFilter": { |
| "$ref": "IdFilter", |
| "description": "Filters on entities by their entity IDs." |
| }, |
| "inventorySourceFilter": { |
| "$ref": "InventorySourceFilter", |
| "description": "Filters on Inventory Sources by their IDs." |
| }, |
| "parentEntityFilter": { |
| "$ref": "ParentEntityFilter", |
| "description": "Filters on selected file types. The entities in each file are filtered\n by a chosen set of filter entities. The filter entities must be the same\n type as, or a parent type of, the selected file types." |
| }, |
| "partnerId": { |
| "description": "The ID of the partner to download SDF for.", |
| "format": "int64", |
| "type": "string" |
| }, |
| "version": { |
| "description": "Required. The SDF version of the downloaded file. If set to\n`SDF_VERSION_UNSPECIFIED`, this will default to the version specified by\nthe advertiser or partner identified by `root_id`. An advertiser inherits\nits SDF version from its partner unless configured otherwise.", |
| "enum": [ |
| "SDF_VERSION_UNSPECIFIED", |
| "SDF_VERSION_3_1", |
| "SDF_VERSION_4", |
| "SDF_VERSION_4_1", |
| "SDF_VERSION_4_2", |
| "SDF_VERSION_5", |
| "SDF_VERSION_5_1" |
| ], |
| "enumDescriptions": [ |
| "SDF version value is not specified or is unknown in this version.", |
| "SDF version 3.1", |
| "SDF version 4", |
| "SDF version 4.1", |
| "SDF version 4.2", |
| "SDF version 5.", |
| "SDF version 5.1" |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleBytestreamMedia": { |
| "description": "Media resource.", |
| "id": "GoogleBytestreamMedia", |
| "properties": { |
| "resourceName": { |
| "description": "Name of the media resource.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "IdFilter": { |
| "description": "A filtering option that filters entities by their entity IDs.", |
| "id": "IdFilter", |
| "properties": { |
| "adGroupAdIds": { |
| "description": "TrueView Ads to download by ID. All IDs must belong to the same\nAdvertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest.", |
| "items": { |
| "format": "int64", |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "adGroupIds": { |
| "description": "TrueView Ad Groups to download by ID. All IDs must belong to the same\nAdvertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest.", |
| "items": { |
| "format": "int64", |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "campaignIds": { |
| "description": "Campaigns to download by ID. All IDs must belong to the same\nAdvertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest.", |
| "items": { |
| "format": "int64", |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "insertionOrderIds": { |
| "description": "Insertion Orders to download by ID. All IDs must belong to the same\nAdvertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest.", |
| "items": { |
| "format": "int64", |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "lineItemIds": { |
| "description": "Line Items to download by ID. All IDs must belong to the same\nAdvertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest.", |
| "items": { |
| "format": "int64", |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "mediaProductIds": { |
| "description": "Media Products to download by ID. All IDs must belong to the same\nAdvertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest.", |
| "items": { |
| "format": "int64", |
| "type": "string" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "InventorySourceFilter": { |
| "description": "A filtering option for filtering on Inventory Source entities.", |
| "id": "InventorySourceFilter", |
| "properties": { |
| "inventorySourceIds": { |
| "description": "Inventory Sources to download by ID. All IDs must belong to the same\nAdvertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest. Leave empty to download all Inventory\nSources for the selected Advertiser or Partner.", |
| "items": { |
| "format": "int64", |
| "type": "string" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "Operation": { |
| "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", |
| "id": "Operation", |
| "properties": { |
| "done": { |
| "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", |
| "type": "boolean" |
| }, |
| "error": { |
| "$ref": "Status", |
| "description": "The error result of the operation in case of failure or cancellation." |
| }, |
| "metadata": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", |
| "type": "object" |
| }, |
| "name": { |
| "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.", |
| "type": "string" |
| }, |
| "response": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", |
| "type": "object" |
| } |
| }, |
| "type": "object" |
| }, |
| "ParentEntityFilter": { |
| "description": "A filtering option that filters on selected file types belonging to a chosen\nset of filter entities.", |
| "id": "ParentEntityFilter", |
| "properties": { |
| "fileType": { |
| "description": "Required. File types that will be returned.", |
| "enumDescriptions": [ |
| "Default value when type is unspecified or is unknown in this version.", |
| "Campaign.", |
| "Media Product.", |
| "Insertion Order.", |
| "Line Item.", |
| "TrueView Ad Group.", |
| "TrueView Ad." |
| ], |
| "items": { |
| "enum": [ |
| "FILE_TYPE_UNSPECIFIED", |
| "FILE_TYPE_CAMPAIGN", |
| "FILE_TYPE_MEDIA_PRODUCT", |
| "FILE_TYPE_INSERTION_ORDER", |
| "FILE_TYPE_LINE_ITEM", |
| "FILE_TYPE_AD_GROUP", |
| "FILE_TYPE_AD" |
| ], |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "filterIds": { |
| "description": "The IDs of the specified filter type. This is used to filter entities to\nfetch. If filter type is not `FILTER_TYPE_NONE`, at least one ID must be\nspecified.", |
| "items": { |
| "format": "int64", |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "filterType": { |
| "description": "Required. Filter type used to filter fetched entities.", |
| "enum": [ |
| "FILTER_TYPE_UNSPECIFIED", |
| "FILTER_TYPE_NONE", |
| "FILTER_TYPE_ADVERTISER_ID", |
| "FILTER_TYPE_CAMPAIGN_ID", |
| "FILTER_TYPE_MEDIA_PRODUCT_ID", |
| "FILTER_TYPE_INSERTION_ORDER_ID", |
| "FILTER_TYPE_LINE_ITEM_ID" |
| ], |
| "enumDescriptions": [ |
| "Default value when type is unspecified or is unknown in this version.", |
| "If selected, no filter will be applied to the download. Can only be used if\nan Advertiser is specified\nin CreateSdfDownloadTaskRequest.", |
| "Advertiser ID. If selected, all filter IDs must be Advertiser IDs that\nbelong to the Partner specified\nin CreateSdfDownloadTaskRequest.", |
| "Campaign ID. If selected, all filter IDs must be Campaign IDs that belong\nto the Advertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest.", |
| "Media Product ID. If selected, all filter IDs must be Media Product IDs\nthat belong to the Advertiser\nor Partner specified in\nCreateSdfDownloadTaskRequest. Can only be used for downloading\n`FILE_TYPE_MEDIA_PRODUCT`.", |
| "Insertion Order ID. If selected, all filter IDs must be Insertion Order IDs\nthat belong to the Advertiser\nor Partner specified in\nCreateSdfDownloadTaskRequest. Can only be used for downloading\n`FILE_TYPE_INSERTION_ORDER`, `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_AD_GROUP`,\nand `FILE_TYPE_AD`.", |
| "Line Item ID. If selected, all filter IDs must be Line Item IDs that belong\nto the Advertiser or\nPartner specified in\nCreateSdfDownloadTaskRequest. Can only be used for downloading\n`FILE_TYPE_LINE_ITEM`, `FILE_TYPE_AD_GROUP`, and `FILE_TYPE_AD`." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "SdfDownloadTask": { |
| "description": "Type for the response returned\nby [SdfDownloadTaskService.CreateSdfDownloadTask].", |
| "id": "SdfDownloadTask", |
| "properties": { |
| "resourceName": { |
| "description": "A resource name to be used in\nmedia.download to Download the prepared\nfiles. Resource names have the format\n`download/sdfdownloadtasks/media/{media_id}`. `media_id` will be made\navailable by the long running operation service once the task status is\ndone.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "SdfDownloadTaskMetadata": { |
| "description": "Type for the metadata returned\nby [SdfDownloadTaskService.CreateSdfDownloadTask].", |
| "id": "SdfDownloadTaskMetadata", |
| "properties": { |
| "createTime": { |
| "description": "The time when the operation was created.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "endTime": { |
| "description": "The time when execution was completed.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "version": { |
| "description": "The SDF version used to execute this download task.", |
| "enum": [ |
| "SDF_VERSION_UNSPECIFIED", |
| "SDF_VERSION_3_1", |
| "SDF_VERSION_4", |
| "SDF_VERSION_4_1", |
| "SDF_VERSION_4_2", |
| "SDF_VERSION_5", |
| "SDF_VERSION_5_1" |
| ], |
| "enumDescriptions": [ |
| "SDF version value is not specified or is unknown in this version.", |
| "SDF version 3.1", |
| "SDF version 4", |
| "SDF version 4.1", |
| "SDF version 4.2", |
| "SDF version 5.", |
| "SDF version 5.1" |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "Status": { |
| "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).", |
| "id": "Status", |
| "properties": { |
| "code": { |
| "description": "The status code, which should be an enum value of google.rpc.Code.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "details": { |
| "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", |
| "items": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "type": "object" |
| }, |
| "type": "array" |
| }, |
| "message": { |
| "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| } |
| }, |
| "servicePath": "", |
| "title": "Display \u0026 Video 360 API", |
| "version": "v1", |
| "version_module": true |
| } |
