getUsers: Returns detailed information on users

In Dementiy/vkR: Access to VK API via R

Description

Returns detailed information on users

Usage

getUsers(
  user_ids = "",
  fields = "",
  name_case = "nom",
  flatten = FALSE,
  v = getAPIVersion()
)

Arguments

user_ids	User IDs or screen names (screen_name). By default, current user ID (the maximum number of elements allowed is 1000)
fields	Profile fields to return (see fetails for more information about fields)
name_case	Case for declension of user name and surname
flatten	Automatically flatten nested data frames into a single non-nested data frame
v	Version of API

Details

User object describes a user profile, contains the following fields:

• uid User ID

• first_name First name

• last_name Last name

• deactivated Returns if a profile is deleted or blocked. Gets the value deleted or banned. Keep in mind that in this case no additional fields are returned

• hidden: 1 Returns while operating without access_token if a user has set the "Who can see my profile on the Internet" -> "Only VK users" privacy setting. Keep in mind that in this case no additional fields are returned

• verified Returns 1 if the profile is verified, 0 if not

• blacklisted Returns 1 if a current user is in the requested user's blacklist

• sex User sex (1 - female; 2 - male; 0 - not specified)

• bdate User's date of birth. Returned as DD.MM.YYYY or DD.MM (if birth year is hidden). If the whole date is hidden, no field is returned

• city ID of the city specified on user's page in "Contacts" section. Returns city ID that can be used to get its name using places.getCityById method. If no city is specified or main information on the page is hidden for in privacy settings, then it returns 0

• country ID of the country specified on user's page in "Contacts" section. Returns country ID that can be used to get its name using places.getCountryById method. If no country is specified or main information on the page is hidden in privacy settings, then it returns 0

• home_town User's home town

• photo_50 Returns URL of square photo of the user with 50 pixels in width. In case user does not have a photo, http://vk.com/images/camera_c.gif is returned

• photo_100 Returns URL of square photo of the user with 100 pixels in width. In case user does not have a photo, http://vk.com/images/camera_b.gif is returned

• photo_200_orig Returns URL of user's photo with 200 pixels in width. In case user does not have a photo, http://vk.com/images/camera_a.gif is returned

• photo_200 Returns URL of square photo of the user with 200 pixels in width. If the photo was uploaded long time ago, there can be no image of such size and in this case the reply will not include this field

• photo_400_orig Returns URL of user's photo with 400 pixels in width. If user does not have a photo of such size, reply will not include this field

• photo_max Returns URL of square photo of the user with maximum width. Can be returned a photo both 200 and 100 pixels in width. In case user does not have a photo, http://vk.com/images/camera_b.gif is returned

• photo_max_orig Returns URL of user's photo of maximum size. Can be returned a photo both 400 and 200 pixels in width. In case user does not have a photo, http://vk.com/images/camera_a.gif is returned

• online Information whether the user is online. Returned values: 1 - online, 0 - offline. If user utilizes a mobile application or site mobile version, it returns online_mobile additional field that includes 1. With that, in case of application, online_app additional field is returned with application ID.

• lists Information about friend lists. Returns IDs of friend lists the user is member of, separated with a comma. The field is available for friends.get method only. To get information about ID and names of friend lists use friends.getLists method. If user is not a member of any friend list, then when accepting data in XML format the respective <user> node does not contain <lists> tag

• domain Page screen name. Returns a string with a page screen name (only subdomain is returned, like andrew). If not set, "id'+uid is returned, e.g. id35828305

• has_mobile Information whether the user's mobile phone number is available. Returned values: 1 - available, 0 - not available. We recommend you to use it prior to call of secure.sendSMSNotification method

• contacts Information about user's phone numbers. If data are available and not hidden in privacy settings, the following fields are returned (mobile_phone - user's mobile phone number (only for standalone applications); home_phone - user's additional phone number)

• site Returns a website address from a user profile

• education Information about user's higher education institution. The following fields are returned:

  • university University ID

  • university_name University name

  • faculty Faculty ID

  • faculty_name Faculty name

  • graduation Graduation year

• universities List of higher education institutions where user studied. Returns universities array with university objects with the following fields:

  • id University ID

  • country ID of the country the university is located in

  • city ID of the city the university is located in

  • name University name

  • faculty Faculty ID

  • faculty_name Faculty name

  • chair University chair ID

  • chair_name Chair name

  • graduation Graduation year

• schools List of schools where user studied in. Returns schools array with school objects with the following fields:

  • id School ID

  • country ID of the country the school is located in

  • city ID of the city the school is located in

  • name School name

  • year_from Year the user started to study

  • year_to Year the user finished to study

  • year_graduated Graduation year

  • class School class letter

  • speciality Speciality

  • type Type ID

  • type_str Type name

• status User status. Returns a string with status text that is in the profile below user's name

• last_seen Last visit date. Returns last_seen object with the following fields:

  • time Last visit date (in Unix time)

  • platform Type of the platform that used for the last authorization. See more at Using LongPoll server

• followers_count Number of user's followers

• common_count Number of common friends with a current user

• counters Number of various objects the user has. Can be used in users.get method only when requesting information about a user. Returns an object with fields:

  • albums Number of photo albums

  • videos Number of videos

  • audios Number of audios

  • notes Number of notes

  • friends Number of friends

  • groups Number of communities

  • online_friends Number of online friends

  • mutual_friends Number of mutual friends

  • user_videos Number of videos the user is tagged on

  • followers Number of followers

  • user_photos Number of photos the user is tagged on

  • subscriptions Number of subscriptions

• occupation Current user's occupation. Returns following fields:

  • type Can take the values: work, school, university

  • id ID of school, university, company group (the one a user works in)

  • name Name of school, university or work place

• nickname User nickname

• relatives Current user's relatives list. Returns a list of objects with id and type fields (name instead of id if a relative is not a VK user). type - relationship type. Possible values:

  • sibling

  • parent

  • child

  • grandparent

  • grandchild

• relation User relationship status. Returned values:

  • 1 - Single

  • 2 - In a relationship

  • 3 - Engaged

  • 4 - Married

  • 5 - It's complicated

  • 6 - Actively searching

  • 7 - In love

• personal Information from the "Personal views" section

  • political Political views:

    • 1 - Communist

    • 2 - Socialist

    • 3 - Moderate

    • 4 - Liberal

    • 5 - Conservative

    • 6 - Monarchist

    • 7 - Ultraconservative

    • 8 - Apathetic

    • 9 - Libertian

  • langs Languages

  • religion World view

  • inspired_by Inspired by

  • people_main Improtant in others:

    • 1 - Intellect and creativity

    • 2 - Kindness and honesty

    • 3 - Health and beauty

    • 4 - Wealth and power

    • 5 - Courage and persistance

    • 6 - Humor and love for life

  • life_main Personal priority:

    • 1 - Family and children

    • 2 - Career and money

    • 3 - Entertainment and leisure

    • 4 - Science and research

    • 5 - Improving the world

    • 6 - Personal development

    • 7 - Beauty and art

    • 8 - Fame and influence

  • smoking Views on smoking (1 - very negative; 2 - negative; 3 - neutral; 4 - compromisable; 5 - positive)

  • alcohol Views on alcohol (1 - very negative; 2 - negative; 3 - neutral; 4 - compromisable; 5 - positive)

• connections Returns specified services such as: skype, facebook, twitter, livejournal, instagram

• exports External services with export configured (twitter, facebook, livejournal, instagram)

• wall_comments Wall comments allowed(1 - allowed, 0 - not allowed)

• activities Activities

• interests Interests

• music Favorite music

• movies Favorite movies

• tv Favorite TV shows

• books Favorite books

• games Favorite games

• about "About me"

• quotes Favorite quotes

• can_post Can post on the wall: 1 - allowed, 0 - not allowed

• can_see_all_posts Can see other users' posts on the wall: 1 - allowed, 0 - not allowed

• can_see_audio Can see other users' audio on the wall: 1 - allowed, 0 - not allowed

• can_write_private_message Can write private messages to a current user: 1 - allowed, 0 - not allowed

• timezone user time zone. Retuns only while requesting current user info

• screen_name User page's screen name (subdomain)

Examples

## Not run: 
user <- getUsers('1', fields='sex,bdate,city')

## End(Not run)

Dementiy/vkR documentation built on Oct. 1, 2020, 9:48 a.m.