...

Text file src/google.golang.org/api/displayvideo/v4/displayvideo-api.json

Documentation: google.golang.org/api/displayvideo/v4

     1{
     2  "auth": {
     3    "oauth2": {
     4      "scopes": {
     5        "https://www.googleapis.com/auth/display-video": {
     6          "description": "Create, see, edit, and permanently delete your Display \u0026 Video 360 entities and reports"
     7        },
     8        "https://www.googleapis.com/auth/doubleclickbidmanager": {
     9          "description": "View and manage your reports in DoubleClick Bid Manager"
    10        }
    11      }
    12    }
    13  },
    14  "basePath": "",
    15  "baseUrl": "https://displayvideo.googleapis.com/",
    16  "batchPath": "batch",
    17  "canonicalName": "Display Video",
    18  "description": "Display \u0026 Video 360 API allows users to automate complex Display \u0026 Video 360 workflows, such as creating insertion orders and setting targeting options for individual line items.",
    19  "discoveryVersion": "v1",
    20  "documentationLink": "https://developers.google.com/display-video/",
    21  "fullyEncodeReservedExpansion": true,
    22  "icons": {
    23    "x16": "http://www.google.com/images/icons/product/search-16.gif",
    24    "x32": "http://www.google.com/images/icons/product/search-32.gif"
    25  },
    26  "id": "displayvideo:v4",
    27  "kind": "discovery#restDescription",
    28  "mtlsRootUrl": "https://displayvideo.mtls.googleapis.com/",
    29  "name": "displayvideo",
    30  "ownerDomain": "google.com",
    31  "ownerName": "Google",
    32  "parameters": {
    33    "$.xgafv": {
    34      "description": "V1 error format.",
    35      "enum": [
    36        "1",
    37        "2"
    38      ],
    39      "enumDescriptions": [
    40        "v1 error format",
    41        "v2 error format"
    42      ],
    43      "location": "query",
    44      "type": "string"
    45    },
    46    "access_token": {
    47      "description": "OAuth access token.",
    48      "location": "query",
    49      "type": "string"
    50    },
    51    "alt": {
    52      "default": "json",
    53      "description": "Data format for response.",
    54      "enum": [
    55        "json",
    56        "media",
    57        "proto"
    58      ],
    59      "enumDescriptions": [
    60        "Responses with Content-Type of application/json",
    61        "Media download with context-dependent Content-Type",
    62        "Responses with Content-Type of application/x-protobuf"
    63      ],
    64      "location": "query",
    65      "type": "string"
    66    },
    67    "callback": {
    68      "description": "JSONP",
    69      "location": "query",
    70      "type": "string"
    71    },
    72    "fields": {
    73      "description": "Selector specifying which fields to include in a partial response.",
    74      "location": "query",
    75      "type": "string"
    76    },
    77    "key": {
    78      "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.",
    79      "location": "query",
    80      "type": "string"
    81    },
    82    "oauth_token": {
    83      "description": "OAuth 2.0 token for the current user.",
    84      "location": "query",
    85      "type": "string"
    86    },
    87    "prettyPrint": {
    88      "default": "true",
    89      "description": "Returns response with indentations and line breaks.",
    90      "location": "query",
    91      "type": "boolean"
    92    },
    93    "quotaUser": {
    94      "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.",
    95      "location": "query",
    96      "type": "string"
    97    },
    98    "uploadType": {
    99      "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
   100      "location": "query",
   101      "type": "string"
   102    },
   103    "upload_protocol": {
   104      "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
   105      "location": "query",
   106      "type": "string"
   107    }
   108  },
   109  "protocol": "rest",
   110  "resources": {
   111    "media": {
   112      "methods": {
   113        "download": {
   114          "description": "Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string.",
   115          "flatPath": "download/{downloadId}",
   116          "httpMethod": "GET",
   117          "id": "displayvideo.media.download",
   118          "parameterOrder": [
   119            "resourceName"
   120          ],
   121          "parameters": {
   122            "resourceName": {
   123              "description": "Name of the media that is being downloaded. See ReadRequest.resource_name.",
   124              "location": "path",
   125              "pattern": "^.*$",
   126              "required": true,
   127              "type": "string"
   128            }
   129          },
   130          "path": "download/{+resourceName}",
   131          "response": {
   132            "$ref": "GoogleBytestreamMedia"
   133          },
   134          "scopes": [
   135            "https://www.googleapis.com/auth/display-video",
   136            "https://www.googleapis.com/auth/doubleclickbidmanager"
   137          ],
   138          "supportsMediaDownload": true
   139        },
   140        "upload": {
   141          "description": "Uploads media. Upload is supported on the URI `/upload/media/{resource_name=**}?upload_type=media.` **Note**: Upload requests will not be successful without including `upload_type=media` query string.",
   142          "flatPath": "media/{mediaId}",
   143          "httpMethod": "POST",
   144          "id": "displayvideo.media.upload",
   145          "mediaUpload": {
   146            "accept": [
   147              "*/*"
   148            ],
   149            "protocols": {
   150              "simple": {
   151                "multipart": true,
   152                "path": "/upload/media/{+resourceName}"
   153              }
   154            }
   155          },
   156          "parameterOrder": [
   157            "resourceName"
   158          ],
   159          "parameters": {
   160            "resourceName": {
   161              "description": "Name of the media that is being downloaded. See ReadRequest.resource_name.",
   162              "location": "path",
   163              "pattern": "^.*$",
   164              "required": true,
   165              "type": "string"
   166            }
   167          },
   168          "path": "media/{+resourceName}",
   169          "request": {
   170            "$ref": "GoogleBytestreamMedia"
   171          },
   172          "response": {
   173            "$ref": "GoogleBytestreamMedia"
   174          },
   175          "scopes": [
   176            "https://www.googleapis.com/auth/display-video",
   177            "https://www.googleapis.com/auth/doubleclickbidmanager"
   178          ],
   179          "supportsMediaUpload": true
   180        }
   181      }
   182    },
   183    "sdfdownloadtasks": {
   184      "resources": {
   185        "operations": {
   186          "methods": {
   187            "get": {
   188              "description": "Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.",
   189              "flatPath": "v4/sdfdownloadtasks/operations/{operationsId}",
   190              "httpMethod": "GET",
   191              "id": "displayvideo.sdfdownloadtasks.operations.get",
   192              "parameterOrder": [
   193                "name"
   194              ],
   195              "parameters": {
   196                "name": {
   197                  "description": "The name of the operation resource.",
   198                  "location": "path",
   199                  "pattern": "^sdfdownloadtasks/operations/[^/]+$",
   200                  "required": true,
   201                  "type": "string"
   202                }
   203              },
   204              "path": "v4/{+name}",
   205              "response": {
   206                "$ref": "Operation"
   207              },
   208              "scopes": [
   209                "https://www.googleapis.com/auth/display-video",
   210                "https://www.googleapis.com/auth/doubleclickbidmanager"
   211              ]
   212            }
   213          }
   214        }
   215      }
   216    }
   217  },
   218  "revision": "20240118",
   219  "rootUrl": "https://displayvideo.googleapis.com/",
   220  "schemas": {
   221    "GoogleBytestreamMedia": {
   222      "description": "Media resource.",
   223      "id": "GoogleBytestreamMedia",
   224      "properties": {
   225        "resourceName": {
   226          "description": "Name of the media resource.",
   227          "type": "string"
   228        }
   229      },
   230      "type": "object"
   231    },
   232    "Operation": {
   233      "description": "This resource represents a long-running operation that is the result of a network API call.",
   234      "id": "Operation",
   235      "properties": {
   236        "done": {
   237          "description": "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.",
   238          "type": "boolean"
   239        },
   240        "error": {
   241          "$ref": "Status",
   242          "description": "The error result of the operation in case of failure or cancellation."
   243        },
   244        "metadata": {
   245          "additionalProperties": {
   246            "description": "Properties of the object. Contains field @type with type URL.",
   247            "type": "any"
   248          },
   249          "description": "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.",
   250          "type": "object"
   251        },
   252        "name": {
   253          "description": "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}`.",
   254          "type": "string"
   255        },
   256        "response": {
   257          "additionalProperties": {
   258            "description": "Properties of the object. Contains field @type with type URL.",
   259            "type": "any"
   260          },
   261          "description": "The normal, successful response of the operation. 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`.",
   262          "type": "object"
   263        }
   264      },
   265      "type": "object"
   266    },
   267    "Status": {
   268      "description": "The `Status` type defines a logical error model that is suitable for 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).",
   269      "id": "Status",
   270      "properties": {
   271        "code": {
   272          "description": "The status code, which should be an enum value of google.rpc.Code.",
   273          "format": "int32",
   274          "type": "integer"
   275        },
   276        "details": {
   277          "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
   278          "items": {
   279            "additionalProperties": {
   280              "description": "Properties of the object. Contains field @type with type URL.",
   281              "type": "any"
   282            },
   283            "type": "object"
   284          },
   285          "type": "array"
   286        },
   287        "message": {
   288          "description": "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.",
   289          "type": "string"
   290        }
   291      },
   292      "type": "object"
   293    }
   294  },
   295  "servicePath": "",
   296  "title": "Display \u0026 Video 360 API",
   297  "version": "v4",
   298  "version_module": true
   299}

View as plain text