Home | History | Annotate | Download | only in dyn
      1 <html><body>
      2 <style>
      3 
      4 body, h1, h2, h3, div, span, p, pre, a {
      5   margin: 0;
      6   padding: 0;
      7   border: 0;
      8   font-weight: inherit;
      9   font-style: inherit;
     10   font-size: 100%;
     11   font-family: inherit;
     12   vertical-align: baseline;
     13 }
     14 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, h2, h3 {
     50   border-bottom: solid #CCC 1px;
     51 }
     52 
     53 .toc_element {
     54   margin-top: 0.5em;
     55 }
     56 
     57 .firstline {
     58   margin-left: 2 em;
     59 }
     60 
     61 .method  {
     62   margin-top: 1em;
     63   border: solid 1px #CCC;
     64   padding: 1em;
     65   background: #EEE;
     66 }
     67 
     68 .details {
     69   font-weight: bold;
     70   font-size: 14px;
     71 }
     72 
     73 </style>
     74 
     75 <h1><a href="blogger_v3.html">Blogger API</a> . <a href="blogger_v3.postUserInfos.html">postUserInfos</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#get">get(userId, blogId, postId, maxComments=None)</a></code></p>
     79 <p class="firstline">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.</p>
     80 <p class="toc_element">
     81   <code><a href="#list">list(userId, blogId, orderBy=None, startDate=None, endDate=None, labels=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None)</a></code></p>
     82 <p class="firstline">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.</p>
     83 <p class="toc_element">
     84   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     85 <p class="firstline">Retrieves the next page of results.</p>
     86 <h3>Method Details</h3>
     87 <div class="method">
     88     <code class="details" id="get">get(userId, blogId, postId, maxComments=None)</code>
     89   <pre>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.
     90 
     91 Args:
     92   userId: string, ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. (required)
     93   blogId: string, The ID of the blog. (required)
     94   postId: string, The ID of the post to get. (required)
     95   maxComments: integer, Maximum number of comments to pull back on a post.
     96 
     97 Returns:
     98   An object of the form:
     99 
    100     {
    101     "kind": "blogger#postUserInfo", # The kind of this entity. Always blogger#postUserInfo
    102     "post": { # The Post resource.
    103       "status": "A String", # Status of the post. Only set for admin-level requests
    104       "content": "A String", # The content of the Post. May contain HTML markup.
    105       "kind": "blogger#post", # The kind of this entity. Always blogger#post
    106       "titleLink": "A String", # The title link URL, similar to atom's related link.
    107       "author": { # The author of this Post.
    108         "url": "A String", # The URL of the Post creator's Profile page.
    109         "image": { # The Post author's avatar.
    110           "url": "A String", # The Post author's avatar URL.
    111         },
    112         "displayName": "A String", # The display name.
    113         "id": "A String", # The identifier of the Post creator.
    114       },
    115       "replies": { # The container of comments on this Post.
    116         "totalItems": "A String", # The count of comments on this post.
    117         "items": [ # The List of Comments for this Post.
    118           {
    119             "status": "A String", # The status of the comment (only populated for admin users)
    120             "content": "A String", # The actual content of the comment. May include HTML markup.
    121             "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
    122             "inReplyTo": { # Data about the comment this is in reply to.
    123               "id": "A String", # The identified of the parent of this comment.
    124             },
    125             "author": { # The author of this Comment.
    126               "url": "A String", # The URL of the Comment creator's Profile page.
    127               "image": { # The comment creator's avatar.
    128                 "url": "A String", # The comment creator's avatar URL.
    129               },
    130               "displayName": "A String", # The display name.
    131               "id": "A String", # The identifier of the Comment creator.
    132             },
    133             "updated": "A String", # RFC 3339 date-time when this comment was last updated.
    134             "blog": { # Data about the blog containing this comment.
    135               "id": "A String", # The identifier of the blog containing this comment.
    136             },
    137             "published": "A String", # RFC 3339 date-time when this comment was published.
    138             "post": { # Data about the post containing this comment.
    139               "id": "A String", # The identifier of the post containing this comment.
    140             },
    141             "id": "A String", # The identifier for this resource.
    142             "selfLink": "A String", # The API REST URL to fetch this resource from.
    143           },
    144         ],
    145         "selfLink": "A String", # The URL of the comments on this post.
    146       },
    147       "readerComments": "A String", # Comment control and display setting for readers of this post.
    148       "labels": [ # The list of labels this Post was tagged with.
    149         "A String",
    150       ],
    151       "customMetaData": "A String", # The JSON meta-data for the Post.
    152       "updated": "A String", # RFC 3339 date-time when this Post was last updated.
    153       "blog": { # Data about the blog containing this Post.
    154         "id": "A String", # The identifier of the Blog that contains this Post.
    155       },
    156       "url": "A String", # The URL where this Post is displayed.
    157       "etag": "A String", # Etag of the resource.
    158       "location": { # The location for geotagged posts.
    159         "lat": 3.14, # Location's latitude.
    160         "lng": 3.14, # Location's longitude.
    161         "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
    162         "name": "A String", # Location name.
    163       },
    164       "published": "A String", # RFC 3339 date-time when this Post was published.
    165       "images": [ # Display image for the Post.
    166         {
    167           "url": "A String",
    168         },
    169       ],
    170       "title": "A String", # The title of the Post.
    171       "id": "A String", # The identifier of this Post.
    172       "selfLink": "A String", # The API REST URL to fetch this resource from.
    173     },
    174     "post_user_info": { # Information about a User for the Post.
    175       "kind": "blogger#postPerUserInfo", # The kind of this entity. Always blogger#postPerUserInfo
    176       "postId": "A String", # ID of the Post resource.
    177       "userId": "A String", # ID of the User.
    178       "blogId": "A String", # ID of the Blog that the post resource belongs to.
    179       "hasEditAccess": True or False, # True if the user has Author level access to the post.
    180     },
    181   }</pre>
    182 </div>
    183 
    184 <div class="method">
    185     <code class="details" id="list">list(userId, blogId, orderBy=None, startDate=None, endDate=None, labels=None, pageToken=None, status=None, maxResults=None, fetchBodies=None, view=None)</code>
    186   <pre>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.
    187 
    188 Args:
    189   userId: string, ID of the user for the per-user information to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. (required)
    190   blogId: string, ID of the blog to fetch posts from. (required)
    191   orderBy: string, Sort order applied to search results. Default is published.
    192     Allowed values
    193       published - Order by the date the post was published
    194       updated - Order by the date the post was last updated
    195   startDate: string, Earliest post date to fetch, a date-time with RFC 3339 formatting.
    196   endDate: string, Latest post date to fetch, a date-time with RFC 3339 formatting.
    197   labels: string, Comma-separated list of labels to search for.
    198   pageToken: string, Continuation token if the request is paged.
    199   status: string, A parameter (repeated)
    200     Allowed values
    201       draft - Draft posts
    202       live - Published posts
    203       scheduled - Posts that are scheduled to publish in future.
    204   maxResults: integer, Maximum number of posts to fetch.
    205   fetchBodies: boolean, Whether the body content of posts is included. Default is false.
    206   view: string, Access level with which to view the returned result. Note that some fields require elevated access.
    207     Allowed values
    208       ADMIN - Admin level detail
    209       AUTHOR - Author level detail
    210       READER - Reader level detail
    211 
    212 Returns:
    213   An object of the form:
    214 
    215     {
    216     "nextPageToken": "A String", # Pagination token to fetch the next page, if one exists.
    217     "items": [ # The list of Posts with User information for the post, for this Blog.
    218       {
    219         "kind": "blogger#postUserInfo", # The kind of this entity. Always blogger#postUserInfo
    220         "post": { # The Post resource.
    221           "status": "A String", # Status of the post. Only set for admin-level requests
    222           "content": "A String", # The content of the Post. May contain HTML markup.
    223           "kind": "blogger#post", # The kind of this entity. Always blogger#post
    224           "titleLink": "A String", # The title link URL, similar to atom's related link.
    225           "author": { # The author of this Post.
    226             "url": "A String", # The URL of the Post creator's Profile page.
    227             "image": { # The Post author's avatar.
    228               "url": "A String", # The Post author's avatar URL.
    229             },
    230             "displayName": "A String", # The display name.
    231             "id": "A String", # The identifier of the Post creator.
    232           },
    233           "replies": { # The container of comments on this Post.
    234             "totalItems": "A String", # The count of comments on this post.
    235             "items": [ # The List of Comments for this Post.
    236               {
    237                 "status": "A String", # The status of the comment (only populated for admin users)
    238                 "content": "A String", # The actual content of the comment. May include HTML markup.
    239                 "kind": "blogger#comment", # The kind of this entry. Always blogger#comment
    240                 "inReplyTo": { # Data about the comment this is in reply to.
    241                   "id": "A String", # The identified of the parent of this comment.
    242                 },
    243                 "author": { # The author of this Comment.
    244                   "url": "A String", # The URL of the Comment creator's Profile page.
    245                   "image": { # The comment creator's avatar.
    246                     "url": "A String", # The comment creator's avatar URL.
    247                   },
    248                   "displayName": "A String", # The display name.
    249                   "id": "A String", # The identifier of the Comment creator.
    250                 },
    251                 "updated": "A String", # RFC 3339 date-time when this comment was last updated.
    252                 "blog": { # Data about the blog containing this comment.
    253                   "id": "A String", # The identifier of the blog containing this comment.
    254                 },
    255                 "published": "A String", # RFC 3339 date-time when this comment was published.
    256                 "post": { # Data about the post containing this comment.
    257                   "id": "A String", # The identifier of the post containing this comment.
    258                 },
    259                 "id": "A String", # The identifier for this resource.
    260                 "selfLink": "A String", # The API REST URL to fetch this resource from.
    261               },
    262             ],
    263             "selfLink": "A String", # The URL of the comments on this post.
    264           },
    265           "readerComments": "A String", # Comment control and display setting for readers of this post.
    266           "labels": [ # The list of labels this Post was tagged with.
    267             "A String",
    268           ],
    269           "customMetaData": "A String", # The JSON meta-data for the Post.
    270           "updated": "A String", # RFC 3339 date-time when this Post was last updated.
    271           "blog": { # Data about the blog containing this Post.
    272             "id": "A String", # The identifier of the Blog that contains this Post.
    273           },
    274           "url": "A String", # The URL where this Post is displayed.
    275           "etag": "A String", # Etag of the resource.
    276           "location": { # The location for geotagged posts.
    277             "lat": 3.14, # Location's latitude.
    278             "lng": 3.14, # Location's longitude.
    279             "span": "A String", # Location's viewport span. Can be used when rendering a map preview.
    280             "name": "A String", # Location name.
    281           },
    282           "published": "A String", # RFC 3339 date-time when this Post was published.
    283           "images": [ # Display image for the Post.
    284             {
    285               "url": "A String",
    286             },
    287           ],
    288           "title": "A String", # The title of the Post.
    289           "id": "A String", # The identifier of this Post.
    290           "selfLink": "A String", # The API REST URL to fetch this resource from.
    291         },
    292         "post_user_info": { # Information about a User for the Post.
    293           "kind": "blogger#postPerUserInfo", # The kind of this entity. Always blogger#postPerUserInfo
    294           "postId": "A String", # ID of the Post resource.
    295           "userId": "A String", # ID of the User.
    296           "blogId": "A String", # ID of the Blog that the post resource belongs to.
    297           "hasEditAccess": True or False, # True if the user has Author level access to the post.
    298         },
    299       },
    300     ],
    301     "kind": "blogger#postUserInfosList", # The kind of this entity. Always blogger#postList
    302   }</pre>
    303 </div>
    304 
    305 <div class="method">
    306     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    307   <pre>Retrieves the next page of results.
    308 
    309 Args:
    310   previous_request: The request for the previous page. (required)
    311   previous_response: The response from the request for the previous page. (required)
    312 
    313 Returns:
    314   A request object that you can call 'execute()' on to request the next
    315   page. Returns None if there are no more items in the collection.
    316     </pre>
    317 </div>
    318 
    319 </body></html>