...

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

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

     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 manage and create campaigns and reports.",
    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:v1beta",
    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      }
   141    },
   142    "sdfdownloadtask": {
   143      "resources": {
   144        "operations": {
   145          "methods": {
   146            "get": {
   147              "description": "Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.",
   148              "flatPath": "v1beta/sdfdownloadtask/operations/{operationsId}",
   149              "httpMethod": "GET",
   150              "id": "displayvideo.sdfdownloadtask.operations.get",
   151              "parameterOrder": [
   152                "name"
   153              ],
   154              "parameters": {
   155                "name": {
   156                  "description": "The name of the operation resource.",
   157                  "location": "path",
   158                  "pattern": "^sdfdownloadtask/operations/[^/]+$",
   159                  "required": true,
   160                  "type": "string"
   161                }
   162              },
   163              "path": "v1beta/{+name}",
   164              "response": {
   165                "$ref": "Operation"
   166              },
   167              "scopes": [
   168                "https://www.googleapis.com/auth/display-video",
   169                "https://www.googleapis.com/auth/doubleclickbidmanager"
   170              ]
   171            }
   172          }
   173        }
   174      }
   175    },
   176    "sdfdownloadtasks": {
   177      "resources": {
   178        "operations": {
   179          "methods": {
   180            "get": {
   181              "description": "Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds.",
   182              "flatPath": "v1beta/sdfdownloadtasks/operations/{operationsId}",
   183              "httpMethod": "GET",
   184              "id": "displayvideo.sdfdownloadtasks.operations.get",
   185              "parameterOrder": [
   186                "name"
   187              ],
   188              "parameters": {
   189                "name": {
   190                  "description": "The name of the operation resource.",
   191                  "location": "path",
   192                  "pattern": "^sdfdownloadtasks/operations/[^/]+$",
   193                  "required": true,
   194                  "type": "string"
   195                }
   196              },
   197              "path": "v1beta/{+name}",
   198              "response": {
   199                "$ref": "Operation"
   200              },
   201              "scopes": [
   202                "https://www.googleapis.com/auth/display-video",
   203                "https://www.googleapis.com/auth/doubleclickbidmanager"
   204              ]
   205            }
   206          }
   207        }
   208      }
   209    }
   210  },
   211  "revision": "20200901",
   212  "rootUrl": "https://displayvideo.googleapis.com/",
   213  "schemas": {
   214    "GoogleBytestreamMedia": {
   215      "description": "Media resource.",
   216      "id": "GoogleBytestreamMedia",
   217      "properties": {
   218        "resourceName": {
   219          "description": "Name of the media resource.",
   220          "type": "string"
   221        }
   222      },
   223      "type": "object"
   224    },
   225    "Operation": {
   226      "description": "This resource represents a long-running operation that is the result of a network API call.",
   227      "id": "Operation",
   228      "properties": {
   229        "done": {
   230          "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.",
   231          "type": "boolean"
   232        },
   233        "error": {
   234          "$ref": "Status",
   235          "description": "The error result of the operation in case of failure or cancellation."
   236        },
   237        "metadata": {
   238          "additionalProperties": {
   239            "description": "Properties of the object. Contains field @type with type URL.",
   240            "type": "any"
   241          },
   242          "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.",
   243          "type": "object"
   244        },
   245        "name": {
   246          "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}`.",
   247          "type": "string"
   248        },
   249        "response": {
   250          "additionalProperties": {
   251            "description": "Properties of the object. Contains field @type with type URL.",
   252            "type": "any"
   253          },
   254          "description": "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`.",
   255          "type": "object"
   256        }
   257      },
   258      "type": "object"
   259    },
   260    "Status": {
   261      "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).",
   262      "id": "Status",
   263      "properties": {
   264        "code": {
   265          "description": "The status code, which should be an enum value of google.rpc.Code.",
   266          "format": "int32",
   267          "type": "integer"
   268        },
   269        "details": {
   270          "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
   271          "items": {
   272            "additionalProperties": {
   273              "description": "Properties of the object. Contains field @type with type URL.",
   274              "type": "any"
   275            },
   276            "type": "object"
   277          },
   278          "type": "array"
   279        },
   280        "message": {
   281          "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.",
   282          "type": "string"
   283        }
   284      },
   285      "type": "object"
   286    }
   287  },
   288  "servicePath": "",
   289  "title": "Display \u0026 Video 360 API",
   290  "version": "v1beta",
   291  "version_module": true
   292}

View as plain text