google_api_blogger

v0.8.0

google_api_blogger v0.8.0 GoogleApi.Blogger.V3.Api.PostUserInfos View Source

API calls for all endpoints tagged PostUserInfos.

Link to this section Summary

Functions

blogger_post_user_infos_get(connection, user_id, blog_id, post_id, optional_params \\ [], opts \\ [])

Gets one post and user info pair, by post ID and user ID. The post user info contains per-user information about the post, such as access rights, specific to the user.

blogger_post_user_infos_list(connection, user_id, blog_id, optional_params \\ [], opts \\ [])

Retrieves a list of post and post user info pairs, possibly filtered. The post user info contains per-user information about the post, such as access rights, specific to the user.

Link to this section Functions

Link to this function

blogger_post_user_infos_get(connection, user_id, blog_id, post_id, optional_params \\ [], opts \\ [])

View Source 
blogger_post_user_infos_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Blogger.V3.Model.PostUserInfo.t()} | {:error, Tesla.Env.t()}

Gets one post and user info pair, by post ID and user ID. The post user info contains per-user information about the post, such as access rights, specific to the user.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • user_id (type: String.t) - ID of the user for the per-user information to be fetched. Either the word 'self' or the user's profile identifier.
  • blog_id (type: String.t) - The ID of the blog.
  • post_id (type: String.t) - The ID of the post to get.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :maxComments (type: integer()) - Maximum number of comments to pull back on a post.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.PostUserInfo{}} on success
  • {:error, info} on failure
Link to this function

blogger_post_user_infos_list(connection, user_id, blog_id, optional_params \\ [], opts \\ [])

View Source 
blogger_post_user_infos_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Blogger.V3.Model.PostUserInfosList.t()}
  | {:error, Tesla.Env.t()}

Retrieves a list of post and post user info pairs, possibly filtered. The post user info contains per-user information about the post, such as access rights, specific to the user.

Parameters

  • connection (type: GoogleApi.Blogger.V3.Connection.t) - Connection to server
  • user_id (type: String.t) - ID of the user for the per-user information to be fetched. Either the word 'self' or the user's profile identifier.
  • blog_id (type: String.t) - ID of the blog to fetch posts from.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :endDate (type: DateTime.t) - Latest post date to fetch, a date-time with RFC 3339 formatting.
    • :fetchBodies (type: boolean()) - Whether the body content of posts is included. Default is false.
    • :labels (type: String.t) - Comma-separated list of labels to search for.
    • :maxResults (type: integer()) - Maximum number of posts to fetch.
    • :orderBy (type: String.t) - Sort order applied to search results. Default is published.
    • :pageToken (type: String.t) - Continuation token if the request is paged.
    • :startDate (type: DateTime.t) - Earliest post date to fetch, a date-time with RFC 3339 formatting.
    • :status (type: list(String.t)) -
    • :view (type: String.t) - Access level with which to view the returned result. Note that some fields require elevated access.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Blogger.V3.Model.PostUserInfosList{}} on success
  • {:error, info} on failure