Admin Directory API . resources . calendars

Instance Methods

delete(customer, calendarResourceId)

Deletes a calendar resource.

get(customer, calendarResourceId)

Retrieves a calendar resource.

insert(customer, body)

Inserts a calendar resource.

list(customer, pageToken=None, maxResults=None)

Retrieves a list of calendar resources for an account.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(customer, calendarResourceId, body)

Updates a calendar resource. This method supports patch semantics.

update(customer, calendarResourceId, body)

Updates a calendar resource.

Method Details

delete(customer, calendarResourceId)
Deletes a calendar resource.

Args:
  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  calendarResourceId: string, The unique ID of the calendar resource to delete. (required)
get(customer, calendarResourceId)
Retrieves a calendar resource.

Args:
  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  calendarResourceId: string, The unique ID of the calendar resource to retrieve. (required)

Returns:
  An object of the form:

    { # JSON template for Calendar Resource object in Directory API.
      "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
      "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
      "resourceDescription": "A String", # The brief description of the calendar resource.
      "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
      "etags": "A String", # ETag of the resource.
      "resourceId": "A String", # The unique ID for the calendar resource.
      "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
    }
insert(customer, body)
Inserts a calendar resource.

Args:
  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Calendar Resource object in Directory API.
    "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
    "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
    "resourceDescription": "A String", # The brief description of the calendar resource.
    "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
    "etags": "A String", # ETag of the resource.
    "resourceId": "A String", # The unique ID for the calendar resource.
    "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
  }


Returns:
  An object of the form:

    { # JSON template for Calendar Resource object in Directory API.
      "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
      "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
      "resourceDescription": "A String", # The brief description of the calendar resource.
      "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
      "etags": "A String", # ETag of the resource.
      "resourceId": "A String", # The unique ID for the calendar resource.
      "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
    }
list(customer, pageToken=None, maxResults=None)
Retrieves a list of calendar resources for an account.

Args:
  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  pageToken: string, Token to specify the next page in the list.
  maxResults: integer, Maximum number of results to return.

Returns:
  An object of the form:

    { # JSON template for Calendar Resource List Response object in Directory API.
    "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
    "items": [ # The CalendarResources in this page of results.
      { # JSON template for Calendar Resource object in Directory API.
          "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
          "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
          "resourceDescription": "A String", # The brief description of the calendar resource.
          "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
          "etags": "A String", # ETag of the resource.
          "resourceId": "A String", # The unique ID for the calendar resource.
          "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
        },
    ],
    "kind": "admin#directory#resources#calendars#calendarResourcesList", # Identifies this as a collection of CalendarResources. This is always admin#directory#resources#calendars#calendarResourcesList.
    "etag": "A String", # ETag of the resource.
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
patch(customer, calendarResourceId, body)
Updates a calendar resource. This method supports patch semantics.

Args:
  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  calendarResourceId: string, The unique ID of the calendar resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Calendar Resource object in Directory API.
    "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
    "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
    "resourceDescription": "A String", # The brief description of the calendar resource.
    "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
    "etags": "A String", # ETag of the resource.
    "resourceId": "A String", # The unique ID for the calendar resource.
    "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
  }


Returns:
  An object of the form:

    { # JSON template for Calendar Resource object in Directory API.
      "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
      "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
      "resourceDescription": "A String", # The brief description of the calendar resource.
      "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
      "etags": "A String", # ETag of the resource.
      "resourceId": "A String", # The unique ID for the calendar resource.
      "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
    }
update(customer, calendarResourceId, body)
Updates a calendar resource.

Args:
  customer: string, The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. (required)
  calendarResourceId: string, The unique ID of the calendar resource to update. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for Calendar Resource object in Directory API.
    "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
    "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
    "resourceDescription": "A String", # The brief description of the calendar resource.
    "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
    "etags": "A String", # ETag of the resource.
    "resourceId": "A String", # The unique ID for the calendar resource.
    "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
  }


Returns:
  An object of the form:

    { # JSON template for Calendar Resource object in Directory API.
      "kind": "admin#directory#resources#calendars#CalendarResource", # The type of the resource. For calendar resources, the value is admin#directory#resources#calendars#CalendarResource.
      "resourceType": "A String", # The type of the calendar resource. Used for grouping resources in the calendar user interface.
      "resourceDescription": "A String", # The brief description of the calendar resource.
      "resourceEmail": "A String", # The read-only email ID for the calendar resource. Generated as part of creating a new calendar resource.
      "etags": "A String", # ETag of the resource.
      "resourceId": "A String", # The unique ID for the calendar resource.
      "resourceName": "A String", # The name of the calendar resource. For example, Training Room 1A
    }