googleapiclient/discovery_cache/documents/ideahub.v1alpha.json

{
  "basePath": "",
  "baseUrl": "https://ideahub.googleapis.com/",
  "batchPath": "batch",
  "canonicalName": "Ideahub",
  "description": "",
  "discoveryVersion": "v1",
  "documentationLink": "https://console.cloud.google.com/apis/library/ideahub.googleapis.com",
  "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": "ideahub:v1alpha",
  "kind": "discovery#restDescription",
  "mtlsRootUrl": "https://ideahub.mtls.googleapis.com/",
  "name": "ideahub",
  "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": {
    "ideas": {
      "methods": {
        "list": {
          "description": "List ideas for a given Creator and filter and sort options.",
          "flatPath": "v1alpha/ideas",
          "httpMethod": "GET",
          "id": "ideahub.ideas.list",
          "parameterOrder": [],
          "parameters": {
            "creator.platform": {
              "description": "Identifies the platform from which this user is accessing Idea Hub.",
              "enum": [
                "UNKNOWN",
                "BLOGGER",
                "SITEKIT"
              ],
              "enumDescriptions": [
                "",
                "",
                ""
              ],
              "location": "query",
              "type": "string"
            },
            "creator.platformId": {
              "description": "Identifies the platform account (blog/site/etc.) for which to fetch Ideas.",
              "location": "query",
              "type": "string"
            },
            "filter": {
              "description": "Filter semantics described below.",
              "location": "query",
              "type": "string"
            },
            "orderBy": {
              "description": "Order semantics described below.",
              "location": "query",
              "type": "string"
            },
            "pageSize": {
              "description": "The maximum number of ideas per page. If unspecified, at most 10 ideas will be returned. The maximum value is 2000; values above 2000 will be coerced to 2000.",
              "format": "int32",
              "location": "query",
              "type": "integer"
            },
            "pageToken": {
              "description": "Used to fetch next page.",
              "location": "query",
              "type": "string"
            },
            "parent": {
              "description": "If defined, specifies the creator for which to filter by. Format: publishers/{publisher}/properties/{property}",
              "location": "query",
              "type": "string"
            }
          },
          "path": "v1alpha/ideas",
          "response": {
            "$ref": "GoogleSearchIdeahubV1alphaListIdeasResponse"
          }
        }
      }
    },
    "platforms": {
      "resources": {
        "properties": {
          "resources": {
            "ideaStates": {
              "methods": {
                "patch": {
                  "description": "Update an idea state resource.",
                  "flatPath": "v1alpha/platforms/{platformsId}/properties/{propertiesId}/ideaStates/{ideaStatesId}",
                  "httpMethod": "PATCH",
                  "id": "ideahub.platforms.properties.ideaStates.patch",
                  "parameterOrder": [
                    "name"
                  ],
                  "parameters": {
                    "name": {
                      "description": "Unique identifier for the idea state. Format: platforms/{platform}/properties/{property}/ideaStates/{idea_state}",
                      "location": "path",
                      "pattern": "^platforms/[^/]+/properties/[^/]+/ideaStates/[^/]+$",
                      "required": true,
                      "type": "string"
                    },
                    "updateMask": {
                      "description": "The list of fields to be updated.",
                      "format": "google-fieldmask",
                      "location": "query",
                      "type": "string"
                    }
                  },
                  "path": "v1alpha/{+name}",
                  "request": {
                    "$ref": "GoogleSearchIdeahubV1alphaIdeaState"
                  },
                  "response": {
                    "$ref": "GoogleSearchIdeahubV1alphaIdeaState"
                  }
                }
              }
            },
            "ideas": {
              "methods": {
                "list": {
                  "description": "List ideas for a given Creator and filter and sort options.",
                  "flatPath": "v1alpha/platforms/{platformsId}/properties/{propertiesId}/ideas",
                  "httpMethod": "GET",
                  "id": "ideahub.platforms.properties.ideas.list",
                  "parameterOrder": [
                    "parent"
                  ],
                  "parameters": {
                    "creator.platform": {
                      "description": "Identifies the platform from which this user is accessing Idea Hub.",
                      "enum": [
                        "UNKNOWN",
                        "BLOGGER",
                        "SITEKIT"
                      ],
                      "enumDescriptions": [
                        "",
                        "",
                        ""
                      ],
                      "location": "query",
                      "type": "string"
                    },
                    "creator.platformId": {
                      "description": "Identifies the platform account (blog/site/etc.) for which to fetch Ideas.",
                      "location": "query",
                      "type": "string"
                    },
                    "filter": {
                      "description": "Filter semantics described below.",
                      "location": "query",
                      "type": "string"
                    },
                    "orderBy": {
                      "description": "Order semantics described below.",
                      "location": "query",
                      "type": "string"
                    },
                    "pageSize": {
                      "description": "The maximum number of ideas per page. If unspecified, at most 10 ideas will be returned. The maximum value is 2000; values above 2000 will be coerced to 2000.",
                      "format": "int32",
                      "location": "query",
                      "type": "integer"
                    },
                    "pageToken": {
                      "description": "Used to fetch next page.",
                      "location": "query",
                      "type": "string"
                    },
                    "parent": {
                      "description": "If defined, specifies the creator for which to filter by. Format: publishers/{publisher}/properties/{property}",
                      "location": "path",
                      "pattern": "^platforms/[^/]+/properties/[^/]+$",
                      "required": true,
                      "type": "string"
                    }
                  },
                  "path": "v1alpha/{+parent}/ideas",
                  "response": {
                    "$ref": "GoogleSearchIdeahubV1alphaListIdeasResponse"
                  }
                }
              }
            },
            "locales": {
              "methods": {
                "list": {
                  "description": "Returns which locales ideas are available in for a given Creator.",
                  "flatPath": "v1alpha/platforms/{platformsId}/properties/{propertiesId}/locales",
                  "httpMethod": "GET",
                  "id": "ideahub.platforms.properties.locales.list",
                  "parameterOrder": [
                    "parent"
                  ],
                  "parameters": {
                    "pageSize": {
                      "description": "The maximum number of locales to return. The service may return fewer than this value. If unspecified, at most 100 locales will be returned. The maximum value is 100; values above 100 will be coerced to 100.",
                      "format": "int32",
                      "location": "query",
                      "type": "integer"
                    },
                    "pageToken": {
                      "description": "A page token, received from a previous `ListAvailableLocales` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAvailableLocales` must match the call that provided the page token.",
                      "location": "query",
                      "type": "string"
                    },
                    "parent": {
                      "description": "Required. The web property to check idea availability for Format: platforms/{platform}/property/{property}",
                      "location": "path",
                      "pattern": "^platforms/[^/]+/properties/[^/]+$",
                      "required": true,
                      "type": "string"
                    }
                  },
                  "path": "v1alpha/{+parent}/locales",
                  "response": {
                    "$ref": "GoogleSearchIdeahubV1alphaListAvailableLocalesResponse"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "revision": "20210604",
  "rootUrl": "https://ideahub.googleapis.com/",
  "schemas": {
    "GoogleSearchIdeahubV1alphaAvailableLocale": {
      "description": "Represents locales that are available for a web property.",
      "id": "GoogleSearchIdeahubV1alphaAvailableLocale",
      "properties": {
        "locale": {
          "description": "A string in BCP 47 format, without a resource prefix.",
          "type": "string"
        },
        "name": {
          "description": "A string in BCP 47 format, prefixed with the platform and property name, and \"locales/\". Format: platforms/{platform}/properties/{property}/locales/{locale}",
          "type": "string"
        }
      },
      "type": "object"
    },
    "GoogleSearchIdeahubV1alphaIdea": {
      "description": "A single Idea that we want to show the end user.",
      "id": "GoogleSearchIdeahubV1alphaIdea",
      "properties": {
        "name": {
          "description": "Unique identifier for the idea. Format: ideas/{ideaId}",
          "type": "string"
        },
        "text": {
          "description": "The idea\u2019s text.",
          "type": "string"
        },
        "topics": {
          "description": "The Topics that match the idea.",
          "items": {
            "$ref": "GoogleSearchIdeahubV1alphaTopic"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "GoogleSearchIdeahubV1alphaIdeaState": {
      "description": "Represents idea state specific to a web property.",
      "id": "GoogleSearchIdeahubV1alphaIdeaState",
      "properties": {
        "dismissed": {
          "description": "Whether the idea is dismissed.",
          "type": "boolean"
        },
        "name": {
          "description": "Unique identifier for the idea state. Format: platforms/{platform}/properties/{property}/ideaStates/{idea_state}",
          "type": "string"
        },
        "saved": {
          "description": "Whether the idea is saved.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "GoogleSearchIdeahubV1alphaListAvailableLocalesResponse": {
      "description": "Response for whether ideas are available for a given web property on a platform, for the currently logged-in user.",
      "id": "GoogleSearchIdeahubV1alphaListAvailableLocalesResponse",
      "properties": {
        "availableLocales": {
          "description": "Locales for which ideas are available for the given Creator.",
          "items": {
            "$ref": "GoogleSearchIdeahubV1alphaAvailableLocale"
          },
          "type": "array"
        },
        "nextPageToken": {
          "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "GoogleSearchIdeahubV1alphaListIdeasResponse": {
      "id": "GoogleSearchIdeahubV1alphaListIdeasResponse",
      "properties": {
        "ideas": {
          "description": "Results for the ListIdeasRequest.",
          "items": {
            "$ref": "GoogleSearchIdeahubV1alphaIdea"
          },
          "type": "array"
        },
        "nextPageToken": {
          "description": "Used to fetch the next page in a subsequent request.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "GoogleSearchIdeahubV1alphaTopic": {
      "description": "Represents a Topic umbrella for a list of questions that a Creator may want to respond to.",
      "id": "GoogleSearchIdeahubV1alphaTopic",
      "properties": {
        "displayName": {
          "description": "String displayed to the creator indicating the name of the Topic.",
          "type": "string"
        },
        "mid": {
          "description": "The mID of the topic.",
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "servicePath": "",
  "title": "Idea Hub API",
  "version": "v1alpha",
  "version_module": true
}