Google Analytics Admin API . properties . accessBindings

batchCreate(parent, body=None, x__xgafv=None)

Creates information about multiple access bindings to an account or property. This method is transactional. If any AccessBinding cannot be created, none of the AccessBindings will be created.

Args:
  parent: string, Required. The account or property that owns the access bindings. The parent field in the CreateAccessBindingRequest messages must either be empty or match this field. Formats: - accounts/{account} - properties/{property} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for BatchCreateAccessBindings RPC.
  "requests": [ # Required. The requests specifying the access bindings to create. A maximum of 1000 access bindings can be created in a batch.
    { # Request message for CreateAccessBinding RPC.
      "accessBinding": { # A binding of a user to a set of roles. # Required. The access binding to create.
        "name": "A String", # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"
        "roles": [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
          "A String",
        ],
        "user": "A String", # If set, the email address of the user to set roles for. Format: "someuser@gmail.com"
      },
      "parent": "A String", # Required. Formats: - accounts/{account} - properties/{property}
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for BatchCreateAccessBindings RPC.
  "accessBindings": [ # The access bindings created.
    { # A binding of a user to a set of roles.
      "name": "A String", # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"
      "roles": [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
        "A String",
      ],
      "user": "A String", # If set, the email address of the user to set roles for. Format: "someuser@gmail.com"
    },
  ],
}

batchDelete(parent, body=None, x__xgafv=None)

Deletes information about multiple users' links to an account or property.

Args:
  parent: string, Required. The account or property that owns the access bindings. The parent of all provided values for the 'names' field in DeleteAccessBindingRequest messages must match this field. Formats: - accounts/{account} - properties/{property} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for BatchDeleteAccessBindings RPC.
  "requests": [ # Required. The requests specifying the access bindings to delete. A maximum of 1000 access bindings can be deleted in a batch.
    { # Request message for DeleteAccessBinding RPC.
      "name": "A String", # Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

batchGet(parent, names=None, x__xgafv=None)

Gets information about multiple access bindings to an account or property.

Args:
  parent: string, Required. The account or property that owns the access bindings. The parent of all provided values for the 'names' field must match this field. Formats: - accounts/{account} - properties/{property} (required)
  names: string, Required. The names of the access bindings to retrieve. A maximum of 1000 access bindings can be retrieved in a batch. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding} (repeated)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for BatchGetAccessBindings RPC.
  "accessBindings": [ # The requested access bindings.
    { # A binding of a user to a set of roles.
      "name": "A String", # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"
      "roles": [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
        "A String",
      ],
      "user": "A String", # If set, the email address of the user to set roles for. Format: "someuser@gmail.com"
    },
  ],
}

batchUpdate(parent, body=None, x__xgafv=None)

Updates information about multiple access bindings to an account or property.

Args:
  parent: string, Required. The account or property that owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats: - accounts/{account} - properties/{property} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for BatchUpdateAccessBindings RPC.
  "requests": [ # Required. The requests specifying the access bindings to update. A maximum of 1000 access bindings can be updated in a batch.
    { # Request message for UpdateAccessBinding RPC.
      "accessBinding": { # A binding of a user to a set of roles. # Required. The access binding to update.
        "name": "A String", # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"
        "roles": [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
          "A String",
        ],
        "user": "A String", # If set, the email address of the user to set roles for. Format: "someuser@gmail.com"
      },
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for BatchUpdateAccessBindings RPC.
  "accessBindings": [ # The access bindings updated.
    { # A binding of a user to a set of roles.
      "name": "A String", # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"
      "roles": [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
        "A String",
      ],
      "user": "A String", # If set, the email address of the user to set roles for. Format: "someuser@gmail.com"
    },
  ],
}

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates an access binding on an account or property.

Args:
  parent: string, Required. Formats: - accounts/{account} - properties/{property} (required)
  body: object, The request body.
    The object takes the form of:

{ # A binding of a user to a set of roles.
  "name": "A String", # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"
  "roles": [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
    "A String",
  ],
  "user": "A String", # If set, the email address of the user to set roles for. Format: "someuser@gmail.com"
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A binding of a user to a set of roles.
  "name": "A String", # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"
  "roles": [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
    "A String",
  ],
  "user": "A String", # If set, the email address of the user to set roles for. Format: "someuser@gmail.com"
}

delete(name, x__xgafv=None)

Deletes an access binding on an account or property.

Args:
  name: string, Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Gets information about an access binding.

Args:
  name: string, Required. The name of the access binding to retrieve. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A binding of a user to a set of roles.
  "name": "A String", # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"
  "roles": [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
    "A String",
  ],
  "user": "A String", # If set, the email address of the user to set roles for. Format: "someuser@gmail.com"
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists all access bindings on an account or property.

Args:
  parent: string, Required. Formats: - accounts/{account} - properties/{property} (required)
  pageSize: integer, The maximum number of access bindings to return. The service may return fewer than this value. If unspecified, at most 200 access bindings will be returned. The maximum value is 500; values above 500 will be coerced to 500.
  pageToken: string, A page token, received from a previous `ListAccessBindings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccessBindings` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListAccessBindings RPC.
  "accessBindings": [ # List of AccessBindings. These will be ordered stably, but in an arbitrary order.
    { # A binding of a user to a set of roles.
      "name": "A String", # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"
      "roles": [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
        "A String",
      ],
      "user": "A String", # If set, the email address of the user to set roles for. Format: "someuser@gmail.com"
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

list_next()

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(name, body=None, x__xgafv=None)

Updates an access binding on an account or property.

Args:
  name: string, Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200" (required)
  body: object, The request body.
    The object takes the form of:

{ # A binding of a user to a set of roles.
  "name": "A String", # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"
  "roles": [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
    "A String",
  ],
  "user": "A String", # If set, the email address of the user to set roles for. Format: "someuser@gmail.com"
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A binding of a user to a set of roles.
  "name": "A String", # Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"
  "roles": [ # A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.
    "A String",
  ],
  "user": "A String", # If set, the email address of the user to set roles for. Format: "someuser@gmail.com"
}